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