diff options
| author | David M. Syzdek <david@syzdek.net> | 2022-03-21 14:54:38 -0800 |
|---|---|---|
| committer | David M. Syzdek <david@syzdek.net> | 2022-03-21 14:54:38 -0800 |
| commit | 8dc9a954f9d721bbe9bed86658e83427fb31cb84 (patch) | |
| tree | 323a5467ae42b9dc5bdabe3a6e3f344fafabc9a9 | |
| parent | 0535b2e475f687ab378007b61d602d4f75c76bc3 (diff) | |
| download | tinyrad-8dc9a954f9d721bbe9bed86658e83427fb31cb84.tar.gz tinyrad-8dc9a954f9d721bbe9bed86658e83427fb31cb84.tar.bz2 tinyrad-8dc9a954f9d721bbe9bed86658e83427fb31cb84.tar.xz tinyrad-8dc9a954f9d721bbe9bed86658e83427fb31cb84.zip | |
doc: updating tinyrad.conf.5
| -rw-r--r-- | doc/mans/tinyrad.conf.5.in | 34 |
1 files changed, 31 insertions, 3 deletions
diff --git a/doc/mans/tinyrad.conf.5.in b/doc/mans/tinyrad.conf.5.in index eaf1405..6c88a1c 100644 --- a/doc/mans/tinyrad.conf.5.in +++ b/doc/mans/tinyrad.conf.5.in | |||
| @@ -39,6 +39,31 @@ disabled. System-wide defaults for TinyRad clients are set in | |||
| 39 | or \fI.tinyradrc\fR. Directory specific defaults are set in the | 39 | or \fI.tinyradrc\fR. Directory specific defaults are set in the |
| 40 | \fItinyradrc\fR in the current working directory. | 40 | \fItinyradrc\fR in the current working directory. |
| 41 | .PP | 41 | .PP |
| 42 | The path of \fItinyrad.conf\fR can be overridden with the envrionment variable | ||
| 43 | \fBTINYRADCONF\fR. \fBTINYRADCONF\fR can be set to an absolute path or a | ||
| 44 | path relative to the current working directory. The base name of the | ||
| 45 | configuration file for user specific defaults can be overridden with the | ||
| 46 | environment variable \fBTINYRADRC\fR. | ||
| 47 | .PP | ||
| 48 | Environment variables may be used to define transient configurations. The | ||
| 49 | name of the envrionment variable is the option name in all upper case | ||
| 50 | characters with the prefix \fBTINYRAD_\fR. For example, to define | ||
| 51 | \fBBIND_ADDRESS\fR via an environment variable, set the variable | ||
| 52 | \fBTINYRAD_BIND_ADDRESS\fR to the string to use as the \fBBIND_ADDRESS\fR. | ||
| 53 | .PP | ||
| 54 | The following files and variables are read, in order: | ||
| 55 | .PP | ||
| 56 | .nf | ||
| 57 | variable $TINYRADNOINIT (stops processing defaults if defined), | ||
| 58 | system file $TINYRADCONF, | ||
| 59 | user file $HOME/$TINYRADRC, | ||
| 60 | user file $HOME/.$TINYRADRC, | ||
| 61 | user file ./$TINYRADRC, | ||
| 62 | variables $TINYRAD_<uppercase option name>. | ||
| 63 | .fi | ||
| 64 | .PP | ||
| 65 | Duplucate parameter values override previously defined parameter values. | ||
| 66 | .PP | ||
| 42 | .SH OPTIONS | 67 | .SH OPTIONS |
| 43 | .TP | 68 | .TP |
| 44 | \fBBIND_ADDRESS\fR \fI<string>\fR | 69 | \fBBIND_ADDRESS\fR \fI<string>\fR |
| @@ -75,13 +100,16 @@ To be written. | |||
| 75 | disable all defaulting | 100 | disable all defaulting |
| 76 | .TP | 101 | .TP |
| 77 | .I TINYRADCONF | 102 | .I TINYRADCONF |
| 78 | path to system-wide configuration file | 103 | path to system-wide configuration file (default: |
| 104 | `\fI@sysconfdir@/tinyrad.conf\fR'). | ||
| 79 | .TP | 105 | .TP |
| 80 | .I TINYRADRC | 106 | .I TINYRADRC |
| 81 | basename f the tinyrc file in $HOME or $CWD | 107 | basename of the user configuration file in $HOME or $CWD (default: |
| 108 | `\fItinyradrc\fR'). | ||
| 82 | .TP | 109 | .TP |
| 83 | .I TINYRAD_<option-name> | 110 | .I TINYRAD_<option-name> |
| 84 | Set <option-name> as if set in tinyrad.conf | 111 | Set \fI<option-name>\fR as if set in a configuration file. \fI<option-name>\fR |
| 112 | must be in upper case. | ||
| 85 | .SH FILES | 113 | .SH FILES |
| 86 | The configuration files have the following precedence. | 114 | The configuration files have the following precedence. |
| 87 | .TP | 115 | .TP |
