7a80ce3c |
1 | .\" |
2 | .\" Copyright (C) 2007 Fredrik Tolf (fredrik@dolda2000.com) |
3 | .\" |
4 | .\" This is free documentation; you can redistribute it and/or |
5 | .\" modify it under the terms of the GNU General Public License as |
6 | .\" published by the Free Software Foundation; either version 2 of |
7 | .\" the License, or (at your option) any later version. |
8 | .\" |
9 | .\" The GNU General Public License's references to "object code" |
10 | .\" and "executables" are to be interpreted as the output of any |
11 | .\" document formatting or typesetting system, including |
12 | .\" intermediate and printed output. |
13 | .\" |
14 | .\" This manual is distributed in the hope that it will be useful, |
15 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 | .\" GNU General Public License for more details. |
18 | .\" |
19 | .\" You should have received a copy of the GNU General Public |
20 | .\" License along with this manual; if not, write to the Free |
21 | .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, |
22 | .\" USA. |
23 | .\" |
24 | .TH DOLDACOND.CONF 5 "@DATE@" "" "Dolda Connect manual" |
25 | .SH NAME |
26 | doldacond.conf \- Dolda Connect daemon configuration file |
27 | .SH DESCRIPTION |
13e05ddc |
28 | The \fBdoldacond\fP(8) daemon will examine the doldacond.conf file |
29 | upon startup and reception of SIGHUP. The file is written in a |
7a80ce3c |
30 | line-oriented ASCII format, using the following rules. |
31 | .P |
32 | A line is either empty, a comment, or a configuration directive. Empty |
33 | lines are permitted to contain horizontal whitespace, but nothing |
13e05ddc |
34 | else. A comment line begins with a hash sign (`#'), optionally |
35 | preceded by whitespace. A configuration directive is a line with at |
36 | least one token, each token being a series of non-whitespace |
37 | characters or quoted whitespace characters. Quoting can be done either |
38 | by surrounding the characters to be quoted with double quotation |
39 | marks, or by preceding a single character to be quoted with a |
40 | backslash. The first token is considered the directive to be |
41 | evaluated, and the rest being arguments to the directive. Each of the |
42 | possible configuration directives are described in their own sections. |
7a80ce3c |
43 | .SH CONFIGURATION VARIABLES |
44 | The vast majority of the daemon's configuration is controlled via |
45 | named configuration variables. The \fBset\fP directive is used to set |
46 | the value of the configuration variables, which obeys the following |
47 | syntax: |
48 | .P |
49 | \fBset\fP \fIvariable\fP \fIvalue\fP |
50 | .P |
51 | The value of a variable is either a boolean, an integer, a string or |
52 | an IPv4 address. Which one depends on the variable. A boolean may be |
53 | specified using either \fBtrue\fP/\fBfalse\fP, \fBon\fP/\fBoff\fP, |
54 | \fByes\fP/\fBno\fP or \fB1\fP/\fB0\fP. Integers may be given in either |
55 | decimal, octal or hexadecimal format, using standard C syntax \- that |
56 | is, hexadecimal numbers prefixed with \fB0x\fP, octal numbers prefixed |
57 | with \fB0\fP, or directly entered decimal numbers. Strings may contain |
58 | arbitrary Unicode characters, and are decoded according to the |
59 | system's default character coding. IPv4 addresses are specified in |
60 | dotted quad decimal notation. A list of all the known configuration |
61 | variables follows. |
62 | @VARIABLES@ |
63 | .SH TOS VALUES |
64 | Some configuration variables specify IP Type of Service values. Valid |
65 | values for those variables are as follows: |
66 | .TP |
67 | 0 |
68 | System default TOS. |
69 | .TP |
70 | 1 |
71 | Minimize cost |
72 | .TP |
73 | 2 |
74 | Maximize reliability |
75 | .TP |
76 | 3 |
77 | Maximize throughput |
78 | .TP |
79 | 4 |
80 | Minimize delay |
81 | .P |
82 | How routers interpret TOS values is defined by the administrator of |
83 | those routers. For IPv6 connections, which use Diffserv instead of the |
84 | older IPv4 TOS values, the Diffserv values to use are specified by the |
85 | \fBnet.diffserv-mincost\fP, \fBnet.diffserv-maxrel\fP, |
86 | \fBnet.diffserv-maxtp\fP and \fBnet.diffserv-mindelay\fP configuration |
87 | variables, as described above. |
88 | .SH FILES |
89 | All file names specified in the configuration file, and the |
90 | configuration file itself, are looked up by the daemon in a rather |
91 | flexible manner. The only difference between the main configuration |
92 | file and all other files is that the configuration must always be |
93 | named \fBdoldacond.conf\fP, while the name of all other files may be |
94 | specified in the configuration file. In all else, lookup is done |
95 | according to the following rules: |
96 | .TP |
97 | 1 |
98 | If the specified name contains any slashes (not applicable for |
99 | doldacond.conf), it will be considered absolute, and no locations |
100 | other than the explicitly specified will be examined. |
101 | .TP |
102 | 2 |
103 | The home directory of the user running the daemon (as specified by |
104 | either the \fBHOME\fP environment variable or as returned by the |
105 | \fBgetpwuid\fP(3) function) is checked for a dot-file with the |
106 | specified name. |
107 | .TP |
108 | 3 |
109 | If the \fBPATH\fP environment variable exists, the directories it |
110 | specifies are iterated, the last path element of each is replaced by |
111 | `etc', and the resulting directories are checked for the existence of |
112 | the specified file. For example, if \fBPATH\fP is |
113 | /bin:/opt/doldaconnect/bin:/usr/bin, the directories /etc, |
114 | /opt/doldaconnect/etc and /usr/etc will be checked for the file. |
115 | .TP |
116 | 4 |
117 | If the \fBPATH\fP environment variable does not exist (but \fInot\fP |
118 | if \fBPATH\fP does exist and the file simply could not be found |
119 | according to the previous rule), the directories /usr/local/etc, /etc |
120 | and /usr/etc are checked for the file. |
121 | .P |
122 | For files that are created on the fly, such as the hash cache, the |
123 | file will be overwritten in place if found. If not found, it will be |
124 | created in the home directory of the user running the daemon. If the |
125 | home directory cannot be determined, the file will be created in /etc. |
13e05ddc |
126 | .SH BUGS |
127 | IPv4 should also be able to use Diffserv instead of TOS. I have simply |
128 | not been able to find the API to set IPv4 Diffserv values. |
7a80ce3c |
129 | .SH AUTHOR |
130 | Fredrik Tolf <fredrik@dolda2000.com> |
131 | .SH SEE ALSO |
132 | \fBdoldacond\fP(8) |