xref: /openbsd/libexec/fingerd/fingerd.8 (revision 09467b48)
1.\"	$OpenBSD: fingerd.8,v 1.21 2015/01/15 19:06:32 schwarze Exp $
2.\"
3.\" Copyright (c) 1980, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     from: @(#)fingerd.8	8.1 (Berkeley) 6/4/93
31.\"	$Id: fingerd.8,v 1.21 2015/01/15 19:06:32 schwarze Exp $
32.\"
33.Dd $Mdocdate: January 15 2015 $
34.Dt FINGERD 8
35.Os
36.Sh NAME
37.Nm fingerd
38.Nd remote user information server
39.Sh SYNOPSIS
40.Nm fingerd
41.Op Fl lMmpSsu
42.Op Fl P Ar filename
43.Sh DESCRIPTION
44.Nm
45implements a simple protocol based on RFC 1288
46that provides an interface to the
47Name and Finger programs at several network sites.
48The program is supposed to return a friendly,
49human-oriented status report on either the system at the moment
50or a particular person in depth.
51There is no required format and the
52protocol consists mostly of specifying a single
53.Dq command line .
54.Pp
55.Nm
56is started by
57.Xr inetd 8 ,
58which listens for TCP requests at port 79.
59Once connected it reads a single command line
60terminated by a
61.Aq CRLF
62which is passed to
63.Xr finger 1 .
64.Nm
65closes its connections as soon as the output is finished.
66.Pp
67If the line is null (i.e., just a
68.Aq CRLF
69is sent) then
70.Xr finger 1
71returns a
72.Dq default
73report that lists all people logged into
74the system at that moment.
75.Pp
76If a user name is specified (e.g.,
77.Pf eric Aq CRLF )
78then the
79response lists more extended information for only that particular user,
80whether logged in or not.
81Allowable
82.Dq names
83in the command line include both
84.Dq login names
85and
86.Dq user names .
87If a name is ambiguous, all possible derivations are returned.
88.Pp
89The following options may be passed to
90.Nm
91as server program arguments in
92.Pa /etc/inetd.conf :
93.Bl -tag -width Ds
94.It Fl l
95Enable logging.
96The name of the host originating the query and the actual request
97is reported via
98.Xr syslog 3
99at LOG_NOTICE priority.
100A request of the form
101.Sq /W
102or
103.Sq /w
104will return long output.
105Empty requests will return all currently logged in users.
106All other requests look for specific users.
107See RFC 1288 for details.
108.It Fl M
109Enables matching of
110.Ar user
111names.
112This is disabled by default if the system is running YP.
113.It Fl m
114Prevent matching of
115.Ar user
116names.
117.Ar User
118is usually a login name; however, matching will also be done on the
119users' real names, unless the
120.Fl m
121option is supplied.
122.It Fl P Ar filename
123Use an alternate program as the local information provider.
124The default local program
125executed by
126.Nm
127is
128.Xr finger 1 .
129By specifying a customized local server,
130this option allows a system manager
131to have more control over what information is
132provided to remote sites.
133.It Fl p
134Prevents
135.Xr finger 1
136from displaying the contents of the
137.Dq Pa .plan
138and
139.Dq Pa .project
140files.
141.It Fl S
142Prints user information in short mode, one line per user.
143This overrides the
144.Dq Pa Whois switch
145that may be passed in from the remote client.
146.It Fl s
147Enable secure mode.
148Forwarding of queries to other remote hosts is denied.
149.It Fl u
150Queries without a user name are rejected.
151.El
152.Sh SEE ALSO
153.Xr finger 1 ,
154.Xr inetd 8
155.Sh STANDARDS
156.Rs
157.%A D. Zimmerman
158.%D December 1991
159.%R RFC 1288
160.%T The Finger User Information Protocol
161.Re
162.Sh HISTORY
163The
164.Nm
165command appeared in
166.Bx 4.3 .
167