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