diff options
Diffstat (limited to 'frags/using-taler-config.rst')
| -rw-r--r-- | frags/using-taler-config.rst | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/frags/using-taler-config.rst b/frags/using-taler-config.rst index c15df84b..ba4febb4 100644 --- a/frags/using-taler-config.rst +++ b/frags/using-taler-config.rst @@ -1,9 +1,11 @@ Using taler-config ------------------ -The tool ``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. +The tool ``taler-config`` can be used to extract or manipulate configuration +values; however, the configuration use the well-known INI file format and is +generally better edited by hand to preserve comments and structure. Thus, ``taler-config`` should primarily be used +to inspect or understand a configuration that is in place, +and not to update it! Run @@ -17,19 +19,21 @@ Run .. code-block:: console - $ taler-config -s $section -o $option + $ taler-config -s $SECTION -o $OPTION -to extract the respective configuration value for option ``$option`` in -section ``$section``. +to extract the respective configuration value for option ``$OPTION`` in +section ``$SECTION``. -Finally, to change a setting, run +Finally, to change a setting and clobber your entire +configuration file structure, inlining all values and +removing all comments, run .. code-block:: console - $ taler-config -s $section -o $option -V $value + $ taler-config -s $SECTION -o $OPTION -V $VALUE -to set the respective configuration value to ``$value``. Note that you -have to manually restart the Taler backend after you change the +to set the respective configuration value to ``$VALUE``. Note that you +have to manually restart affected Taler components after you change the configuration to make the new configuration go into effect. Some default options will use $-variables, such as ``$DATADIR`` within @@ -39,12 +43,9 @@ compare: .. code-block:: console - $ taler-config -s ACCOUNT-bank \ - -o WIRE_RESPONSE - $ taler-config -f -s ACCOUNT-bank \ - -o WIRE_RESPONSE + $ taler-config --section exchange-offline --option MASTER_PRIV_FILE + $ taler-config -f --section exchange-offline --option MASTER_PRIV_FILE While the configuration file is typically located at -``$HOME/.config/taler.conf``, an alternative location can be specified -to ``taler-merchant-httpd`` and ``taler-config`` using the ``-c`` -option. +``$HOME/.config/taler.conf``, an alternative location can be specified to any +GNU Taler component using the ``-c`` option. |