Sync usage with man page.
[netbsd-mini2440.git] / sbin / routed / rtquery / rtquery.8
blob5b65b7a2b9bd654648b0fbf3d750b2a4ade7a74c
1 .\"     $NetBSD: rtquery.8,v 1.19 2003/09/23 12:14:49 wiz Exp $
2 .\"
3 .Dd September 11, 2009
4 .Dt RTQUERY 8
5 .Os
6 .Sh NAME
7 .Nm rtquery
8 .Nd query routing daemons for their routing tables
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl 1np
12 .Op Fl a Ar secret
13 .Op Fl r Ar addr
14 .Op Fl w Ar timeout
15 .Ar host ...
16 .Nm
17 .Op Fl t Ar op
18 .Ar host ...
19 .Sh DESCRIPTION
20 .Nm
21 is used to query a RIP network routing daemon,
22 .Xr routed 8
24 .Xr gated 8 ,
25 for its routing table by sending a
26 .Em request
28 .Em poll
29 command.
30 The routing information in any routing
31 .Em response
32 packets returned is displayed numerically and symbolically.
33 .Pp
34 .Nm
35 by default uses the
36 .Em request
37 command.
38 When the
39 .Fl p
40 option is specified,
41 .Nm
42 uses the
43 .Em poll
44 command, an
45 undocumented extension to the RIP protocol supported by
46 .Xr gated 8 .
47 When querying
48 .Xr gated 8 ,
49 the
50 .Em poll
51 command is preferred over the
52 .Em request
53 command because the response is not subject to Split Horizon and/or
54 Poisoned Reverse, and because some versions of gated do not answer the
55 .Em request
56 command.
57 .Xr routed 8
58 does not answer the
59 .Em poll
60 command, but recognizes
61 .Em requests
62 coming from
63 .Nm
64 and so answers completely.
65 .Pp
66 .Nm
67 is also used to turn tracing on or off in
68 .Xr routed 8 .
69 .Pp
70 The following options are available:
71 .Bl -tag -width indent
72 .It Fl n
73 displays only the numeric network and host numbers instead of both
74 numeric and symbolic.
75 .It Fl p
76 uses the
77 .Em poll
78 command to request full routing information from
79 .Xr gated 8 .
80 This is an undocumented extension RIP protocol supported only by
81 .Xr gated 8 .
82 .It Fl 1
83 queries using RIP version 1 instead of RIP version 2.
84 .It Fl w Ar timeout
85 changes the delay for an answer from each host.
86 By default, each host is given 15 seconds to respond.
87 .It Fl r Ar addr
88 asks about the route to destination
89 .Em addr .
90 .It Fl a Ar passwd=XXX
91 .It Fl a Ar md5_passwd=XXX|KeyID
92 causes the query to be sent with the indicated cleartext or MD5 password.
93 .It Fl t Ar op
94 changes tracing, where
95 .Em op
96 is one of the following.
97 Requests from processes not running with UID 0 or on distant networks
98 are generally ignored by the daemon except for a message in the system log.
99 .Xr gated 8
100 is likely to ignore these debugging requests.
102 .Bl -tag -width Ds -offset indent-two
103 .It Em on=tracefile
104 turns tracing on into the specified file.
105 That file must usually have been specified when the daemon was
106 started or be the same as a fixed name, often
107 .Pa /etc/routed.trace .
108 .It Em more
109 increases the debugging level.
110 .It Em off
111 turns off tracing.
112 .It Em dump
113 dumps the daemon's routing table to the current tracefile.
115 .Sh SEE ALSO
116 .Xr gated 8 ,
117 .Xr routed 8 ,
118 .Pa pkgsrc/net/gated
120 .%R RFC 1058
121 .%T Routing Information Protocol, RIPv1
122 .%D 1988
125 .%R RFC 1723
126 .%T Routing Information Protocol, RIPv2
127 .%D 1994