usr.sbin/ac/ac.8

   1 .\"
   2 .\" Copyright (c) 1994 Simon J. Gerraty
   3 .\" Copyright (c) 1994 Christopher G. Demetriou
   4 .\" 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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd January 21, 2010
  29 .Dt AC 8
  30 .Os
  31 .Sh NAME
  32 .Nm ac
  33 .Nd connect time accounting
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl dp
  37 .\".Op Fl c Ar console
  38 .Op Fl t Ar tty
  39 .Op Fl w Ar wtmp
  40 .Op Ar users ...
  41 .Sh DESCRIPTION
  42 If the file
  43 .Pa /var/log/utx.log
  44 exists, a record of individual login and logout
  45 times are written to it by
  46 .Xr login 1
  47 and
  48 .Xr init 8 ,
  49 respectively.
  50 The
  51 .Nm
  52 utility
  53 examines these records and writes the accumulated connect time (in hours)
  54 for all logins to the standard output.
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width indentXXX
  58 .It Fl d
  59 Display the connect times in 24 hour chunks.
  60 .\" .It Fl c Ar console
  61 .\" Use
  62 .\" .Ar console
  63 .\" as the name of the device that local X sessions (ut_host of ":0.0")
  64 .\" originate from.  If any login has been recorded on
  65 .\" .Ar console
  66 .\" then these X sessions are ignored unless COMPAT_SUNOS was defined at
  67 .\" compile time.
  68 .It Fl p
  69 Print individual users' totals.
  70 .It Fl t Ar tty
  71 Only do accounting logins on certain ttys.
  72 The
  73 .Ar tty
  74 specification can start with '!' to indicate not this
  75 .Ar tty
  76 and end with '*' to indicate all similarly named ttys.
  77 Multiple
  78 .Fl t
  79 flags may be specified.
  80 .It Fl w Ar wtmp
  81 Read connect time data from
  82 .Ar wtmp
  83 instead of the default file,
  84 .Pa /var/log/utx.log .
  85 .It Ar users ...
  86 Display totals for the given individuals only.
  87 .El
  88 .Pp
  89 If no arguments are given,
  90 .Nm
  91 displays the total connect time for all
  92 accounts with login sessions recorded in
  93 .Pa utx.log .
  94 .Pp
  95 The default
  96 .Pa utx.log
  97 file will increase without bound unless it is truncated.
  98 It is normally truncated by the daily scripts run
  99 by
 100 .Xr cron 8 ,
 101 which rename and rotate the
 102 .Pa utx.log
 103 files, keeping a week's worth of data on
 104 hand.
 105 No login or connect time accounting is performed if
 106 .Pa /var/log/utx.log
 107 does not exist.
 108 .Pp
 109 For example,
 110 .Bd -literal -offset indent
 111 ac -p -t "ttyd*" > modems
 112 ac -p -t "!ttyd*" > other
 113 .Ed
 114 .Pp
 115 allows times recorded in
 116 .Pa modems
 117 to be charged out at a different rate than
 118 .Pa other .
 119 .Sh FILES
 120 .Bl -tag -width /var/log/utx.log -compact
 121 .It Pa /var/log/utx.log
 122 connect time accounting file
 123 .El
 124 .Sh EXIT STATUS
 125 .Ex -std
 126 .Sh SEE ALSO
 127 .Xr login 1 ,
 128 .Xr getutxent 3 ,
 129 .Xr init 8 ,
 130 .Xr sa 8
 131 .\" .Sh NOTES
 132 .\" If COMPAT_SUNOS is defined
 133 .\" .Nm ac
 134 .\" ignores the fact that entries with ut_host of ":0.0" are not real
 135 .\" login sessions.  Normally such entries are ignored except in the case
 136 .\" of a user being logged in when the
 137 .\" .Pa wtmp
 138 .\" file was rotated, in which case a login with ut_host of ":0.0" may
 139 .\" appear without any preceding console logins.
 140 .\" If no one is logged in on the console, the user is deemed to have
 141 .\" logged in on at the earliest time stamp found in
 142 .\" .Pa wtmp .
 143 .\" Use of
 144 .\" .Pa console
 145 .\" allows
 146 .\" .Nm ac
 147 .\" to identify and correctly process a logout for the user.  The default
 148 .\" value for
 149 .\" .Pa console
 150 .\" is usually correct at compile time.