1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | C<gvpe> - GNU Virtual Private Ethernet Daemon |
3 | C<gvpe> - GNU Virtual Private Ethernet Daemon |
|
|
4 | |
4 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
5 | |
6 | |
6 | C<gvpe> [B<-cDlL>] [B<--config=>I<DIR>] [B<--no-detach>] [B<-l=>I<LEVEL]>] |
7 | C<gvpe> [B<-cDlL>] [B<--config=>I<DIR>] [B<--no-detach>] [B<-l=>I<LEVEL]>] |
7 | [B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>] |
8 | [B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>] |
8 | I<NODENAME> |
9 | I<NODENAME> [I<option...>] |
9 | |
10 | |
10 | =head1 DESCRIPTION |
11 | =head1 DESCRIPTION |
11 | |
12 | |
12 | See the gvpe(5) manpage for an introduction to the gvpe suite. |
13 | See the gvpe(5) man page for an introduction to the gvpe suite. |
13 | |
14 | |
14 | This is the manual page for gvpe, the virtual private ethernet daemon. |
15 | This is the manual page for gvpe, the virtual private ethernet daemon. |
15 | When started, C<gvpe> will read it's configuration file to determine the |
16 | When started, C<gvpe> will read it's configuration file to determine the |
16 | network topology, and other configuration information, assuming the role |
17 | network topology, and other configuration information, assuming the role |
17 | of node I<NODENAME>. It will then connect to the tun/tap device and set |
18 | of node I<NODENAME> |
|
|
19 | |
|
|
20 | It will then create/connect to the tun/tap device and set up a socket for |
18 | up a socket for incoming connections. Then a script will be executed to |
21 | incoming connections. Then a C<if-up> script will be executed to further |
19 | further configure the virtual device. If that succeeds, it will detach |
22 | configure the virtual network device. If that succeeds, it will detach |
20 | from the controlling terminal and continue in the background, accepting |
23 | from the controlling terminal and continue in the background, accepting |
21 | and setting up connections to other gvpe daemons that are part of the |
24 | and setting up connections to other gvpe daemons that are part of the |
22 | virtual private ethernet. |
25 | same virtual private ethernet. |
|
|
26 | |
|
|
27 | The optional arguments after the node name have to be of the form: |
|
|
28 | |
|
|
29 | [I<nodename>.]var=value |
|
|
30 | |
|
|
31 | If the argument has a prefix of C<nodename.> |
|
|
32 | (i.e. C<laptop.enable-dns=yes>) then it will be parsed after all the |
|
|
33 | config directives for that node, if not, it is parsed before the first |
|
|
34 | node directive in the config file, and can be used to set global options |
|
|
35 | or default variables. |
|
|
36 | |
|
|
37 | For example, to start C<gvpe> in the foreground, with log-level C<info> on |
|
|
38 | the node C<laptop>, with TCP enabled and HTTP-Proxy host and Port set, use |
|
|
39 | this: |
|
|
40 | |
|
|
41 | gvpe -D -l info laptop \ |
|
|
42 | http-proxy-host=10.0.0.18 http-proxy-port=3128 \ |
|
|
43 | laptop.enable-tcp=yes |
23 | |
44 | |
24 | =head1 OPTIONS |
45 | =head1 OPTIONS |
25 | |
46 | |
26 | =over 4 |
47 | =over 4 |
27 | |
48 | |
… | |
… | |
43 | Don't fork and detach but stay in foreground and log messages to stderr in |
64 | Don't fork and detach but stay in foreground and log messages to stderr in |
44 | addition to syslog. |
65 | addition to syslog. |
45 | |
66 | |
46 | =item B<-L>, B<--mlock> |
67 | =item B<-L>, B<--mlock> |
47 | |
68 | |
48 | Lock C<gvpe> into main memory. This will prevent sensitive data like |
69 | Lock C<gvpe> into main memory. This will prevent sensitive data like |
49 | shared private keys to be written to the system swap files/partitions. |
70 | shared private keys to be written to the system swap files/partitions. |
50 | |
71 | |
51 | =item B<--version> |
72 | =item B<--version> |
52 | |
73 | |
53 | Output version information and exit. |
74 | Output version information and exit. |
… | |
… | |
112 | =head1 BUGS |
133 | =head1 BUGS |
113 | |
134 | |
114 | The cryptography in gvpe has not been thoroughly checked by many people |
135 | The cryptography in gvpe has not been thoroughly checked by many people |
115 | yet. Use it at your own risk! |
136 | yet. Use it at your own risk! |
116 | |
137 | |
117 | If you find any bugs, report them to C<vpe@plan9.de>. |
138 | If you find any bugs, report them to C<gvpe@schmorp.de>. |
118 | |
|
|
119 | =head1 TODO |
|
|
120 | |
|
|
121 | A lot. |
|
|
122 | |
139 | |
123 | =head1 SEE ALSO |
140 | =head1 SEE ALSO |
124 | |
141 | |
125 | gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). |
142 | gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). |
126 | |
143 | |
|
|
144 | The GVPE mailing list, at L<http://lists.schmorp.de/> or |
|
|
145 | C<gvpe@lists.schmorp.de>. |
|
|
146 | |
127 | gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are |
147 | GVPE comes with ABSOLUTELY NO WARRANTY. This is free software, and you are |
128 | welcome to redistribute it under certain conditions; see the file COPYING |
148 | welcome to redistribute it under certain conditions; see the file COPYING |
129 | for details. |
149 | for details. |
130 | |
150 | |
131 | =head1 AUTHORS |
151 | =head1 AUTHOR |
132 | |
152 | |
133 | Marc Lehmann C<< <gvpe@plan9.de> >>. |
153 | Marc Lehmann C<< <gvpe@schmorp.de> >>. |
134 | |
154 | |
135 | And thanks to many others for their contributions to gvpe, especially the |
155 | And thanks to many others for their contributions to gvpe, especially the |
136 | tincd authors, who inspired me to write this program (after scavenging |
156 | tincd authors, who inspired me to write this program (after scavenging |
137 | their sourcecode ;). |
157 | their source code ;). |
138 | |
158 | |