Initial import from FreeBSD RELENG_4:
[dragonfly.git] / libexec / fingerd / fingerd.8
1 .\" Copyright (c) 1980, 1991, 1993
2 .\"     The Regents of the University of California.  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 .\"     @(#)fingerd.8   8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/libexec/fingerd/fingerd.8,v 1.4.2.3 2001/08/16 10:44:15 ru Exp $
34 .\"
35 .Dd June 4, 1993
36 .Dt FINGERD 8
37 .Os
38 .Sh NAME
39 .Nm fingerd
40 .Nd remote user information server
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl s
44 .Op Fl l
45 .Op Fl p Ar filename
46 .Sh DESCRIPTION
47 .Nm Fingerd
48 is a simple protocol based on
49 .%T RFC1196
50 that provides an interface to the
51 Name and Finger programs at several network sites.
52 The program is supposed to return a friendly,
53 human-oriented status report on either the system at the moment
54 or a particular person in depth.
55 There is no required format and the
56 protocol consists mostly of specifying a single
57 .Dq command line .
58 .Pp
59 .Nm Fingerd
60 is started by
61 .Xr inetd 8 ,
62 which listens for
63 .Tn TCP
64 requests at port 79.
65 Once connected it reads a single command line
66 terminated by a
67 .Aq Tn CRLF
68 which is passed to
69 .Xr finger 1 .
70 .Nm Fingerd
71 closes its connections as soon as the output is finished.
72 .Pp
73 If the line is null (i.e. just a
74 .Aq Tn CRLF
75 is sent) then
76 .Xr finger
77 returns a
78 .Dq default
79 report that lists all people logged into
80 the system at that moment.
81 .Pp
82 If a user name is specified (e.g.\&
83 .Pf eric Aq Tn CRLF )
84 then the
85 response lists more extended information for only that particular user,
86 whether logged in or not.
87 Allowable
88 .Dq names
89 in the command line include both
90 .Dq login names
91 and
92 .Dq user names .
93 If a name is ambiguous, all possible derivations are returned.
94 .Pp
95 The following options may be passed to
96 .Nm
97 as server program arguments in
98 .Pa /etc/inetd.conf :
99 .Bl -tag -width indent
100 .It Fl s
101 Enable secure mode.
102 Queries without a user name are rejected and
103 forwarding of queries to other remote hosts is denied.
104 .It Fl l
105 Enable logging.
106 The name of the host originating the query is reported via
107 .Xr syslog 3
108 at LOG_NOTICE priority.
109 .It Fl p
110 Use an alternate program as the local information provider.
111 The default local program
112 executed by
113 .Nm
114 is
115 .Xr finger 1 .
116 By specifying a customized local server,
117 this option allows a system manager
118 to have more control over what information is
119 provided to remote sites.
120 .El
121 .Sh SEE ALSO
122 .Xr finger 1 ,
123 .Xr inetd 8
124 .Sh BUGS
125 Connecting directly to the server from a
126 .Tn TIP
127 or an equally narrow-minded
128 .Tn TELNET Ns \-protocol
129 user program can result
130 in meaningless attempts at option negotiation being sent to the
131 server, which will foul up the command line interpretation.
132 .Nm Fingerd
133 should be taught to filter out
134 .Tn IAC Ns \'s
135 and perhaps even respond
136 negatively
137 .Pq Tn IAC WON'T
138 to all option commands received.
139 .Sh HISTORY
140 The
141 .Nm
142 command appeared in
143 .Bx 4.3 .