summaryrefslogtreecommitdiff
path: root/doc/manual.texi
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-30 21:44:44 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-05-30 21:45:02 +0200
commit7a62a58ef80dc3e2d546b60303d6554a46b01c38 (patch)
tree730df91b100479c3aa0fe9809d3f7a2e560c89b0 /doc/manual.texi
parent1d3c450d377207cfd1ef8e583e65d01b67190322 (diff)
downloadmerchant-7a62a58ef80dc3e2d546b60303d6554a46b01c38.tar.gz
merchant-7a62a58ef80dc3e2d546b60303d6554a46b01c38.tar.bz2
merchant-7a62a58ef80dc3e2d546b60303d6554a46b01c38.zip
fix doc compilation error
Diffstat (limited to 'doc/manual.texi')
-rw-r--r--doc/manual.texi135
1 files changed, 72 insertions, 63 deletions
diff --git a/doc/manual.texi b/doc/manual.texi
index bc4742f1..c4c28d24 100644
--- a/doc/manual.texi
+++ b/doc/manual.texi
@@ -741,69 +741,6 @@ reachable. Production systems should be configured to bind
to a UNIX domain socket or properly restrict access to the
port.
-@chapter Configuration in Taler
-
-In Taler realm, any component obeys to the same pattern to get configuration
-values. According to this pattern, once the component has been installed, the
-installation deploys default values in @code{$@{prefix@}/share/taler/config.d/}, in
-@emph{.conf} files. In order to override these defaults, the user can write a custom
-@emph{.conf} file and either pass it to the component at execution time, or name it
-@code{taler.conf} and place it under @code{$HOME/.config/}.
-
-A config file is a text file containing `sections`, and each section contains
-its `values`. The right format follows::
-
-@smallexample
-[section1]
-value1 = string
-value2 = 23
-
-[section2]
-value21 = string
-value22 = /path22
-@end smallexample
-
-Throughout any configuration file, it is possible to use @emph{$}-prefixed variables,
-like @code{$VAR}, especially when they represent filesystem paths.
-It is also possible to provide defaults values for those variables that are unset,
-by using the following syntax: @code{$@{VAR:-default@}}.
-However, there are two ways a user can set @emph{$}-prefixable variables:
-
-by defining them under a @code{[paths]} section, see example below,
-
-@smallexample
-[paths]
-TALER_DEPLOYMENT_SHARED = ${HOME}/shared-data
-..
-[section-x]
-path-x = ${TALER_DEPLOYMENT_SHARED}/x
-@end smallexample
-
-or by setting them in the environment
-
-@smallexample
-$ export VAR=/x
-@end smallexample
-
-The configuration loader will give precedence to variables set under @code{[path]},
-though.
-
-The utility @code{taler-config}, which gets installed along with the exchange,
-serves to get and set configuration values without directly editing the @emph{.conf}.
-The option @code{-f} is particularly useful to resolve pathnames, when they use
-several levels of @emph{$}-expanded variables. See @code{taler-config --help}.
-
-Note that, in this stage of development, the file @code{$HOME/.config/taler.conf}
-can contain sections for @emph{all} the component. For example, both an exchange and
-a bank can read values from it.
-
-The repository @emph{git://taler.net/deployment} contains examples of configuration
-file used in our demos. See under @code{deployment/config}.
-
-Expectably, some components will not work just by using default values, as their
-work is often interdependent. For example, a merchant needs to know an exchange
-URL, or a database name.
-
@node Testing
@chapter Testing
@@ -912,11 +849,83 @@ $ taler-merchant-dbinit -r
@chapter Advanced topics
@menu
+* Configuration in Taler:: Configuration patterns
* Using taler-config:: Introduction to the taler-config tool
* Key management:: Managing the merchant's cryptographic keys
* SEPA configuration:: Configuring a SEPA bank account
@end menu
+@node Configuration in Taler
+@section Configuration in Taler
+@cindex configuration
+
+In Taler realm, any component obeys to the same pattern to get configuration
+values. According to this pattern, once the component has been installed, the
+installation deploys default values in @cite{$@{prefix@}/share/taler/config.d/}, in
+@cite{.conf} files. In order to override these defaults, the user can write a custom
+@cite{.conf} file and either pass it to the component at execution time, or name it
+@cite{taler.conf} and place it under @cite{$HOME/.config/}.
+
+
+A config file is a text file containing @cite{sections}, and each section contains
+its @cite{values}. The right format follows:
+
+@example
+[section1]
+value1 = string
+value2 = 23
+
+[section2]
+value21 = string
+value22 = /path22
+@end example
+
+Throughout any configuration file, it is possible to use @code{$}-prefixed variables,
+like @code{$VAR}, especially when they represent filesystem paths.
+It is also possible to provide defaults values for those variables that are unset,
+by using the following syntax: @code{$@{VAR:-default@}}.
+However, there are two ways a user can set @code{$}-prefixable variables:
+
+by defining them under a @code{[paths]} section, see example below,
+
+@example
+[paths]
+TALER_DEPLOYMENT_SHARED = $@{HOME@}/shared-data
+..
+[section-x]
+path-x = $@{TALER_DEPLOYMENT_SHARED@}/x
+@end example
+
+or by setting them in the environment:
+
+@example
+$ export VAR=/x
+@end example
+
+The configuration loader will give precedence to variables set under @code{[path]},
+though.
+
+The utility @code{taler-config}, which gets installed along with the exchange, serves
+to get and set configuration values without directly editing the @cite{.conf}.
+The option @code{-f} is particularly useful to resolve pathnames, when they use
+several levels of @code{$}-expanded variables. See @code{taler-config --help}.
+
+Note that, in this stage of development, the file @code{$HOME/.config/taler.conf}
+can contain sections for @emph{all} the component. For example, both an exchange and
+a bank can read values from it.
+
+The repository @code{git://taler.net/deployment} contains examples of configuration
+file used in our demos. See under @code{deployment/config}.
+
+@cartouche
+@quotation Note
+Expectably, some components will not work just by using default values, as their
+work is often interdependent. For example, a merchant needs to know an exchange
+URL, or a database name.
+@end quotation
+@end cartouche
+
+
@node Using taler-config
@section Using taler-config
@cindex taler-config