Merge commit 'dc97a43d4a70c8773a619f11b95b07a787f6f5b7' into merges
[unleashed.git] / share / man / man8 / rtquery.8
blobbd91f9c40aacde106ae5b0f7ffaf1647a2c2aa27
1 '\" te
2 .\" Copyright (c) 2002, Sun Microsystems, Inc.
3 .\" All Rights Reserved.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH RTQUERY 8 "Apr 24, 2002"
8 .SH NAME
9 rtquery \- query routing daemons for their routing tables
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBrtquery\fR [\fB-np1\fR] [\fB-w\fR \fItimeout\fR] [\fB-r\fR \fIaddr\fR] [\fB-a\fR \fIsecret\fR] \fIhost\fR...
14 .fi
16 .LP
17 .nf
18 \fBrtquery\fR [\fB-t\fR \fIoperation\fR] \fIhost\fR...
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 The \fBrtquery\fR command is used to query a RIP network routing daemon,
25 \fBin.routed\fR(8) or \fBGateD\fR, for its routing table by sending a request
26 or poll command. The routing information in any routing response packets
27 returned is displayed numerically and symbolically.
28 .sp
29 .LP
30 By default, \fBrtquery\fR uses the request command. When the -p option is
31 specified, \fBrtquery\fR uses the poll command, an undocumented extension to
32 the RIP protocol supported by \fBGateD\fR. When querying \fBGateD\fR, the poll
33 command is preferred over the request command because the response is not
34 subject to Split Horizon and/or Poisoned Reverse, and because some versions of
35 \fBGateD\fR do not answer the request command. \fBin.routed\fR does not answer
36 the poll command, but recognizes requests coming from \fBrtquery\fR and so
37 answers completely.
38 .sp
39 .LP
40 The \fBrtquery\fR command is also used to turn tracing on or off in
41 \fBin.routed\fR.
42 .SH OPTIONS
43 .sp
44 .LP
45 The following options are supported:
46 .sp
47 .ne 2
48 .na
49 \fB\fB-a\fR \fBpasswd=\fR\fIXXX\fR\fR
50 .ad
51 .br
52 .na
53 \fB\fB-a\fR \fBmd5_passwd=\fR\fIXXX\fR|\fIKeyID\fR\fR
54 .ad
55 .RS 27n
56 Causes the query to be sent with the indicated cleartext or MD5 password.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB-n\fR\fR
63 .ad
64 .RS 27n
65 Displays only the numeric network and host addresses instead of both numeric
66 and symbolic names.
67 .RE
69 .sp
70 .ne 2
71 .na
72 \fB\fB-p\fR\fR
73 .ad
74 .RS 27n
75 Uses the poll command to request full routing information from \fBGateD\fR.
76 This is an undocumented extension RIP protocol supported only by \fBGateD\fR.
77 .RE
79 .sp
80 .ne 2
81 .na
82 \fB\fB-r\fR \fIaddr\fR\fR
83 .ad
84 .RS 27n
85 Asks about the route to destination \fIaddr\fR.
86 .RE
88 .sp
89 .ne 2
90 .na
91 \fB\fB-t\fR \fIoperation\fR\fR
92 .ad
93 .RS 27n
94 Changes tracing, where \fIoperation\fR is one of the actions listed below.
95 Requests from processes not running with UID 0 or on distant networks are
96 generally ignored by the daemon except for a message in the system log.
97 \fBGateD\fR is likely to ignore these debugging requests.
98 .sp
99 .ne 2
101 \fBon=\fItracefile\fR\fR
103 .RS 16n
104 Turns tracing on, directing tracing into the specified file. That file must
105 have been specified when the daemon was started or have the name,
106 \fB/var/log/in.routed.trace\fR.
110 .ne 2
112 \fBmore\fR
114 .RS 16n
115 Increases the debugging level.
119 .ne 2
121 \fBoff\fR
123 .RS 16n
124 Turns off tracing.
128 .ne 2
130 \fBdump\fR
132 .RS 16n
133 Dumps the daemon's routing table to the current trace file.
139 .ne 2
141 \fB\fB-w\fR \fItimeout\fR\fR
143 .RS 27n
144 Changes the delay for an answer from each host. By default, each host is given
145 15 seconds to respond.
149 .ne 2
151 \fB\fB-1\fR\fR
153 .RS 27n
154 Queries using RIP version 1 instead of RIP version 2.
157 .SH EXIT STATUS
160 The following exit values are returned:
162 .ne 2
164 \fB\fB0\fR\fR
166 .RS 6n
167 Successful completion.
171 .ne 2
173 \fB>\fB0\fR\fR
175 .RS 6n
176 An error occurred.
179 .SH SEE ALSO
182 \fBin.routed\fR(8),  \fBroute\fR(8), \fBgateways\fR(4), \fBattributes\fR(5),
183 \fBicmp\fR(7P), \fBinet\fR(7P), \fBudp\fR(7P)
186 \fIRouting Information Protocol, RIPv1, RFC 1058\fR
189 \fIRouting Information Protocol, RIPv2, RFC 2453, STD 0056\fR