1 |
=head1 NAME |
2 |
|
3 |
C<gvpe> - GNU Virtual Private Ethernet Daemon |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
C<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>] |
9 |
I<NODENAME> |
10 |
|
11 |
=head1 DESCRIPTION |
12 |
|
13 |
See the gvpe(5) manpage for an introduction to the gvpe suite. |
14 |
|
15 |
This is the manual page for gvpe, the virtual private ethernet daemon. |
16 |
When started, C<gvpe> will read it's configuration file to determine the |
17 |
network topology, and other configuration information, assuming the role |
18 |
of node I<NODENAME>. It will then connect to the tun/tap device and set |
19 |
up a socket for incoming connections. Then a script will be executed to |
20 |
further configure the virtual device. If that succeeds, it will detach |
21 |
from the controlling terminal and continue in the background, accepting |
22 |
and setting up connections to other gvpe daemons that are part of the |
23 |
virtual private ethernet. |
24 |
|
25 |
=head1 OPTIONS |
26 |
|
27 |
=over 4 |
28 |
|
29 |
=item B<-c>, B<--config=>I<DIR> |
30 |
|
31 |
Read configuration options from I<DIR> |
32 |
|
33 |
=item B<-d>, B<--l=>I<LEVEL> |
34 |
|
35 |
Set logging level to I<LEVEL> (one of: noise, trace, debug, info, notice, |
36 |
warn, error, critical). |
37 |
|
38 |
=item B<--help> |
39 |
|
40 |
Display short list of options. |
41 |
|
42 |
=item B<-D>, B<--no-detach> |
43 |
|
44 |
Don't fork and detach but stay in foreground and log messages to stderr in |
45 |
addition to syslog. |
46 |
|
47 |
=item B<-L>, B<--mlock> |
48 |
|
49 |
Lock C<gvpe> into main memory. This will prevent sensitive data like |
50 |
shared private keys to be written to the system swap files/partitions. |
51 |
|
52 |
=item B<--version> |
53 |
|
54 |
Output version information and exit. |
55 |
|
56 |
=back |
57 |
|
58 |
=head1 SIGNALS |
59 |
|
60 |
=over 4 |
61 |
|
62 |
=item HUP |
63 |
|
64 |
Closes/resets all connections, resets the retry time and will start connecting |
65 |
again (it will NOT re-read the config file). This is useful e.g. in a |
66 |
C</etc/ppp/if-up> script. |
67 |
|
68 |
=item TERM |
69 |
|
70 |
Closes/resets all connections and exits. |
71 |
|
72 |
=item USR1 |
73 |
|
74 |
Dump current network status into the syslog (at loglevel C<notice>, so make |
75 |
sure your loglevel allows this). |
76 |
|
77 |
=back |
78 |
|
79 |
=head1 FILES |
80 |
|
81 |
=over 4 |
82 |
|
83 |
=item C</etc/gvpe/gvpe.conf> |
84 |
|
85 |
The configuration file for C<gvpe>. |
86 |
|
87 |
=item C</etc/gvpe/if-up> |
88 |
|
89 |
Script which is executed as soon as the virtual network device has been |
90 |
allocated. Purpose is to further configure that device. |
91 |
|
92 |
=item C</etc/gvpe/node-up> |
93 |
|
94 |
Script which is executed whenever a node connects to this node. This can |
95 |
be used for example to run nsupdate. |
96 |
|
97 |
=item C</etc/gvpe/node-down> |
98 |
|
99 |
Script which is executed whenever a connection to another node is lost. |
100 |
for example to run nsupdate. |
101 |
|
102 |
=item C</etc/gvpe/pubkey/*> |
103 |
|
104 |
The directory containing the public keys for every node, usually |
105 |
autogenerated by executing C<gvpectrl --generate-keys>. |
106 |
|
107 |
=item C</var/run/gvpe.pid> |
108 |
|
109 |
The PID of the currently running C<gvpe> is stored in this file. |
110 |
|
111 |
=back |
112 |
|
113 |
=head1 BUGS |
114 |
|
115 |
The cryptography in gvpe has not been thoroughly checked by many people |
116 |
yet. Use it at your own risk! |
117 |
|
118 |
If you find any bugs, report them to C<gvpe@plan9.de>. |
119 |
|
120 |
=head1 SEE ALSO |
121 |
|
122 |
gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). |
123 |
|
124 |
The GVPE mailing list, at L<http://lists.schmorp.de/> or |
125 |
C<gvpe@lists.schmorp.de>. |
126 |
|
127 |
gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are |
128 |
welcome to redistribute it under certain conditions; see the file COPYING |
129 |
for details. |
130 |
|
131 |
=head1 AUTHOR |
132 |
|
133 |
Marc Lehmann C<< <gvpe@plan9.de> >>. |
134 |
|
135 |
And thanks to many others for their contributions to gvpe, especially the |
136 |
tincd authors, who inspired me to write this program (after scavenging |
137 |
their sourcecode ;). |
138 |
|