From f44933abe753b26634b636e6a0c4a231b7e5b60b Mon Sep 17 00:00:00 2001 From: Michal Toman Date: Mon, 16 May 2011 13:45:23 +0200 Subject: retrace client: add manpage (trac #246) --- abrt.spec.in | 1 + src/plugins/Makefile.am | 3 +- src/plugins/abrt-retrace-client.txt | 84 +++++++++++++++++++++++++++++++++++++ 3 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 src/plugins/abrt-retrace-client.txt diff --git a/abrt.spec.in b/abrt.spec.in index cd42ddfe..b7ef9aa3 100644 --- a/abrt.spec.in +++ b/abrt.spec.in @@ -451,6 +451,7 @@ gtk-update-icon-cache %{_datadir}/icons/hicolor &>/dev/null || : %{_mandir}/man5/abrt_event.conf.5.gz # {_mandir}/man5/pyhook.conf.5.gz %{_mandir}/man7/abrt-plugins.7.gz +%{_mandir}/man1/abrt-retrace-client.1.gz %{_datadir}/dbus-1/system-services/com.redhat.abrt.service %files -n libreport diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am index df0ad944..37974dca 100644 --- a/src/plugins/Makefile.am +++ b/src/plugins/Makefile.am @@ -67,7 +67,8 @@ MAN_TXT = \ abrt-action-analyze-backtrace.txt \ abrt-action-mailx.txt \ abrt-action-bugzilla.txt \ - abrt-action-list-dsos.txt + abrt-action-list-dsos.txt \ + abrt-retrace-client.txt # Manual pages are generated from .txt via Docbook man1_MANS = ${MAN_TXT:%.txt=%.1} diff --git a/src/plugins/abrt-retrace-client.txt b/src/plugins/abrt-retrace-client.txt new file mode 100644 index 00000000..9ae536bd --- /dev/null +++ b/src/plugins/abrt-retrace-client.txt @@ -0,0 +1,84 @@ +abrt-retrace-client(1) +====================== + +NAME +---- +abrt-retrace-client - Handles the communication with Retrace server. + +SYNOPSIS +-------- +'abrt-retrace-client' [options] + +DESCRIPTION +----------- +This tool is able to comunicate with Retrace server: create a new task, +ask about task's status, download log or backtrace of a finished task. + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-retrace-client' can be used as an analyzer for +application crashes which dump core. + +Example usage in abrt_event.conf: + +------------ +EVENT=analyze analyzer=CCpp + abrt-retrace-client +------------ + +OPERATIONS +---------- +create:: + Creates a new task. Prints task ID and password to stdout. + Either -d or -c is required. + +status:: + Prints task\'s status to stdout. Both -t and -p are required. + +log:: + Prints finished task\'s log to stdout. Both -t and -p are required. + +backtrace:: + Print finished task\'s backtrace to stdout. Both -t and -p are required. + +batch:: + Runs all operations in one step: creates a new task, periodically + asks for status and downloads the result when finished. If the task + was successful, backtrace file is saved, otherwise log is printed + to stdout. Either -c or -d is required. + +OPTIONS +------- +-v, --verbose:: + be verbose + +-s, --syslog:: + log to syslog + +-k, --insecure:: + allow insecure connection to retrace server + +--url URL:: + retrace server URL + +--headers:: + (debug) show received HTTP headers + +-d, --dir DIR:: + read data from ABRT crash dump directory + +-c, --core COREDUMP:: + read data from coredump + +--no-unlink:: + (debug) do not delete temporary archive created in /tmp + +-t, --task ID:: + ID of the task on server + +-p, --password PWD:: + password of the task on server + +AUTHORS +------- +* ABRT team -- cgit