diff options
author | Denys Vlasenko <dvlasenk@redhat.com> | 2011-05-04 17:05:20 +0200 |
---|---|---|
committer | Denys Vlasenko <dvlasenk@redhat.com> | 2011-05-04 17:05:20 +0200 |
commit | fc6c27a7a09135166b79c594972b04c457b7f16c (patch) | |
tree | ad14b975abcd9af10de1538d2792552fd8ff581d | |
parent | 17e63b2a00006e2215e9e4c58d0fed51e003b06a (diff) | |
download | abrt-fc6c27a7a09135166b79c594972b04c457b7f16c.tar.gz abrt-fc6c27a7a09135166b79c594972b04c457b7f16c.tar.xz abrt-fc6c27a7a09135166b79c594972b04c457b7f16c.zip |
abrt-cli: update manpage. Closes #243
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
-rw-r--r-- | src/cli/Makefile.am | 20 | ||||
-rw-r--r-- | src/cli/abrt-cli.1 | 58 | ||||
-rw-r--r-- | src/cli/abrt-cli.txt | 70 |
3 files changed, 88 insertions, 60 deletions
diff --git a/src/cli/Makefile.am b/src/cli/Makefile.am index 18ff434e..7f46a152 100644 --- a/src/cli/Makefile.am +++ b/src/cli/Makefile.am @@ -41,8 +41,24 @@ abrt_handle_crashdump_CPPFLAGS = \ abrt_handle_crashdump_LDADD = \ ../lib/libreport.la -man_MANS = abrt-cli.1 -EXTRA_DIST = $(man_MANS) +MAN_TXT = \ + abrt-cli.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 \ + abrt-action-analyze-core.py completiondir = $(sysconfdir)/bash_completion.d dist_completion_DATA = abrt-cli.bash diff --git a/src/cli/abrt-cli.1 b/src/cli/abrt-cli.1 deleted file mode 100644 index 9e0a630e..00000000 --- a/src/cli/abrt-cli.1 +++ /dev/null @@ -1,58 +0,0 @@ -.TH abrt\-cli "1" "12 Oct 2009" "" -.SH NAME -abrt\-cli \- a command line interface to abrt -.SH SYNOPSIS -.B abrt\-cli -[option] -.SH DESCRIPTION -.I abrt\-cli -is a command line tool that manages application crashes catched by -.I abrtd -daemon. It enables access to problem data, and allows to report -problems depending on active abrt plugins. -.SH OPTIONS -.B Basic startup options -.IP "\-V, \-\-version" -Displays version of abrt\-cli. -.IP "\-?, \-\-help" -Print a help message describing all of abrt-cli’s command-line options. - -.PP -.B Crash action options -.IP "\-l, \-\-list" -Prints list of crashes which are not reported yet. -.IP "\-r, \-\-report \fIDUMPDIR\fR" -Creates a crash report and then the text editor is invoked on that -report. When you are done with editing the report just exit the editor -and then you will be asked if you want to send the report. -.IP "\-d, \-\-delete \fIDUMPDIR\fR" -Removes data about particular crash. -.IP "\-i, \-\-info \fIDUMPDIR\fR" -Prints detailed information about particular crash. - -.PP -.B Listing options -.IP "\-f, \-\-full" -List all crashes, including already reported. - -.PP -.B Report options -.IP "\-y, \-\-always" -Creates and sends the crash report automatically, without asking -any questions. - -.PP -.B Info options -.IP "\-b, \-\-backtrace" -Includes the crash backtrace in the info output if the backtrace is -available. - -.SH ENVIRONMENT VARIABLES -The editor used to edit the crash report is chosen from the -ABRT_EDITOR environment variable, the VISUAL environment variable, or -the EDITOR environment variable, in that order. - -.SH SEE ALSO -.IR abrtd (8), -.IR abrt.conf (5), -.IR abrt-plugins (7) diff --git a/src/cli/abrt-cli.txt b/src/cli/abrt-cli.txt new file mode 100644 index 00000000..62310a7d --- /dev/null +++ b/src/cli/abrt-cli.txt @@ -0,0 +1,70 @@ +abrt-cli(1) +=========== + +NAME +---- +abrt-cli - Work with ABRT dump directories from command line. + +SYNOPSIS +-------- +'abrt-cli' [-vsp] -l[f] [-D BASE_DIR]... + +'abrt-cli' [-vsp] -i[f] DUMP_DIR + +'abrt-cli' [-vsp] -e EVENT DUMP_DIR + +'abrt-cli' [-vsp] -a[y] DUMP_DIR + +'abrt-cli' [-vsp] -r[y] DUMP_DIR + +'abrt-cli' [-vsp] -d DUMP_DIR + +DESCRIPTION +----------- +'abrt-cli' is a command line tool that manages application crashes and other problems +catched by abrtd daemon. It enables access to, manipulation of problem data, and reporting. + +OPTIONS +------- +-l:: + List not yet reported problems, or all problems with -f + +-D BASE_DIR:: + Directory to list problems from (default: -D $HOME/.abrt/spool -D /var/spool/abrt) + +-i, --info:: + Print information about DUMP_DIR (detailed with -f) + +-e EVENT:: + Run EVENT on DUMP_DIR + +-a, --analyze:: + Run analyze event(s) on DUMP_DIR + +-r, --report:: + Send a report about DUMP_DIR + +-d, --delete:: + Remove DUMP_DIR + +-f, --full:: + Full listing + +-y, --always:: + Noninteractive: don't ask questions, assume positive answer to all of them + +-v, --verbose:: + Be verbose + +-s:: + Log to syslog + +-p:: + Add program names to log + +-V, --version:: + Display version and exit + +AUTHORS +------- +* ABRT team |