Return to fingerd.8 CVS log

Up to [cvs.NetBSD.org] / src / libexec / fingerd

Annotation of src/libexec/fingerd/fingerd.8, Revision 1.20

1.20    ! wiz         1: .\"    $NetBSD: fingerd.8,v 1.19 2003/09/07 16:22:22 wiz Exp $
1.5       thorpej     2: .\"
1.3       explorer    3: .\" Copyright (c) 1980, 1991, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         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.
1.18      agc        14: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        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: .\"
1.3       explorer   30: .\"     from: @(#)fingerd.8    8.1 (Berkeley) 6/4/93
1.1       cgd        31: .\"
1.16      wiz        32: .Dd September 12, 2002
1.1       cgd        33: .Dt FINGERD 8
1.11      garbled    34: .Os
1.1       cgd        35: .Sh NAME
                     36: .Nm fingerd
                     37: .Nd remote user information server
                     38: .Sh SYNOPSIS
1.8       enami      39: .Nm
1.15      wiz        40: .Op Fl 8ghlmpSsu
1.3       explorer   41: .Op Fl P Ar filename
1.1       cgd        42: .Sh DESCRIPTION
1.8       enami      43: .Nm
1.20    ! wiz        44: is a simple protocol based on RFC 1288
1.1       cgd        45: that provides an interface to the
                     46: Name and Finger programs at several network sites.
                     47: The program is supposed to return a friendly,
                     48: human-oriented status report on either the system at the moment
                     49: or a particular person in depth.
                     50: There is no required format and the
                     51: protocol consists mostly of specifying a single
                     52: .Dq command line .
                     53: .Pp
1.8       enami      54: .Nm
1.4       cjs        55: is started by
                     56: .Xr inetd 8 ,
                     57: which listens for
1.1       cgd        58: .Tn TCP
                     59: requests at port 79.
1.4       cjs        60: Once handed a connection,
1.8       enami      61: .Nm
1.4       cjs        62: reads a single command line
1.1       cgd        63: terminated by a
                     64: .Aq Tn CRLF
1.4       cjs        65: which it then passes to
1.1       cgd        66: .Xr finger 1 .
1.8       enami      67: .Nm
1.1       cgd        68: closes its connections as soon as the output is finished.
                     69: .Pp
1.20    ! wiz        70: If the line is null (i.e., just a
1.1       cgd        71: .Aq Tn CRLF
1.9       fair       72: is sent) then
                     73: .Xr finger 1
1.1       cgd        74: returns a
                     75: .Dq default
                     76: report that lists all people logged into
                     77: the system at that moment.
                     78: .Pp
1.20    ! wiz        79: If a user name is specified (e.g.,
1.1       cgd        80: .Pf eric Aq Tn CRLF )
                     81: then the
                     82: response lists more extended information for only that particular user,
                     83: whether logged in or not.
                     84: Allowable
                     85: .Dq names
                     86: in the command line include both
                     87: .Dq login names
                     88: and
                     89: .Dq user names .
                     90: If a name is ambiguous, all possible derivations are returned.
1.3       explorer   91: .Pp
                     92: The following options may be passed to
1.8       enami      93: .Nm
1.3       explorer   94: as server program arguments in
                     95: .Pa /etc/inetd.conf :
1.20    ! wiz        96: .Bl -tag -width XPXfilenameX
1.15      wiz        97: .It Fl 8
                     98: Enable 8-bit output.
                     99: .It Fl g
                    100: Do not show any gecos information besides the users' real names.
                    101: .It Fl h
                    102: Display the name of the remote host in short mode,
                    103: instead of the office location and office phone.
1.3       explorer  104: .It Fl l
                    105: Enable logging.
1.20    ! wiz       106: The name of the host originating the query, and the actual request
        !           107: is reported via
1.3       explorer  108: .Xr syslog 3
1.9       fair      109: at LOG_NOTICE priority.
1.15      wiz       110: A request of the form
1.20    ! wiz       111: .Sq /W
        !           112: or
        !           113: .Sq /w
1.15      wiz       114: will return long output.
1.9       fair      115: Empty requests will return all currently logged in users.
                    116: All other requests look for specific users.
1.20    ! wiz       117: See RFC 1288 for details.
1.3       explorer  118: .It Fl m
                    119: Prevent matching of
                    120: .Ar user
                    121: names.
                    122: .Ar User
                    123: is usually a login name; however, matching will also be done on the
                    124: users' real names, unless the
                    125: .Fl m
                    126: option is supplied.
1.20    ! wiz       127: .It Fl P Ar filename
1.15      wiz       128: Use an alternate program as the local information provider.
                    129: The default local program executed by
                    130: .Nm
                    131: is
                    132: .Xr finger 1 .
                    133: By specifying a customized local server, this option allows a system manager
                    134: to have more control over what information is provided to remote sites.
1.3       explorer  135: .It Fl p
                    136: Prevents
1.8       enami     137: .Xr finger 1
1.3       explorer  138: from displaying the contents of the
                    139: .Dq Pa .plan
                    140: and
                    141: .Dq Pa .project
                    142: files.
                    143: .It Fl S
                    144: Prints user information in short mode, one line per user.
                    145: This overrides the
                    146: .Dq Pa Whois switch
                    147: that may be passed in from the remote client.
1.15      wiz       148: .It Fl s
                    149: Disable forwarding of queries to other remote hosts.
                    150: .It Fl u
                    151: Queries without a user name are rejected.
1.3       explorer  152: .El
1.1       cgd       153: .Sh SEE ALSO
1.4       cjs       154: .Xr finger 1 ,
                    155: .Xr inetd 8
1.12      wiz       156: .Sh HISTORY
                    157: The
                    158: .Nm
                    159: command appeared in
                    160: .Bx 4.3 .
1.1       cgd       161: .Sh BUGS
                    162: Connecting directly to the server from a
                    163: .Tn TIP
                    164: or an equally narrow-minded
1.17      wiz       165: .Tn TELNET Ns -protocol
1.1       cgd       166: user program can result
                    167: in meaningless attempts at option negotiation being sent to the
                    168: server, which will foul up the command line interpretation.
1.8       enami     169: .Nm
1.1       cgd       170: should be taught to filter out
1.17      wiz       171: .Tn IAC Ns 's
1.1       cgd       172: and perhaps even respond
                    173: negatively
                    174: .Pq Tn IAC WON'T
                    175: to all option commands received.