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