xref: /netbsd/libexec/fingerd/fingerd.8 (revision bf9ec67e)
1.\"	$NetBSD: fingerd.8,v 1.12 2002/01/15 02:19:50 wiz Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  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: @(#)fingerd.8	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt FINGERD 8
38.Os
39.Sh NAME
40.Nm fingerd
41.Nd remote user information server
42.Sh SYNOPSIS
43.Nm
44.Op Fl s
45.Op Fl l
46.Op Fl u
47.Op Fl h
48.Op Fl m
49.Op Fl p
50.Op Fl S
51.Op Fl g
52.Op Fl P Ar filename
53.Sh DESCRIPTION
54.Nm
55is a simple protocol based on
56.%T RFC1196
57that provides an interface to the
58Name and Finger programs at several network sites.
59The program is supposed to return a friendly,
60human-oriented status report on either the system at the moment
61or a particular person in depth.
62There is no required format and the
63protocol consists mostly of specifying a single
64.Dq command line .
65.Pp
66.Nm
67is started by
68.Xr inetd 8 ,
69which listens for
70.Tn TCP
71requests at port 79.
72Once handed a connection,
73.Nm
74reads a single command line
75terminated by a
76.Aq Tn CRLF
77which it then passes to
78.Xr finger 1 .
79.Nm
80closes its connections as soon as the output is finished.
81.Pp
82If the line is null (i.e. just a
83.Aq Tn CRLF
84is sent) then
85.Xr finger 1
86returns a
87.Dq default
88report that lists all people logged into
89the system at that moment.
90.Pp
91If a user name is specified (e.g.
92.Pf eric Aq Tn CRLF )
93then the
94response lists more extended information for only that particular user,
95whether logged in or not.
96Allowable
97.Dq names
98in the command line include both
99.Dq login names
100and
101.Dq user names .
102If a name is ambiguous, all possible derivations are returned.
103.Pp
104The following options may be passed to
105.Nm
106as server program arguments in
107.Pa /etc/inetd.conf :
108.Bl -tag -width Ds
109.It Fl s
110Disable forwarding of queries to other remote hosts.
111.It Fl l
112Enable logging.
113The name of the host originating the query, and the actual request is reported via
114.Xr syslog 3
115at LOG_NOTICE priority.
116A request of the form `\\W' and `\\w' will return long output.
117Empty requests will return all currently logged in users.
118All other requests look for specific users.
119See RFC1196 for details.
120.It Fl u
121Queries without a user name are rejected.
122.It Fl h
123Display the name of the remote host in short mode,
124instead of the office location and office phone.
125.It Fl m
126Prevent matching of
127.Ar user
128names.
129.Ar User
130is usually a login name; however, matching will also be done on the
131users' real names, unless the
132.Fl m
133option is supplied.
134.It Fl p
135Prevents
136.Xr finger 1
137from displaying the contents of the
138.Dq Pa .plan
139and
140.Dq Pa .project
141files.
142.It Fl S
143Prints user information in short mode, one line per user.
144This overrides the
145.Dq Pa Whois switch
146that may be passed in from the remote client.
147.It Fl g
148Do not show any gecos information besides the users' real names.
149.It Fl P
150Use an alternate program as the local information provider.
151The default local program
152executed by
153.Nm
154is
155.Xr finger 1 .
156By specifying a customized local server,
157this option allows a system manager
158to have more control over what information is
159provided to remote sites.
160.El
161.Sh SEE ALSO
162.Xr finger 1 ,
163.Xr inetd 8
164.Sh HISTORY
165The
166.Nm
167command appeared in
168.Bx 4.3 .
169.Sh BUGS
170Connecting directly to the server from a
171.Tn TIP
172or an equally narrow-minded
173.Tn TELNET Ns \-protocol
174user program can result
175in meaningless attempts at option negotiation being sent to the
176server, which will foul up the command line interpretation.
177.Nm
178should be taught to filter out
179.Tn IAC Ns \'s
180and perhaps even respond
181negatively
182.Pq Tn IAC WON'T
183to all option commands received.
184