1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
1 | .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
23 | .ft R |
23 | .ft R |
24 | .fi |
24 | .fi |
25 | .. |
25 | .. |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
26 | .\" Set up some character translations and predefined strings. \*(-- will |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
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 |
28 | .\" 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 |
29 | .\" 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' |
30 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
31 | .\" nothing in troff, for use with C<>. |
32 | .tr \(*W-|\(bv\*(Tr |
32 | .tr \(*W- |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 | .ie n \{\ |
34 | .ie n \{\ |
35 | . ds -- \(*W- |
35 | . ds -- \(*W- |
36 | . ds PI pi |
36 | . ds PI pi |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
… | |
… | |
46 | . ds PI \(*p |
46 | . ds PI \(*p |
47 | . ds L" `` |
47 | . ds L" `` |
48 | . ds R" '' |
48 | . ds R" '' |
49 | 'br\} |
49 | 'br\} |
50 | .\" |
50 | .\" |
|
|
51 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
52 | .ie \n(.g .ds Aq \(aq |
|
|
53 | .el .ds Aq ' |
|
|
54 | .\" |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
55 | .\" 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 |
56 | .\" 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 |
57 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
54 | .\" output yourself in some meaningful fashion. |
58 | .\" output yourself in some meaningful fashion. |
55 | .if \nF \{\ |
59 | .ie \nF \{\ |
56 | . de IX |
60 | . de IX |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
61 | . tm Index:\\$1\t\\n%\t"\\$2" |
58 | .. |
62 | .. |
59 | . nr % 0 |
63 | . nr % 0 |
60 | . rr F |
64 | . rr F |
61 | .\} |
65 | .\} |
62 | .\" |
66 | .el \{\ |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
67 | . de IX |
64 | .\" way too many mistakes in technical documents. |
68 | .. |
65 | .hy 0 |
69 | .\} |
66 | .if n .na |
|
|
67 | .\" |
70 | .\" |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
71 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
72 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
70 | . \" fudge factors for nroff and troff |
73 | . \" fudge factors for nroff and troff |
71 | .if n \{\ |
74 | .if n \{\ |
… | |
… | |
127 | .\} |
130 | .\} |
128 | .rm #[ #] #H #V #F C |
131 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
132 | .\" ======================================================================== |
130 | .\" |
133 | .\" |
131 | .IX Title "GVPE 8" |
134 | .IX Title "GVPE 8" |
132 | .TH GVPE 8 "2005-03-18" "1.8" "GNU Virtual Private Ethernet" |
135 | .TH GVPE 8 "2008-09-01" "2.2" "GNU Virtual Private Ethernet" |
|
|
136 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
137 | .\" way too many mistakes in technical documents. |
|
|
138 | .if n .ad l |
|
|
139 | .nh |
133 | .SH "NAME" |
140 | .SH "NAME" |
134 | \&\f(CW\*(C`gvpe\*(C'\fR \- GNU Virtual Private Ethernet Daemon |
141 | \&\f(CW\*(C`gvpe\*(C'\fR \- \s-1GNU\s0 Virtual Private Ethernet Daemon |
135 | .SH "SYNOPSIS" |
142 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
143 | .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] |
144 | \&\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] |
145 | [\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 |
146 | \&\fI\s-1NODENAME\s0\fR [\fIoption...\fR] |
140 | .SH "DESCRIPTION" |
147 | .SH "DESCRIPTION" |
141 | .IX Header "DESCRIPTION" |
148 | .IX Header "DESCRIPTION" |
142 | See the \fIgvpe\fR\|(5) manpage for an introduction to the gvpe suite. |
149 | See the \fIgvpe\fR\|(5) man page for an introduction to the gvpe suite. |
143 | .PP |
150 | .PP |
144 | This is the manual page for gvpe, the virtual private ethernet daemon. |
151 | 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 |
152 | 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 |
153 | 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 |
154 | of node \fI\s-1NODENAME\s0\fR |
148 | up a socket for incoming connections. Then a script will be executed to |
155 | .PP |
|
|
156 | It will then create/connect to the tun/tap device and set up a socket for |
|
|
157 | incoming connections. Then a \f(CW\*(C`if\-up\*(C'\fR script will be executed to further |
149 | further configure the virtual device. If that succeeds, it will detach |
158 | configure the virtual network device. If that succeeds, it will detach |
150 | from the controlling terminal and continue in the background, accepting |
159 | from the controlling terminal and continue in the background, accepting |
151 | and setting up connections to other gvpe daemons that are part of the |
160 | and setting up connections to other gvpe daemons that are part of the |
152 | virtual private ethernet. |
161 | same virtual private ethernet. |
|
|
162 | .PP |
|
|
163 | The optional arguments after the node name have to be of the form: |
|
|
164 | .PP |
|
|
165 | .Vb 1 |
|
|
166 | \& [I<nodename>.]var=value |
|
|
167 | .Ve |
|
|
168 | .PP |
|
|
169 | If the argument has a prefix of \f(CW\*(C`nodename.\*(C'\fR |
|
|
170 | (i.e. \f(CW\*(C`laptop.enable\-dns=yes\*(C'\fR) then it will be parsed after all the |
|
|
171 | config directives for that node, if not, it is parsed before the first |
|
|
172 | node directive in the config file, and can be used to set global options |
|
|
173 | or default variables. |
|
|
174 | .PP |
|
|
175 | For example, to start \f(CW\*(C`gvpe\*(C'\fR in the foreground, with log-level \f(CW\*(C`info\*(C'\fR on |
|
|
176 | the node \f(CW\*(C`laptop\*(C'\fR, with \s-1TCP\s0 enabled and HTTP-Proxy host and Port set, use |
|
|
177 | this: |
|
|
178 | .PP |
|
|
179 | .Vb 3 |
|
|
180 | \& gvpe \-D \-l info laptop \e |
|
|
181 | \& http\-proxy\-host=10.0.0.18 http\-proxy\-port=3128 \e |
|
|
182 | \& laptop.enable\-tcp=yes |
|
|
183 | .Ve |
153 | .SH "OPTIONS" |
184 | .SH "OPTIONS" |
154 | .IX Header "OPTIONS" |
185 | .IX Header "OPTIONS" |
155 | .IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 |
186 | .IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 |
156 | .IX Item "-c, --config=DIR" |
187 | .IX Item "-c, --config=DIR" |
157 | Read configuration options from \fI\s-1DIR\s0\fR |
188 | Read configuration options from \fI\s-1DIR\s0\fR |
… | |
… | |
166 | .IX Item "-D, --no-detach" |
197 | .IX Item "-D, --no-detach" |
167 | Don't fork and detach but stay in foreground and log messages to stderr in |
198 | Don't fork and detach but stay in foreground and log messages to stderr in |
168 | addition to syslog. |
199 | addition to syslog. |
169 | .IP "\fB\-L\fR, \fB\-\-mlock\fR" 4 |
200 | .IP "\fB\-L\fR, \fB\-\-mlock\fR" 4 |
170 | .IX Item "-L, --mlock" |
201 | .IX Item "-L, --mlock" |
171 | Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like |
202 | 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. |
203 | shared private keys to be written to the system swap files/partitions. |
173 | .IP "\fB\-\-version\fR" 4 |
204 | .IP "\fB\-\-version\fR" 4 |
174 | .IX Item "--version" |
205 | .IX Item "--version" |
175 | Output version information and exit. |
206 | Output version information and exit. |
176 | .SH "SIGNALS" |
207 | .SH "SIGNALS" |
… | |
… | |
220 | .SH "BUGS" |
251 | .SH "BUGS" |
221 | .IX Header "BUGS" |
252 | .IX Header "BUGS" |
222 | The cryptography in gvpe has not been thoroughly checked by many people |
253 | The cryptography in gvpe has not been thoroughly checked by many people |
223 | yet. Use it at your own risk! |
254 | yet. Use it at your own risk! |
224 | .PP |
255 | .PP |
225 | If you find any bugs, report them to \f(CW\*(C`gvpe@plan9.de\*(C'\fR. |
256 | If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR. |
226 | .SH "SEE ALSO" |
257 | .SH "SEE ALSO" |
227 | .IX Header "SEE ALSO" |
258 | .IX Header "SEE ALSO" |
228 | \&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8). |
259 | \&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8). |
229 | .PP |
260 | .PP |
230 | The \s-1GVPE\s0 mailing list at http://lists.schmorp.de/ |
261 | The \s-1GVPE\s0 mailing list, at <http://lists.schmorp.de/> or |
|
|
262 | \&\f(CW\*(C`gvpe@lists.schmorp.de\*(C'\fR. |
231 | .PP |
263 | .PP |
232 | gvpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are |
264 | \&\s-1GVPE\s0 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 |
265 | welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0 |
234 | for details. |
266 | for details. |
235 | .SH "AUTHOR" |
267 | .SH "AUTHOR" |
236 | .IX Header "AUTHOR" |
268 | .IX Header "AUTHOR" |
237 | Marc Lehmann \f(CW\*(C`<gvpe@plan9.de>\*(C'\fR. |
269 | Marc Lehmann \f(CW\*(C`<gvpe@schmorp.de>\*(C'\fR. |
238 | .PP |
270 | .PP |
239 | And thanks to many others for their contributions to gvpe, especially the |
271 | And thanks to many others for their contributions to gvpe, especially the |
240 | tincd authors, who inspired me to write this program (after scavenging |
272 | tincd authors, who inspired me to write this program (after scavenging |
241 | their sourcecode ;). |
273 | their source code ;). |