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