ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.8.pod
(Generate patch)

Comparing gvpe/doc/gvpe.8.pod (file contents):
Revision 1.8 by pcg, Tue Jun 21 08:46:53 2005 UTC vs.
Revision 1.9 by pcg, Mon Sep 1 05:31:28 2008 UTC

8[B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>] 8[B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>]
9I<NODENAME> [I<option...>] 9I<NODENAME> [I<option...>]
10 10
11=head1 DESCRIPTION 11=head1 DESCRIPTION
12 12
13See the gvpe(5) manpage for an introduction to the gvpe suite. 13See the gvpe(5) man page for an introduction to the gvpe suite.
14 14
15This is the manual page for gvpe, the virtual private ethernet daemon. 15This is the manual page for gvpe, the virtual private ethernet daemon.
16When started, C<gvpe> will read it's configuration file to determine the 16When started, C<gvpe> will read it's configuration file to determine the
17network topology, and other configuration information, assuming the role 17network topology, and other configuration information, assuming the role
18of node I<NODENAME>. It will then connect to the tun/tap device and set 18of node I<NODENAME>
19
20It will then create/connect to the tun/tap device and set up a socket for
19up a socket for incoming connections. Then a script will be executed to 21incoming connections. Then a C<if-up> script will be executed to further
20further configure the virtual device. If that succeeds, it will detach 22configure the virtual network device. If that succeeds, it will detach
21from the controlling terminal and continue in the background, accepting 23from the controlling terminal and continue in the background, accepting
22and setting up connections to other gvpe daemons that are part of the 24and setting up connections to other gvpe daemons that are part of the
23virtual private ethernet. 25same virtual private ethernet.
24 26
25The optional arguments after the node name have to be of the form: 27The optional arguments after the node name have to be of the form:
26 28
27 [I<nodename>.]var=value 29 [I<nodename>.]var=value
28 30
29If the argument has a prefix of C<nodename.> 31If the argument has a prefix of C<nodename.>
30(i.e. C<laptop.enable-dns=yes>) then it will be parsed after all the 32(i.e. C<laptop.enable-dns=yes>) then it will be parsed after all the
31config directives for that node, if not, it is parsed befroe the first 33config directives for that node, if not, it is parsed before the first
32node directive in the config file, and can be used to set global options 34node directive in the config file, and can be used to set global options
33or default variables. 35or default variables.
34 36
35For example, to start C<gvpe> in the foreground, with log-level C<info> on 37For example, to start C<gvpe> in the foreground, with log-level C<info> on
36the node C<laptop>, with TCP enabled and HTTP-Proxy host and Port set, use 38the node C<laptop>, with TCP enabled and HTTP-Proxy host and Port set, use
62Don't fork and detach but stay in foreground and log messages to stderr in 64Don't fork and detach but stay in foreground and log messages to stderr in
63addition to syslog. 65addition to syslog.
64 66
65=item B<-L>, B<--mlock> 67=item B<-L>, B<--mlock>
66 68
67Lock C<gvpe> into main memory. This will prevent sensitive data like 69Lock C<gvpe> into main memory. This will prevent sensitive data like
68shared private keys to be written to the system swap files/partitions. 70shared private keys to be written to the system swap files/partitions.
69 71
70=item B<--version> 72=item B<--version>
71 73
72Output version information and exit. 74Output version information and exit.
140gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). 142gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8).
141 143
142The GVPE mailing list, at L<http://lists.schmorp.de/> or 144The GVPE mailing list, at L<http://lists.schmorp.de/> or
143C<gvpe@lists.schmorp.de>. 145C<gvpe@lists.schmorp.de>.
144 146
145gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are 147GVPE comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
146welcome to redistribute it under certain conditions; see the file COPYING 148welcome to redistribute it under certain conditions; see the file COPYING
147for details. 149for details.
148 150
149=head1 AUTHOR 151=head1 AUTHOR
150 152
151Marc Lehmann C<< <gvpe@schmorp.de> >>. 153Marc Lehmann C<< <gvpe@schmorp.de> >>.
152 154
153And thanks to many others for their contributions to gvpe, especially the 155And thanks to many others for their contributions to gvpe, especially the
154tincd authors, who inspired me to write this program (after scavenging 156tincd authors, who inspired me to write this program (after scavenging
155their sourcecode ;). 157their source code ;).
156 158

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines