File: tunctl.sgml

package info (click to toggle)
uml-utilities 20070815.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 748 kB
  • sloc: ansic: 3,395; perl: 1,277; makefile: 243; exp: 129; sh: 122
file content (164 lines) | stat: -rw-r--r-- 4,801 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!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:
-->