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