lib/libc/sys/acct.2

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