diff options
Diffstat (limited to 'man/taler.conf.5')
| -rw-r--r-- | man/taler.conf.5 | 92 |
1 files changed, 55 insertions, 37 deletions
diff --git a/man/taler.conf.5 b/man/taler.conf.5 index ce21f218..32d2dce0 100644 --- a/man/taler.conf.5 +++ b/man/taler.conf.5 @@ -27,35 +27,26 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "TALER.CONF" "5" "Jul 16, 2023" "0.9" "GNU Taler" +.TH "TALER.CONF" "5" "Sep 08, 2023" "0.9" "GNU Taler" .SH NAME taler.conf \- Taler configuration file .SH DESCRIPTION .sp -The configuration file is line\-oriented. -Blank lines and whitespace at the beginning and end of a line are ignored. -Comments start with \fB#\fP or \fB%\fP in the first column -(after any beginning\-of\-line whitespace) and go to the end of the line. -.sp -The file is split into sections. -Every section begins with “[SECTIONNAME]” and -contains a number of options of the form “OPTION=VALUE”. -There may be whitespace around the \fB=\fP (equal sign). -Section names and options are \fIcase\-insensitive\fP\&. -.sp -The values, however, are \fIcase\-sensitive\fP\&. -In particular, boolean values are one of \fBYES\fP or \fBNO\fP\&. -Values can include whitespace by surrounding -the entire value with \fB\(dq\fP (double quote). -Note, however, that there are no escape characters in such strings; -all characters between the double quotes (including other double quotes) -are taken verbatim. -.sp -Values that represent filenames can begin with a \fB/bin/sh\fP\-like -variable reference. -This can be simple, such as \fB$TMPDIR/foo\fP, or complex, -such as \fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&. -See \fB[PATHS]\fP (below). +The configuration file is line\-oriented. Blank lines and whitespace at the +beginning and end of a line are ignored. Comments start with \fB#\fP or \fB%\fP +in the first column (after any beginning\-of\-line whitespace) and go to the end +of the line. +.sp +The file is split into sections. Every section begins with \fB[SECTIONNAME]\fP +and contains a number of options of the form \fBOPTION=VALUE\fP\&. There may be +whitespace around the \fB=\fP (equal sign). Section names and options are +\fIcase\-insensitive\fP\&. +.sp +The values, however, are \fIcase\-sensitive\fP\&. In particular, boolean values are +one of \fBYES\fP or \fBNO\fP\&. Values can include whitespace by surrounding the +entire value with \fB\(dq\fP (double quote). Note, however, that there are no +escape characters in such strings; all characters between the double quotes +(including other double quotes) are taken verbatim. .sp Values that represent a time duration are represented as a series of one or more \fBNUMBER UNIT\fP pairs, e.g. \fB60 s\fP, \fB4 weeks 1 day\fP, @@ -65,16 +56,25 @@ Values that represent an amount are in the usual amount syntax: \fBCURRENCY:VALUE.FRACTION\fP, e.g. \fBEUR:1.50\fP\&. The \fBFRACTION\fP portion may extend up to 8 places. .sp -The “[PATHS]” section is special in that it contains paths that can be -referenced using “$” in other configuration values that specify +Values that represent filenames can begin with a \fB/bin/sh\fP\-like variable +reference. This can be simple, such as \fB$TMPDIR/foo\fP, or complex, such as +\fB${TMPDIR:\-${TMP:\-/tmp}}/foo\fP\&. The variables are expanded either using +key\-values from the \fB[PATHS]\fP section (see below) or from the environment +(\fBgetenv()\fP). The values from \fB[PATHS]\fP take precedence over those from +the environment. If the variable name is found in neither \fB[PATHS]\fP nor the +environment, a warning is printed and the value is left unchanged. Variables (including those from the environment) are expanded recursively, so if \fBFOO=$BAR\fP and \fBBAR=buzz\fP then the result is \fBFOO=buzz\fP\&. Recursion is bounded to at most 128 levels to avoid undefined behavior for mutually recursive expansions like if \fBBAR=$FOO\fP in the example above. +.sp +The \fB[PATHS]\fP section is special in that it contains paths that can be +referenced using \fB$\fP in other configuration values that specify \fIfilenames\fP\&. Note that configuration options that are not specifically retrieved by the application as \fIfilenames\fP will not see “$”\-expressions -expanded. To expand “$”\-expressions when using \fBtaler\-config\fP, you must pass +expanded. To expand \fB$\fP\-expressions when using \fBtaler\-config\fP, you must pass the \fB\-f\fP command\-line option. .sp -The system automatically pre\-populates the “[PATHS]” section with a few values -at run\-time in addition to the values that are in the actual configuration -file. These automatically generated values refer to installation properties +The system automatically pre\-populates the \fB[PATHS]\fP section with a few values +at run\-time (in addition to the values that are in the actual configuration +file and automatically overwriting those values if they are present). +These automatically generated values refer to installation properties from \fI\%GNU autoconf\fP\&. The values are usually dependent on an \fBINSTALL_PREFIX\fP which is determined by the \fB\-\-prefix\fP option given to configure. The canonical values are: @@ -103,7 +103,8 @@ DATADIR = $INSTALL_PREFIX/share/taler/ .sp Note that on some platforms, the given paths may differ depending on how the system was compiled or installed, the above are just the -canonical locations of the various resources. +canonical locations of the various resources. These +automatically generated values are never written to disk. .sp Files containing default values for many of the options described below are installed under \fB$TALER_PREFIX/share/taler/config.d/\fP\&. @@ -184,10 +185,6 @@ Hostname to which the exchange HTTP server should be bound to, e.g. \(dqlocalhos Crockford Base32\-encoded master public key, public version of the exchange\(aqs long\-time offline signing key. .TP -.B MASTER_PRIV_FILE -Location of the master private key on disk. Only used by tools that -can be run offline (as the master key is for offline signing). -.TP .B AML_THRESHOLD Largest amount in this currency that can be transferred per month without an AML staff member doing a (manual) AML check. For example: \(dqUSD:1000000\(dq. @@ -202,6 +199,26 @@ that rewards are allowed. The option merely announces that rewards is enabled or disabled, and protocol\-compliant merchant backends will then enable or disable the feature accordingly. .TP +.B CURRENCY_FRACTION_DIGITS +How many digits should amounts be rendered +with by default. Small capitals should +be used to render fractions beyond the number +given here (like on gas stations). Defaults to 0. +For EUR and USD, the value would be 2, while for +JPY it would be 0. +.TP +.B STEFAN_ABS +Absolte amount to use in the STEFAN fee approximation +curve (see DD47). Defaults to 0 if not specified. +.TP +.B STEFAN_LOG +Logarithmic factor to use in the STEFAN fee approximation +curve (see DD47). Defaults to 0 if not specified. +.TP +.B STEFAN_LIN +Linear factor to use in the STEFAN fee approximation +curve (see DD47). Defaults to 0 if not specified. +.TP .B BASE_URL The base URL under which the exchange can be reached. Added to wire transfers to enable tracking by merchants. @@ -423,7 +440,8 @@ The following options must be in the section \(dq[exchange\-offline]\(dq. .INDENT 0.0 .TP .B MASTER_PRIV_FILE -Where to store the offline private key of the exchange. +Location of the master private key on disk. Only used by tools that +can be run offline (as the master key is for offline signing). Mandatory. .TP .B SECM_TOFU_FILE |