Annotation of src/usr.bin/finger/finger.1, Revision 1.1.1.1
1.1 deraadt 1: .\" Copyright (c) 1989, 1990 The Regents of the University of California.
2: .\" All rights reserved.
3: .\"
4: .\" Redistribution and use in source and binary forms, with or without
5: .\" modification, are permitted provided that the following conditions
6: .\" are met:
7: .\" 1. Redistributions of source code must retain the above copyright
8: .\" notice, this list of conditions and the following disclaimer.
9: .\" 2. Redistributions in binary form must reproduce the above copyright
10: .\" notice, this list of conditions and the following disclaimer in the
11: .\" documentation and/or other materials provided with the distribution.
12: .\" 3. All advertising materials mentioning features or use of this software
13: .\" must display the following acknowledgement:
14: .\" This product includes software developed by the University of
15: .\" California, Berkeley and its contributors.
16: .\" 4. Neither the name of the University nor the names of its contributors
17: .\" may be used to endorse or promote products derived from this software
18: .\" without specific prior written permission.
19: .\"
20: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30: .\" SUCH DAMAGE.
31: .\"
32: .\" from: @(#)finger.1 6.14 (Berkeley) 7/27/91
33: .\" $Id: finger.1,v 1.5 1995/07/25 18:16:57 jtc Exp $
34: .\"
35: .Dd July 27, 1991
36: .Dt FINGER 1
37: .Os BSD 4
38: .Sh NAME
39: .Nm finger
40: .Nd user information lookup program
41: .Sh SYNOPSIS
42: .Nm finger
43: .Op Fl lmsp
44: .Op Ar user ...
45: .Op Ar user@host ...
46: .Sh DESCRIPTION
47: The
48: .Nm finger
49: displays information about the system users.
50: .Pp
51: Options are:
52: .Bl -tag -width flag
53: .It Fl s
54: .Nm Finger
55: displays the user's login name, real name, terminal name and write
56: status (as a ``*'' before the terminal name if write permission is
57: denied), idle time, login time, office location and office phone
58: number.
59: .Pp
60: Idle time is in minutes if it is a single integer, hours and minutes
61: if a ``:'' is present, or days if a ``d'' is present.
62: Login time is displayed as month, day, hours and minutes, unless
63: more than six months ago, in which case the year is displayed rather
64: than the hours and minutes.
65: .Pp
66: Unknown devices as well as nonexistent idle and login times are
67: displayed as single asterisks.
68: .Pp
69: .It Fl l
70: Produces a multi-line format displaying all of the information
71: described for the
72: .Fl s
73: option as well as the user's home directory, home phone number, login
74: shell, mail status, and the contents of the files
75: .Dq Pa .plan
76: and
77: .Dq Pa .project
78: from the user's home directory.
79: .Pp
80: If idle time is at least a minute and less than a day, it is
81: presented in the form ``hh:mm''.
82: Idle times greater than a day are presented as ``d day[s]hh:mm''.
83: .Pp
84: Phone numbers specified as eleven digits are printed as ``+N-NNN-NNN-NNNN''.
85: Numbers specified as ten or seven digits are printed as the appropriate
86: subset of that string.
87: Numbers specified as five digits are printed as ``xN-NNNN''.
88: Numbers specified as four digits are printed as ``xNNNN''.
89: .Pp
90: If write permission is denied to the device, the phrase ``(messages off)''
91: is appended to the line containing the device name.
92: One entry per user is displayed with the
93: .Fl l
94: option; if a user is logged on multiple times, terminal information
95: is repeated once per login.
96: .Pp
97: Mail status is shown as ``No Mail.'' if there is no mail at all,
98: ``Mail last read DDD MMM ## HH:MM YYYY (TZ)'' if the person has looked
99: at their mailbox since new mail arriving, or ``New mail received ...'',
100: `` Unread since ...'' if they have new mail.
101: .Pp
102: .It Fl p
103: Prevents
104: the
105: .Fl l
106: option of
107: .Nm finger
108: from displaying the contents of the
109: .Dq Pa .plan
110: and
111: .Dq Pa .project
112: files.
113: .It Fl m
114: Prevent matching of
115: .Ar user
116: names.
117: .Ar User
118: is usually a login name; however, matching will also be done on the
119: users' real names, unless the
120: .Fl m
121: option is supplied.
122: All name matching performed by
123: .Nm finger
124: is case insensitive.
125: .El
126: .Pp
127: If no options are specified,
128: .Nm finger
129: defaults to the
130: .Fl l
131: style output if operands are provided, otherwise to the
132: .Fl s
133: style.
134: Note that some fields may be missing, in either format, if information
135: is not available for them.
136: .Pp
137: If no arguments are specified,
138: .Nm finger
139: will print an entry for each user currently logged into the system.
140: .Pp
141: .Nm Finger
142: may be used to look up users on a remote machine.
143: The format is to specify a
144: .Ar user
145: as
146: .Dq Li user@host ,
147: or
148: .Dq Li @host ,
149: where the default output
150: format for the former is the
151: .Fl l
152: style, and the default output format for the latter is the
153: .Fl s
154: style.
155: The
156: .Fl l
157: option is the only option that may be passed to a remote machine.
158: .Sh SEE ALSO
159: .Xr chpass 1 ,
160: .Xr w 1 ,
161: .Xr who 1
162: .Sh HISTORY
163: The
164: .Nm finger
165: command appeared in
166: .Bx 3.0 .