xref: /freebsd/usr.sbin/ac/ac.8 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
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 February 14, 2020
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
42If the file
43.Pa /var/log/utx.log
44exists, a record of individual login and logout
45times are written to it by
46.Xr login 1
47and
48.Xr init 8 ,
49respectively.
50The
51.Nm
52utility
53examines these records and writes the accumulated connect time (in hours)
54for all logins to the standard output.
55.Pp
56The options are as follows:
57.Bl -tag -width indentXXX
58.It Fl d
59Display 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
69Print individual users' totals.
70.It Fl t Ar tty
71Only do accounting logins on certain ttys.
72The
73.Ar tty
74specification can start with '!' to indicate not this
75.Ar tty
76and end with '*' to indicate all similarly named ttys.
77Multiple
78.Fl t
79flags may be specified.
80.It Fl w Ar wtmp
81Read connect time data from
82.Ar wtmp
83instead of the default file,
84.Pa /var/log/utx.log .
85.It Ar users ...
86Display totals for the given individuals only.
87.El
88.Pp
89If no arguments are given,
90.Nm
91displays the total connect time for all
92accounts with login sessions recorded in
93.Pa utx.log .
94.Pp
95The default
96.Pa utx.log
97file will increase without bound unless it is truncated.
98It is normally truncated by the daily scripts run
99by
100.Xr cron 8 ,
101which rename and rotate the
102.Pa utx.log
103files, keeping a week's worth of data on
104hand.
105No login or connect time accounting is performed if
106.Pa /var/log/utx.log
107does not exist.
108.Sh FILES
109.Bl -tag -width /var/log/utx.log -compact
110.It Pa /var/log/utx.log
111connect time accounting file
112.El
113.Sh EXIT STATUS
114.Ex -std
115.Sh EXAMPLES
116Allow times recorded in
117.Pa modems
118to be charged out at a different rate than
119.Pa other :
120.Bd -literal -offset indent
121ac -p -t "ttyd*" > modems
122ac -p -t "!ttyd*" > other
123.Ed
124.Sh SEE ALSO
125.Xr login 1 ,
126.Xr getutxent 3 ,
127.Xr init 8 ,
128.Xr sa 8
129.Sh HISTORY
130An
131.Nm
132command appeared in
133.At v5 .
134This version of
135.Nm
136was written for
137.Nx 0.9a
138from the specification provided by various systems' manual pages.
139.\" .Sh NOTES
140.\" If COMPAT_SUNOS is defined
141.\" .Nm ac
142.\" ignores the fact that entries with ut_host of ":0.0" are not real
143.\" login sessions.  Normally such entries are ignored except in the case
144.\" of a user being logged in when the
145.\" .Pa wtmp
146.\" file was rotated, in which case a login with ut_host of ":0.0" may
147.\" appear without any preceding console logins.
148.\" If no one is logged in on the console, the user is deemed to have
149.\" logged in on at the earliest time stamp found in
150.\" .Pa wtmp .
151.\" Use of
152.\" .Pa console
153.\" allows
154.\" .Nm ac
155.\" to identify and correctly process a logout for the user.  The default
156.\" value for
157.\" .Pa console
158.\" is usually correct at compile time.
159