Release new version 0.14.1
[grml-network.git] / docs / grml-vnet.8.txt
1 GRML-VNET(8)
2 ============
3
4 NAME
5 ----
6 grml-vnet - creates persistent tun/tap devices with bridge handling
7
8
9 SYNOPSIS
10 --------
11 *grml-vnet* [OPTIONS] <tun1> <tun2> ...
12
13
14 DESCRIPTION
15 -----------
16 This manual page documents briefly the *grml-vnet* command.
17
18 *grml-vnet* is a script to create persistent tun/tap devices with integrated
19 bridge handling.
20
21
22 OPTIONS
23 -------
24 *-d*::
25 Delete the tun/tap devices and remove them from the bridge (if given with -b).
26
27 *-u <user>*::
28 Make tun devices useable from <user> without special permissions.
29
30 *-g <group>*::
31 Make tun devices useable from <group> without special permissions.
32
33 *-b <bridge>*::
34 Remove/delete given tun devices from <bridge>.
35
36 *-a*::
37 Automatic bridge handling, eg. create bridge if not existing and delete it if
38 no more devices are part of it after removing the given tun/tap devices.
39
40 *-h*::
41 Show the help message.
42
43
44 EXAMPLES
45 --------
46
47 Config sample file for /etc/network/interfaces with bridge and tun/tap devices.
48 This creates tap0..tap3 which are part of the bridge vnet.
49
50 -------------
51     auto vnet
52     iface vnet inet static
53         post-up  /usr/sbin/grml-vnet -u grml -b vnet tap{0..3}
54         pre-down /usr/sbin/grml-vnet -u grml -b vnet -d tap{0..3}
55         bridge_ports none
56         address 192.168.10.1
57         netmask 255.255.255.0
58 -------------
59
60
61 SEE ALSO
62 --------
63 grml-ap(8), grml-bridge(8), grml-router(8)
64
65
66 AUTHOR
67 ------
68 grml-vnet was written by Michael Gebetsroither <gebi@grml.org>
69
70 This manual page was written by Michael Gebetsroither <gebi@grml.org>