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.1 by pcg, Fri Jun 11 15:56:12 2004 UTC vs.
Revision 1.9 by pcg, Mon Sep 1 05:31:28 2008 UTC

1=head1 NAME 1=head1 NAME
2 2
3C<gvpe> - GNU Virtual Private Ethernet Daemon 3C<gvpe> - GNU Virtual Private Ethernet Daemon
4
4=head1 SYNOPSIS 5=head1 SYNOPSIS
5 6
6C<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]>]
7[B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>] 8[B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>]
8I<NODENAME> 9I<NODENAME> [I<option...>]
9 10
10=head1 DESCRIPTION 11=head1 DESCRIPTION
11 12
12See the gvpe(5) manpage for an introduction to the gvpe suite. 13See the gvpe(5) man page for an introduction to the gvpe suite.
13 14
14This is the manual page for gvpe, the virtual private ethernet daemon. 15This is the manual page for gvpe, the virtual private ethernet daemon.
15When 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
16network topology, and other configuration information, assuming the role 17network topology, and other configuration information, assuming the role
17of 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
18up 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
19further configure the virtual device. If that succeeds, it will detach 22configure the virtual network device. If that succeeds, it will detach
20from the controlling terminal and continue in the background, accepting 23from the controlling terminal and continue in the background, accepting
21and 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
22virtual 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
23 44
24=head1 OPTIONS 45=head1 OPTIONS
25 46
26=over 4 47=over 4
27 48
… …
43Don'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
44addition to syslog. 65addition to syslog.
45 66
46=item B<-L>, B<--mlock> 67=item B<-L>, B<--mlock>
47 68
48Lock C<gvpe> into main memory. This will prevent sensitive data like 69Lock C<gvpe> into main memory. This will prevent sensitive data like
49shared private keys to be written to the system swap files/partitions. 70shared private keys to be written to the system swap files/partitions.
50 71
51=item B<--version> 72=item B<--version>
52 73
53Output version information and exit. 74Output version information and exit.
… …
93Script which is executed whenever a node connects to this node. This can 114Script which is executed whenever a node connects to this node. This can
94be used for example to run nsupdate. 115be used for example to run nsupdate.
95 116
96=item C</etc/gvpe/node-down> 117=item C</etc/gvpe/node-down>
97 118
98Script which is executed whenever a conenction to another node is lost. 119Script which is executed whenever a connection to another node is lost.
99for example to run nsupdate. 120for example to run nsupdate.
100 121
101=item C</etc/gvpe/pubkey/*> 122=item C</etc/gvpe/pubkey/*>
102 123
103The directory containing the public keys for every node, usually 124The directory containing the public keys for every node, usually
… …
112=head1 BUGS 133=head1 BUGS
113 134
114The cryptography in gvpe has not been thoroughly checked by many people 135The cryptography in gvpe has not been thoroughly checked by many people
115yet. Use it at your own risk! 136yet. Use it at your own risk!
116 137
117If you find any bugs, report them to C<vpe@plan9.de>. 138If you find any bugs, report them to C<gvpe@schmorp.de>.
118
119=head1 TODO
120
121A lot.
122 139
123=head1 SEE ALSO 140=head1 SEE ALSO
124 141
125gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). 142gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8).
126 143
144The GVPE mailing list, at L<http://lists.schmorp.de/> or
145C<gvpe@lists.schmorp.de>.
146
127gvpe 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
128welcome to redistribute it under certain conditions; see the file COPYING 148welcome to redistribute it under certain conditions; see the file COPYING
129for details. 149for details.
130 150
131=head1 AUTHORS 151=head1 AUTHOR
132 152
133Marc Lehmann C<< <gvpe@plan9.de> >>. 153Marc Lehmann C<< <gvpe@schmorp.de> >>.
134 154
135And thanks to many others for their contributions to gvpe, especially the 155And thanks to many others for their contributions to gvpe, especially the
136tincd authors, who inspired me to write this program (after scavenging 156tincd authors, who inspired me to write this program (after scavenging
137their sourcecode ;). 157their source code ;).
138 158

Diff Legend

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