1 |
.Dd 2002-03-25 |
2 |
.Dt VPECTRL 8 |
3 |
.\" Manual page created by: |
4 |
.\" Ivo Timmermans <ivo@o2w.nl> |
5 |
.\" Guus Sliepen <guus@sliepen.eu.org> |
6 |
.\" Modified extensively by Marc Lehmann <pcg@goof.com> |
7 |
.Sh NAME |
8 |
.Nm vpectrl |
9 |
.Nd Virtual Private Ethernet Control Program |
10 |
.Sh SYNOPSIS |
11 |
.Nm |
12 |
.Op Fl cgks |
13 |
.Op Fl -config Ns = Ns Ar DIR |
14 |
.Op Fl -generate-keys |
15 |
.Op Fl -help |
16 |
.Op Fl -kill Ns = Ns Ar SIGNAL |
17 |
.Op Fl -show-config |
18 |
.Op Fl -version |
19 |
.Sh DESCRIPTION |
20 |
This is the control program for the vped, the virtual private ethernet daemon. |
21 |
.Sh OPTIONS |
22 |
.Bl -tag -width indent |
23 |
.It Fl c, -config Ns = Ns Ar DIR |
24 |
Read configuration options from |
25 |
.Ar DIR . |
26 |
.It Fl g, -generate-keys |
27 |
Generate public/private RSA keypair and exit. |
28 |
.It Fl -help |
29 |
Display short list of options. |
30 |
.It Fl k, -kill Ns Op = Ns Ar SIGNAL |
31 |
Attempt to kill a running |
32 |
.Nm |
33 |
(optionally with the specified |
34 |
.Ar SIGNAL |
35 |
instead of SIGTERM) and exit. |
36 |
.It Fl s, --show-config |
37 |
Show a summary of the configuration, and how vped interprets it. Can also be very useful |
38 |
when designing firewall scripts. |
39 |
.It Fl -version |
40 |
Output version information and exit. |
41 |
.El |
42 |
.Sh BUGS |
43 |
.Pp |
44 |
If you find any bugs, report them to vpe@plan9.de. |
45 |
.Sh TODO |
46 |
A lot. |
47 |
.Sh SEE ALSO |
48 |
.Xr vpe.conf 5 , |
49 |
.Xr vped 8 , |
50 |
.Pp |
51 |
The full documentation for vpe is maintained as a Texinfo manual. |
52 |
If the info and tinc programs are properly installed at your site, |
53 |
the command |
54 |
.Ic info vpe |
55 |
should give you access to the complete manual. |
56 |
.Pp |
57 |
vpe comes with ABSOLUTELY NO WARRANTY. |
58 |
This is free software, and you are welcome to redistribute it under certain conditions; |
59 |
see the file COPYING for details. |
60 |
.Sh AUTHORS |
61 |
.An "Marc Lehmann" Aq vpe@plan9.de |
62 |
.Pp |
63 |
And thanks to many others for their contributions to vpe, especially the tincd authors |
64 |
who inspired this program and whose sourcecode I scavanged! |