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

Comparing gvpe/doc/gvpe.8 (file contents):
Revision 1.3 by pcg, Sun Sep 5 02:19:07 2004 UTC vs.
Revision 1.13 by root, Wed Mar 30 04:02:50 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 "GVPE 8" 135.IX Title "GVPE 8"
132.TH GVPE 8 "2004-07-26" "1.7" "GNU Virtual Private Ethernet" 136.TH GVPE 8 "2015-10-31" "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`gvpe\*(C'\fR \- GNU Virtual Private Ethernet Daemon 142"gvpe" \- GNU Virtual Private Ethernet Daemon
135.SH "SYNOPSIS" 143.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 144.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] 145\&\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] 146[\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 147\&\fI\s-1NODENAME\s0\fR [\fIoption...\fR]
140.SH "DESCRIPTION" 148.SH "DESCRIPTION"
141.IX Header "DESCRIPTION" 149.IX Header "DESCRIPTION"
142See the \fIgvpe\fR\|(5) manpage for an introduction to the gvpe suite. 150See the \fIgvpe\fR\|(5) man page for an introduction to the gvpe suite.
143.PP 151.PP
144This is the manual page for gvpe, the virtual private ethernet daemon. 152This is the manual page for gvpe, the virtual private ethernet daemon.
145When started, \f(CW\*(C`gvpe\*(C'\fR will read it's configuration file to determine the 153When started, \f(CW\*(C`gvpe\*(C'\fR will read it's configuration file to determine the
146network topology, and other configuration information, assuming the role 154network topology, and other configuration information, assuming the role
147of node \fI\s-1NODENAME\s0\fR. It will then connect to the tun/tap device and set 155of node \fI\s-1NODENAME\s0\fR
148up a socket for incoming connections. Then a script will be executed to 156.PP
157It will then create/connect to the tun/tap device and set up a socket for
158incoming connections. Then a \f(CW\*(C`if\-up\*(C'\fR script will be executed to further
149further configure the virtual device. If that succeeds, it will detach 159configure the virtual network device. If that succeeds, it will detach
150from the controlling terminal and continue in the background, accepting 160from the controlling terminal and continue in the background, accepting
151and setting up connections to other gvpe daemons that are part of the 161and setting up connections to other gvpe daemons that are part of the
152virtual private ethernet. 162same virtual private ethernet.
163.PP
164The optional arguments after the node name have to be of the form:
165.PP
166.Vb 1
167\& [I<nodename>.]var=value
168.Ve
169.PP
170If the argument has a prefix of \f(CW\*(C`nodename.\*(C'\fR
171(i.e. \f(CW\*(C`laptop.enable\-dns=yes\*(C'\fR) then it will be parsed after all the
172config directives for that node, if not, it is parsed before the first
173node directive in the config file, and can be used to set global options
174or default variables.
175.PP
176For example, to start \f(CW\*(C`gvpe\*(C'\fR in the foreground, with log-level \f(CW\*(C`info\*(C'\fR on
177the node \f(CW\*(C`laptop\*(C'\fR, with \s-1TCP\s0 enabled and HTTP-Proxy host and Port set, use
178this:
179.PP
180.Vb 3
181\& gvpe \-D \-l info laptop \e
182\& http\-proxy\-host=10.0.0.18 http\-proxy\-port=3128 \e
183\& laptop.enable\-tcp=yes
184.Ve
153.SH "OPTIONS" 185.SH "OPTIONS"
154.IX Header "OPTIONS" 186.IX Header "OPTIONS"
155.IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 187.IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4
156.IX Item "-c, --config=DIR" 188.IX Item "-c, --config=DIR"
157Read configuration options from \fI\s-1DIR\s0\fR 189Read configuration options from \fI\s-1DIR\s0\fR
… …
166.IX Item "-D, --no-detach" 198.IX Item "-D, --no-detach"
167Don't fork and detach but stay in foreground and log messages to stderr in 199Don't fork and detach but stay in foreground and log messages to stderr in
168addition to syslog. 200addition to syslog.
169.IP "\fB\-L\fR, \fB\-\-mlock\fR" 4 201.IP "\fB\-L\fR, \fB\-\-mlock\fR" 4
170.IX Item "-L, --mlock" 202.IX Item "-L, --mlock"
171Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like 203Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like
172shared private keys to be written to the system swap files/partitions. 204shared private keys to be written to the system swap files/partitions.
173.IP "\fB\-\-version\fR" 4 205.IP "\fB\-\-version\fR" 4
174.IX Item "--version" 206.IX Item "--version"
175Output version information and exit. 207Output version information and exit.
176.SH "SIGNALS" 208.SH "SIGNALS"
… …
220.SH "BUGS" 252.SH "BUGS"
221.IX Header "BUGS" 253.IX Header "BUGS"
222The cryptography in gvpe has not been thoroughly checked by many people 254The cryptography in gvpe has not been thoroughly checked by many people
223yet. Use it at your own risk! 255yet. Use it at your own risk!
224.PP 256.PP
225If you find any bugs, report them to \f(CW\*(C`vpe@plan9.de\*(C'\fR. 257If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR.
226.SH "TODO"
227.IX Header "TODO"
228A lot.
229.SH "SEE ALSO" 258.SH "SEE ALSO"
230.IX Header "SEE ALSO" 259.IX Header "SEE ALSO"
231\&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8). 260\&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8).
232.PP 261.PP
262The \s-1GVPE\s0 mailing list, at <http://lists.schmorp.de/> or
263\&\f(CW\*(C`gvpe@lists.schmorp.de\*(C'\fR.
264.PP
233gvpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are 265\&\s-1GVPE\s0 comes with \s-1ABSOLUTELY NO WARRANTY. \s0 This is free software, and you are
234welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0 266welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0
235for details. 267for details.
236.SH "AUTHORS" 268.SH "AUTHOR"
237.IX Header "AUTHORS" 269.IX Header "AUTHOR"
238Marc Lehmann \f(CW\*(C`<gvpe@plan9.de>\*(C'\fR. 270Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR.
239.PP 271.PP
240And thanks to many others for their contributions to gvpe, especially the 272And thanks to many others for their contributions to gvpe, especially the
241tincd authors, who inspired me to write this program (after scavenging 273tincd authors, who inspired me to write this program (after scavenging
242their sourcecode ;). 274their source code ;).

Diff Legend

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