xref: /freebsd/usr.bin/finger/finger.1 (revision 6ff6d951ade3f3379932df7f878ef3ea272cfc59)
1.\" Copyright (c) 1989, 1990, 1993, 1994
2.\"	The Regents of the University of California.  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	8.3 (Berkeley) 5/5/94
33.\" $FreeBSD$
34.\"
35.Dd April 11, 2007
36.Dt FINGER 1
37.Os
38.Sh NAME
39.Nm finger
40.Nd user information lookup program
41.Sh SYNOPSIS
42.Nm
43.Op Fl 46gklmpsho
44.Op Ar user ...\&
45.Op Ar user@host ...\&
46.Sh DESCRIPTION
47The
48.Nm
49utility displays information about the system users.
50.Pp
51Options are:
52.Bl -tag -width indent
53.It Fl 4
54Forces
55.Nm
56to use IPv4 addresses only.
57.It Fl 6
58Forces
59.Nm
60to use IPv6 addresses only.
61.It Fl s
62Display the user's login name, real name, terminal name and write
63status (as a ``*'' before the terminal name if write permission is
64denied), idle time, login time, and either office location and office
65phone number, or the remote host.
66If
67.Fl o
68is given, the office location and office phone number is printed
69(the default).
70If
71.Fl h
72is given, the remote host is printed instead.
73.Pp
74Idle time is in minutes if it is a single integer, hours and minutes
75if a ``:'' is present, or days if a ``d'' is present.
76If it is an
77.Dq * ,
78the login time indicates the time of last login.
79Login time is displayed as the day name if less than 6 days, else month, day;
80hours and minutes, unless more than six months ago, in which case the year
81is displayed rather than the hours and minutes.
82.Pp
83Unknown devices as well as nonexistent idle and login times are
84displayed as single asterisks.
85.It Fl h
86When used in conjunction with the
87.Fl s
88option, the name of the remote host is displayed instead of the office
89location and office phone.
90.It Fl o
91When used in conjunction with the
92.Fl s
93option, the office location and office phone information is displayed
94instead of the name of the remote host.
95.It Fl g
96This option restricts the gecos output to only the users' real
97name.
98It also has the side-effect of restricting the output
99of the remote host when used in conjunction with the
100.Fl h
101option.
102.It Fl k
103Disable all use of
104.Xr utmp 5 .
105.It Fl l
106Produce a multi-line format displaying all of the information
107described for the
108.Fl s
109option as well as the user's home directory, home phone number, login
110shell, mail status, and the contents of the files
111.Pa .forward ,
112.Pa .plan ,
113.Pa .project
114and
115.Pa .pubkey
116from the user's home directory.
117.Pp
118If idle time is at least a minute and less than a day, it is
119presented in the form ``hh:mm''.
120Idle times greater than a day are presented as ``d day[s]hh:mm''.
121.Pp
122Phone numbers specified as eleven digits are printed as ``+N-NNN-NNN-NNNN''.
123Numbers specified as ten or seven digits are printed as the appropriate
124subset of that string.
125Numbers specified as five digits are printed as ``xN-NNNN''.
126Numbers specified as four digits are printed as ``xNNNN''.
127.Pp
128If write permission is denied to the device, the phrase ``(messages off)''
129is appended to the line containing the device name.
130One entry per user is displayed with the
131.Fl l
132option; if a user is logged on multiple times, terminal information
133is repeated once per login.
134.Pp
135Mail status is shown as ``No Mail.'' if there is no mail at all, ``Mail
136last read DDD MMM ## HH:MM YYYY (TZ)'' if the person has looked at their
137mailbox since new mail arriving, or ``New mail received ...'', ``Unread
138since ...'' if they have new mail.
139.It Fl p
140Prevent
141the
142.Fl l
143option of
144.Nm
145from displaying the contents of the
146.Pa .forward ,
147.Pa .plan ,
148.Pa .project
149and
150.Pa .pubkey
151files.
152.It Fl m
153Prevent matching of
154.Ar user
155names.
156.Ar User
157is usually a login name; however, matching will also be done on the
158users' real names, unless the
159.Fl m
160option is supplied.
161All name matching performed by
162.Nm
163is case insensitive.
164.El
165.Pp
166If no options are specified,
167.Nm
168defaults to the
169.Fl l
170style output if operands are provided, otherwise to the
171.Fl s
172style.
173Note that some fields may be missing, in either format, if information
174is not available for them.
175.Pp
176If no arguments are specified,
177.Nm
178will print an entry for each user currently logged into the system.
179.Pp
180The
181.Nm
182utility may be used to look up users on a remote machine.
183The format is to specify a
184.Ar user
185as
186.Dq Li user@host ,
187or
188.Dq Li @host ,
189where the default output
190format for the former is the
191.Fl l
192style, and the default output format for the latter is the
193.Fl s
194style.
195The
196.Fl l
197option is the only option that may be passed to a remote machine.
198.Pp
199If the file
200.Pa .nofinger
201exists in the user's home directory,
202and the program is not run with superuser privileges,
203.Nm
204behaves as if the user in question does not exist.
205.Pp
206The optional
207.Xr finger.conf 5
208configuration file can be used to specify aliases.
209Since
210.Nm
211is invoked by
212.Xr fingerd 8 ,
213aliases will work for both local and network queries.
214.Sh ENVIRONMENT
215The
216.Nm
217utility utilizes the following environment variable, if it exists:
218.Bl -tag -width Fl
219.It Ev FINGER
220This variable may be set with favored options to
221.Nm .
222.El
223.Sh FILES
224.Bl -tag -width /var/log/lastlog -compact
225.It Pa /etc/finger.conf
226alias definition data base
227.It Pa /var/log/lastlog
228last login data base
229.El
230.Sh SEE ALSO
231.Xr chpass 1 ,
232.Xr w 1 ,
233.Xr who 1 ,
234.Xr finger.conf 5 ,
235.Xr fingerd 8
236.Rs
237.%A D. Zimmerman
238.%T The Finger User Information Protocol
239.%R RFC 1288
240.%D December, 1991
241.Re
242.Sh HISTORY
243The
244.Nm
245command appeared in
246.Bx 3.0 .
247.Sh BUGS
248The
249.Nm
250utility does not recognize multibyte characters.
251