Annotation of src/usr.bin/finger/finger.1, Revision 1.19
1.19 ! bentley 1: .\" $OpenBSD: finger.1,v 1.18 2012/01/15 20:06:40 schwarze 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: .\"
1.19 ! bentley 32: .Dd $Mdocdate: January 15 2012 $
1.1 deraadt 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.16 jmc 40: .Op Fl hlMmops
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.4 kstailey 89: .It Fl h
1.12 aaron 90: If the
1.4 kstailey 91: .Fl s
1.12 aaron 92: option is also specified, the name of the remote host is displayed instead of
93: the office location and office phone.
1.1 deraadt 94: .It Fl l
1.12 aaron 95: Long format.
96: Produces a multi-line format displaying all of the information available from
97: the
1.1 deraadt 98: .Fl s
99: option as well as the user's home directory, home phone number, login
1.12 aaron 100: shell, mail status, and the contents of the
1.1 deraadt 101: .Dq Pa .plan
102: and
103: .Dq Pa .project
1.12 aaron 104: files from the user's home directory.
1.1 deraadt 105: .Pp
106: If idle time is at least a minute and less than a day, it is
1.12 aaron 107: presented in the form
108: .Dq hh:mm .
109: Idle times greater than a day are presented as
110: .Dq d day[s]hh:mm .
1.1 deraadt 111: .Pp
1.12 aaron 112: Phone numbers specified as eleven digits are printed as
113: .Dq +N-NNN-NNN-NNNN .
1.1 deraadt 114: Numbers specified as ten or seven digits are printed as the appropriate
115: subset of that string.
1.12 aaron 116: Numbers specified as five digits are printed as
117: .Dq xN-NNNN .
118: Numbers specified as four digits are printed as
119: .Dq xNNNN .
1.1 deraadt 120: .Pp
1.12 aaron 121: If write permission is denied to the device, the phrase
122: .Dq (messages off)
1.1 deraadt 123: is appended to the line containing the device name.
124: One entry per user is displayed with the
125: .Fl l
126: option; if a user is logged on multiple times, terminal information
127: is repeated once per login.
128: .Pp
1.12 aaron 129: Mail status is shown as
130: .Dq \&No Mail.
131: if there is no mail at all,
132: .Do
133: Mail last read DDD MMM ## HH:MM YYYY (TZ)
134: .Dc
135: if the person has looked
136: at their mailbox since new mail arriving, or
137: .Dq New mail received ... ,
138: .Dq Unread since ...
139: if they have new mail.
1.16 jmc 140: .It Fl M
141: Enable matching of
142: .Ar user
143: names.
144: This is disabled by default on systems running YP or with large
145: password databases.
1.1 deraadt 146: .It Fl m
147: Prevent matching of
148: .Ar user
149: names.
150: .Ar User
151: is usually a login name; however, matching will also be done on the
152: users' real names, unless the
153: .Fl m
154: option is supplied.
155: All name matching performed by
1.10 aaron 156: .Nm
1.1 deraadt 157: is case insensitive.
1.16 jmc 158: .It Fl o
159: If the
160: .Fl s
161: option is also specified, the office location and office phone is displayed
162: instead of the name of the remote host.
163: .It Fl p
164: Prevents
165: the
166: .Fl l
167: option of
168: .Nm
169: from displaying the contents of the
170: .Dq Pa .plan
171: and
172: .Dq Pa .project
173: files.
174: .It Fl s
175: Short format (default).
176: The information as described above is displayed in a columnar fashion.
1.1 deraadt 177: .El
178: .Pp
179: If no options are specified,
1.10 aaron 180: .Nm
1.1 deraadt 181: defaults to the
182: .Fl l
183: style output if operands are provided, otherwise to the
184: .Fl s
185: style.
186: Note that some fields may be missing, in either format, if information
187: is not available for them.
188: .Pp
1.10 aaron 189: .Nm
1.1 deraadt 190: may be used to look up users on a remote machine.
191: The format is to specify a
192: .Ar user
193: as
194: .Dq Li user@host ,
195: or
196: .Dq Li @host ,
197: where the default output
198: format for the former is the
199: .Fl l
200: style, and the default output format for the latter is the
201: .Fl s
202: style.
203: The
204: .Fl l
205: option is the only option that may be passed to a remote machine.
206: .Sh SEE ALSO
207: .Xr chpass 1 ,
208: .Xr w 1 ,
1.8 alex 209: .Xr who 1 ,
210: .Xr fingerd 8
1.19 ! bentley 211: .Sh STANDARDS
! 212: .Rs
! 213: .%A D. Zimmerman
! 214: .%D December 1991
! 215: .%R RFC 1288
! 216: .%T The Finger User Information Protocol
! 217: .Re
1.1 deraadt 218: .Sh HISTORY
219: The
1.10 aaron 220: .Nm
1.1 deraadt 221: command appeared in
1.18 schwarze 222: .Bx 2 .
223: .Sh AUTHORS
224: .An Earl T. Cohen .