summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-01-13 21:27:25 +0100
committerChristian Grothoff <christian@grothoff.org>2021-01-13 21:27:25 +0100
commitbc99e88764505e05ac35682d9791e70143243152 (patch)
tree3b23a53ae50b2d0ddfdfb24b555c366ce7329b15 /manpages
parent835c23f9ce34e0cb1a6070c34b34ede260a9a60a (diff)
downloaddocs-bc99e88764505e05ac35682d9791e70143243152.tar.gz
docs-bc99e88764505e05ac35682d9791e70143243152.tar.bz2
docs-bc99e88764505e05ac35682d9791e70143243152.zip
man page for taler-auditor-sync
Diffstat (limited to 'manpages')
-rw-r--r--manpages/taler-auditor-sync.1.rst73
1 files changed, 73 insertions, 0 deletions
diff --git a/manpages/taler-auditor-sync.1.rst b/manpages/taler-auditor-sync.1.rst
new file mode 100644
index 0000000..d23624e
--- /dev/null
+++ b/manpages/taler-auditor-sync.1.rst
@@ -0,0 +1,73 @@
+taler-auditor-sync(1)
+#####################
+
+.. only:: html
+
+ Name
+ ====
+
+ **taler-auditor-sync** - create a "safe" synchronized copy of a Taler exchange database for an audit
+
+
+Synopsis
+========
+
+**taler-auditor-sync**
+[**-s** *FILENAME* | **––source-configuration=**\ ‌\ *FILENAME*]
+[**-d** *FILENAME* | **––destination-configuration=**\ ‌\ *FILENAME*]
+[**-h** | **––help**]
+[**-b** *SIZE* | **––batch=**\ ‌\ *SIZE*]
+[**-t** | **––terminate-when-synchronized**]
+[**-v** | **––version**]
+[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
+
+Description
+===========
+
+**taler-auditor-sync** is a command-line tool to synchronize the
+Taler auditor's database in a safe way from a Taler exchange
+database. If the exchange database violates the assumed database
+invariants (as expressed by database constraints) or attempts to
+DELETE or UPDATE tables (at least those that the auditor relies
+upon), **taler-auditor-sync** will not replicate those changes
+and instead halt with an error.
+
+Its options are as follows:
+
+**-s** *FILENAME* \| **––source-configuration=**\ ‌\ *FILENAME*
+ Use the configuration in *FILENAME* to access the original (source) exchange
+ database to copy records from.
+
+**-d** *FILENAME* \| **––destination-configuration=**\ ‌\ *FILENAME*
+ Use the configuration in *FILENAME* to access the target (destination) exchange
+ database to copy records to.
+
+**-t** \| **––terminate-when-synchronized**
+ The program should exit once the two databases are in sync, instead of continuously
+ copying more records when the source database is updated.
+
+**-h** \| **––help**
+ Print short help on options.
+
+**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
+ Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
+ ``WARNING``, ``ERROR``.
+
+**-b** *SIZE* \| **––batch=**\ ‌\ *SIZE*
+ Target number of records to copy in one transaction. Once the databases are
+ in sync, the batch size is used to determine how long the process sleeps before
+ trying to again synchronize the two databases. Not useful if **-t** is used.
+
+**-v** \| **––version**
+ Print version information.
+
+See Also
+========
+
+taler-auditor(1), taler.conf(5).
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net/ or by sending electronic
+mail to <taler@gnu.org>.