Asciidoc manpage support; abrt-action-mailx manpage

3 files changed, 108 insertions, 1 deletions

diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am
index 52006b5e..8744a7d9 100644
--- a/src/plugins/Makefile.am
+++ b/src/plugins/Makefile.am
@@ -60,6 +60,21 @@ man_MANS = \
     abrt-Upload.7 \
     abrt-plugins.7
 
+MAN_TXT = \
+    abrt-action-mailx.txt
+
+# Manual pages are generated from .txt via Docbook
+man1_MANS = ${MAN_TXT:%.txt=%.1}
+
+%.1 %.5 %.7: %.xml
+	xmlto man $<
+
+%.xml: %.txt ../../asciidoc.conf
+	asciidoc --backend=docbook --doctype=manpage --conf-file ../../asciidoc.conf -aabrt_version=$(PACKAGE_VERSION) -o $@ $<
+
+
+CLEANFILES = $(man1_MANS)
+
 PYTHON_FILES = \
     abrt-action-install-debuginfo.py \
     abrt-action-list-dsos.py \
@@ -67,6 +82,7 @@ PYTHON_FILES = \
 
 EXTRA_DIST = \
     $(man_MANS) \
+    $(MAN_TXT) \
     $(PYTHON_FILES) \
     report_Bugzilla.xml.in \
     report_Bugzilla.conf \
diff --git a/src/plugins/abrt-action-mailx.c b/src/plugins/abrt-action-mailx.c
index a4ee31cd..d1b35564 100644
--- a/src/plugins/abrt-action-mailx.c
+++ b/src/plugins/abrt-action-mailx.c
@@ -142,7 +142,7 @@ int main(int argc, char **argv)
     const char *program_usage_string = _(
         PROGNAME" [-v] -d DIR [-c CONFFILE]\n"
         "\n"
-        "Sends compressed tarball of dump directory DIR via email"
+        "Sends contents of a dump directory DIR via email"
     );
     enum {
         OPT_v = 1 << 0,
diff --git a/src/plugins/abrt-action-mailx.txt b/src/plugins/abrt-action-mailx.txt
new file mode 100644
index 00000000..2fb11bef
--- /dev/null
+++ b/src/plugins/abrt-action-mailx.txt
@@ -0,0 +1,91 @@
+abrt-action-mailx(1)
+====================
+
+NAME
+----
+abrt-action-mailx - Sends contents of a dump directory via email.
+
+SYNOPSIS
+--------
+'abrt-action-mailx' [-v] -d DIR [-c CONFFILE]
+
+DESCRIPTION
+-----------
+The tool reads a problem dump directory, composes an email message
+from the directory contents, and uses mailx to send the message to
+specified recipient.
+
+Properties of email messages can be specified in a configuration file,
+and via environment variables.
+
+Configuration file
+~~~~~~~~~~~~~~~~~~
+Configuration file contains entries in a format "Option = Value".
+
+The options are:
+
+'Subject'::
+       The subject of the email message.
+
+'EmailFrom'::
+       The sender of the email message.
+
+'EmailTo'::
+       The recipient of the email message.
+
+'SendBinaryData'::
+       Use yes/true/on/1 to attach all binary files from the dump
+       directory to the email. This can cause the emails to be very
+       large.
+
+Integration with ABRT events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'abrt-action-mailx' can be used as a reporter, to allow users report
+problems via email when they decide to do it. This usage is
+pre-configured in /etc/abrt/events.d/mailx_events.conf:
+
+------------
+EVENT=report_Mailx      abrt-action-mailx
+------------
+
+It can also be used to notify administrator automatically when a
+problem happens. When this is desired, modify the event configuration
+file to run the tool on the 'post-create' event:
+
+------------
+EVENT=post-create	abrt-action-mailx
+------------
+
+OPTIONS
+-------
+-d DIR::
+   Path to dump directory.
+
+-c CONFFILE::
+   Path to configration file. When used in ABRT event system, the file
+   contains site-wide configuration. Users can change the values via
+   environment variables.
+
+ENVIRONMENT VARIABLES
+---------------------
+Environment variables take precedence over values provided in
+the configuration file.
+
+'Mailx_Subject'::
+       Subject of the email message.
+
+'Mailx_EmailFrom'::
+       Sender of the email message.
+
+'Mailx_EmailTo'::
+       Recipient of the email message. If nor the environment variable
+       nor the corresponding option is defined, the message is send to
+       "root@localhost".
+
+'Mailx_SendBinaryData'::
+       Use yes/true/on/1 to attach all binary files from the dump
+       directory to the email.
+
+AUTHORS
+-------
+* ABRT team