lib/libc/sys/acct.2

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