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.5 2004/04/17 10:04:10 brueffer Exp $
  34 .\" $DragonFly: src/lib/libc/sys/acct.2,v 1.4 2006/05/26 19:39:37 swildner Exp $
  35 .\"
  36 .Dd April 17, 2004
  37 .Dt ACCT 2
  38 .Os
  39 .Sh NAME
  40 .Nm acct
  41 .Nd enable or disable process accounting
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft int
  47 .Fn acct "const char *file"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn acct
  51 call enables or disables the collection of system accounting
  52 records.
  53 If the argument
  54 .Fa file
  55 is a nil pointer, accounting is disabled.
  56 If
  57 .Fa file
  58 is an
  59 .Em existing
  60 pathname (null-terminated), record collection is enabled and for
  61 every process initiated which terminates under normal
  62 conditions an accounting record is appended to
  63 .Fa file .
  64 Abnormal conditions of termination are reboots
  65 or other fatal system problems.
  66 Records for processes which never terminate can not be
  67 produced by
  68 .Fn acct .
  69 .Pp
  70 For more information on the record structure used by
  71 .Fn acct ,
  72 see
  73 .In sys/acct.h
  74 and
  75 .Xr acct 5 .
  76 .Pp
  77 This call is permitted only to the super-user.
  78 .Sh NOTES
  79 Accounting is automatically disabled when the file system the
  80 accounting file resides on runs out of space; it is enabled when
  81 space once again becomes available.
  82 The values controlling this behaviour can be modified using the following
  83 .Xr sysctl 8
  84 variables:
  85 .Bl -tag -width ".Va kern.acct_chkfreq"
  86 .It Va kern.acct_chkfreq
  87 Specifies the frequency (in seconds) with which free disk
  88 space should be checked.
  89 .It Va kern.acct_resume
  90 The percentage of free disk space above which process
  91 accounting will resume.
  92 .It Va kern.acct_suspend
  93 The percentage of free disk space below which process
  94 accounting will suspend.
  95 .El
  96 .Sh RETURN VALUES
  97 On error -1 is returned.
  98 The file must exist and the call may be exercised only by the super-user.
  99 .Sh ERRORS
 100 .Fn Acct
 101 will fail if one of the following is true:
 102 .Bl -tag -width Er
 103 .It Bq Er EPERM
 104 The caller is not the super-user.
 105 .It Bq Er ENOTDIR
 106 A component of the path prefix is not a directory.
 107 .It Bq Er ENAMETOOLONG
 108 A component of a pathname exceeded 255 characters,
 109 or an entire path name exceeded 1023 characters.
 110 .It Bq Er ENOENT
 111 The named file does not exist.
 112 .It Bq Er EACCES
 113 Search permission is denied for a component of the path prefix,
 114 or the path name is not a regular file.
 115 .It Bq Er ELOOP
 116 Too many symbolic links were encountered in translating the pathname.
 117 .It Bq Er EROFS
 118 The named file resides on a read-only file system.
 119 .It Bq Er EFAULT
 120 .Fa File
 121 points outside the process's allocated address space.
 122 .It Bq Er EIO
 123 An I/O error occurred while reading from or writing to the file system.
 124 .El
 125 .Sh SEE ALSO
 126 .Xr acct 5 ,
 127 .Xr accton 8 ,
 128 .Xr sa 8
 129 .Sh HISTORY
 130 An
 131 .Fn acct
 132 function call appeared in
 133 .At v7 .