doc/rarpd.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook" version="5.0"
   2 xml:id="man.rarpd">
   3
   4   <refentryinfo>
   5     <title>rarpd</title>
   6     <productname>iputils</productname>
   7   </refentryinfo>
   8
   9   <refmeta>
  10     <refentrytitle>
  11       <application>rarpd</application>
  12     </refentrytitle>
  13     <manvolnum>8</manvolnum>
  14     <refmiscinfo class='manual'>iputils</refmiscinfo>
  15   </refmeta>
  16
  17   <refnamediv>
  18     <refname>rarpd</refname>
  19     <refpurpose>answer RARP REQUESTs</refpurpose>
  20   </refnamediv>
  21
  22   <refsynopsisdiv>
  23     <cmdsynopsis sepchar=" ">
  24       <command>rarpd</command>
  25       <arg choice="opt" rep="norepeat">
  26         <option>-AadevV</option>
  27       </arg>
  28       <arg choice="opt" rep="norepeat">
  29         <option>-b
  30         <replaceable>bootdir</replaceable></option>
  31       </arg>
  32       <arg choice="req" rep="norepeat">interface</arg>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsection xml:id="description">
  37     <info>
  38       <title>DESCRIPTION</title>
  39     </info>
  40     <para>Listens for RARP requests broadcasted by clients. If the MAC address
  41     of the client is found in <filename>/etc/ethers</filename> and the obtained
  42     hostname is resolvable to a valid IP address from the attached network,
  43     <command>rarpd</command> answers to the client with a RARPD reply
  44     and provides an IP address.</para>
  45
  46     <para>To allow multiple boot servers on the network
  47     <command>rarpd</command> optionally checks if a Sun-like
  48     bootable image in the TFTP directory is present. It should be formatted like
  49     <emphasis remap="B">Hexadecimal_IP.ARCH</emphasis>. For example: To
  50     load sparc 193.233.7.98,
  51     <emphasis remap="I">C1E90762.SUN4M</emphasis> is linked to an
  52     image appropriate for SUN4M in the directory
  53     <filename>/etc/tftpboot</filename>.</para>
  54   </refsection>
  55
  56   <refsection xml:id="warning">
  57     <info>
  58       <title>WARNING</title>
  59     </info>
  60     <para>This facility is deeply obsoleted by BOOTP and later DHCP
  61     protocols. However, some clients actually still need this to
  62     boot.</para>
  63   </refsection>
  64
  65   <refsection xml:id="options">
  66     <info>
  67       <title>OPTIONS</title>
  68     </info>
  69     <variablelist remap="TP">
  70       <varlistentry>
  71         <term>
  72           <option>-a</option>
  73         </term>
  74         <listitem>
  75           <para>Listen on all available interfaces. Currently it is an
  76           internal option, its function is overwritten with the
  77           <emphasis remap="I">interface</emphasis> argument. It
  78           should not be used.</para>
  79         </listitem>
  80       </varlistentry>
  81       <varlistentry>
  82         <term>
  83           <option>-A</option>
  84         </term>
  85         <listitem>
  86           <para>Listen not only to RARP but also ARP messages. Some
  87           rare clients use ARP for some unknown reason.</para>
  88         </listitem>
  89       </varlistentry>
  90       <varlistentry>
  91         <term>
  92           <option>-v</option>
  93         </term>
  94         <listitem>
  95           <para>Be verbose.</para>
  96         </listitem>
  97       </varlistentry>
  98       <varlistentry>
  99         <term>
 100           <option>-d</option>
 101         </term>
 102         <listitem>
 103           <para>Debug mode. Do not go to background.</para>
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term>
 108           <option>-e</option>
 109         </term>
 110         <listitem>
 111           <para>Do not check for the presence of a boot image. Reply if
 112           MAC address resolves to a valid IP address using
 113           <filename>/etc/ethers</filename> database and DNS.</para>
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term>
 118           <option>-b</option>
 119           <emphasis remap="I">bootdir</emphasis>
 120         </term>
 121         <listitem>
 122           <para>TFTP boot directory. Default is
 123           <filename>/etc/tftpboot</filename></para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term>
 128           <option>-V</option>
 129         </term>
 130         <listitem>
 131           <para>Print version and exit.</para>
 132         </listitem>
 133       </varlistentry>
 134     </variablelist>
 135   </refsection>
 136
 137   <refsection xml:id="see_also">
 138     <info>
 139       <title>SEE ALSO</title>
 140     </info>
 141     <para>
 142     <citerefentry>
 143       <refentrytitle>arping</refentrytitle>
 144       <manvolnum>8</manvolnum>
 145     </citerefentry>,
 146     <citerefentry>
 147       <refentrytitle>tftpd</refentrytitle>
 148       <manvolnum>8</manvolnum>
 149     </citerefentry>.</para>
 150   </refsection>
 151
 152   <refsection xml:id="author">
 153     <info>
 154       <title>AUTHOR</title>
 155     </info>
 156     <para>
 157     <command>rarpd</command> was written by Alexey Kuznetsov
 158     &lt;kuznet@ms2.inr.ac.ru&gt;.</para>
 159   </refsection>
 160
 161   <refsection xml:id="security">
 162     <info>
 163       <title>SECURITY</title>
 164     </info>
 165     <para>
 166     <command>rarpd</command> requires CAP_NET_RAW capability to
 167     listen and send RARP and ARP packets. It also needs
 168     CAP_NET_ADMIN to assist the kernel with ARP resolution; this
 169     is not strictly required, but some (to be more exact: most) of
 170     the clients are so badly broken that they are not able to answer
 171     to ARP before they are fully booted. This is no surprise, taking
 172     into account that clients using RARPD in 2002 are all
 173     unsupported relic creatures of the 90's and even earlier.</para>
 174   </refsection>
 175
 176   <refsection xml:id="availability">
 177     <info>
 178       <title>AVAILABILITY</title>
 179     </info>
 180     <para>
 181     <emphasis remap="B">rarpd</emphasis> is part of the
 182     <emphasis remap="I">iputils</emphasis> package.</para>
 183   </refsection>
 184 </refentry>