doc/rdisc.sgml

   1 <refentry id="rdisc">
   2
   3 <refmeta>
   4 <refentrytitle>rdisc</refentrytitle>
   5 <manvolnum>8</manvolnum>
   6 <refmiscinfo>iputils-&snapshot;</refmiscinfo>
   7 </refmeta>
   8
   9 <refnamediv>
  10 <refname>rdisc</refname>
  11 <refpurpose>network router discovery daemon</refpurpose>
  12 </refnamediv>
  13
  14 <refsynopsisdiv>
  15 <cmdsynopsis>
  16 <command>rdisc</command>
  17 <arg choice="opt"><option>-abdfstvV</option></arg>
  18 <arg choice="opt"><replaceable/send_address/</arg>
  19 <arg choice="opt"><replaceable/receive_address/</arg>
  20 </cmdsynopsis>
  21 </refsynopsisdiv>
  22
  23 <refsect1><title>DESCRIPTION</title>
  24 <para>
  25 <command/rdisc/ implements client side of the ICMP router discover protocol.
  26 <command/rdisc/ is invoked at boot time to populate the network
  27 routing tables with default routes.
  28 </para>
  29
  30 <para>
  31 <command/rdisc/ listens on the ALL_HOSTS (224.0.0.1) multicast address
  32 (or <replaceable/receive_address/ provided it is given)
  33 for ROUTER_ADVERTISE messages from routers. The received
  34 messages are handled by first ignoring those listed router addresses
  35 with which the host does not share a network. Among the remaining addresses
  36 the ones with the highest preference are selected as default routers
  37 and a default route is entered in the kernel routing table
  38 for each one of them.
  39 </para>
  40
  41 <para>
  42 Optionally, <command/rdisc/ can avoid waiting for routers to announce
  43 themselves by sending out a few ROUTER_SOLICITATION messages
  44 to the ALL_ROUTERS (224.0.0.2) multicast address
  45 (or <replaceable/send_address/ provided it is given)
  46 when it is started.
  47 </para>
  48
  49 <para>
  50 A timer is associated with each router address and the address will
  51 no longer be considered for inclusion in the the routing tables if the
  52 timer expires before a new
  53 <emphasis/advertise/ message is received from the router.
  54 The address will also be excluded from consideration if the host receives an
  55 <emphasis/advertise/
  56 message with the preference being maximally negative.
  57 </para>
  58
  59 <para>
  60 Server side of router discovery protocol is supported by Cisco IOS
  61 and by any more or less complete UNIX routing daemon, f.e <command/gated/.
  62 </para>
  63
  64 </refsect1>
  65
  66 <refsect1><title>OPTIONS</title>
  67
  68 <variablelist>
  69  <varlistentry>
  70   <term><option/-a/</term>
  71   <listitem><para>
  72 Accept all routers independently of the preference they have in their
  73 <emphasis/advertise/ messages.
  74 Normally <command/rdisc/ only accepts (and enters in the kernel routing
  75 tables) the router or routers with the highest preference.
  76   </para></listitem>
  77  </varlistentry>
  78  <varlistentry>
  79   <term><option/-b/</term>
  80   <listitem><para>
  81 Opposite to <option/-a/, i.e. install only router with the best
  82 preference value. It is default behaviour.
  83   </para></listitem>
  84  </varlistentry>
  85  <varlistentry>
  86   <term><option/-d/</term>
  87   <listitem><para>
  88 Send debugging messages to syslog.
  89   </para></listitem>
  90  </varlistentry>
  91  <varlistentry>
  92   <term><option/-f/</term>
  93   <listitem><para>
  94 Run <command/rdisc/ forever even if no routers are found.
  95 Normally <command/rdisc/ gives up if it has not received any
  96 <emphasis/advertise/ message after after soliciting three times,
  97 in which case it exits with a non-zero exit code.
  98 If <option/-f/ is not specified in the first form then
  99 <option/-s/ must be specified.
 100   </para></listitem>
 101  </varlistentry>
 102
 103  <varlistentry>
 104   <term><option/-s/</term>
 105   <listitem><para>
 106 Send three <emphasis/solicitation/ messages initially to quickly discover
 107 the routers when the system is booted.
 108 When <option/-s/ is specified <command/rdisc/
 109 exits with a non-zero exit code if it can not find any routers.
 110 This can be overridden with the <option/-f/ option.
 111   </para></listitem>
 112  </varlistentry>
 113
 114  <varlistentry>
 115   <term><option/-t/</term>
 116   <listitem><para>
 117 Test mode. Do not go to background.
 118   </para></listitem>
 119  </varlistentry>
 120
 121
 122  <varlistentry>
 123   <term><option/-v/</term>
 124   <listitem><para>
 125 Be verbose i.e. send lots of debugging messages to syslog.
 126   </para></listitem>
 127  </varlistentry>
 128
 129  <varlistentry>
 130   <term><option/-V/</term>
 131   <listitem><para>
 132 Print version and exit.
 133   </para></listitem>
 134  </varlistentry>
 135 </variablelist>
 136 </refsect1>
 137
 138 <refsect1><title>HISTORY</title>
 139 <para>
 140 This program was developed by Sun Microsystems (see copyright
 141 notice in source file). It was ported to Linux by
 142 <ulink url="mailto:kuznet@ms2.inr.ac.ru">Alexey Kuznetsov
 143 &lt;kuznet@ms2.inr.ac.ru&gt;</ulink>.
 144 It is now maintained by
 145 <ulink url="mailto:yoshfuji@skbuff.net">YOSHIFUJI Hideaki
 146 &lt;yoshfuji@skbuff.net&gt;</ulink>.
 147 </para>
 148 </refsect1>
 149
 150
 151 <refsect1><title>SEE ALSO</title>
 152 <para>
 153 <citerefentry><refentrytitle/icmp/<manvolnum/7/</citerefentry>,
 154 <citerefentry><refentrytitle/inet/<manvolnum/7/</citerefentry>,
 155 <link linkend="ping">
 156 <citerefentry><refentrytitle/ping/<manvolnum/8/</citerefentry></link>.
 157 </para>
 158 </refsect1>
 159
 160 <refsect1><title>REFERENCES</title>
 161 <para>
 162 Deering, S.E.,ed "ICMP Router Discovery Messages",
 163 <ulink url="ftp://ftp.isi.edu/in-notes/rfc1256.txt">
 164 RFC1256</ulink>, Network Information Center, SRI International,
 165 Menlo Park, Calif., September 1991.
 166 </para>
 167 </refsect1>
 168
 169 <refsect1><title>SECURITY</title>
 170 <para>
 171 <command/rdisc/ requires <constant/CAP_NET_RAWIO/ to listen
 172 and send ICMP messages and capability <constant/CAP_NET_ADMIN/
 173 to update routing tables.
 174 </para>
 175 </refsect1>
 176
 177 <refsect1><title>AVAILABILITY</title>
 178 <para>
 179 <command/rdisc/ is part of <filename/iputils/ package
 180 and the latest versions are  available in source form at
 181 <ulink url="http://www.skbuff.net/iputils/iputils-current.tar.bz2">
 182 http://www.skbuff.net/iputils/iputils-current.tar.bz2</ulink>.
 183 </para>
 184 </refsect1>
 185
 186 <![IGNORE[
 187 <refsect1><title>COPYING</title>
 188 <para>
 189 <literallayout>
 190 Rdisc (this program) was developed by Sun Microsystems, Inc. and is
 191 provided for unrestricted use provided that this legend is included on
 192 all tape media and as a part of the software program in whole or part.
 193 Users may copy or modify Rdisc without charge, and they may freely
 194 distribute it.
 195
 196 RDISC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
 197 WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 198 PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
 199
 200 Rdisc is provided with no support and without any obligation on the
 201 part of Sun Microsystems, Inc. to assist in its use, correction,
 202 modification or enhancement.
 203
 204 SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
 205 INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY RDISC
 206 OR ANY PART THEREOF.
 207
 208 In no event will Sun Microsystems, Inc. be liable for any lost revenue
 209 or profits or other special, indirect and consequential damages, even if
 210 Sun has been advised of the possibility of such damages.
 211
 212 Sun Microsystems, Inc.
 213 2550 Garcia Avenue
 214 Mountain View, California  94043
 215 </literallayout>
 216 </para>
 217 </refsect1>
 218 ]]>
 219
 220
 221 </refentry>