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