Merge branch 'vendor/LIBARCHIVE' into HEAD
[dragonfly.git] / usr.sbin / IPXrouted / IPXrouted.8
1 .\" Copyright (c) 1986, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Copyright (c) 1995 John Hay.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\" $FreeBSD: src/usr.sbin/IPXrouted/IPXrouted.8,v 1.8.2.5 2003/03/11 21:13:47 trhodes Exp $
35 .\" $DragonFly: src/usr.sbin/IPXrouted/IPXrouted.8,v 1.4 2008/05/09 20:31:04 swildner Exp $
36 .\"
37 .Dd October 11, 1995
38 .Dt IPXROUTED 8
39 .Os
40 .Sh NAME
41 .Nm IPXrouted
42 .Nd IPX Routing Information Protocol daemon
43 .Sh SYNOPSIS
44 .Nm
45 .Op Fl N
46 .Op Fl q
47 .Op Fl s
48 .Op Fl S
49 .Op Fl t
50 .Op Ar logfile
51 .Sh DESCRIPTION
52 The
53 .Nm
54 utility is invoked at boot time to manage the IPX routing tables.
55 The IPX routing daemon uses the Novell IPX Routing
56 Information Protocol in maintaining up to date kernel routing
57 table entries.
58 .Pp
59 Available options:
60 .Bl -tag -width logfile
61 .It Fl N
62 Do not reply on GetNearestServer SAP request.
63 .It Fl q
64 Do not supply routing information (opposite of
65 .Fl s
66 option below).
67 .It Fl s
68 Forces
69 .Nm
70 to supply routing information whether it is acting as an internetwork
71 router or not.
72 .It Fl S
73 Do not supply Service Advertising Protocol
74 (SAP)
75 information.
76 The default is to supply
77 SAP
78 information.
79 .It Fl t
80 All packets sent or received are
81 printed on the standard output.  In addition,
82 .Nm
83 will not divorce itself from the controlling terminal
84 so that interrupts from the keyboard will kill the process.
85 .It Ar logfile
86 Name of file in which
87 .Nm Ns 's
88 actions should be logged.  This log contains information
89 about any changes to the routing tables and a history of
90 recent messages sent and received which are related to
91 the changed route.
92 .El
93 .Pp
94 In normal operation
95 .Nm
96 listens
97 for routing information packets.  If the host is connected to
98 multiple IPX networks, it periodically supplies copies
99 of its routing tables to any directly connected hosts
100 and networks.
101 .Pp
102 When
103 .Nm
104 is started, it uses the
105 .Dv SIOCGIFCONF
106 .Xr ioctl 2
107 to find those
108 directly connected interfaces configured into the
109 system and marked
110 .Dq up
111 (the software loopback interface
112 is ignored).  If multiple interfaces
113 are present, it is assumed the host will forward packets
114 between networks.
115 The
116 .Nm
117 utility then transmits a
118 .Em request
119 packet on each interface (using a broadcast packet if
120 the interface supports it) and enters a loop, listening
121 for
122 .Em request
123 and
124 .Em response
125 packets from other hosts.
126 .Pp
127 When a
128 .Em request
129 packet is received,
130 .Nm
131 formulates a reply based on the information maintained in its
132 internal tables.  The
133 .Em response
134 packet generated contains a list of known routes, each marked
135 with a
136 .Dq hop count
137 metric (a count of 16, or greater, is
138 considered
139 .Dq infinite ) .
140 The metric associated with each
141 route returned provides a metric
142 .Em relative to the sender .
143 .Pp
144 .Em Response
145 packets received by
146 .Nm
147 are used to update the routing tables if one of the following
148 conditions is satisfied:
149 .Bl -bullet
150 .It
151 No routing table entry exists for the destination network
152 or host, and the metric indicates the destination is ``reachable''
153 (i.e. the hop count is not infinite).
154 .It
155 The source host of the packet is the same as the router in the
156 existing routing table entry.  That is, updated information is
157 being received from the very internetwork router through which
158 packets for the destination are being routed.
159 .It
160 The existing entry in the routing table has not been updated for
161 some time (defined to be 90 seconds) and the route is at least
162 as cost effective as the current route.
163 .It
164 The new route describes a shorter route to the destination than
165 the one currently stored in the routing tables; the metric of
166 the new route is compared against the one stored in the table
167 to decide this.
168 .El
169 .Pp
170 When an update is applied,
171 .Nm
172 records the change in its internal tables and generates a
173 .Em response
174 packet to all directly connected hosts and networks.
175 .Xr Routed 8
176 waits a short period
177 of time (no more than 30 seconds) before modifying the kernel's
178 routing tables to allow possible unstable situations to settle.
179 .Pp
180 In addition to processing incoming packets,
181 .Nm
182 also periodically checks the routing table entries.
183 If an entry has not been updated for 3 minutes, the entry's metric
184 is set to infinity and marked for deletion.  Deletions are delayed
185 an additional 60 seconds to insure the invalidation is propagated
186 to other routers.
187 .Pp
188 Hosts acting as internetwork routers gratuitously supply their
189 routing tables every 30 seconds to all directly connected hosts
190 and networks.
191 .Pp
192 If
193 .Nm
194 receives a
195 .Dv SIGINFO
196 signal the current contents of the RIP and SAP
197 tables are appended to the file
198 .Pa /var/log/ipxrouted.dmp .
199 .Sh SEE ALSO
200 .Xr ipx 3
201 .\".Sh HISTORY