--- gvpe/doc/vpectrl.8 2003/03/01 15:53:02 1.1 +++ gvpe/doc/vpectrl.8 2003/10/15 01:02:27 1.5 @@ -1,64 +1,176 @@ -.Dd 2002-03-25 -.Dt VPECTRL 8 -.\" Manual page created by: -.\" Ivo Timmermans -.\" Guus Sliepen -.\" Modified extensively by Marc Lehmann -.Sh NAME -.Nm vpectrl -.Nd Virtual Private Ethernet Control Program -.Sh SYNOPSIS -.Nm -.Op Fl cgks -.Op Fl -config Ns = Ns Ar DIR -.Op Fl -generate-keys -.Op Fl -help -.Op Fl -kill Ns = Ns Ar SIGNAL -.Op Fl -show-config -.Op Fl -version -.Sh DESCRIPTION -This is the control program for the vped, the virtual private ethernet daemon. -.Sh OPTIONS -.Bl -tag -width indent -.It Fl c, -config Ns = Ns Ar DIR -Read configuration options from -.Ar DIR . -.It Fl g, -generate-keys -Generate public/private RSA keypair and exit. -.It Fl -help +.\" Automatically generated by Pod::Man v1.36, Pod::Parser v1.13 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. | will give a +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' +.\" expand to `' in nroff, nothing in troff, for use with C<>. +.tr \(*W-|\(bv\*(Tr +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` +. ds C' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "VPECTRL 8" +.TH VPECTRL 8 "2003-03-28" "0.9" "Virtual Private Ethernet" +.SH "NAME" +\&\f(CW\*(C`vpectrl\*(C'\fR \- Virtual Private Ethernet Control Program +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\f(CW\*(C`vpectrl\*(C'\fR [\fB\-ckgs\fR] [\fB\-\-config=\fR\fI\s-1DIR\s0\fR] [\fB\-\-generate\-keys\fR] [\fB\-\-help\fR] +[\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-show\-config\fR] [\fB\-\-version\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This is the control program for the \f(CW\*(C`vped\*(C'\fR, the virtual private ethernet daemon. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 +.IX Item "-c, --config=DIR" +Read configuration options from \fI\s-1DIR\s0\fR. +.IP "\fB\-g\fR, \fB\-\-generate\-keys\fR" 4 +.IX Item "-g, --generate-keys" +Generate public/private \s-1RSA\s0 keypair and exit. +.IP "\fB\-\-help\fR" 4 +.IX Item "--help" Display short list of options. -.It Fl k, -kill Ns Op = Ns Ar SIGNAL -Attempt to kill a running -.Nm -(optionally with the specified -.Ar SIGNAL -instead of SIGTERM) and exit. -.It Fl s, --show-config +.IP "\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]" 4 +.IX Item "--kill[=SIGNAL]" +Attempt to kill a running \f(CW\*(C`vpectrl\*(C'\fR (optionally with the specified +\&\fI\s-1SIGNAL\s0\fR instead of \f(CW\*(C`SIGTERM\*(C'\fR) and exit. +.IP "\fB\-\-show\-config\fR" 4 +.IX Item "--show-config" Show a summary of the configuration, and how vped interprets it. Can also be very useful when designing firewall scripts. -.It Fl -version +.IP "\fB\-\-version\fR" 4 +.IX Item "--version" Output version information and exit. -.El -.Sh BUGS -.Pp -If you find any bugs, report them to vpe@plan9.de. -.Sh TODO -A lot. -.Sh SEE ALSO -.Xr vpe.conf 5 , -.Xr vped 8 , -.Pp -The full documentation for vpe is maintained as a Texinfo manual. -If the info and tinc programs are properly installed at your site, -the command -.Ic info vpe -should give you access to the complete manual. -.Pp -vpe comes with ABSOLUTELY NO WARRANTY. -This is free software, and you are welcome to redistribute it under certain conditions; -see the file COPYING for details. -.Sh AUTHORS -.An "Marc Lehmann" Aq vpe@plan9.de -.Pp -And thanks to many others for their contributions to vpe, especially the tincd authors -who inspired this program and whose sourcecode I scavanged! +.SH "BUGS" +.IX Header "BUGS" +If you find any bugs, report them to \f(CW\*(C`vpe@plan9.de\*(C'\fR. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIvpe\fR\|(5), \fIvpe.conf\fR\|(5), \fIvped\fR\|(8). +.PP +vpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are +welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0 +for details. +.SH "AUTHORS" +.IX Header "AUTHORS" +Marc Lehmann \f(CW\*(C`\*(C'\fR.