]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - libexec/fingerd/fingerd.8
ifconfig(8): wordsmith -G and -g descriptions
[FreeBSD/FreeBSD.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 .Dd November 19, 2014
29 .Dt FINGERD 8
30 .Os
31 .Sh NAME
32 .Nm fingerd
33 .Nd remote user information server
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl d
37 .Op Fl k
38 .Op Fl s
39 .Op Fl l
40 .Op Fl p Ar filename
41 .Sh DESCRIPTION
42 The
43 .Nm
44 utility uses a simple protocol based on
45 .%T RFC1196
46 that provides an interface to
47 .Xr finger 1
48 at several network sites.
49 It is supposed to return a friendly,
50 human-oriented status report on either the system at the moment
51 or a particular person in depth.
52 There is no required format and the
53 protocol consists mostly of specifying a single
54 .Dq "command line" ,
55 thus,
56 .Nm
57 can also be used to implement other protocols in conjunction with the
58 .Fl p
59 flag.
60 .Pp
61 The
62 .Nm
63 utility is started by
64 .Xr inetd 8 ,
65 which listens for
66 .Tn TCP
67 requests at port 79.
68 Once connected it reads a single command line
69 terminated by a
70 .Aq Tn CRLF
71 which is passed to
72 .Xr finger 1 .
73 The
74 .Nm
75 utility closes its connections as soon as the output is finished.
76 .Pp
77 If the line is null (i.e., just a
78 .Aq Tn CRLF
79 is sent) then
80 .Xr finger 1
81 returns a
82 .Dq default
83 report that lists all people logged into
84 the system at that moment.
85 .Pp
86 If a user name is specified (e.g.,\&
87 .Pf eric Aq Tn CRLF )
88 then the
89 response lists more extended information for only that particular user,
90 whether logged in or not.
91 Allowable
92 .Dq names
93 in the command line include both
94 .Dq login names
95 and
96 .Dq user names .
97 If a name is ambiguous, all possible derivations are returned.
98 .Pp
99 The following options may be passed to
100 .Nm
101 as server program arguments in
102 .Pa /etc/inetd.conf :
103 .Bl -tag -width indent
104 .It Fl d
105 Enable debugging mode.
106 In debugging mode,
107 .Nm
108 will not attempt any network-related operations on
109 .Va stdin ,
110 and it will print the full
111 .Nm finger
112 command line
113 to
114 .Va stderr
115 before executing it.
116 .It Fl k
117 Suppress login information.
118 See the description of the
119 .Fl k
120 option in
121 .Xr finger 1
122 for details.
123 .It Fl s
124 Enable secure mode.
125 Queries without a user name are rejected and
126 forwarding of queries to other remote hosts is denied.
127 .It Fl l
128 Enable logging.
129 The name of the host originating the query is reported via
130 .Xr syslog 3
131 at LOG_NOTICE priority.
132 .It Fl p
133 Use an alternate program as the local information provider.
134 The default local program
135 executed by
136 .Nm
137 is
138 .Xr finger 1 .
139 By specifying a customized local server,
140 this option allows a system manager
141 to have more control over what information is
142 provided to remote sites.
143 If
144 .Fl p
145 is specified,
146 .Nm
147 will also set the environment variable
148 .Ev FINGERD_REMOTE_HOST
149 to the name of the host making the request.
150 .El
151 .Sh SEE ALSO
152 .Xr finger 1 ,
153 .Xr inetd 8
154 .Sh HISTORY
155 The
156 .Nm
157 utility appeared in
158 .Bx 4.3 .