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

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@
  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Matt</firstname>">
  <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>December  5, 2001</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>mdz@debian.org</email>">
  <!ENTITY dhusername  "Matt Zimmerman">
  <!ENTITY dhucpackage "<refentrytitle>UML_SWITCH</refentrytitle>">
  <!ENTITY dhpackage   "uml_switch">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

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

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

    <refpurpose>switch daemon for user-mode Linux</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option>-unix</option> <replaceable>control_socket</replaceable> <replaceable>data_socket</replaceable></arg>
      <arg><option>-hub</option></arg>
      <arg><option>-tap <replaceable>tun device</replaceable></option></arg>
      <arg><option>-compat-v0</option></arg>
      <arg><option>-daemon</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

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

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

    <para><command>&dhpackage;</command> is a daemon for managing a
    virtual network between user-mode Linux systems, with no
    connection to the host system's network.</para>

    <para>It will listen for connections on a pair of UNIX domain
    sockets, and forward packets between clients which connect to
    them.</para>

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

    <variablelist>
      <varlistentry>
        <term><option>-unix <replaceable>control_socket</replaceable> <replaceable>data_socket</replaceable>
          </option></term>
        <listitem>
          <para>Listen on the specified pair of sockets, instead of
          the defaults.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-hub</option></term>
        <listitem>
          <para>Act like a hub.  This means that packets received will
          be broadcast over all virtual links.  The default is to act
          as a switch, where packets are only sent to the link
          matching the destination MAC address of the packet.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-tap <replaceable>tap device</replaceable></option></term>
        <listitem>
          <para>Connect the switch to a dynamically created tap device
          on the host</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-compat-v0</option></term>
        <listitem>
          <para>Specify control protocol version 0 compatibility.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-daemon</option></term>
        <listitem>
          <para>Run in the background as a daemon.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>linux(1)</para>

    <para>The <ulink
    url="http://user-mode-linux.sourceforge.net/UserModeLinux-HOWTO.html"
    type=alternate>UserModeLinux-HOWTO</ulink></para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhpackage; was written by Jeff Dike and others.</para>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> Free Documentation
      License, Version 1.1 or any later version published by the Free
      Software Foundation; with no Invariant Sections, no Front-Cover
      Texts and no Back-Cover Texts.</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:
-->
