<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Javier</firstname>">
  <!ENTITY dhsurname   "<surname>Fernandez-Sanguino</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>August 24th, 2007</date>">
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>jfs@debian.org</email>">
  <!ENTITY dhusername  "Javier Fernandez-Sanguino">
  <!ENTITY dhucpackage "<refentrytitle>xorp</refentrytitle>">
  <!ENTITY dhpackage   "xorp">
  <!ENTITY dhcmd       "xorp_rtrmgr">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2007</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhcmd;</refname>

    <refpurpose>XORP Router Manager</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhcmd;</command>

      <arg><option>-a <replaceable>allowed host</replaceable></option></arg>

      <arg><option>-l <replaceable>file</replaceable></option></arg>

      <arg><option>-L <replaceable>syslog facility</replaceable></option></arg>

      <arg><option>-n <replaceable>allowed net</replaceable></option></arg>

      <arg><option>-b|-c <replaceable>file</replaceable></option></arg>

      <arg><option>-i <replaceable>interface</replaceable></option></arg>

      <arg><option>-p <replaceable>port</replaceable></option></arg>

      <arg><option>-P <replaceable>pidfile</replaceable></option></arg>

      <arg><option>-q <replaceable>seconds</replaceable></option></arg>

      <arg><option>-t <replaceable>directory</replaceable></option></arg>

      <arg><option>-x <replaceable>directory</replaceable></option></arg>

      <arg><option>-C <replaceable>directory</replaceable></option></arg>

      <arg><option>-m <replaceable>directory</replaceable></option></arg>

      <arg><option>-N</option></arg>

      <arg><option>-h</option></arg>

      <arg><option>-v</option></arg>

      <arg><option>-d</option></arg>

      <arg><option>-r</option></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhcmd;</command> command.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para><command>&dhcmd;</command> is the program that that manages the whole
    eXtensible Open Router Platform (XORP) platform. The program loads its
    configuration file (commonly named <filename>config.boot</filename>) 
    which will read from the current working directory You can specify a
    different filename for the configuration file using the <option>-b</option>
    command line flag. The <option>-N</option> "no execute" flag will cause
    <command>&dhcmd;</command> to startup and pretend the router is operating
    normally, but to not actually start any processes. This can be used to
    check configuration files.
    </para>

    <para>Typically <command>xorp_rtrmgr</command> must be run as root. This is
    because it starts up processes that need privileged access to insert routes
    into the forwarding path in the kernel.</para>

    <para>To interact with the router via the command line interface, the
    operator should use the XORP command shell
    <command>xorpsh</command>.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para><command>&dhcmd;</command> allows the following options:</para>

    <variablelist>
      <varlistentry>
        <term><option>-a <replaceable>allowed host</replaceable></option>
        </term>
        <listitem>
          <para>Host allowed by the finder.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-b, -c <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Boot configuration file to load.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-C <replaceable>directory</replaceable></option>
        </term>
        <listitem>
          <para>Specify operational commands directory.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option>
        </term>
        <listitem>
          <para>Run in daemon mode in background.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-h</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-i <replaceable>interface</replaceable></option>
        </term>
        <listitem>
          <para>Set or add an interface run Finder on.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-l <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Log all the program information and errors to a file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-L <replaceable>facility.priority</replaceable></option>
        </term>
        <listitem>
          <para>Log all the program output to a given syslog facility.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-m <replaceable>directory</replaceable></option>
        </term>
        <listitem>
          <para>Specify protocol modules directory.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n <replaceable>allowed net</replaceable></option>
        </term>
        <listitem>
          <para>Subnet allowed by the finder.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-N</option>
        </term>
        <listitem>
          <para>Load the configuration but do not execute XRLs and do not start
          processes.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p <replaceable>port</replaceable></option>
        </term>
        <listitem>
          <para>Set port to run Finder on.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-P <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Write the process ID to a given file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-q <replaceable>seconds</replaceable></option>
        </term>
        <listitem>
          <para>Set forced quit period.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-r</option>
        </term>
        <listitem>
          <para>Restart failed processes (not implemented yet).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-t <replaceable>directory</replaceable></option>
        </term>
        <listitem>
          <para>Specify templates directory.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option>
        </term>
        <listitem>
          <para>Print verbose information.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-x <replaceable>directory</replaceable></option>
        </term>
        <listitem>
          <para>Specify Xrl targets directory.</para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>xorpsh (1)</para>

    <para>The programs are documented fully in the <citetitle>Xorp
      User Manual</citetitle> available at
      <filename>/usr/share/doc/xorp-doc/</filename> in Debian systems when the
      xorp-doc package is installed.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>XORP is Copyright (c) 2001-2009 XORP, Inc.</para>

    <para>This manual page was written by &dhusername; &dhemail; for the
    &debian; system (but may be used by others). For licensing details
    please see <filename>/usr/share/doc/xorp/copyright</filename>.</para>


  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


