Bring in a transport-independent RPC (TI-RPC).
[games.git] / usr.sbin / rpcbind / rpcbind.8
1 .\" @(#)rpcbind.1m 1.19 92/09/14 SMI; from SVr4
2 .\" Copyright 1989 AT&T
3 .\" Copyright 1991 Sun Microsystems, Inc.
4 .\" $FreeBSD: src/usr.sbin/rpcbind/rpcbind.8,v 1.10 2007/04/23 07:09:25 matteo Exp $
5 .\" $DragonFly$
6 .Dd April 23, 2007
7 .Dt RPCBIND 8
8 .Os
9 .Sh NAME
10 .Nm rpcbind
11 .Nd universal addresses to RPC program number mapper
12 .Sh SYNOPSIS
13 .Nm
14 .Op Fl 6adiLls
15 .Op Fl h Ar bindip
16 .Sh DESCRIPTION
17 The
18 .Nm
19 utility is a server that converts
20 .Tn RPC
21 program numbers into
22 universal addresses.
23 It must be running on the host to be able to make
24 .Tn RPC
25 calls
26 on a server on that machine.
27 .Pp
28 When an
29 .Tn RPC
30 service is started,
31 it tells
32 .Nm
33 the address at which it is listening,
34 and the
35 .Tn RPC
36 program numbers it is prepared to serve.
37 When a client wishes to make an
38 .Tn RPC
39 call to a given program number,
40 it first contacts
41 .Nm
42 on the server machine to determine
43 the address where
44 .Tn RPC
45 requests should be sent.
46 .Pp
47 The
48 .Nm
49 utility should be started before any other RPC service.
50 Normally, standard
51 .Tn RPC
52 servers are started by port monitors, so
53 .Nm
54 must be started before port monitors are invoked.
55 .Pp
56 When
57 .Nm
58 is started, it checks that certain name-to-address
59 translation-calls function correctly.
60 If they fail, the network configuration databases may be corrupt.
61 Since
62 .Tn RPC
63 services cannot function correctly in this situation,
64 .Nm
65 reports the condition and terminates.
66 .Pp
67 The
68 .Nm
69 utility can only be started by the super-user.
70 .Sh OPTIONS
71 .Bl -tag -width indent
72 .It Fl 6
73 Bind to AF_INET6 (IPv6) addresses only.
74 .It Fl a
75 When debugging
76 .Pq Fl d ,
77 do an abort on errors.
78 .It Fl d
79 Run in debug mode.
80 In this mode,
81 .Nm
82 will not fork when it starts, will print additional information
83 during operation, and will abort on certain errors if
84 .Fl a
85 is also specified.
86 With this option, the name-to-address translation consistency
87 checks are shown in detail.
88 .It Fl h Ar bindip
89 Specify specific IP addresses to bind to for TCP and UDP requests.
90 This option
91 may be specified multiple times and is typically necessary when running
92 on a multi-homed host.
93 If no
94 .Fl h
95 option is specified,
96 .Nm
97 will bind to
98 .Dv INADDR_ANY ,
99 which could lead to problems on a multi-homed host due to
100 .Nm
101 returning a UDP packet from a different IP address than it was
102 sent to.
103 Note that when specifying IP addresses with
104 .Fl h ,
105 .Nm
106 will automatically add
107 .Li 127.0.0.1
108 and if IPv6 is enabled,
109 .Li ::1
110 to the list.
111 .It Fl i
112 .Dq Insecure
113 mode.
114 Allow calls to SET and UNSET from any host.
115 Normally
116 .Nm
117 accepts these requests only from the loopback interface for security reasons.
118 This change is necessary for programs that were compiled with earlier
119 versions of the rpc library and do not make those requests using the
120 loopback interface.
121 .It Fl L
122 Allow old-style local connections over the loopback interface.
123 Without this flag, local connections are only allowed over a local socket,
124 .Pa /var/run/rpcbind.sock .
125 .It Fl l
126 Turn on libwrap connection logging.
127 .It Fl s
128 Cause
129 .Nm
130 to change to the user daemon as soon as possible.
131 This causes
132 .Nm
133 to use non-privileged ports for outgoing connections, preventing non-privileged
134 clients from using
135 .Nm
136 to connect to services from a privileged port.
137 .El
138 .Sh NOTES
139 All RPC servers must be restarted if
140 .Nm
141 is restarted.
142 .Sh FILES
143 .Bl -tag -width /var/run/rpcbind.sock -compact
144 .It Pa /var/run/rpcbind.sock
145 .El
146 .Sh SEE ALSO
147 .Xr rpcbind 3 ,
148 .Xr netconfig 5 ,
149 .Xr rpcinfo 8