--- gvpe/doc/gvpe.8.pod 2005/03/17 23:59:37 1.5 +++ gvpe/doc/gvpe.8.pod 2008/09/01 05:31:28 1.9 @@ -6,21 +6,41 @@ C [B<-cDlL>] [B<--config=>I] [B<--no-detach>] [B<-l=>I] [B<--kill>[B<=>I]] [B<--mlock>] [B<--help>] [B<--version>] -I +I [I] =head1 DESCRIPTION -See the gvpe(5) manpage for an introduction to the gvpe suite. +See the gvpe(5) man page for an introduction to the gvpe suite. This is the manual page for gvpe, the virtual private ethernet daemon. When started, C will read it's configuration file to determine the network topology, and other configuration information, assuming the role -of node I. It will then connect to the tun/tap device and set -up a socket for incoming connections. Then a script will be executed to -further configure the virtual device. If that succeeds, it will detach +of node I + +It will then create/connect to the tun/tap device and set up a socket for +incoming connections. Then a C script will be executed to further +configure the virtual network device. If that succeeds, it will detach from the controlling terminal and continue in the background, accepting and setting up connections to other gvpe daemons that are part of the -virtual private ethernet. +same virtual private ethernet. + +The optional arguments after the node name have to be of the form: + + [I.]var=value + +If the argument has a prefix of C +(i.e. C) then it will be parsed after all the +config directives for that node, if not, it is parsed before the first +node directive in the config file, and can be used to set global options +or default variables. + +For example, to start C in the foreground, with log-level C on +the node C, with TCP enabled and HTTP-Proxy host and Port set, use +this: + + gvpe -D -l info laptop \ + http-proxy-host=10.0.0.18 http-proxy-port=3128 \ + laptop.enable-tcp=yes =head1 OPTIONS @@ -46,7 +66,7 @@ =item B<-L>, B<--mlock> -Lock C into main memory. This will prevent sensitive data like +Lock C into main memory. This will prevent sensitive data like shared private keys to be written to the system swap files/partitions. =item B<--version> @@ -115,23 +135,24 @@ The cryptography in gvpe has not been thoroughly checked by many people yet. Use it at your own risk! -If you find any bugs, report them to C. +If you find any bugs, report them to C. =head1 SEE ALSO gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). -The GVPE mailing list at http://lists.schmorp.de/ +The GVPE mailing list, at L or +C. -gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are +GVPE comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under certain conditions; see the file COPYING for details. =head1 AUTHOR -Marc Lehmann C<< >>. +Marc Lehmann C<< >>. And thanks to many others for their contributions to gvpe, especially the tincd authors, who inspired me to write this program (after scavenging -their sourcecode ;). +their source code ;).