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.6 by pcg, Fri Aug 15 17:45:12 2008 UTC vs.
Revision 1.9 by root, Wed Nov 2 07:06:38 2016 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 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
… …
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.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 47.el .ds Aq '
54.\" 48.\"
55.\" 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
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" 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
58.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 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)) \{
60. if \nF \{
60. de IX 61. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 62. tm Index:\\$1\t\\n%\t"\\$2"
62.. 63..
63. nr % 0 64. if !\nF==2 \{
64. rr F 65. nr % 0
66. nr F 2
67. \}
68. \}
65.\} 69.\}
66.el \{\ 70.rr rF
67. de IX
68..
69.\}
70.\" 71.\"
71.\" 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).
72.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
74.if n \{\ 75.if n \{\
… …
130.\} 131.\}
131.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
132.\" ======================================================================== 133.\" ========================================================================
133.\" 134.\"
134.IX Title "GVPECTRL 8" 135.IX Title "GVPECTRL 8"
135.TH GVPECTRL 8 "2008-08-11" "2.2" "GNU Virtual Private Ethernet" 136.TH GVPECTRL 8 "2016-11-02" "2.25" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
138.if n .ad l 139.if n .ad l
139.nh 140.nh
140.SH "NAME" 141.SH "NAME"
141\&\f(CW\*(C`gvpectrl\*(C'\fR \- \s-1GNU\s0 Virtual Private Ethernet Control Program 142"gvpectrl" \- GNU Virtual Private Ethernet Control Program
142.SH "SYNOPSIS" 143.SH "SYNOPSIS"
143.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
144\&\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]
145[\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]
146.SH "DESCRIPTION" 147.SH "DESCRIPTION"
… …
149.SH "OPTIONS" 150.SH "OPTIONS"
150.IX Header "OPTIONS" 151.IX Header "OPTIONS"
151.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
152.IX Item "-c, --config=DIR" 153.IX Item "-c, --config=DIR"
153Read 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.
154.IP "\fB\-g\fR, \fB\-\-generate\-keys\fR" 4 168.IP "\fB\-G\fR, \fB\-\-generate\-keys\fR" 4
155.IX Item "-g, --generate-keys" 169.IX Item "-G, --generate-keys"
156Generate 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.
157.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 183.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
158.IX Item "-q, --quiet" 184.IX Item "-q, --quiet"
159Suppresses messages the author finds nonessential for scripting purposes. 185Suppresses messages the author finds nonessential for scripting purposes.
160.IP "\fB\-\-help\fR" 4 186.IP "\fB\-\-help\fR" 4
161.IX Item "--help" 187.IX Item "--help"
… …
176If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR. 202If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR.
177.SH "SEE ALSO" 203.SH "SEE ALSO"
178.IX Header "SEE ALSO" 204.IX Header "SEE ALSO"
179\&\fIgvpe\fR\|(5), \fIgvpe.conf\fR\|(5), \fIgvpe\fR\|(8). 205\&\fIgvpe\fR\|(5), \fIgvpe.conf\fR\|(5), \fIgvpe\fR\|(8).
180.PP 206.PP
181gvpe 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
182welcome 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
183for details. 209for details.
184.SH "AUTHOR" 210.SH "AUTHOR"
185.IX Header "AUTHOR" 211.IX Header "AUTHOR"
186Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR. 212Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines