No empty .Rs/.Re
[netbsd-mini2440.git] / usr.bin / rpcinfo / rpcinfo.8
blob164b4e9812f5ca229801c5c4ad57f7a84c37ecf3
1 .\" @(#)rpcinfo.1m 1.23 93/03/29 SMI; from SVr4
2 .\" Copyright 1989 AT&T
3 .\" Copyright 1991 Sun Microsystems, Inc.
4 .\" $NetBSD: rpcinfo.8,v 1.13 2003/02/25 10:35:53 wiz Exp $
5 .Dd August 18, 1992
6 .Dt RPCINFO 8
7 .Os
8 .Sh NAME
9 .Nm rpcinfo
10 .Nd report RPC information
11 .Sh SYNOPSIS
12 .Nm
13 .Op Fl m Li \&| Fl s
14 .Op Ar host
15 .Nm
16 .Fl p Op Ar host
17 .Nm
18 .Fl T Ar transport
19 .Ar host Ar prognum
20 .Op Ar versnum
21 .Nm
22 .Fl l
23 .Op Fl T Ar transport
24 .Ar host Ar prognum
25 .Op Ar versnum
26 .Nm
27 .Op Fl n Ar portnum
28 .Fl u
29 .Ar host Ar prognum
30 .Op Ar versnum
31 .Nm
32 .Op Fl n Ar portnum
33 .Op Fl t
34 .Ar host Ar prognum
35 .Op Ar versnum
36 .Nm
37 .Fl a Ar serv_address
38 .Fl T Ar transport
39 .Ar prognum
40 .Op Ar versnum
41 .Nm
42 .Fl b
43 .Op Fl T Ar transport
44 .Ar prognum Ar versnum
45 .Nm
46 .Fl d
47 .Op Fl T Ar transport
48 .Ar prognum Ar versnum
49 .Sh DESCRIPTION
50 .Nm
51 makes an RPC call to an RPC
52 server and reports what it finds.
53 .Pp
54 In the first synopsis,
55 .Nm
56 lists all the registered RPC services with
57 .Nm rpcbind
59 .Ar host .
61 .Ar host
62 is not specified, the local host is the default.
64 .Fl s
65 is used, the information is displayed in a concise format.
66 .Pp
67 In the second synopsis,
68 .Nm
69 lists all the RPC services registered with
70 .Nm rpcbind ,
71 version 2.
72 Also note that the format of the information
73 is different in the first and the second synopsis.
74 This is because the second synopsis is an older protocol used to
75 collect the information displayed (version 2 of the
76 .Nm rpcbind
77 protocol).
78 .Pp
79 The third synopsis makes an RPC call to procedure 0
81 .Ar prognum
82 and
83 .Ar versnum
84 on the specified
85 .Ar host
86 and reports whether a response was received.
87 .Ar transport
88 is the transport which has to be used for contacting the
89 given service.
90 The remote address of the service is obtained by
91 making a call to the remote
92 .Nm rpcbind .
93 .Pp
94 The
95 .Ar prognum
96 argument is a number that represents an RPC program number.
97 If a
98 .Ar versnum
99 is specified,
101 attempts to call that version of the specified
102 .Ar prognum .
103 Otherwise,
105 attempts to find all the registered version
106 numbers for the specified
107 .Ar prognum
108 by calling version 0,
109 which is presumed not to exist;
110 if it does exist,
112 attempts to obtain this information by calling
113 an extremely high version number instead,
114 and attempts to call each registered version.
115 Note:
116 the version number is required for
117 .Fl b
119 .Fl d
120 options.
121 .Sh OPTIONS
122 .Bl -tag -width indent
123 .It Fl T Ar transport
124 Specify the transport on which the service is required.
125 If this option is not specified,
127 uses the transport specified in the
128 .Ev NETPATH
129 environment variable, or if that is unset or null, the transport
130 in the
131 .Xr netconfig 5
132 database is used.
133 This is a generic option,
134 and can be used in conjunction with other options as
135 shown in the SYNOPSIS.
137 .It Fl a Ar serv_address
139 .Ar serv_address
140 as the (universal) address for the service on
141 .Ar transport
142 to ping procedure 0
143 of the specified
144 .Ar prognum
145 and report whether a response was received.
147 .Fl T
148 option is required with the
149 .Fl a
150 option.
153 .Ar versnum
154 is not specified,
156 tries to ping all
157 available version numbers for that program number.
158 This option avoids calls to remote
159 .Nm rpcbind
160 to find the address of the service.
162 .Ar serv_address
163 is specified in universal address format of the given transport.
165 .It Fl b
166 Make an RPC broadcast to procedure 0
167 of the specified
168 .Ar prognum
170 .Ar versnum
171 and report all hosts that respond.
173 .Ar transport
174 is specified, it broadcasts its request only on the
175 specified transport.
176 If broadcasting is not supported by any
177 transport,
178 an error message is printed.
179 Use of broadcasting should be limited because of the potential for adverse
180 effect on other systems.
182 .It Fl d
183 Delete registration for the RPC service of the specified
184 .Ar prognum
186 .Ar versnum .
188 .Ar transport
189 is specified,
190 unregister the service on only that transport,
191 otherwise unregister the service on all
192 the transports on which it was registered.
193 Only the owner of a service can delete a registration, except the
194 super-user who can delete any service.
196 .It Fl l
197 Display a list of entries with a given
198 .Ar prognum
200 .Ar versnum
201 on the specified
202 .Ar host .
203 Entries are returned for all transports
204 in the same protocol family as that used to contact the remote
205 .Nm rpcbind .
207 .It Fl m
208 Display a table of statistics of
209 .Nm rpcbind
210 operations on the given
211 .Ar host .
212 The table shows statistics for each version of
213 .Nm rpcbind
214 (versions 2, 3 and 4), giving the number of times each procedure was
215 requested and successfully serviced, the number and type of remote call
216 requests that were made, and information about RPC address lookups that were
217 handled. This is useful for monitoring RPC activities on
218 .Ar host .
220 .It Fl n Ar portnum
222 .Ar portnum
223 as the port number for the
224 .Fl t
226 .Fl u
227 options instead of the port number given by
228 .Nm rpcbind .
229 Use of this option avoids a call to the remote
230 .Nm rpcbind
231 to find out the address of the service. This option is made
232 obsolete by the
233 .Fl a
234 option.
236 .It Fl p
237 Probe
238 .Nm rpcbind
240 .Ar host
241 using version 2 of the
242 .Nm rpcbind
243 protocol,
244 and display a list of all registered RPC programs.
246 .Ar host
247 is not specified, it defaults to the local host.
248 Note: Version 2 of the
249 .Nm rpcbind
250 protocol was previously known as the portmapper protocol.
252 .It Fl s
253 Display a concise list of all registered RPC programs on
254 .Ar host .
256 .Ar host
257 is not specified, it defaults to the local host.
259 .It Fl t
260 Make an RPC call to procedure 0 of
261 .Ar prognum
262 on the specified
263 .Ar host
264 using TCP,
265 and report whether a response was received. This option is made
266 obsolete by the
267 .Fl T
268 option as shown in the third synopsis.
270 .It Fl u
271 Make an RPC call to procedure 0 of
272 .Ar prognum
273 on the specified
274 .Ar host
275 using UDP,
276 and report whether a response was received. This option is made
277 obsolete by the
278 .Fl T
279 option as shown in the third synopsis.
281 .Sh EXAMPLES
282 To show all of the RPC services registered on the local machine use:
284 .Bd -literal
285         example% rpcinfo
288 To show all of the RPC
289 services registered with
290 .Nm rpcbind
291 on the machine named
292 .Nm klaxon
293 use:
295 .Bd -literal
296         example% rpcinfo klaxon
299 The information displayed by the above commands can be quite lengthy.
300 Use the
301 .Fl s
302 option to display a more concise list:
304 .Bd -literal
305         example$ rpcinfo -s klaxon
307 .Bl -column "program" "version(s)" "local,tcp,udp,tcp6,udp6" "nlockmgr" "super-user"
308 .It program Ta version(s) Ta netid(s) Ta service Ta owner
309 .It 100000 Ta 2,3,4 Ta local,tcp,udp,tcp6,udp6 Ta rpcbind Ta super-user
310 .It 100008 Ta 1 Ta udp,tcp,udp6,tcp6 Ta walld Ta super-user
311 .It 100002 Ta 2,1 Ta udp,udp6 Ta rusersd Ta super-user
312 .It 100001 Ta 2,3,4 Ta udp,udp6 Ta rstatd Ta super-user
313 .It 100012 Ta 1 Ta udp,tcp Ta sprayd Ta super-user
314 .It 100007 Ta 3 Ta udp,tcp Ta ypbind Ta super-user
317 To show whether the RPC
318 service with program number
319 .Ar prognum
320 and version
321 .Ar versnum
322 is registered on the machine named
323 .Nm klaxon
324 for the transport TCP
325 use:
327 .Bd -literal
328         example% rpcinfo -T tcp klaxon prognum versnum
331 To show all RPC
332 services registered with version 2 of the
333 .Nm rpcbind
334 protocol on the local machine use:
335 .Bd -literal
336         example% rpcinfo -p
339 To delete the registration for version
340 1 of the
341 .Nm walld
342 (program number 100008 )
343 service for all transports use:
344 .Bd -literal
345         example# rpcinfo -d 100008 1
349 .Bd -literal
350         example# rpcinfo -d walld 1
352 .Sh SEE ALSO
353 .Xr rpc 3 ,
354 .Xr netconfig 5 ,
355 .Xr rpc 5 ,
356 .Xr rpcbind 8