Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / finger / finger.1
blob70d8c2639354d1511d6b0f38832adef1e73e0b15
1 .\"     $NetBSD: finger.1,v 1.14 2002/09/30 11:09:00 grant Exp $
2 .\"
3 .\" Copyright (c) 1989, 1990, 1993, 1994
4 .\"     The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     from: @(#)finger.1      8.3 (Berkeley) 5/5/94
31 .\"
32 .Dd September 12, 2002
33 .Dt FINGER 1
34 .Os
35 .Sh NAME
36 .Nm finger
37 .Nd user information lookup program
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl 8ghlmops
41 .Op Ar user ...
42 .Op Ar user@host ...
43 .Sh DESCRIPTION
44 The
45 .Nm
46 displays information about the system users.
47 .Pp
48 Options are:
49 .Bl -tag -width flag
50 .It Fl 8
51 Pass through 8-bit data.
52 This option is intended for enabling 8-bit
53 data output in the
54 .Xr fingerd 8
55 service.
56 Using this from the command line is
57 .Em dangerous ,
58 as the output data may include control characters for your terminal.
59 .It Fl g
60 This option restricts the gecos output to only the users' real names.
61 .It Fl h
62 When used in conjunction with the
63 .Fl s
64 option, the name of the remote host is displayed instead of the office
65 location and office phone.
66 .It Fl l
67 Produces a multi-line format displaying all of the information
68 described for the
69 .Fl s
70 option as well as the user's home directory, home phone number, login
71 shell, mail status, and the contents of the files
72 .Dq Pa .forward ,
73 .Dq Pa .plan
74 and
75 .Dq Pa .project
76 from the user's home directory.
77 .Pp
78 If idle time is at least a minute and less than a day, it is
79 presented in the form
80 .Dq hh:mm .
81 Idle times greater than a day are presented as
82 .Dq d day[s]hh:mm .
83 .Pp
84 Phone numbers specified as eleven digits are printed as
85 .Dq +N-NNN-NNN-NNNN .
86 Numbers specified as ten or seven digits are printed as the appropriate
87 subset of that string.
88 Numbers specified as five digits are printed as
89 .Dq xN-NNNN .
90 Numbers specified as four digits are printed as
91 .Dq xNNNN .
92 .Pp
93 If write permission is denied to the device, the phrase
94 .Dq (messages off)
95 is appended to the line containing the device name.
96 One entry per user is displayed with the
97 .Fl l
98 option; if a user is logged on multiple times, terminal information
99 is repeated once per login.
101 Mail status is shown as
102 .Dq \&No Mail.
103 if there is no mail at all, ``Mail last read DDD MMM ## HH:MM YYYY (TZ)''
104 if the person has looked at their
105 mailbox since new mail arriving, or
106 .Dq New mail received ... ,
107 .Dq Unread since \&...
108 if they have new mail.
109 .It Fl m
110 Prevent matching of
111 .Ar user
112 names.
113 .Ar User
114 is usually a login name; however, matching will also be done on the
115 users' real names, unless the
116 .Fl m
117 option is supplied.
118 All name matching performed by
120 is case insensitive.
121 .It Fl o
122 When used in conjunction with the
123 .Fl s
124 option, the office location and office phone information is displayed
125 instead of the name of the remote host.
126 .It Fl p
127 Prevents
129 .Fl l
130 option of
132 from displaying the contents of the
133 .Dq Pa .forward ,
134 .Dq Pa .plan
136 .Dq Pa .project
137 files.
138 .It Fl s
140 displays the user's login name, real name, terminal name and write
141 status (as a
142 .Dq *
143 after the terminal name if write permission is denied), idle time,
144 login time, and either office location and office phone number,
145 or the remote host.
147 .Fl h
148 is given, the remote is printed.
150 .Fl o
151 is given, the office location and phone number is printed instead
152 (the default).
154 Idle time is in minutes if it is a single integer, hours and minutes
155 if a
156 .Dq \&:
157 is present, or days if a
158 .Dq d
159 is present.
160 Login time is displayed as the dayname if less than six days,
161 else month, day, hours and minutes, unless
162 more than six months ago, in which case the year is displayed rather
163 than the hours and minutes.
165 Unknown devices as well as nonexistent idle and login times are
166 displayed as single asterisks.
169 If no options are specified,
171 defaults to the
172 .Fl l
173 style output if operands are provided, otherwise to the
174 .Fl s
175 style.
176 Note that some fields may be missing, in either format, if information
177 is not available for them.
179 If no arguments are specified,
181 will print an entry for each user currently logged into the system.
184 may be used to look up users on a remote machine.
185 The format is to specify a
186 .Ar user
188 .Dq Li user@host ,
190 .Dq Li @host ,
191 where the default output
192 format for the former is the
193 .Fl l
194 style, and the default output format for the latter is the
195 .Fl s
196 style.
198 .Fl l
199 option is the only option that may be passed to a remote machine.
200 .Sh FILES
201 .Bl -tag -width /var/log/lastlog -compact
202 .It Pa /var/log/lastlog
203 last login data base
205 .Sh SEE ALSO
206 .Xr chpass 1 ,
207 .Xr w 1 ,
208 .Xr who 1
209 .Sh HISTORY
212 command appeared in
213 .Bx 3.0 .