3f6a636cc90ca35baf7d976139a9b9c52c852293
[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 .\" $DragonFly: src/usr.sbin/ac/ac.8,v 1.3 2006/02/17 19:40:09 swildner Exp $
33 .\"
34 .Dd March 15, 1994
35 .Dt AC 8
36 .Os
37 .Sh NAME
38 .Nm ac
39 .Nd connect time accounting
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl dp
43 .\".Op Fl c Ar console
44 .Op Fl t Ar tty
45 .Op Fl w Ar wtmp
46 .Op Ar users ...
47 .Sh DESCRIPTION
48 If the file
49 .Pa /var/log/wtmp
50 exists, a record of individual login and logout
51 times are written to it by
52 .Xr login 1
53 and
54 .Xr init 8 ,
55 respectively.
56 The
57 .Nm
58 utility
59 examines these records and writes the accumulated connect time (in hours)
60 for all logins to the standard output.
61 .Pp
62 The options are as follows:
63 .Bl -tag -width indentXXX
64 .It Fl d
65 Display the connect times in 24 hour chunks.
66 .\" .It Fl c Ar console
67 .\" Use
68 .\" .Ar console
69 .\" as the name of the device that local X sessions (ut_host of ":0.0")
70 .\" originate from.  If any login has been recorded on
71 .\" .Ar console
72 .\" then these X sessions are ignored unless COMPAT_SUNOS was defined at
73 .\" compile time.
74 .It Fl p
75 Print individual users' totals.
76 .It Fl t Ar tty
77 Only do accounting logins on certain ttys.  The
78 .Ar tty
79 specification can start with '!' to indicate not this
80 .Ar tty
81 and end with '*' to indicate all similarly named ttys.
82 Multiple
83 .Fl t
84 flags may be specified.
85 .It Fl w Ar wtmp
86 Read connect time data from
87 .Ar wtmp
88 instead of the default file,
89 .Pa /var/log/wtmp .
90 .It Ar users ...
91 Display totals for the given individuals only.
92 .El
93 .Pp
94 If no arguments are given,
95 .Nm
96 displays the total connect time for all
97 accounts with login sessions recorded in
98 .Pa wtmp .
99 .Pp
100 The default
101 .Pa wtmp
102 file will increase without bound unless it is truncated.
103 It is normally truncated by the daily scripts run
104 by
105 .Xr cron 8 ,
106 which rename and rotate the
107 .Pa wtmp
108 files, keeping a week's worth of data on
109 hand.  No login or connect time accounting is performed if
110 .Pa /var/log/wtmp
111 does not exist.
112 .Pp
113 For example,
114 .Bd -literal -offset
115 ac -p -t "ttyd*" > modems
116 ac -p -t "!ttyd*" > other
117 .Ed
118 .Pp
119 allows times recorded in
120 .Pa modems
121 to be charged out at a different rate than
122 .Pa other .
123 .Sh FILES
124 .Bl -tag -width /var/log/wtmp -compact
125 .It Pa /var/log/wtmp
126 connect time accounting file
127 .El
128 .Sh EXIT STATUS
129 .Ex -std
130 .Sh SEE ALSO
131 .Xr login 1 ,
132 .Xr utmp 5 ,
133 .Xr init 8 ,
134 .Xr sa 8
135 .\" .Sh NOTES
136 .\" If COMPAT_SUNOS is defined
137 .\" .Nm ac
138 .\" ignores the fact that entries with ut_host of ":0.0" are not real
139 .\" login sessions.  Normally such entries are ignored except in the case
140 .\" of a user being logged in when the
141 .\" .Pa wtmp
142 .\" file was rotated, in which case a login with ut_host of ":0.0" may
143 .\" appear without any preceding console logins.
144 .\" If no one is logged in on the console, the user is deemed to have
145 .\" logged in on at the earliest time stamp found in
146 .\" .Pa wtmp .
147 .\" Use of
148 .\" .Pa console
149 .\" allows
150 .\" .Nm ac
151 .\" to identify and correctly process a logout for the user.  The default
152 .\" value for
153 .\" .Pa console
154 .\" is usually correct at compile time.