ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.8
Revision: 1.5
Committed: Thu Mar 17 23:59:37 2005 UTC (19 years, 2 months ago) by pcg
Branch: MAIN
Changes since 1.4: +3 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2     .\"
3     .\" Standard preamble:
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)
14     .if t .sp .5v
15     .if n .sp
16     ..
17     .de Vb \" Begin verbatim text
18     .ft CW
19     .nf
20     .ne \\$1
21     ..
22     .de Ve \" End verbatim text
23     .ft R
24     .fi
25     ..
26     .\" Set up some character translations and predefined strings. \*(-- will
27     .\" 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
29     .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30     .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31     .\" expand to `' in nroff, nothing in troff, for use with C<>.
32     .tr \(*W-|\(bv\*(Tr
33     .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34     .ie n \{\
35     . ds -- \(*W-
36     . ds PI pi
37     . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38     . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39     . ds L" ""
40     . ds R" ""
41     . ds C`
42     . ds C'
43     'br\}
44     .el\{\
45     . ds -- \|\(em\|
46     . ds PI \(*p
47     . ds L" ``
48     . ds R" ''
49     'br\}
50     .\"
51     .\" 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
53     .\" entries marked with X<> in POD. Of course, you'll have to process the
54     .\" output yourself in some meaningful fashion.
55     .if \nF \{\
56     . de IX
57     . tm Index:\\$1\t\\n%\t"\\$2"
58     ..
59     . nr % 0
60     . rr F
61     .\}
62     .\"
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     .\"
68     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69     .\" Fear. Run. Save yourself. No user-serviceable parts.
70     . \" fudge factors for nroff and troff
71     .if n \{\
72     . ds #H 0
73     . ds #V .8m
74     . ds #F .3m
75     . ds #[ \f1
76     . ds #] \fP
77     .\}
78     .if t \{\
79     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80     . ds #V .6m
81     . ds #F 0
82     . ds #[ \&
83     . ds #] \&
84     .\}
85     . \" simple accents for nroff and troff
86     .if n \{\
87     . ds ' \&
88     . ds ` \&
89     . ds ^ \&
90     . ds , \&
91     . ds ~ ~
92     . ds /
93     .\}
94     .if t \{\
95     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101     .\}
102     . \" troff and (daisy-wheel) nroff accents
103     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110     .ds ae a\h'-(\w'a'u*4/10)'e
111     .ds Ae A\h'-(\w'A'u*4/10)'E
112     . \" corrections for vroff
113     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115     . \" for low resolution devices (crt and lpr)
116     .if \n(.H>23 .if \n(.V>19 \
117     \{\
118     . ds : e
119     . ds 8 ss
120     . ds o a
121     . ds d- d\h'-1'\(ga
122     . ds D- D\h'-1'\(hy
123     . ds th \o'bp'
124     . ds Th \o'LP'
125     . ds ae ae
126     . ds Ae AE
127     .\}
128     .rm #[ #] #H #V #F C
129     .\" ========================================================================
130     .\"
131     .IX Title "GVPE 8"
132 pcg 1.5 .TH GVPE 8 "2005-03-18" "1.8" "GNU Virtual Private Ethernet"
133 pcg 1.1 .SH "NAME"
134     \&\f(CW\*(C`gvpe\*(C'\fR \- GNU Virtual Private Ethernet Daemon
135 pcg 1.3 .SH "SYNOPSIS"
136     .IX Header "SYNOPSIS"
137     \&\f(CW\*(C`gvpe\*(C'\fR [\fB\-cDlL\fR] [\fB\-\-config=\fR\fI\s-1DIR\s0\fR] [\fB\-\-no\-detach\fR] [\fB\-l=\fR\fI\s-1LEVEL\s0]\fR]
138     [\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-mlock\fR] [\fB\-\-help\fR] [\fB\-\-version\fR]
139     \&\fI\s-1NODENAME\s0\fR
140 pcg 1.1 .SH "DESCRIPTION"
141     .IX Header "DESCRIPTION"
142     See the \fIgvpe\fR\|(5) manpage for an introduction to the gvpe suite.
143     .PP
144     This is the manual page for gvpe, the virtual private ethernet daemon.
145     When started, \f(CW\*(C`gvpe\*(C'\fR will read it's configuration file to determine the
146     network topology, and other configuration information, assuming the role
147     of node \fI\s-1NODENAME\s0\fR. It will then connect to the tun/tap device and set
148     up a socket for incoming connections. Then a script will be executed to
149     further configure the virtual device. If that succeeds, it will detach
150     from the controlling terminal and continue in the background, accepting
151     and setting up connections to other gvpe daemons that are part of the
152     virtual private ethernet.
153     .SH "OPTIONS"
154     .IX Header "OPTIONS"
155     .IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4
156     .IX Item "-c, --config=DIR"
157     Read configuration options from \fI\s-1DIR\s0\fR
158     .IP "\fB\-d\fR, \fB\-\-l=\fR\fI\s-1LEVEL\s0\fR" 4
159     .IX Item "-d, --l=LEVEL"
160     Set logging level to \fI\s-1LEVEL\s0\fR (one of: noise, trace, debug, info, notice,
161     warn, error, critical).
162     .IP "\fB\-\-help\fR" 4
163     .IX Item "--help"
164     Display short list of options.
165     .IP "\fB\-D\fR, \fB\-\-no\-detach\fR" 4
166     .IX Item "-D, --no-detach"
167     Don't fork and detach but stay in foreground and log messages to stderr in
168     addition to syslog.
169     .IP "\fB\-L\fR, \fB\-\-mlock\fR" 4
170     .IX Item "-L, --mlock"
171     Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like
172     shared private keys to be written to the system swap files/partitions.
173     .IP "\fB\-\-version\fR" 4
174     .IX Item "--version"
175     Output version information and exit.
176     .SH "SIGNALS"
177     .IX Header "SIGNALS"
178     .IP "\s-1HUP\s0" 4
179     .IX Item "HUP"
180     Closes/resets all connections, resets the retry time and will start connecting
181     again (it will \s-1NOT\s0 re-read the config file). This is useful e.g. in a
182     \&\f(CW\*(C`/etc/ppp/if\-up\*(C'\fR script.
183     .IP "\s-1TERM\s0" 4
184     .IX Item "TERM"
185     Closes/resets all connections and exits.
186     .IP "\s-1USR1\s0" 4
187     .IX Item "USR1"
188     Dump current network status into the syslog (at loglevel \f(CW\*(C`notice\*(C'\fR, so make
189     sure your loglevel allows this).
190     .SH "FILES"
191     .IX Header "FILES"
192     .ie n .IP "\*(C`/etc/gvpe/gvpe.conf\*(C'" 4
193     .el .IP "\f(CW\*(C`/etc/gvpe/gvpe.conf\*(C'\fR" 4
194     .IX Item "/etc/gvpe/gvpe.conf"
195     The configuration file for \f(CW\*(C`gvpe\*(C'\fR.
196     .ie n .IP "\*(C`/etc/gvpe/if\-up\*(C'" 4
197     .el .IP "\f(CW\*(C`/etc/gvpe/if\-up\*(C'\fR" 4
198     .IX Item "/etc/gvpe/if-up"
199     Script which is executed as soon as the virtual network device has been
200     allocated. Purpose is to further configure that device.
201     .ie n .IP "\*(C`/etc/gvpe/node\-up\*(C'" 4
202     .el .IP "\f(CW\*(C`/etc/gvpe/node\-up\*(C'\fR" 4
203     .IX Item "/etc/gvpe/node-up"
204     Script which is executed whenever a node connects to this node. This can
205     be used for example to run nsupdate.
206     .ie n .IP "\*(C`/etc/gvpe/node\-down\*(C'" 4
207     .el .IP "\f(CW\*(C`/etc/gvpe/node\-down\*(C'\fR" 4
208     .IX Item "/etc/gvpe/node-down"
209 pcg 1.2 Script which is executed whenever a connection to another node is lost.
210 pcg 1.1 for example to run nsupdate.
211     .ie n .IP "\*(C`/etc/gvpe/pubkey/*\*(C'" 4
212     .el .IP "\f(CW\*(C`/etc/gvpe/pubkey/*\*(C'\fR" 4
213     .IX Item "/etc/gvpe/pubkey/*"
214     The directory containing the public keys for every node, usually
215     autogenerated by executing \f(CW\*(C`gvpectrl \-\-generate\-keys\*(C'\fR.
216     .ie n .IP "\*(C`/var/run/gvpe.pid\*(C'" 4
217     .el .IP "\f(CW\*(C`/var/run/gvpe.pid\*(C'\fR" 4
218     .IX Item "/var/run/gvpe.pid"
219     The \s-1PID\s0 of the currently running \f(CW\*(C`gvpe\*(C'\fR is stored in this file.
220     .SH "BUGS"
221     .IX Header "BUGS"
222     The cryptography in gvpe has not been thoroughly checked by many people
223     yet. Use it at your own risk!
224     .PP
225 pcg 1.4 If you find any bugs, report them to \f(CW\*(C`gvpe@plan9.de\*(C'\fR.
226 pcg 1.1 .SH "SEE ALSO"
227     .IX Header "SEE ALSO"
228     \&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8).
229     .PP
230 pcg 1.5 The \s-1GVPE\s0 mailing list at http://lists.schmorp.de/
231     .PP
232 pcg 1.1 gvpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are
233     welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0
234     for details.
235 pcg 1.4 .SH "AUTHOR"
236     .IX Header "AUTHOR"
237 pcg 1.1 Marc Lehmann \f(CW\*(C`<gvpe@plan9.de>\*(C'\fR.
238     .PP
239     And thanks to many others for their contributions to gvpe, especially the
240     tincd authors, who inspired me to write this program (after scavenging
241     their sourcecode ;).