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.3 by pcg, Mon Jul 26 14:53:36 2004 UTC vs.
Revision 1.9 by pcg, Mon Sep 1 05:31:28 2008 UTC

… …
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7C<gvpe> [B<-cDlL>] [B<--config=>I<DIR>] [B<--no-detach>] [B<-l=>I<LEVEL]>] 7C<gvpe> [B<-cDlL>] [B<--config=>I<DIR>] [B<--no-detach>] [B<-l=>I<LEVEL]>]
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> 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.
26
27The optional arguments after the node name have to be of the form:
28
29 [I<nodename>.]var=value
30
31If the argument has a prefix of C<nodename.>
32(i.e. C<laptop.enable-dns=yes>) then it will be parsed after all the
33config directives for that node, if not, it is parsed before the first
34node directive in the config file, and can be used to set global options
35or default variables.
36
37For example, to start C<gvpe> in the foreground, with log-level C<info> on
38the node C<laptop>, with TCP enabled and HTTP-Proxy host and Port set, use
39this:
40
41 gvpe -D -l info laptop \
42 http-proxy-host=10.0.0.18 http-proxy-port=3128 \
43 laptop.enable-tcp=yes
24 44
25=head1 OPTIONS 45=head1 OPTIONS
26 46
27=over 4 47=over 4
28 48
… …
44Don'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
45addition to syslog. 65addition to syslog.
46 66
47=item B<-L>, B<--mlock> 67=item B<-L>, B<--mlock>
48 68
49Lock C<gvpe> into main memory. This will prevent sensitive data like 69Lock C<gvpe> into main memory. This will prevent sensitive data like
50shared private keys to be written to the system swap files/partitions. 70shared private keys to be written to the system swap files/partitions.
51 71
52=item B<--version> 72=item B<--version>
53 73
54Output version information and exit. 74Output version information and exit.
… …
113=head1 BUGS 133=head1 BUGS
114 134
115The cryptography in gvpe has not been thoroughly checked by many people 135The cryptography in gvpe has not been thoroughly checked by many people
116yet. Use it at your own risk! 136yet. Use it at your own risk!
117 137
118If you find any bugs, report them to C<vpe@plan9.de>. 138If you find any bugs, report them to C<gvpe@schmorp.de>.
119
120=head1 TODO
121
122A lot.
123 139
124=head1 SEE ALSO 140=head1 SEE ALSO
125 141
126gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). 142gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8).
127 143
144The GVPE mailing list, at L<http://lists.schmorp.de/> or
145C<gvpe@lists.schmorp.de>.
146
128gvpe 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
129welcome to redistribute it under certain conditions; see the file COPYING 148welcome to redistribute it under certain conditions; see the file COPYING
130for details. 149for details.
131 150
132=head1 AUTHORS 151=head1 AUTHOR
133 152
134Marc Lehmann C<< <gvpe@plan9.de> >>. 153Marc Lehmann C<< <gvpe@schmorp.de> >>.
135 154
136And thanks to many others for their contributions to gvpe, especially the 155And thanks to many others for their contributions to gvpe, especially the
137tincd authors, who inspired me to write this program (after scavenging 156tincd authors, who inspired me to write this program (after scavenging
138their sourcecode ;). 157their source code ;).
139 158

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines