ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpectrl.8
(Generate patch)

Comparing gvpe/doc/gvpectrl.8 (file contents):
Revision 1.3 by pcg, Wed Mar 23 21:55:39 2005 UTC vs.
Revision 1.9 by root, Wed Nov 2 07:06:38 2016 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
23.ft R 15.ft R
24.fi 16.fi
25.. 17..
26.\" Set up some character translations and predefined strings. \*(-- will 18.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 23.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 26.ie n \{\
35. ds -- \(*W- 27. ds -- \(*W-
36. ds PI pi 28. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
44.el\{\ 36.el\{\
45. ds -- \|\(em\| 37. ds -- \|\(em\|
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
49'br\} 43'br\}
50.\" 44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
56..
57.nr rF 0
58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
55.if \nF \{\ 60. if \nF \{
56. de IX 61. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 62. tm Index:\\$1\t\\n%\t"\\$2"
58.. 63..
59. nr % 0 64. if !\nF==2 \{
60. rr F 65. nr % 0
66. nr F 2
67. \}
68. \}
61.\} 69.\}
62.\" 70.rr rF
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\" 71.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
71.if n \{\ 75.if n \{\
127.\} 131.\}
128.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
129.\" ======================================================================== 133.\" ========================================================================
130.\" 134.\"
131.IX Title "GVPECTRL 8" 135.IX Title "GVPECTRL 8"
132.TH GVPECTRL 8 "2005-03-23" "1.9" "GNU Virtual Private Ethernet" 136.TH GVPECTRL 8 "2016-11-02" "2.25" "GNU Virtual Private Ethernet"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
133.SH "NAME" 141.SH "NAME"
134\&\f(CW\*(C`gvpectrl\*(C'\fR \- GNU Virtual Private Ethernet Control Program 142"gvpectrl" \- GNU Virtual Private Ethernet Control Program
135.SH "SYNOPSIS" 143.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
137\&\f(CW\*(C`gvpectrl\*(C'\fR [\fB\-ckgs\fR] [\fB\-\-config=\fR\fI\s-1DIR\s0\fR] [\fB\-\-generate\-keys\fR] [\fB\-\-help\fR] 145\&\f(CW\*(C`gvpectrl\*(C'\fR [\fB\-ckgs\fR] [\fB\-\-config=\fR\fI\s-1DIR\s0\fR] [\fB\-\-generate\-keys\fR] [\fB\-\-help\fR]
138[\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-show\-config\fR] [\fB\-\-version\fR] 146[\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-show\-config\fR] [\fB\-\-version\fR]
139.SH "DESCRIPTION" 147.SH "DESCRIPTION"
142.SH "OPTIONS" 150.SH "OPTIONS"
143.IX Header "OPTIONS" 151.IX Header "OPTIONS"
144.IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 152.IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4
145.IX Item "-c, --config=DIR" 153.IX Item "-c, --config=DIR"
146Read configuration options from \fI\s-1DIR\s0\fR. 154Read configuration options from \fI\s-1DIR\s0\fR.
155.IP "\fB\-g\fR, \fB\-\-generate\-key=path\fR" 4
156.IX Item "-g, --generate-key=path"
157Generates a single \s-1RSA\s0 key-pair. The public key will be stored in \fI\fIpath\fI\fR
158while the private key will be stored in \fI\fIpath\fI .privkey\fR. Neither file must be
159non-empty for this to succeed.
160.Sp
161The public key file \fI\fIpath\fI\fR is normally copied to \fIpubkey/nodename\fR in
162the config directory on all nodes, while the private key \fI\fIpath\fI.privkey\fR
163should be copied to the file \fIhostkey\fR on the node the key is for.
164.Sp
165It's recommended to generate the keypair on the node where it will be
166used, so that the private key file does not have to travel over the
167network.
147.IP "\fB\-g\fR, \fB\-\-generate\-keys\fR" 4 168.IP "\fB\-G\fR, \fB\-\-generate\-keys\fR" 4
148.IX Item "-g, --generate-keys" 169.IX Item "-G, --generate-keys"
149Generate public/private \s-1RSA\s0 keypair and exit. 170Generate public/private \s-1RSA\s0 key-pairs for all nodes not having a key and exit.
171.Sp
172Note that in normal configurations this will fail, as there cna only be
173one private key per host. To make this configuration work you need to
174specify separate keyfiles for hostkeys in your config file, e.g.:
175.Sp
176.Vb 1
177\& private\-key = hostkeys/%s
178.Ve
179.Sp
180Such a configuration makes it easier to distribute a configuration
181centrally but requires private keys to be transported securely over the
182network.
183.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
184.IX Item "-q, --quiet"
185Suppresses messages the author finds nonessential for scripting purposes.
150.IP "\fB\-\-help\fR" 4 186.IP "\fB\-\-help\fR" 4
151.IX Item "--help" 187.IX Item "--help"
152Display short list of options. 188Display short list of options.
153.IP "\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]" 4 189.IP "\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]" 4
154.IX Item "--kill[=SIGNAL]" 190.IX Item "--kill[=SIGNAL]"
161.IP "\fB\-\-version\fR" 4 197.IP "\fB\-\-version\fR" 4
162.IX Item "--version" 198.IX Item "--version"
163Output version information and exit. 199Output version information and exit.
164.SH "BUGS" 200.SH "BUGS"
165.IX Header "BUGS" 201.IX Header "BUGS"
166If you find any bugs, report them to \f(CW\*(C`gvpe@plan9.de\*(C'\fR. 202If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR.
167.SH "SEE ALSO" 203.SH "SEE ALSO"
168.IX Header "SEE ALSO" 204.IX Header "SEE ALSO"
169\&\fIgvpe\fR\|(5), \fIgvpe.conf\fR\|(5), \fIgvpe\fR\|(8). 205\&\fIgvpe\fR\|(5), \fIgvpe.conf\fR\|(5), \fIgvpe\fR\|(8).
170.PP 206.PP
171gvpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are 207\&\s-1GVPE\s0 comes with \s-1ABSOLUTELY NO WARRANTY. \s0 This is free software, and you are
172welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0 208welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0
173for details. 209for details.
174.SH "AUTHOR" 210.SH "AUTHOR"
175.IX Header "AUTHOR" 211.IX Header "AUTHOR"
176Marc Lehmann \f(CW\*(C`<gvpe@plan9.de>\*(C'\fR. 212Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines