share/man/man2/acct.2

   1 '\" te
   2 .\"  Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved  Copyright 1989 AT&T
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ACCT 2 "Jan 20, 2003"
   7 .SH NAME
   8 acct \- enable or disable process accounting
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <unistd.h>
  13
  14 \fBint\fR \fBacct\fR(\fBconst char *\fR\fIpath\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBacct()\fR function enables or disables the system process accounting
  21 routine. If the routine is enabled, an accounting record will be written in an
  22 accounting file for each process that terminates. The termination of a process
  23 can be caused by either an \fBexit\fR(2) call or a \fBsignal\fR(3C)). The
  24 effective user \fBID\fR of the process calling \fBacct()\fR must have the
  25 appropriate privileges.
  26 .sp
  27 .LP
  28 The \fIpath\fR argument points to the pathname of the accounting file, whose
  29 file format is described on the \fBacct.h\fR(3HEAD) manual page.
  30 .sp
  31 .LP
  32 The accounting routine is enabled if \fIpath\fR is non-zero and no errors occur
  33 during the function. It is disabled if \fIpath\fR is  \fBNULL\fR  and
  34 no errors occur during the function.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
  39 returned and \fBerrno\fR is set to indicate the error.
  40 .SH ERRORS
  41 .sp
  42 .LP
  43 The \fBacct()\fR function will fail if:
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBEACCES\fR\fR
  48 .ad
  49 .RS 16n
  50 The file named by \fIpath\fR is not an ordinary file.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBEBUSY\fR\fR
  57 .ad
  58 .RS 16n
  59 An attempt is being made to enable accounting using the same file that is
  60 currently being used.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBEFAULT\fR\fR
  67 .ad
  68 .RS 16n
  69 The \fIpath\fR argument points to an illegal address.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBELOOP\fR\fR
  76 .ad
  77 .RS 16n
  78 Too many symbolic links were encountered in translating \fIpath\fR.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBENAMETOOLONG\fR\fR
  85 .ad
  86 .RS 16n
  87 The length of the  \fIpath\fR argument exceeds {\fBPATH_MAX\fR}, or the length
  88 of a \fIpath\fR argument exceeds {\fBNAME_MAX\fR} while \fB_POSIX_NO_TRUNC\fR
  89 is in effect.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBENOENT\fR\fR
  96 .ad
  97 .RS 16n
  98 One or more components of the accounting file pathname do not exist.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBENOTDIR\fR\fR
 105 .ad
 106 .RS 16n
 107 A component of the path prefix is not a directory.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEPERM\fR\fR
 114 .ad
 115 .RS 16n
 116 The {\fBPRIV_SYS_ACCT\fR} privilege is not asserted in the effective set of the
 117 calling process.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBEROFS\fR\fR
 124 .ad
 125 .RS 16n
 126 The named file resides on a read-only file system.
 127 .RE
 128
 129 .SH SEE ALSO
 130 .sp
 131 .LP
 132 \fBexit\fR(2), \fBacct.h\fR(3HEAD), \fBsignal\fR(3C), \fBprivileges\fR(5)