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