Annotation of src/usr.bin/finger/finger.1, Revision 1.15
1.15 ! millert 1: .\" $OpenBSD: finger.1,v 1.14 2000/11/09 17:52:08 aaron Exp $
1.3 downsj 2: .\"
1.1 deraadt 3: .\" Copyright (c) 1989, 1990 The Regents of the University of California.
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.
1.15 ! millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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 6.14 (Berkeley) 7/27/91
31: .\"
32: .Dd July 27, 1991
33: .Dt FINGER 1
1.9 aaron 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm finger
37: .Nd user information lookup program
38: .Sh SYNOPSIS
39: .Nm finger
1.4 kstailey 40: .Op Fl lmMspho
1.1 deraadt 41: .Op Ar user ...
1.12 aaron 42: .Nm finger
43: .Op Fl l
1.1 deraadt 44: .Op Ar user@host ...
45: .Sh DESCRIPTION
46: The
1.10 aaron 47: .Nm
1.12 aaron 48: utility displays information about local and remote system users.
49: By default, the following information is displayed about each user
50: currently logged-in to the local host:
51: .Pp
52: .Bl -bullet -offset indent -compact
53: .It
54: login name
55: .It
56: user's full name
57: .It
58: associated terminal name
59: .It
60: idle time
61: .It
62: login time
63: .It
64: office location
65: .It
66: office phone
67: .El
1.1 deraadt 68: .Pp
69: Idle time is in minutes if it is a single integer, hours and minutes
1.12 aaron 70: if a
71: .Ql \&:
72: is present, or days if a
73: .Sq d
74: is present.
75: Login time is displayed as the day name if less than six days,
1.4 kstailey 76: else month, day, hours and minutes, unless
1.1 deraadt 77: more than six months ago, in which case the year is displayed rather
78: than the hours and minutes.
79: .Pp
1.12 aaron 80: The names of terminals for which write permission is denied (see
81: .Xr mesg 1 )
82: are prepended with an asterisk
83: .Pq Sq \&* .
1.1 deraadt 84: Unknown devices as well as nonexistent idle and login times are
85: displayed as single asterisks.
1.4 kstailey 86: .Pp
1.12 aaron 87: The options are as follows:
1.14 aaron 88: .Bl -tag -width Ds
1.12 aaron 89: .It Fl s
90: Short format (default).
91: The information as described above is displayed in a columnar fashion.
92: .Pp
1.4 kstailey 93: .It Fl h
1.12 aaron 94: If the
1.4 kstailey 95: .Fl s
1.12 aaron 96: option is also specified, the name of the remote host is displayed instead of
97: the office location and office phone.
1.4 kstailey 98: .Pp
99: .It Fl o
1.12 aaron 100: If the
1.4 kstailey 101: .Fl s
1.12 aaron 102: option is also specified, the office location and office phone is displayed
1.4 kstailey 103: instead of the name of the remote host.
1.1 deraadt 104: .Pp
105: .It Fl l
1.12 aaron 106: Long format.
107: Produces a multi-line format displaying all of the information available from
108: the
1.1 deraadt 109: .Fl s
110: option as well as the user's home directory, home phone number, login
1.12 aaron 111: shell, mail status, and the contents of the
1.1 deraadt 112: .Dq Pa .plan
113: and
114: .Dq Pa .project
1.12 aaron 115: files from the user's home directory.
1.1 deraadt 116: .Pp
117: If idle time is at least a minute and less than a day, it is
1.12 aaron 118: presented in the form
119: .Dq hh:mm .
120: Idle times greater than a day are presented as
121: .Dq d day[s]hh:mm .
1.1 deraadt 122: .Pp
1.12 aaron 123: Phone numbers specified as eleven digits are printed as
124: .Dq +N-NNN-NNN-NNNN .
1.1 deraadt 125: Numbers specified as ten or seven digits are printed as the appropriate
126: subset of that string.
1.12 aaron 127: Numbers specified as five digits are printed as
128: .Dq xN-NNNN .
129: Numbers specified as four digits are printed as
130: .Dq xNNNN .
1.1 deraadt 131: .Pp
1.12 aaron 132: If write permission is denied to the device, the phrase
133: .Dq (messages off)
1.1 deraadt 134: is appended to the line containing the device name.
135: One entry per user is displayed with the
136: .Fl l
137: option; if a user is logged on multiple times, terminal information
138: is repeated once per login.
139: .Pp
1.12 aaron 140: Mail status is shown as
141: .Dq \&No Mail.
142: if there is no mail at all,
143: .Do
144: Mail last read DDD MMM ## HH:MM YYYY (TZ)
145: .Dc
146: if the person has looked
147: at their mailbox since new mail arriving, or
148: .Dq New mail received ... ,
149: .Dq Unread since ...
150: if they have new mail.
1.1 deraadt 151: .Pp
152: .It Fl p
153: Prevents
154: the
155: .Fl l
156: option of
1.10 aaron 157: .Nm
1.1 deraadt 158: from displaying the contents of the
159: .Dq Pa .plan
160: and
161: .Dq Pa .project
162: files.
163: .It Fl m
164: Prevent matching of
165: .Ar user
166: names.
167: .Ar User
168: is usually a login name; however, matching will also be done on the
169: users' real names, unless the
170: .Fl m
171: option is supplied.
172: All name matching performed by
1.10 aaron 173: .Nm
1.1 deraadt 174: is case insensitive.
1.3 downsj 175: .It Fl M
176: Enable matching of
177: .Ar user
1.13 aaron 178: names.
179: This is disabled by default on systems running YP or with large
1.11 downsj 180: password databases.
1.1 deraadt 181: .El
182: .Pp
183: If no options are specified,
1.10 aaron 184: .Nm
1.1 deraadt 185: defaults to the
186: .Fl l
187: style output if operands are provided, otherwise to the
188: .Fl s
189: style.
190: Note that some fields may be missing, in either format, if information
191: is not available for them.
192: .Pp
1.10 aaron 193: .Nm
1.1 deraadt 194: may be used to look up users on a remote machine.
195: The format is to specify a
196: .Ar user
197: as
198: .Dq Li user@host ,
199: or
200: .Dq Li @host ,
201: where the default output
202: format for the former is the
203: .Fl l
204: style, and the default output format for the latter is the
205: .Fl s
206: style.
207: The
208: .Fl l
209: option is the only option that may be passed to a remote machine.
210: .Sh SEE ALSO
211: .Xr chpass 1 ,
212: .Xr w 1 ,
1.8 alex 213: .Xr who 1 ,
214: .Xr fingerd 8
1.1 deraadt 215: .Sh HISTORY
216: The
1.10 aaron 217: .Nm
1.1 deraadt 218: command appeared in
219: .Bx 3.0 .