ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpectrl.8
Revision: 1.8
Committed: Wed Mar 30 04:02:50 2016 UTC (8 years, 1 month ago) by root
Branch: MAIN
Changes since 1.7: +23 -22 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.8 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
2 pcg 1.1 .\"
3     .\" Standard preamble:
4     .\" ========================================================================
5     .de Sp \" Vertical space (when we can't use .PP)
6     .if t .sp .5v
7     .if n .sp
8     ..
9     .de Vb \" Begin verbatim text
10     .ft CW
11     .nf
12     .ne \\$1
13     ..
14     .de Ve \" End verbatim text
15     .ft R
16     .fi
17     ..
18     .\" Set up some character translations and predefined strings. \*(-- will
19     .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 pcg 1.6 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21     .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22     .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23     .\" nothing in troff, for use with C<>.
24     .tr \(*W-
25 pcg 1.1 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26     .ie n \{\
27     . ds -- \(*W-
28     . ds PI pi
29     . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30     . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31     . ds L" ""
32     . ds R" ""
33     . ds C`
34     . ds C'
35     'br\}
36     .el\{\
37     . ds -- \|\(em\|
38     . ds PI \(*p
39     . ds L" ``
40     . ds R" ''
41 root 1.8 . ds C`
42     . ds C'
43 pcg 1.1 'br\}
44     .\"
45 pcg 1.6 .\" Escape single quotes in literal strings from groff's Unicode transform.
46     .ie \n(.g .ds Aq \(aq
47     .el .ds Aq '
48     .\"
49 pcg 1.1 .\" If the F register is turned on, we'll generate index entries on stderr for
50 root 1.8 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 pcg 1.1 .\" entries marked with X<> in POD. Of course, you'll have to process the
52     .\" output yourself in some meaningful fashion.
53 root 1.8 .\"
54     .\" Avoid warning from groff about undefined register 'F'.
55     .de IX
56 pcg 1.6 ..
57 root 1.8 .nr rF 0
58     .if \n(.g .if rF .nr rF 1
59     .if (\n(rF:(\n(.g==0)) \{
60     . if \nF \{
61     . de IX
62     . tm Index:\\$1\t\\n%\t"\\$2"
63     ..
64     . if !\nF==2 \{
65     . nr % 0
66     . nr F 2
67     . \}
68     . \}
69 pcg 1.6 .\}
70 root 1.8 .rr rF
71 pcg 1.1 .\"
72     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73     .\" Fear. Run. Save yourself. No user-serviceable parts.
74     . \" fudge factors for nroff and troff
75     .if n \{\
76     . ds #H 0
77     . ds #V .8m
78     . ds #F .3m
79     . ds #[ \f1
80     . ds #] \fP
81     .\}
82     .if t \{\
83     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84     . ds #V .6m
85     . ds #F 0
86     . ds #[ \&
87     . ds #] \&
88     .\}
89     . \" simple accents for nroff and troff
90     .if n \{\
91     . ds ' \&
92     . ds ` \&
93     . ds ^ \&
94     . ds , \&
95     . ds ~ ~
96     . ds /
97     .\}
98     .if t \{\
99     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105     .\}
106     . \" troff and (daisy-wheel) nroff accents
107     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114     .ds ae a\h'-(\w'a'u*4/10)'e
115     .ds Ae A\h'-(\w'A'u*4/10)'E
116     . \" corrections for vroff
117     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119     . \" for low resolution devices (crt and lpr)
120     .if \n(.H>23 .if \n(.V>19 \
121     \{\
122     . ds : e
123     . ds 8 ss
124     . ds o a
125     . ds d- d\h'-1'\(ga
126     . ds D- D\h'-1'\(hy
127     . ds th \o'bp'
128     . ds Th \o'LP'
129     . ds ae ae
130     . ds Ae AE
131     .\}
132     .rm #[ #] #H #V #F C
133     .\" ========================================================================
134     .\"
135     .IX Title "GVPECTRL 8"
136 root 1.8 .TH GVPECTRL 8 "2015-10-31" "2.25" "GNU Virtual Private Ethernet"
137 pcg 1.6 .\" 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
141 pcg 1.1 .SH "NAME"
142 root 1.8 "gvpectrl" \- GNU Virtual Private Ethernet Control Program
143 pcg 1.1 .SH "SYNOPSIS"
144     .IX Header "SYNOPSIS"
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]
146     [\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-show\-config\fR] [\fB\-\-version\fR]
147     .SH "DESCRIPTION"
148     .IX Header "DESCRIPTION"
149     This is the control program for the \f(CW\*(C`gvpe\*(C'\fR, the virtual private ethernet daemon.
150     .SH "OPTIONS"
151     .IX Header "OPTIONS"
152     .IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4
153     .IX Item "-c, --config=DIR"
154     Read configuration options from \fI\s-1DIR\s0\fR.
155     .IP "\fB\-g\fR, \fB\-\-generate\-keys\fR" 4
156     .IX Item "-g, --generate-keys"
157 pcg 1.7 Generate public/private \s-1RSA\s0 key-pair and exit.
158 pcg 1.6 .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
159     .IX Item "-q, --quiet"
160     Suppresses messages the author finds nonessential for scripting purposes.
161 pcg 1.1 .IP "\fB\-\-help\fR" 4
162     .IX Item "--help"
163     Display short list of options.
164     .IP "\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]" 4
165     .IX Item "--kill[=SIGNAL]"
166     Attempt to kill a running \f(CW\*(C`gvpectrl\*(C'\fR (optionally with the specified
167     \&\fI\s-1SIGNAL\s0\fR instead of \f(CW\*(C`SIGTERM\*(C'\fR) and exit.
168     .IP "\fB\-\-show\-config\fR" 4
169     .IX Item "--show-config"
170     Show a summary of the configuration, and how gvpe interprets it. Can also be very useful
171     when designing firewall scripts.
172     .IP "\fB\-\-version\fR" 4
173     .IX Item "--version"
174     Output version information and exit.
175     .SH "BUGS"
176     .IX Header "BUGS"
177 pcg 1.5 If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR.
178 pcg 1.1 .SH "SEE ALSO"
179     .IX Header "SEE ALSO"
180     \&\fIgvpe\fR\|(5), \fIgvpe.conf\fR\|(5), \fIgvpe\fR\|(8).
181     .PP
182 root 1.8 \&\s-1GVPE\s0 comes with \s-1ABSOLUTELY NO WARRANTY. \s0 This is free software, and you are
183 pcg 1.1 welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0
184     for details.
185 pcg 1.2 .SH "AUTHOR"
186     .IX Header "AUTHOR"
187 pcg 1.5 Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR.