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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)acct.2      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/sys/acct.2,v 1.6.2.5 2004/04/17 10:04:10 brueffer Exp $
  30 .\" $DragonFly: src/lib/libc/sys/acct.2,v 1.4 2006/05/26 19:39:37 swildner Exp $
  31 .\"
  32 .Dd April 17, 2004
  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 .In 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 The values controlling this behaviour can be modified using the following
  79 .Xr sysctl 8
  80 variables:
  81 .Bl -tag -width ".Va kern.acct_chkfreq"
  82 .It Va kern.acct_chkfreq
  83 Specifies the frequency (in seconds) with which free disk
  84 space should be checked.
  85 .It Va kern.acct_resume
  86 The percentage of free disk space above which process
  87 accounting will resume.
  88 .It Va kern.acct_suspend
  89 The percentage of free disk space below which process
  90 accounting will suspend.
  91 .El
  92 .Sh RETURN VALUES
  93 On error -1 is returned.
  94 The file must exist and the call may be exercised only by the super-user.
  95 .Sh ERRORS
  96 .Fn Acct
  97 will fail if one of the following is true:
  98 .Bl -tag -width Er
  99 .It Bq Er EPERM
 100 The caller is not the super-user.
 101 .It Bq Er ENOTDIR
 102 A component of the path prefix is not a directory.
 103 .It Bq Er ENAMETOOLONG
 104 A component of a pathname exceeded 255 characters,
 105 or an entire path name exceeded 1023 characters.
 106 .It Bq Er ENOENT
 107 The named file does not exist.
 108 .It Bq Er EACCES
 109 Search permission is denied for a component of the path prefix,
 110 or the path name is not a regular file.
 111 .It Bq Er ELOOP
 112 Too many symbolic links were encountered in translating the pathname.
 113 .It Bq Er EROFS
 114 The named file resides on a read-only file system.
 115 .It Bq Er EFAULT
 116 .Fa File
 117 points outside the process's allocated address space.
 118 .It Bq Er EIO
 119 An I/O error occurred while reading from or writing to the file system.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr acct 5 ,
 123 .Xr accton 8 ,
 124 .Xr sa 8
 125 .Sh HISTORY
 126 An
 127 .Fn acct
 128 function call appeared in
 129 .At v7 .