summaryrefslogtreecommitdiff
path: root/doc/anastasis-reducer.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/anastasis-reducer.1')
-rw-r--r--doc/anastasis-reducer.193
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/anastasis-reducer.1 b/doc/anastasis-reducer.1
new file mode 100644
index 0000000..8a79075
--- /dev/null
+++ b/doc/anastasis-reducer.1
@@ -0,0 +1,93 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "ANASTASIS-REDUCER" "1" "Jul 18, 2021" "0.0" "Anastasis"
+.SH NAME
+anastasis-reducer \- anastasis CLI frontend
+.
+.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
+..
+.SH SYNOPSIS
+.sp
+\fBanastasis\-reducer\fP
+[\fB\-a**_*JSON*_|_\fP–arguments=\fIJSON\fP]
+[\fB\-b**_|_\fP–backup]
+[\fB\-c\fP\ \fIFILENAME\fP\ |\ \fB––config=\fP‌\fIFILENAME\fP]
+[\fB\-h\fP\ |\ \fB––help\fP]
+[\fB\-L\fP\ \fILOGLEVEL\fP\ |\ \fB––loglevel=\fP‌\fILOGLEVEL\fP]
+[\fB\-l\fP\ \fIFILENAME\fP\ |\ \fB––logfile=\fP‌\fIFILENAME\fP]
+[\fB\-r**_|_\fP–restore]
+[\fB\-v\fP\ |\ \fB––version\fP] COMMAND
+.SH DESCRIPTION
+.sp
+\fBanastasis\-reducer\fP is a command\-line tool to run Anastasis
+key recover and backup operations using a reducer\-style interface.
+The reducer will read the current state from standard input and
+write the resulting state to standard output. A COMMAND must
+be given on the command line. The arguments (if any) are to
+be given in JSON format to the \fB\-a\fP option. A list of
+commands can be found in the \&../reducer
+chapter.
+.INDENT 0.0
+.TP
+\fB\-a\fP \fIJSON\fP | \fB––arguments=\fP\fIJSON\fP
+Provide JSON inputs for the given command.
+.TP
+\fB\-b\fP | \fB–backup\fP
+Begin fresh reducer operation for a back up operation.
+.TP
+\fB\-c\fP \fIFILENAME\fP | \fB––config=\fP‌\fIFILENAME\fP
+Use the configuration from \fIFILENAME\fP\&.
+.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\-l\fP \fIFILENAME\fP | \fB––logfile=\fP‌\fIFILENAME\fP
+Send logging output to \fIFILENAME\fP\&.
+.TP
+\fB\-r\fP | \fB–restore\fP
+Begin fresh reducer operation for a restore operation.
+.TP
+\fB\-v\fP | \fB––version\fP
+Print version information.
+.UNINDENT
+.SH SEE ALSO
+.sp
+anastasis\-gtk(1), anastasis\-httpd(1), anastasis.conf(5).
+.SH BUGS
+.sp
+Report bugs by using \fI\%https://bugs.anastasis.lu/\fP or by sending electronic
+mail to <\fI\%contact@anastasis.lu\fP>.
+.SH AUTHOR
+Anastasis SARL
+.SH COPYRIGHT
+2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+)
+.\" Generated by docutils manpage writer.
+.