<!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>February 12, 2002</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>mdz@debian.org</email>">
  <!ENTITY dhusername  "Matt Zimmerman">
  <!ENTITY dhucpackage "<refentrytitle>TUNCTL</refentrytitle>">
  <!ENTITY dhpackage   "tunctl">

  <!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>create and manage persistent TUN/TAP interfaces</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      
      <command>&dhpackage;</command>

      <arg choice=opt><option>-f</option> <replaceable>tun-clone-device</replaceable></arg>

      <arg><option>-u</option> <replaceable>owner</replaceable></arg>
      <arg><option>-t</option> <replaceable>device-name</replaceable></arg>

    </cmdsynopsis>

    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg choice=opt><option>-f</option> <replaceable>tun-clone-device</replaceable></arg>
      <arg choice=req><option>-d</option> <replaceable>device-name</replaceable></arg>
    </cmdsynopsis>

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

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

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.
      Instead, it has documentation in HTML format; see below.</para>

    <para><command>&dhpackage;</command> allows the host sysadmin to
    preconfigure a TUN/TAP device for use by a particular user.  That
    user may open and use the device, but may not change any aspects
    of the host side of the interface.</para>

  </refsect1>

  <refsect1>
    <title>USAGE</title>

    <para>To create an interface for use by a particular user, invoke
    tunctl without the -d option:</para>

    <informalexample>
      <screen>
        <prompt>#</prompt> <userinput>tunctl -u someuser</userinput>

        Set 'tap0' persistent and owned by 'someuser'
      </screen>
    </informalexample>

    <para>Then, configure the interface as normal:</para>

    <informalexample>
      <screen>
        <prompt>#</prompt> <userinput>ifconfig tap0 192.168.0.254 up</userinput>

        <prompt>#</prompt> <userinput>route add -host 192.168.0.253 dev tap0</userinput>

        <prompt>#</prompt> <userinput>bash -c 'echo 1 > /proc/sys/net/ipv4/conf/tap0/proxy_arp'</userinput>

        <prompt>#</prompt> <userinput>arp -Ds 192.168.0.253 eth0 pub</userinput>
      </screen>
    </informalexample>

    <para>To delete the interface, use the -d option:</para>

    <informalexample>
      <screen>
        <prompt>#</prompt> <userinput>tunctl -d tap0</userinput>

        Set 'tap0' nonpersistent
      </screen>
    </informalexample>
  </refsect1>

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

    <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
    <email>jdike@karaya.com</email></para> 

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system, based on examples from Jeff Dike.</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:
-->
