sync
[bitrig.git] / usr.sbin / identd / identd.8
blob84d0559ba6c661a9eeb2c9a5454389c04f5a6dfa
1 .\"   $OpenBSD: identd.8,v 1.10 2013/04/29 04:17:58 dlg Exp $
2 .\"
3 .\" Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd $Mdocdate: April 29 2013 $
18 .Dt IDENTD 8
19 .Os
20 .Sh NAME
21 .Nm identd
22 .Nd Identification Protocol daemon
23 .Sh SYNOPSIS
24 .Nm
25 .Op Fl 46dehNn
26 .Op Fl l Ar address
27 .Op Fl t Ar timeout
28 .Sh DESCRIPTION
29 .Nm
30 is a server which implements the Identification Protocol as specified in
31 RFC 1413.
32 .Pp
33 .Nm
34 operates by looking up specific TCP/IP connections and returning
35 the name of the user running the process responsible for the connection.
36 .Pp
37 The options are as follows:
38 .Bl -tag -width Ds
39 .It Fl 4
40 Forces
41 .Nm
42 to use IPv4 addresses only.
43 .It Fl 6
44 Forces
45 .Nm
46 to use IPv6 addresses only.
47 .It Fl d
48 Do not daemonize.
49 If this option is specified,
50 .Nm
51 will run in the foreground and log to stderr.
52 .It Fl e
53 Always return
54 .Dq UNKNOWN-ERROR
55 instead of the
56 .Dq NO-USER
58 .Dq INVALID-PORT
59 errors.
60 .It Fl h
61 Hide the actual information about the user by providing an opaque
62 token instead.
63 This token is entered into the local system logs
64 so that the administrator can later discover who the real user was.
65 .It Fl l Ar address
66 Listen on the specified address.
67 By default
68 .Nm
69 listens on wildcard addresses.
70 .It Fl N
71 When replying with a user name or ID, first
72 check for a file
73 .Pa .noident
74 in the user's home directory.
75 If this file is accessible, return
76 .Dq HIDDEN-USER
77 instead of the normal USERID response.
78 .It Fl n
79 Always return UID numbers instead of usernames.
80 .It Fl t Ar timeout
81 Specifies the idle timeout for client connections,
82 in seconds.
83 The default timeout is 120 seconds.
84 .El
85 .\" .Sh SEE ALSO
86 .Sh STANDARDS
87 .Rs
88 .%A M. St. Johns
89 .%D February 1993
90 .%R RFC 1413
91 .%T Identification Protocol
92 .Re
93 .Sh HISTORY
94 The
95 .Nm
96 command was originally a process run via
97 .Xr inetd 8 .
98 It was rewritten for
99 .Ox 5.4
100 as a persistent non-blocking daemon.