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