commit 0964251471216b8b256247d7abb453734d420f94 parent b49c2ffa2c8d469e23c64e66e32e913b9e456704 Author: Florian Dold <dold@taler.net> Date: Sat, 29 Aug 2026 21:36:13 +0200 merchant man pages: document program exit codes Diffstat:
16 files changed, 248 insertions(+), 0 deletions(-)
diff --git a/manpages/taler-merchant-benchmark.1.rst b/manpages/taler-merchant-benchmark.1.rst @@ -79,6 +79,21 @@ Common Options **-v** \| **--version** Print version information. +Exit Status +=========== + +``0`` + The benchmark completed successfully. + +``1`` + The benchmark failed. + +``2`` + The command-line arguments are invalid. + +``6`` + A required configuration setting is missing or invalid. + See Also ======== diff --git a/manpages/taler-merchant-config.1.rst b/manpages/taler-merchant-config.1.rst @@ -78,6 +78,21 @@ Description **-v** \| **--version** Print GNU Taler version number. +Exit Status +=========== + +``0`` + The requested operation completed successfully. + +``1`` + The default configuration could not be loaded for a rewrite operation. + +``2`` + The arguments are invalid or the configuration file could not be written. + +``6`` + The requested configuration setting is missing or invalid. + See Also diff --git a/manpages/taler-merchant-dbconfig.1.rst b/manpages/taler-merchant-dbconfig.1.rst @@ -49,6 +49,19 @@ Its options are as follows: **-u** *USER* Specifies the (main) merchant user that will access the database. +Exit Status +=========== + +``0`` + The database was configured successfully. + +``1`` + An argument, prerequisite, permission, or database operation caused setup + to fail. + +The script may also propagate another non-zero status from a utility it +invokes, such as **taler-merchant-config**. + See Also ======== diff --git a/manpages/taler-merchant-dbinit.1.rst b/manpages/taler-merchant-dbinit.1.rst @@ -55,6 +55,18 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + The requested database operation completed successfully. + +``1`` + A database connection or operation failed. + +``3`` + Command-line or configuration processing failed. + See Also ======== diff --git a/manpages/taler-merchant-depositcheck.1.rst b/manpages/taler-merchant-depositcheck.1.rst @@ -76,6 +76,28 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``5`` + A required worker process is unavailable or failed. + +``6`` + A required configuration setting is missing or invalid. + +``9`` + A hard failure occurred. Automatic restart should be suppressed until an + operator has intervened. + See Also ======== diff --git a/manpages/taler-merchant-donaukeyupdate.1.rst b/manpages/taler-merchant-donaukeyupdate.1.rst @@ -71,6 +71,18 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + See Also ======== diff --git a/manpages/taler-merchant-exchangekeyupdate.1.rst b/manpages/taler-merchant-exchangekeyupdate.1.rst @@ -70,6 +70,21 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``6`` + A required configuration setting is missing or invalid. + See Also ======== diff --git a/manpages/taler-merchant-httpd.1.rst b/manpages/taler-merchant-httpd.1.rst @@ -78,6 +78,31 @@ SIGTERM Sending a SIGTERM to the process will cause it to shutdown cleanly. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``4`` + Required database access is unavailable. + +``5`` + Required templates or single-page application resources are unavailable. + +``6`` + A required configuration setting is missing or invalid. + +``9`` + A hard failure occurred. Automatic restart should be suppressed until an + operator has intervened. + See Also ======== diff --git a/manpages/taler-merchant-kyccheck.1.rst b/manpages/taler-merchant-kyccheck.1.rst @@ -70,6 +70,21 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``6`` + A required configuration setting is missing or invalid. + See Also ======== diff --git a/manpages/taler-merchant-passwd.1.rst b/manpages/taler-merchant-passwd.1.rst @@ -57,6 +57,24 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + The password was updated successfully. + +``1`` + The merchant database could not be opened. + +``2`` + The requested merchant instance does not exist. + +``3`` + Command-line processing or a database operation failed. + +``255`` + The new password is missing or a superfluous positional argument was given. + See Also ======== diff --git a/manpages/taler-merchant-reconciliation.1.rst b/manpages/taler-merchant-reconciliation.1.rst @@ -71,6 +71,21 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Reconciliation completed without finding a problem. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``7`` + Reconciliation completed and found an inconsistency. + See Also ======== diff --git a/manpages/taler-merchant-report-generator-email.1.rst b/manpages/taler-merchant-report-generator-email.1.rst @@ -41,6 +41,18 @@ Its options are as follows: **-t** *ADDRESS* Specifies the target e-mail address for the report. +Exit Status +=========== + +``0`` + The report was sent successfully, or help was requested. + +``1`` + An argument is invalid or a required utility is unavailable. + +The script may also propagate another non-zero status from a utility it +invokes to prepare or send the message. + See Also ======== diff --git a/manpages/taler-merchant-report-generator.1.rst b/manpages/taler-merchant-report-generator.1.rst @@ -57,6 +57,24 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``5`` + The merchant database is unavailable. + +``6`` + A required configuration setting is missing or invalid. + See Also ======== diff --git a/manpages/taler-merchant-rproxy-setup.1.rst b/manpages/taler-merchant-rproxy-setup.1.rst @@ -76,6 +76,16 @@ Options **-h** \| **--help** Print short help on options. +Exit Status +=========== + +``0`` + The reverse proxy was configured successfully, or help was requested. + +``1`` + An argument, prerequisite, permission, DNS check, or configuration step + caused setup to fail. + See Also ======== diff --git a/manpages/taler-merchant-webhook.1.rst b/manpages/taler-merchant-webhook.1.rst @@ -56,6 +56,18 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + See Also ======== diff --git a/manpages/taler-merchant-wirewatch.1.rst b/manpages/taler-merchant-wirewatch.1.rst @@ -66,6 +66,25 @@ Its options are as follows: **-v** \| **–version** Print version information. +Exit Status +=========== + +``0`` + Successful termination. + +``1`` + An operational failure occurred. + +``2`` + The command-line arguments are invalid. + +``6`` + A required configuration setting is missing or invalid. + +``9`` + A hard failure occurred. Automatic restart should be suppressed until an + operator has intervened. + See Also ========