doc: Add man page for dovecot-sysreport

diff --git a/.gitignore b/.gitignore
index e85788532bf1eb5e74716bd5c3319af9f8026a99..35506f068906a9cc6b4c191d53e17f98923b54a6 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -97,6 +97,7 @@ doc/man/doveadm.1
 doc/man/doveconf.1
 doc/man/dovecot-lda.1
 doc/man/dovecot.1
+doc/man/dovecot-sysreport.1
 
 doc/example-config/README
 doc/wiki/*.txt

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 727f0d300fc4acd3aac9aa5914eb9721ebb52bbe..0b0b8fbb4dc02bdc17e1751d525565d2cd1cc8d9 100644 (file)
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -54,7 +54,8 @@ nodist_man1_MANS = \
        doveadm-who.1 \
        doveconf.1 \
        dovecot.1 \
-       dovecot-lda.1
+       dovecot-lda.1 \
+       dovecot-sysreport.1
 
 man_includefiles = \
        $(srcdir)/global-options-formatter.inc \
@@ -106,6 +107,7 @@ EXTRA_DIST = \
        doveconf.1.in \
        dovecot.1.in \
        dovecot-lda.1.in \
+       dovecot-sysreport.1.in \
        sed.sh \
        $(man_includefiles)
 

diff --git a/doc/man/dovecot-sysreport.1.in b/doc/man/dovecot-sysreport.1.in
new file mode 100644 (file)
index 0000000..bd73621
--- /dev/null
+++ b/doc/man/dovecot-sysreport.1.in
@@ -0,0 +1,40 @@
+.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
+.TH DOVECOT-SYSREPORT 1 "2020-01-21" "Dovecot v2.3" "Dovecot"
+.SH NAME
+dovecot-sysreport \- Dovecot\(aqs system report utility
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR dovecot-sysreport " [" \-h|\-\-help "] [" \-c|\-\-core
+.IR binary " " core "]
+.BR "[\-d|\-\-destination
+.IR dest "]
+.BR "[\-k|\-\-keeptemp]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+.B dovecot-sysreport
+is a utility that should be used to gather information from the current
+system to be reported for dovecot bug fixes. It will collect dovecot's
+ps output, service status, process status, uptime command's output,
+error log, stats dump and if given, a core file along with its binary
+dependencies.
+.\"------------------------------------------------------------------------
+.SH OPTIONS
+.TP
+.B \-h|\-\-help
+Prints a help message.
+.TP
+.BI \-c|\-\-config\  root_config_file
+Sets the root file of the dovecot's configuration. If not set, it will be
+assumed to be in the default configuration path.
+.TP
+.BI \-o|\-\-core\  "binary\  core"
+Includes a core file along with its dependencies extracted from the
+specified binary file.
+.TP
+.BI \-d|\-\-destination\  dest
+Sets the file location which the report archive should be put to. The default 
+value is dovecot-sysreport-<hostname>-<current_timestamp>.tar.gz in the
+current path.
+.TP
+.B \-k|\-\-keeptemp
+If set, temp files would not be deleted at the end.
\ No newline at end of file