1 | .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 |
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 | .. |
5 | .de Sp \" Vertical space (when we can't use .PP) |
13 | .de Sp \" Vertical space (when we can't use .PP) |
6 | .if t .sp .5v |
14 | .if t .sp .5v |
7 | .if n .sp |
15 | .if n .sp |
8 | .. |
16 | .. |
9 | .de Vb \" Begin verbatim text |
17 | .de Vb \" Begin verbatim text |
… | |
… | |
38 | . ds PI \(*p |
46 | . ds PI \(*p |
39 | . ds L" `` |
47 | . ds L" `` |
40 | . ds R" '' |
48 | . ds R" '' |
41 | 'br\} |
49 | 'br\} |
42 | .\" |
50 | .\" |
43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
|
|
44 | .ie \n(.g .ds Aq \(aq |
|
|
45 | .el .ds Aq ' |
|
|
46 | .\" |
|
|
47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
50 | .\" output yourself in some meaningful fashion. |
54 | .\" output yourself in some meaningful fashion. |
51 | .ie \nF \{\ |
55 | .if \nF \{\ |
52 | . de IX |
56 | . de IX |
53 | . tm Index:\\$1\t\\n%\t"\\$2" |
57 | . tm Index:\\$1\t\\n%\t"\\$2" |
54 | .. |
58 | .. |
55 | . nr % 0 |
59 | . nr % 0 |
56 | . rr F |
60 | . rr F |
57 | .\} |
61 | .\} |
58 | .el \{\ |
62 | .\" |
59 | . de IX |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
60 | .. |
64 | .\" way too many mistakes in technical documents. |
61 | .\} |
65 | .hy 0 |
|
|
66 | .if n .na |
62 | .\" |
67 | .\" |
63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
65 | . \" fudge factors for nroff and troff |
70 | . \" fudge factors for nroff and troff |
66 | .if n \{\ |
71 | .if n \{\ |
… | |
… | |
122 | .\} |
127 | .\} |
123 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
124 | .\" ======================================================================== |
129 | .\" ======================================================================== |
125 | .\" |
130 | .\" |
126 | .IX Title "GVPE.CONF 5" |
131 | .IX Title "GVPE.CONF 5" |
127 | .TH GVPE.CONF 5 "2011-02-12" "2.24" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2011-02-15" "2.24" "GNU Virtual Private Ethernet" |
128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
|
|
129 | .\" way too many mistakes in technical documents. |
|
|
130 | .if n .ad l |
|
|
131 | .nh |
|
|
132 | .SH "NAME" |
133 | .SH "NAME" |
133 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
135 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .Vb 4 |
137 | .Vb 4 |
137 | \& # global options for all nodes |
138 | \& # global options for all nodes |
138 | \& udp\-port = 407 |
139 | \& udp\-port = 407 |
139 | \& mtu = 1492 |
140 | \& mtu = 1492 |
140 | \& ifname = vpn0 |
141 | \& ifname = vpn0 |
141 | \& |
142 | .Ve |
|
|
143 | .PP |
|
|
144 | .Vb 3 |
142 | \& # first node is named branch1 and is at 1.2.3.4 |
145 | \& # first node is named branch1 and is at 1.2.3.4 |
143 | \& node = branch1 |
146 | \& node = branch1 |
144 | \& hostname = 1.2.3.4 |
147 | \& hostname = 1.2.3.4 |
145 | \& |
148 | .Ve |
|
|
149 | .PP |
|
|
150 | .Vb 4 |
146 | \& # second node uses dns to resolve the address |
151 | \& # second node uses dns to resolve the address |
147 | \& node = branch2 |
152 | \& node = branch2 |
148 | \& hostname = www.example.net |
153 | \& hostname = www.example.net |
149 | \& udp\-port = 500 # this host uses a different udp\-port |
154 | \& udp\-port = 500 # this host uses a different udp\-port |
150 | \& |
155 | .Ve |
|
|
156 | .PP |
|
|
157 | .Vb 3 |
151 | \& # third node has no fixed ip address |
158 | \& # third node has no fixed ip address |
152 | \& node = branch3 |
159 | \& node = branch3 |
153 | \& connect = ondemand |
160 | \& connect = ondemand |
154 | .Ve |
161 | .Ve |
155 | .SH "DESCRIPTION" |
162 | .SH "DESCRIPTION" |
… | |
… | |
188 | .PP |
195 | .PP |
189 | Node-specific settings can be used at any time. If used before the first |
196 | Node-specific settings can be used at any time. If used before the first |
190 | node section they will set the default values for all following nodes. |
197 | node section they will set the default values for all following nodes. |
191 | .SH "CONFIG VARIABLES" |
198 | .SH "CONFIG VARIABLES" |
192 | .IX Header "CONFIG VARIABLES" |
199 | .IX Header "CONFIG VARIABLES" |
193 | .SS "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
200 | .Sh "\s-1GLOBAL\s0 \s-1SETTINGS\s0" |
194 | .IX Subsection "GLOBAL SETTINGS" |
201 | .IX Subsection "GLOBAL SETTINGS" |
195 | Global settings will affect the behaviour of the running gvpe daemon, that |
202 | Global settings will affect the behaviour of the running gvpe daemon, that |
196 | is, they are in some sense node-specific (config files can set different |
203 | is, they are in some sense node-specific (config files can set different |
197 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
204 | values on different nodes using \f(CW\*(C`on\*(C'\fR), but will affect the behaviour of |
198 | the gvpe daemon and all connections it creates. |
205 | the gvpe daemon and all connections it creates. |
… | |
… | |
503 | via gvpe and gvpe traffic via the normal system routing tables: |
510 | via gvpe and gvpe traffic via the normal system routing tables: |
504 | .Sp |
511 | .Sp |
505 | .Vb 1 |
512 | .Vb 1 |
506 | \& ip rule add not fwmark 1000 lookup 99 |
513 | \& ip rule add not fwmark 1000 lookup 99 |
507 | .Ve |
514 | .Ve |
508 | .SS "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
515 | .Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" |
509 | .IX Subsection "NODE SPECIFIC SETTINGS" |
516 | .IX Subsection "NODE SPECIFIC SETTINGS" |
510 | The following settings are node-specific, that is, every node can have |
517 | The following settings are node\-specific, that is, every node can have |
511 | different settings, even within the same gvpe instance. Settings that are |
518 | different settings, even within the same gvpe instance. Settings that are |
512 | set before the first node section set the defaults, settings that are |
519 | set before the first node section set the defaults, settings that are |
513 | set within a node section only apply to the given node. |
520 | set within a node section only apply to the given node. |
514 | .IP "allow-direct = nodename" 4 |
521 | .IP "allow-direct = nodename" 4 |
515 | .IX Item "allow-direct = nodename" |
522 | .IX Item "allow-direct = nodename" |
… | |
… | |
614 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
621 | when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. |
615 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
622 | .IP "enable-udp = yes|true|on | no|false|off" 4 |
616 | .IX Item "enable-udp = yes|true|on | no|false|off" |
623 | .IX Item "enable-udp = yes|true|on | no|false|off" |
617 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
624 | See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol. |
618 | .Sp |
625 | .Sp |
619 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, |
626 | Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR). |
620 | unless no other protocol is enabled for a node, in which case this |
|
|
621 | protocol is enabled automatically). |
|
|
622 | .Sp |
|
|
623 | \&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want to use it even though |
|
|
624 | it might get switched on automatically, as some future version might |
|
|
625 | default to another default protocol. |
|
|
626 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
627 | .IP "hostname = hostname | ip [can not be defaulted]" 4 |
627 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
628 | .IX Item "hostname = hostname | ip [can not be defaulted]" |
628 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
629 | Forces the address of this node to be set to the given \s-1DNS\s0 hostname or \s-1IP\s0 |
629 | address. It will be resolved before each connect request, so dyndns should |
630 | address. It will be resolved before each connect request, so dyndns should |
630 | work fine. If this setting is not specified and a router is available, |
631 | work fine. If this setting is not specified and a router is available, |
… | |
… | |
637 | .IX Item "icmp-type = integer" |
638 | .IX Item "icmp-type = integer" |
638 | Sets the type value to be used for outgoing (and incoming) packets sent |
639 | Sets the type value to be used for outgoing (and incoming) packets sent |
639 | via the \s-1ICMP\s0 transport. |
640 | via the \s-1ICMP\s0 transport. |
640 | .Sp |
641 | .Sp |
641 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
642 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
642 | \&\*(L"ping-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
643 | \&\*(L"ping\-reply\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
643 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
644 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
644 | .IP "if-up-data = value" 4 |
645 | .IP "if-up-data = value" 4 |
645 | .IX Item "if-up-data = value" |
646 | .IX Item "if-up-data = value" |
646 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
647 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
647 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
648 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
… | |
… | |
712 | .IX Item "gvpe.conf" |
713 | .IX Item "gvpe.conf" |
713 | The config file. |
714 | The config file. |
714 | .IP "if-up" 4 |
715 | .IP "if-up" 4 |
715 | .IX Item "if-up" |
716 | .IX Item "if-up" |
716 | The if-up script |
717 | The if-up script |
717 | .IP "node-up, node-down" 4 |
718 | .IP "node\-up, node-down" 4 |
718 | .IX Item "node-up, node-down" |
719 | .IX Item "node-up, node-down" |
719 | If used the node up or node-down scripts. |
720 | If used the node up or node-down scripts. |
720 | .IP "hostkey" 4 |
721 | .IP "hostkey" 4 |
721 | .IX Item "hostkey" |
722 | .IX Item "hostkey" |
722 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |
723 | The private key (taken from \f(CW\*(C`hostkeys/nodename\*(C'\fR) of the current host. |