Annotation of src/usr.bin/finger/finger.1, Revision 1.11
1.11 ! downsj 1: .\" $OpenBSD: finger.1,v 1.10 1999/07/04 11:53:54 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.
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 ...
46: .Op Ar user@host ...
47: .Sh DESCRIPTION
48: The
1.10 aaron 49: .Nm
1.6 aaron 50: utility displays information about the system users.
1.1 deraadt 51: .Pp
52: Options are:
53: .Bl -tag -width flag
54: .It Fl s
1.10 aaron 55: .Nm
1.1 deraadt 56: displays the user's login name, real name, terminal name and write
57: status (as a ``*'' before the terminal name if write permission is
1.4 kstailey 58: denied), idle time, login time, and either office location and office
59: phone number, or the remote host.
60: If
61: .Fl h
1.5 kstailey 62: is given, the remote host is printed.
1.4 kstailey 63: If
64: .Fl o
65: is given, the office location and phone number is printed instead
66: (the default).
1.1 deraadt 67: .Pp
68: Idle time is in minutes if it is a single integer, hours and minutes
69: if a ``:'' is present, or days if a ``d'' is present.
1.4 kstailey 70: Login time is displayed as the dayname if less than six days,
71: else month, day, hours and minutes, unless
1.1 deraadt 72: more than six months ago, in which case the year is displayed rather
73: than the hours and minutes.
74: .Pp
75: Unknown devices as well as nonexistent idle and login times are
76: displayed as single asterisks.
1.4 kstailey 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.
1.1 deraadt 89: .Pp
90: .It Fl l
91: Produces 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 .plan
97: and
98: .Dq Pa .project
99: from the user's home directory.
100: .Pp
101: If idle time is at least a minute and less than a day, it is
102: presented in the form ``hh:mm''.
103: Idle times greater than a day are presented as ``d day[s]hh:mm''.
104: .Pp
105: Phone numbers specified as eleven digits are printed as ``+N-NNN-NNN-NNNN''.
106: Numbers specified as ten or seven digits are printed as the appropriate
107: subset of that string.
108: Numbers specified as five digits are printed as ``xN-NNNN''.
109: Numbers specified as four digits are printed as ``xNNNN''.
110: .Pp
111: If write permission is denied to the device, the phrase ``(messages off)''
112: is appended to the line containing the device name.
113: One entry per user is displayed with the
114: .Fl l
115: option; if a user is logged on multiple times, terminal information
116: is repeated once per login.
117: .Pp
118: Mail status is shown as ``No Mail.'' if there is no mail at all,
119: ``Mail last read DDD MMM ## HH:MM YYYY (TZ)'' if the person has looked
120: at their mailbox since new mail arriving, or ``New mail received ...'',
121: `` Unread since ...'' if they have new mail.
122: .Pp
123: .It Fl p
124: Prevents
125: the
126: .Fl l
127: option of
1.10 aaron 128: .Nm
1.1 deraadt 129: from displaying the contents of the
130: .Dq Pa .plan
131: and
132: .Dq Pa .project
133: files.
134: .It Fl m
135: Prevent matching of
136: .Ar user
137: names.
138: .Ar User
139: is usually a login name; however, matching will also be done on the
140: users' real names, unless the
141: .Fl m
142: option is supplied.
143: All name matching performed by
1.10 aaron 144: .Nm
1.1 deraadt 145: is case insensitive.
1.3 downsj 146: .It Fl M
147: Enable matching of
148: .Ar user
1.11 ! downsj 149: names. This is disabled by default on systems running YP or with large
! 150: password databases.
1.1 deraadt 151: .El
152: .Pp
153: If no options are specified,
1.10 aaron 154: .Nm
1.1 deraadt 155: defaults to the
156: .Fl l
157: style output if operands are provided, otherwise to the
158: .Fl s
159: style.
160: Note that some fields may be missing, in either format, if information
161: is not available for them.
162: .Pp
163: If no arguments are specified,
1.10 aaron 164: .Nm
1.1 deraadt 165: will print an entry for each user currently logged into the system.
166: .Pp
1.10 aaron 167: .Nm
1.1 deraadt 168: may be used to look up users on a remote machine.
169: The format is to specify a
170: .Ar user
171: as
172: .Dq Li user@host ,
173: or
174: .Dq Li @host ,
175: where the default output
176: format for the former is the
177: .Fl l
178: style, and the default output format for the latter is the
179: .Fl s
180: style.
181: The
182: .Fl l
183: option is the only option that may be passed to a remote machine.
184: .Sh SEE ALSO
185: .Xr chpass 1 ,
186: .Xr w 1 ,
1.8 alex 187: .Xr who 1 ,
188: .Xr fingerd 8
1.1 deraadt 189: .Sh HISTORY
190: The
1.10 aaron 191: .Nm
1.1 deraadt 192: command appeared in
193: .Bx 3.0 .