rc.d: Introduce 'dhcp_client' to wrap over dhclient and dhcpcd
[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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)fingerd.8   8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/libexec/fingerd/fingerd.8,v 1.14 2005/01/18 09:29:39 ru Exp $
30 .\" $DragonFly: src/libexec/fingerd/fingerd.8,v 1.5 2007/11/23 23:16:36 swildner Exp $
31 .\"
32 .Dd June 4, 1993
33 .Dt FINGERD 8
34 .Os
35 .Sh NAME
36 .Nm fingerd
37 .Nd remote user information server
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl s
41 .Op Fl l
42 .Op Fl p Ar filename
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility uses a simple protocol based on
47 .%T RFC 1196
48 that provides an interface to
49 .Xr finger 1
50 at several network sites.
51 It is supposed to return a friendly,
52 human-oriented status report on either the system at the moment
53 or a particular person in depth.
54 There is no required format and the
55 protocol consists mostly of specifying a single
56 .Dq "command line" ,
57 thus,
58 .Nm
59 can also be used to implement other protocols in conjunction with the
60 .Fl p
61 flag.
62 .Pp
63 The
64 .Nm
65 utility is started by
66 .Xr inetd 8 ,
67 which listens for
68 .Tn TCP
69 requests at port 79.
70 Once connected it reads a single command line
71 terminated by a
72 .Aq Tn CRLF
73 which is passed to
74 .Xr finger 1 .
75 The
76 .Nm
77 utility closes its connections as soon as the output is finished.
78 .Pp
79 If the line is null (i.e., just a
80 .Aq Tn CRLF
81 is sent) then
82 .Xr finger 1
83 returns a
84 .Dq default
85 report that lists all people logged into
86 the system at that moment.
87 .Pp
88 If a user name is specified (e.g.\&
89 .Pf eric Aq Tn CRLF )
90 then the
91 response lists more extended information for only that particular user,
92 whether logged in or not.
93 Allowable
94 .Dq names
95 in the command line include both
96 .Dq login names
97 and
98 .Dq user names .
99 If a name is ambiguous, all possible derivations are returned.
100 .Pp
101 The following options may be passed to
102 .Nm
103 as server program arguments in
104 .Pa /etc/inetd.conf :
105 .Bl -tag -width indent
106 .It Fl s
107 Enable secure mode.
108 Queries without a user name are rejected and
109 forwarding of queries to other remote hosts is denied.
110 .It Fl l
111 Enable logging.
112 The name of the host originating the query is reported via
113 .Xr syslog 3
114 at LOG_NOTICE priority.
115 .It Fl p
116 Use an alternate program as the local information provider.
117 The default local program
118 executed by
119 .Nm
120 is
121 .Xr finger 1 .
122 By specifying a customized local server,
123 this option allows a system manager
124 to have more control over what information is
125 provided to remote sites.
126 If
127 .Fl p
128 is specified,
129 .Nm
130 will also set the environment variable
131 .Ev FINGERD_REMOTE_HOST
132 to the name of the host making the request.
133 .El
134 .Sh SEE ALSO
135 .Xr finger 1 ,
136 .Xr inetd 8
137 .Sh HISTORY
138 The
139 .Nm
140 utility appeared in
141 .Bx 4.3 .
142 .Sh BUGS
143 Connecting directly to the server from a
144 .Tn TIP
145 or an equally narrow-minded
146 .Tn TELNET Ns \-protocol
147 user program can result
148 in meaningless attempts at option negotiation being sent to the
149 server, which will foul up the command line interpretation.
150 The
151 .Nm
152 utility should be taught to filter out
153 .Tn IAC Ns \'s
154 and perhaps even respond
155 negatively
156 .Pq Tn IAC WON'T
157 to all option commands received.