xref: /386bsd/usr/src/usr.bin/finger/finger.1 (revision a2142627)
1.\" Copyright (c) 1989, 1990 The Regents of the University of California.
2.\" 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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	@(#)finger.1	6.14 (Berkeley) 7/27/91
33.\"
34.Dd July 27, 1991
35.Dt FINGER 1
36.Os BSD 4
37.Sh NAME
38.Nm finger
39.Nd user information lookup program
40.Sh SYNOPSIS
41.Nm finger
42.Op Fl lmsp
43.Op Ar user ...
44.Op Ar user@host ...
45.Sh DESCRIPTION
46The
47.Nm finger
48displays information about the system users.
49.Pp
50Options are:
51.Bl -tag -width flag
52.It Fl s
53.Nm Finger
54displays the user's login name, real name, terminal name and write
55status (as a ``*'' after the terminal name if write permission is
56denied), idle time, login time, office location and office phone
57number.
58.Pp
59Idle time is in minutes if it is a single integer, hours and minutes
60if a ``:'' is present, or days if a ``d'' is present.
61Login time is displayed as month, day, hours and minutes, unless
62more than six months ago, in which case the year is displayed rather
63than the hours and minutes.
64.Pp
65Unknown devices as well as nonexistent idle and login times are
66displayed as single asterisks.
67.Pp
68.It Fl l
69Produces a multi-line format displaying all of the information
70described for the
71.Fl s
72option as well as the user's home directory, home phone number, login
73shell, and the contents of the files
74.Dq Pa .forward ,
75.Dq Pa .plan
76and
77.Dq Pa .project
78from the user's home directory.
79.Pp
80If idle time is at least a minute and less than a day, it is
81presented in the form ``hh:mm''.
82Idle times greater than a day are presented as ``d day[s]hh:mm''.
83.Pp
84Phone numbers specified as eleven digits are printed as ``+N-NNN-NNN-NNNN''.
85Numbers specified as ten or seven digits are printed as the appropriate
86subset of that string.
87Numbers specified as five digits are printed as ``xN-NNNN''.
88.Pp
89If write permission is denied to the device, the phrase ``(messages off)''
90is appended to the line containing the device name.
91One entry per user is displayed with the
92.Fl l
93option; if a user is logged on multiple times, terminal information
94is repeated once per login.
95.Pp
96.It Fl p
97Prevents
98the
99.Fl l
100option of
101.Nm finger
102from displaying the contents of the
103.Dq Pa .forward ,
104.Dq Pa .plan
105and
106.Dq Pa .project
107files.
108.It Fl m
109Prevent matching of
110.Ar user
111names.
112.Ar User
113is usually a login name; however, matching will also be done on the
114users' real names, unless the
115.Fl m
116option is supplied.
117All name matching performed by
118.Nm finger
119is case insensitive.
120.El
121.Pp
122If no options are specified,
123.Nm finger
124defaults to the
125.Fl l
126style output if operands are provided, otherwise to the
127.Fl s
128style.
129Note that some fields may be missing, in either format, if information
130is not available for them.
131.Pp
132If no arguments are specified,
133.Nm finger
134will print an entry for each user currently logged into the system.
135.Pp
136.Nm Finger
137may be used to look up users on a remote machine.
138The format is to specify a
139.Ar user
140as
141.Dq Li user@host ,
142or
143.Dq Li @host ,
144where the default output
145format for the former is the
146.Fl l
147style, and the default output format for the latter is the
148.Fl s
149style.
150The
151.Fl l
152option is the only option that may be passed to a remote machine.
153.Sh SEE ALSO
154.Xr chpass 1 ,
155.Xr w 1 ,
156.Xr who 1 ,
157.Sh HISTORY
158The
159.Nm finger
160command appeared in
161.Bx 3.0 .
162