aboutsummaryrefslogtreecommitdiff
path: root/doc/taler-config.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/taler-config.texi')
-rw-r--r--doc/taler-config.texi47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/taler-config.texi b/doc/taler-config.texi
new file mode 100644
index 000000000..efca5a2d7
--- /dev/null
+++ b/doc/taler-config.texi
@@ -0,0 +1,47 @@
+@c This file is used both in the exchange and merchant
+@c manuals. Edits should be propagated to both Gits!
+
+@node Using taler-config
+@section Using taler-config
+@cindex taler-config
+
+The tool @code{taler-config} can be used to
+extract or manipulate configuration values; however, the configuration
+use the well-known INI file format and can also be edited by hand.
+
+Run
+@example
+$ taler-config -s $SECTION
+@end example
+to list all of the configuration values in section @code{$SECTION}.
+
+Run
+@example
+$ taler-config -s $section -o $option
+@end example
+to extract the respective configuration value for option @code{$option}
+in section @code{$section}.
+
+Finally, to change a setting, run
+@example
+$ taler-config -s $section -o $option -V $value
+@end example
+to set the respective configuration value to @code{$value}. Note that you have to
+manually restart the Taler backend after you change the configuration to
+make the new configuration go into effect.
+
+Some default options will use $-variables, such as @code{$DATADIR}
+within their value. To expand the @code{$DATADIR} or other $-variables
+in the configuration, pass the @code{-f} option to
+@code{taler-config}. For example, compare:
+@example
+$ taler-config -s ACCOUNT-bank \
+ -o WIRE_RESPONSE
+$ taler-config -f -s ACCOUNT-bank \
+ -o WIRE_RESPONSE
+@end example
+
+While the configuration file is typically located at
+@code{$HOME/.config/taler.conf}, an alternative location can be
+specified to @code{taler-merchant-httpd} and @code{taler-config} using
+the @code{-c} option.