BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / acct.2

diff --git a/usr/src/lib/libc/sys/acct.2 b/usr/src/lib/libc/sys/acct.2
index 0104129..0a36e7b 100644 (file)
--- a/usr/src/lib/libc/sys/acct.2
+++ b/usr/src/lib/libc/sys/acct.2
@@ -1,84 +1,115 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)acct.2      6.4 (Berkeley) 5/22/86
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.TH ACCT 2 "May 22, 1986"
-.UC 4
-.SH NAME
-acct \- turn accounting on or off
-.SH SYNOPSIS
-.nf
-.ft B
-acct(file)
-char *file;
-.ft R
-.fi
-.SH DESCRIPTION
-The system is prepared to write a record
-in an accounting
-.I file
-for each process as it terminates.
-This
-call, with a null-terminated string naming an existing file
-as argument, turns on accounting;
-records for each terminating process are appended to
-.IR file .
-An argument of 0 causes accounting to be turned off.
-.PP
-The accounting file format is given in
-.IR acct (5).
-.PP
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)acct.2     6.5 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt ACCT 2
+.Os BSD 4
+.Sh NAME
+.Nm acct
+.Nd enable or disable process accounting
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn acct "const char *file"
+.Sh DESCRIPTION
+The
+.Fn acct
+call enables or disables the collection of system accounting
+records.
+If the argument
+.Fa file
+is a nil pointer, accounting is disabled.
+If
+.Fa file
+is an
+.Em existing
+pathname (null-terminated), record collection is enabled and for 
+every process initiated which terminates under normal
+conditions an accounting record is appended to
+.Fa file .
+Abnormal conditions of termination are reboots
+or other fatal system problems.
+Records for processes which never terminate can not be
+produced by
+.Fn acct .
+.Pp
+For more information on the record structure used by
+.Fn acct ,
+see
+.Pa /usr/include/sys/acct.h
+and
+.Xr acct 5 .
+.Pp

 This call is permitted only to the super-user.
 This call is permitted only to the super-user.

-.SH NOTES
+.Sh NOTES

 Accounting is automatically disabled when the file system the
 accounting file resides on runs out of space; it is enabled when
 space once again becomes available.
 Accounting is automatically disabled when the file system the
 accounting file resides on runs out of space; it is enabled when
 space once again becomes available.

-.SH "RETURN VALUE
-On error \-1 is returned.
+.Sh RETURN VALUES
+On error -1 is returned.

 The file must exist and the call may be exercised only by the super-user.
 The file must exist and the call may be exercised only by the super-user.

-It is erroneous to try to turn on accounting when it is already on.
-.SH ERRORS
-.I Acct
+.Sh ERRORS
+.Fn Acct

 will fail if one of the following is true:
 will fail if one of the following is true:

-.TP 15
-[EPERM]
+.Bl -tag -width Er
+.It Bq Er EPERM

 The caller is not the super-user.
 The caller is not the super-user.

-.TP 15
-[ENOTDIR]
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named file does not exist.
 The named file does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for a component of the path prefix,
 or the path name is not a regular file.
 Search permission is denied for a component of the path prefix,
 or the path name is not a regular file.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EROFS]
+.It Bq Er EROFS

 The named file resides on a read-only file system.
 The named file resides on a read-only file system.

-.TP 15
-[EFAULT]
-.I File
+.It Bq Er EFAULT
+.Fa File

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while reading from or writing to the file system.
 An I/O error occurred while reading from or writing to the file system.

-.SH "SEE ALSO"
-acct(5), sa(8)
-.SH BUGS
-No accounting is produced for programs running
-when a crash occurs.
-In particular non-terminating programs are never
-accounted for.
+.El
+.Sh SEE ALSO
+.Xr acct 5 ,
+.Xr sa 8
+.Sh HISTORY
+An
+.Nm
+function call appeared in Version 7 AT&T UNIX.