summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDenys Vlasenko <dvlasenk@redhat.com>2011-05-04 00:15:14 +0200
committerDenys Vlasenko <dvlasenk@redhat.com>2011-05-04 00:15:14 +0200
commit27e7d86db7c6c96e8da75e8e8dda6359b9e73c41 (patch)
treed2604d41c74bf43a733df8cc7d0fe144d49b62a4
parent05d4e677b2754690d0d0b9e2dff1ea6db42681ae (diff)
downloadabrt-27e7d86db7c6c96e8da75e8e8dda6359b9e73c41.tar.gz
abrt-27e7d86db7c6c96e8da75e8e8dda6359b9e73c41.tar.xz
abrt-27e7d86db7c6c96e8da75e8e8dda6359b9e73c41.zip
add abrt-action-print manpage. Closes #238
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
-rw-r--r--abrt.spec.in1
-rw-r--r--src/plugins/Makefile.am1
-rw-r--r--src/plugins/abrt-action-print.c2
-rw-r--r--src/plugins/abrt-action-print.txt63
4 files changed, 66 insertions, 1 deletions
diff --git a/abrt.spec.in b/abrt.spec.in
index 396d6308..81163f83 100644
--- a/abrt.spec.in
+++ b/abrt.spec.in
@@ -563,6 +563,7 @@ fi
%{_sysconfdir}/%{name}/events/report_Logger.conf
%{_mandir}/man7/abrt-Logger.7.gz
%{_bindir}/abrt-action-print
+%{_mandir}/man*/abrt-action-print.*
%files plugin-mailx
%defattr(-,root,root,-)
diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am
index 1a538151..bf7cf966 100644
--- a/src/plugins/Makefile.am
+++ b/src/plugins/Makefile.am
@@ -61,6 +61,7 @@ man_MANS = \
abrt-plugins.7
MAN_TXT = \
+ abrt-action-print.txt \
abrt-action-trim-files.txt \
abrt-action-generate-backtrace.txt \
abrt-action-analyze-backtrace.txt \
diff --git a/src/plugins/abrt-action-print.c b/src/plugins/abrt-action-print.c
index f76abf86..aa61563c 100644
--- a/src/plugins/abrt-action-print.c
+++ b/src/plugins/abrt-action-print.c
@@ -36,7 +36,7 @@ int main(int argc, char **argv)
/* Can't keep these strings/structs static: _() doesn't support that */
const char *program_usage_string = _(
- PROGNAME" [-v] -d DIR [-o FILE] [-a yes/no]\n"
+ PROGNAME" [-v] -d DIR [-o FILE] [-a yes/no] [-r]\n"
"\n"
"Prints problem information to standard output or FILE"
);
diff --git a/src/plugins/abrt-action-print.txt b/src/plugins/abrt-action-print.txt
new file mode 100644
index 00000000..200ea671
--- /dev/null
+++ b/src/plugins/abrt-action-print.txt
@@ -0,0 +1,63 @@
+abrt-action-print(1)
+====================
+
+NAME
+----
+abrt-action-print - Prints problem information to standard output or FILE.
+
+SYNOPSIS
+--------
+'abrt-action-print' [-v] [-d DIR] [-o FILE] [-a yes/no] [-r]
+
+DESCRIPTION
+-----------
+The tool reads dump directory DIR and prints its text representation
+to stdout or to a specified FILE.
+
+Integration with ABRT events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'abrt-action-print' can be used as a reporter, to allow users
+to report problems by writinf them to a file. Example:
+
+------------
+EVENT=report abrt-action-print -o "${Log_File:-/tmp/abrt.log}"
+------------
+
+OPTIONS
+-------
+-d DIR::
+ Path to dump directory.
+
+-v::
+ Be more verbose. Can be given multiple times.
+
+-o FILE::
+ Output file
+
+-a yes/no::
+ If -o FILE is specified, controls whether FILE is appended to, or overwritten.
+
+-r::
+ Add a recor to 'reported_to' in DIR which specifies that this problem
+ was reported. Some tools use this to differentiate between problems
+ which were and weren't yet reported.
+
+Output format
+~~~~~~~~~~~~~
+The output is designed to be machine-parseable. The elements which have only
+one line are printed in the form
+
+ NAME:<whitespace>VALUE
+
+Elements which have more than one line are printed in the form
+
+ NAME:
+ :LINE1
+ :LINE2
+ :LINE3
+
+Output may contain empty lines for better readability.
+
+AUTHORS
+-------
+* ABRT team