--- gvpe/doc/gvpe.8 2004/09/05 02:19:07 1.3 +++ gvpe/doc/gvpe.8 2016/03/30 04:02:50 1.13 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -46,24 +38,36 @@ . ds PI \(*p . ds L" `` . ds R" '' +. ds C` +. ds C' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX .. -. nr % 0 -. rr F +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{ +. if \nF \{ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{ +. nr % 0 +. nr F 2 +. \} +. \} .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,27 +133,55 @@ .\" ======================================================================== .\" .IX Title "GVPE 8" -.TH GVPE 8 "2004-07-26" "1.7" "GNU Virtual Private Ethernet" +.TH GVPE 8 "2015-10-31" "2.25" "GNU Virtual Private Ethernet" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" -\&\f(CW\*(C`gvpe\*(C'\fR \- GNU Virtual Private Ethernet Daemon +"gvpe" \- GNU Virtual Private Ethernet Daemon .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\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] [\fB\-\-kill\fR[\fB=\fR\fI\s-1SIGNAL\s0\fR]] [\fB\-\-mlock\fR] [\fB\-\-help\fR] [\fB\-\-version\fR] -\&\fI\s-1NODENAME\s0\fR +\&\fI\s-1NODENAME\s0\fR [\fIoption...\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" -See the \fIgvpe\fR\|(5) manpage for an introduction to the gvpe suite. +See the \fIgvpe\fR\|(5) man page for an introduction to the gvpe suite. .PP This is the manual page for gvpe, the virtual private ethernet daemon. When started, \f(CW\*(C`gvpe\*(C'\fR will read it's configuration file to determine the network topology, and other configuration information, assuming the role -of node \fI\s-1NODENAME\s0\fR. It will then connect to the tun/tap device and set -up a socket for incoming connections. Then a script will be executed to -further configure the virtual device. If that succeeds, it will detach +of node \fI\s-1NODENAME\s0\fR +.PP +It will then create/connect to the tun/tap device and set up a socket for +incoming connections. Then a \f(CW\*(C`if\-up\*(C'\fR script will be executed to further +configure the virtual network device. If that succeeds, it will detach from the controlling terminal and continue in the background, accepting and setting up connections to other gvpe daemons that are part of the -virtual private ethernet. +same virtual private ethernet. +.PP +The optional arguments after the node name have to be of the form: +.PP +.Vb 1 +\& [I.]var=value +.Ve +.PP +If the argument has a prefix of \f(CW\*(C`nodename.\*(C'\fR +(i.e. \f(CW\*(C`laptop.enable\-dns=yes\*(C'\fR) then it will be parsed after all the +config directives for that node, if not, it is parsed before the first +node directive in the config file, and can be used to set global options +or default variables. +.PP +For example, to start \f(CW\*(C`gvpe\*(C'\fR in the foreground, with log-level \f(CW\*(C`info\*(C'\fR on +the node \f(CW\*(C`laptop\*(C'\fR, with \s-1TCP\s0 enabled and HTTP-Proxy host and Port set, use +this: +.PP +.Vb 3 +\& gvpe \-D \-l info laptop \e +\& http\-proxy\-host=10.0.0.18 http\-proxy\-port=3128 \e +\& laptop.enable\-tcp=yes +.Ve .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-c\fR, \fB\-\-config=\fR\fI\s-1DIR\s0\fR" 4 @@ -168,7 +200,7 @@ addition to syslog. .IP "\fB\-L\fR, \fB\-\-mlock\fR" 4 .IX Item "-L, --mlock" -Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like +Lock \f(CW\*(C`gvpe\*(C'\fR into main memory. This will prevent sensitive data like shared private keys to be written to the system swap files/partitions. .IP "\fB\-\-version\fR" 4 .IX Item "--version" @@ -222,21 +254,21 @@ The cryptography in gvpe has not been thoroughly checked by many people yet. Use it at your own risk! .PP -If you find any bugs, report them to \f(CW\*(C`vpe@plan9.de\*(C'\fR. -.SH "TODO" -.IX Header "TODO" -A lot. +If you find any bugs, report them to \f(CW\*(C`gvpe@schmorp.de\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIgvpe\fR\|(5) for an introduction, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8). .PP -gvpe comes with \s-1ABSOLUTELY\s0 \s-1NO\s0 \s-1WARRANTY\s0. This is free software, and you are +The \s-1GVPE\s0 mailing list, at or +\&\f(CW\*(C`gvpe@lists.schmorp.de\*(C'\fR. +.PP +\&\s-1GVPE\s0 comes with \s-1ABSOLUTELY NO WARRANTY. \s0 This is free software, and you are welcome to redistribute it under certain conditions; see the file \s-1COPYING\s0 for details. -.SH "AUTHORS" -.IX Header "AUTHORS" -Marc Lehmann \f(CW\*(C`\*(C'\fR. +.SH "AUTHOR" +.IX Header "AUTHOR" +Marc Lehmann \f(CW\*(C`\*(C'\fR. .PP And thanks to many others for their contributions to gvpe, especially the tincd authors, who inspired me to write this program (after scavenging -their sourcecode ;). +their source code ;).