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.7 by pcg, Mon Mar 28 20:39:18 2005 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) manpage for an introduction to the gvpe suite.
13 14
18up a socket for incoming connections. Then a script will be executed to 19up a socket for incoming connections. Then a script will be executed to
19further configure the virtual device. If that succeeds, it will detach 20further configure the virtual device. If that succeeds, it will detach
20from the controlling terminal and continue in the background, accepting 21from the controlling terminal and continue in the background, accepting
21and setting up connections to other gvpe daemons that are part of the 22and setting up connections to other gvpe daemons that are part of the
22virtual private ethernet. 23virtual private ethernet.
24
25The optional arguments after the node name have to be of the form:
26
27 [I<nodename>.]var=value
28
29If the argument has a prefix of C<nodename.>
30(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
32node directive in the config file, and can be used to set global options
33or default variables.
34
35For 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
37this:
38
39 gvpe -D -l info laptop \
40 http-proxy-host=10.0.0.18 http-proxy-port=3128 \
41 laptop.enable-tcp=yes
23 42
24=head1 OPTIONS 43=head1 OPTIONS
25 44
26=over 4 45=over 4
27 46
93Script which is executed whenever a node connects to this node. This can 112Script which is executed whenever a node connects to this node. This can
94be used for example to run nsupdate. 113be used for example to run nsupdate.
95 114
96=item C</etc/gvpe/node-down> 115=item C</etc/gvpe/node-down>
97 116
98Script which is executed whenever a conenction to another node is lost. 117Script which is executed whenever a connection to another node is lost.
99for example to run nsupdate. 118for example to run nsupdate.
100 119
101=item C</etc/gvpe/pubkey/*> 120=item C</etc/gvpe/pubkey/*>
102 121
103The directory containing the public keys for every node, usually 122The directory containing the public keys for every node, usually
112=head1 BUGS 131=head1 BUGS
113 132
114The cryptography in gvpe has not been thoroughly checked by many people 133The cryptography in gvpe has not been thoroughly checked by many people
115yet. Use it at your own risk! 134yet. Use it at your own risk!
116 135
117If you find any bugs, report them to C<vpe@plan9.de>. 136If you find any bugs, report them to C<gvpe@plan9.de>.
118
119=head1 TODO
120
121A lot.
122 137
123=head1 SEE ALSO 138=head1 SEE ALSO
124 139
125gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). 140gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8).
126 141
142The GVPE mailing list, at L<http://lists.schmorp.de/> or
143C<gvpe@lists.schmorp.de>.
144
127gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are 145gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
128welcome to redistribute it under certain conditions; see the file COPYING 146welcome to redistribute it under certain conditions; see the file COPYING
129for details. 147for details.
130 148
131=head1 AUTHORS 149=head1 AUTHOR
132 150
133Marc Lehmann C<< <gvpe@plan9.de> >>. 151Marc Lehmann C<< <gvpe@plan9.de> >>.
134 152
135And thanks to many others for their contributions to gvpe, especially the 153And thanks to many others for their contributions to gvpe, especially the
136tincd authors, who inspired me to write this program (after scavenging 154tincd authors, who inspired me to write this program (after scavenging

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines