xref: /openbsd/lib/libc/sys/acct.2 (revision db3296cf)
1.\"	$OpenBSD: acct.2,v 1.9 2003/06/02 20:18:38 millert Exp $
2.\"	$NetBSD: acct.2,v 1.6 1995/02/27 12:31:47 cgd Exp $
3.\"
4.\" Copyright (c) 1980, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)acct.2	8.1 (Berkeley) 6/4/93
32.\"
33.Dd June 4, 1993
34.Dt ACCT 2
35.Os
36.Sh NAME
37.Nm acct
38.Nd enable or disable process accounting
39.Sh SYNOPSIS
40.Fd #include <unistd.h>
41.Ft int
42.Fn acct "const char *file"
43.Sh DESCRIPTION
44The
45.Fn acct
46call enables or disables the collection of system accounting records.
47If
48.Fa file
49is
50.Dv NULL ,
51accounting is disabled.
52If
53.Fa file
54is an existing, null-terminated pathname, record collection is enabled
55and for every process initiated which terminates under normal conditions
56an accounting record is appended to
57.Fa file .
58Abnormal conditions of termination are reboots or other
59fatal system problems.
60Records for processes which never terminate can not be produced by
61.Fn acct .
62.Pp
63For more information on the record structure used by
64.Fn acct ,
65see
66.Pa /usr/include/sys/acct.h
67and
68.Xr acct 5 .
69.Pp
70This call is permitted only to the superuser.
71.Sh NOTES
72Accounting is automatically disabled when the file system the
73accounting file resides on runs out of space; it is enabled when
74space once again becomes available.
75.Sh RETURN VALUES
76On error \-1 is returned.
77The file must exist and the call may be exercised only by the superuser.
78.Sh ERRORS
79.Fn acct
80will fail if one of the following is true:
81.Bl -tag -width Er
82.It Bq Er EPERM
83The caller is not the superuser.
84.It Bq Er ENOTDIR
85A component of the path prefix is not a directory.
86.It Bq Er ENAMETOOLONG
87A component of a pathname exceeded
88.Dv {NAME_MAX}
89characters, or an entire path name exceeded
90.Dv {PATH_MAX}
91characters.
92.It Bq Er ENOENT
93The named file does not exist.
94.It Bq Er EACCES
95Search permission is denied for a component of the path prefix,
96or the path name is not a regular file.
97.It Bq Er ELOOP
98Too many symbolic links were encountered in translating the pathname.
99.It Bq Er EROFS
100The named file resides on a read-only file system.
101.It Bq Er EFAULT
102.Fa file
103points outside the process's allocated address space.
104.It Bq Er EIO
105An I/O error occurred while reading from or writing to the file system.
106.El
107.Sh SEE ALSO
108.Xr acct 5 ,
109.Xr accton 8 ,
110.Xr sa 8
111.Sh HISTORY
112An
113.Fn acct
114function call appeared in
115.At v7 .
116