add abrt-action-kerneloops man page (trac#235)

3 files changed, 70 insertions, 0 deletions

diff --git a/abrt.spec.in b/abrt.spec.in
index 49168082..600a142c 100644
--- a/abrt.spec.in
+++ b/abrt.spec.in
@@ -529,6 +529,7 @@ gtk-update-icon-cache %{_datadir}/icons/hicolor &>/dev/null || :
 %{_sysconfdir}/%{name}/events/report_Kerneloops.xml
 %config(noreplace) %{_sysconfdir}/%{name}/events.d/koops_events.conf
 %{_initrddir}/abrt-oops
+%{_mandir}/man*/abrt-action-kerneloops.*
 %{_mandir}/man7/abrt-KerneloopsReporter.7.gz
 %{_bindir}/abrt-dump-oops
 %{_bindir}/abrt-action-analyze-oops
diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am
index e5bcf7dc..59da3702 100644
--- a/src/plugins/Makefile.am
+++ b/src/plugins/Makefile.am
@@ -68,6 +68,7 @@ MAN_TXT = \
     abrt-action-mailx.txt \
     abrt-action-bugzilla.txt \
     abrt-action-list-dsos.txt \
+    abrt-action-kerneloops.txt \
     abrt-retrace-client.txt
 
 # Manual pages are generated from .txt via Docbook
diff --git a/src/plugins/abrt-action-kerneloops.txt b/src/plugins/abrt-action-kerneloops.txt
new file mode 100644
index 00000000..0a49a4b5
--- /dev/null
+++ b/src/plugins/abrt-action-kerneloops.txt
@@ -0,0 +1,68 @@
+abrt-action-kerneloops(1)
+=========================
+
+NAME
+----
+abrt-action-kerneloops - Reports kernel oops to kerneloops.org (or similar)
+site.
+
+SYNOPSIS
+--------
+'abrt-action-kerneloops' [-v] [-c CONFFILE]... [ -d DIR ]
+
+DESCRIPTION
+-----------
+The tool is used to report the crash to the Kerneloops tracker.
+
+Configuration file
+~~~~~~~~~~~~~~~~~~
+Configuration file contains entries in a format "Option = Value".
+
+The options are:
+
+'SubmitURL'::
+        The URL of the kerneloops tracker, the default is
+        "http://submit.kerneloops.org/submitoops.php".
+
+Integration with ABRT events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'abrt-action-kerneloops' can be used as a reporter, to allow users to report
+problems to the Kerneloops tracker. This usage is pre-configured in
+/etc/abrt/events.d/koops_events.conf:
+
+------------
+EVENT=report_Kerneloops analyzer=Kerneloops abrt-action-kerneloops
+------------
+
+It can be also used automatically and immediately without user interaction.
+When this is desired, modify the event configuration file to run the tool on
+the 'post-create' event:
+
+------------
+EVENT=post-create analyzer=Kerneloops  abrt-action-kerneloops
+------------
+
+OPTIONS
+-------
+-v::
+   Be more verbose. Can be given multiple times.
+
+-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.
+
+'KerneloopsReporter_SubmitURL'::
+        The URL of the kerneloops tracker.
+
+AUTHORS
+-------
+* ABRT team