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