summaryrefslogtreecommitdiff
path: root/man/taler-auditor-sync.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/taler-auditor-sync.1')
-rw-r--r--man/taler-auditor-sync.195
1 files changed, 95 insertions, 0 deletions
diff --git a/man/taler-auditor-sync.1 b/man/taler-auditor-sync.1
new file mode 100644
index 00000000..55a33fb2
--- /dev/null
+++ b/man/taler-auditor-sync.1
@@ -0,0 +1,95 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "TALER-AUDITOR-SYNC" "1" "Apr 12, 2024" "0.9" "GNU Taler"
+.SH NAME
+taler-auditor-sync \- tool to safely synchronize auditor database
+.SH SYNOPSIS
+.sp
+\fBtaler\-auditor\-sync\fP
+[\fB\-s\fP\ \fIFILENAME\fP\ |\ \fB–source\-configuration=\fP‌\fIFILENAME\fP]
+[\fB\-d\fP\ \fIFILENAME\fP\ |\ \fB–destination\-configuration=\fP‌\fIFILENAME\fP]
+[\fB\-h\fP\ |\ \fB–help\fP]
+[\fB\-b\fP\ \fISIZE\fP\ |\ \fB–batch=\fP‌\fISIZE\fP]
+[\fB\-t\fP\ |\ \fB–terminate\-when\-synchronized\fP]
+[\fB\-v\fP\ |\ \fB–version\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB–loglevel=\fP‌\fILOGLEVEL\fP]
+.SH DESCRIPTION
+.sp
+\fBtaler\-auditor\-sync\fP 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), \fBtaler\-auditor\-sync\fP will not replicate those changes
+and instead halt with an error.
+.sp
+Its options are as follows:
+.INDENT 0.0
+.TP
+\fB\-s\fP \fIFILENAME\fP | \fB–source\-configuration=\fP‌\fIFILENAME\fP
+Use the configuration in \fIFILENAME\fP to access the original (source) exchange
+database to copy records from.
+.TP
+\fB\-d\fP \fIFILENAME\fP | \fB–destination\-configuration=\fP‌\fIFILENAME\fP
+Use the configuration in \fIFILENAME\fP to access the target (destination) exchange
+database to copy records to.
+.TP
+\fB\-t\fP | \fB–terminate\-when\-synchronized\fP
+The program should exit once the two databases are in sync, instead of continuously
+copying more records when the source database is updated.
+.TP
+\fB\-h\fP | \fB–help\fP
+Print short help on options.
+.TP
+\fB\-L\fP \fILOGLEVEL\fP | \fB–loglevel=\fP‌\fILOGLEVEL\fP
+Specifies the log level to use. Accepted values are: \fBDEBUG\fP, \fBINFO\fP,
+\fBWARNING\fP, \fBERROR\fP\&.
+.TP
+\fB\-b\fP \fISIZE\fP | \fB–batch=\fP‌\fISIZE\fP
+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 \fB\-t\fP is used.
+.TP
+\fB\-v\fP | \fB–version\fP
+Print version information.
+.UNINDENT
+.SH SEE ALSO
+.sp
+taler\-auditor(1), taler.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.taler.net/\fP or by sending electronic
+mail to <\fI\%taler@gnu.org\fP>.
+.SH AUTHOR
+GNU Taler contributors
+.SH COPYRIGHT
+2014-2024 Taler Systems SA (GPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.