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