Related to #672
Signed-off-by: Jakub Filak jfilak@redhat.com --- doc/Makefile.am | 15 +++++++++ doc/abrt-action-analyze-core.txt | 33 ++++++++++++++++++++ doc/abrt-action-analyze-vulnerability.txt | 24 ++++++++++++++ doc/abrt-action-analyze-xorg.txt | 47 ++++++++++++++++++++++++++++ doc/abrt-action-install-debuginfo.txt | 44 ++++++++++++++++++++++++++ doc/abrt-action-perform-ccpp-analysis.txt | 40 ++++++++++++++++++++++++ doc/abrt-action-save-kernel-data.txt | 33 ++++++++++++++++++++ doc/abrt-applet.txt | 33 ++++++++++++++++++++ doc/abrt-dedup-client.txt | 52 +++++++++++++++++++++++++++++++ doc/abrt-dump-oops.txt | 49 +++++++++++++++++++++++++++++ doc/abrt-dump-xorg.txt | 46 +++++++++++++++++++++++++++ doc/abrt-harvest-uefioops.txt | 25 +++++++++++++++ doc/abrt-harvest-vmcore.txt | 32 +++++++++++++++++++ doc/abrt-merge-uefioops.txt | 30 ++++++++++++++++++ doc/abrt-watch-log.txt | 34 ++++++++++++++++++++ doc/system-config-abrt.txt | 19 +++++++++++ 16 files changed, 556 insertions(+) create mode 100644 doc/abrt-action-analyze-core.txt create mode 100644 doc/abrt-action-analyze-vulnerability.txt create mode 100644 doc/abrt-action-analyze-xorg.txt create mode 100644 doc/abrt-action-install-debuginfo.txt create mode 100644 doc/abrt-action-perform-ccpp-analysis.txt create mode 100644 doc/abrt-action-save-kernel-data.txt create mode 100644 doc/abrt-applet.txt create mode 100644 doc/abrt-dedup-client.txt create mode 100644 doc/abrt-dump-oops.txt create mode 100644 doc/abrt-dump-xorg.txt create mode 100644 doc/abrt-harvest-uefioops.txt create mode 100644 doc/abrt-harvest-vmcore.txt create mode 100644 doc/abrt-merge-uefioops.txt create mode 100644 doc/abrt-watch-log.txt create mode 100644 doc/system-config-abrt.txt
diff --git a/doc/Makefile.am b/doc/Makefile.am index 94d8f8f..872d210 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,17 +8,32 @@ MAN1_TXT += abrt-action-trim-files.txt MAN1_TXT += abrt-action-generate-backtrace.txt MAN1_TXT += abrt-action-generate-core-backtrace.txt MAN1_TXT += abrt-action-analyze-backtrace.txt +MAN1_TXT += abrt-action-analyze-core.txt MAN1_TXT += abrt-action-analyze-oops.txt MAN1_TXT += abrt-action-analyze-python.txt +MAN1_TXT += abrt-action-analyze-xorg.txt +MAN1_TXT += abrt-action-analyze-vulnerability.txt +MAN1_TXT += abrt-action-install-debuginfo.txt MAN1_TXT += abrt-action-list-dsos.txt +MAN1_TXT += abrt-action-perform-ccpp-analysis.txt +MAN1_TXT += abrt-applet.txt +MAN1_TXT += abrt-dump-oops.txt +MAN1_TXT += abrt-dump-xorg.txt MAN1_TXT += abrt-retrace-client.txt MAN1_TXT += abrt-handle-upload.txt +MAN1_TXT += abrt-harvest-uefioops.txt +MAN1_TXT += abrt-harvest-vmcore.txt +MAN1_TXT += abrt-merge-uefioops.txt MAN1_TXT += abrt-server.txt +MAN1_TXT += abrt-dedup-client.txt MAN1_TXT += abrt-cli.txt MAN1_TXT += abrt-action-save-package-data.txt +MAN1_TXT += abrt-action-save-kernel-data.txt MAN1_TXT += abrt-install-ccpp-hook.txt MAN1_TXT += abrt-action-analyze-vmcore.txt MAN1_TXT += abrt-action-analyze-ccpp-local.txt +MAN1_TXT += abrt-watch-log.txt +MAN1_TXT += system-config-abrt.txt if BUILD_BODHI MAN1_TXT += abrt-bodhi.txt endif diff --git a/doc/abrt-action-analyze-core.txt b/doc/abrt-action-analyze-core.txt new file mode 100644 index 0000000..750be2d --- /dev/null +++ b/doc/abrt-action-analyze-core.txt @@ -0,0 +1,33 @@ +abrt-action-analyze-core(1) +============================= + +NAME +---- +abrt-action-analyze-core - Extracts builds from a core dump + +SYNOPSIS +-------- +'abrt-action-analyze-core' [-v] [-o OUTFILE] -c COREFILE + +DESCRIPTION +----------- +The tool reads a core dump and extracts build ids of loaded modules and prints +the list to the standard output if the OUTFILE file is not configured. + +OPTIONS +------- +-c COREFILE:: + Path to a core dump. + +-v:: + Be more verbose. Can be given multiple times. + +-o OUTFILE:: + Output file + +-h, --help:: + Prints help text + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-action-analyze-vulnerability.txt b/doc/abrt-action-analyze-vulnerability.txt new file mode 100644 index 0000000..8dc118f --- /dev/null +++ b/doc/abrt-action-analyze-vulnerability.txt @@ -0,0 +1,24 @@ +abrt-action-analyze-vulnerability(1) +================================== + +NAME +---- +abrt-action-analyze-vulnerability - Provides assessment of potential exploitability of crash + +SYNOPSIS +-------- +abrt-action-analyze-vulnerability + +DESCRIPTION +----------- +This tool expects that file named 'coredump' is placed in the current directory +and runs abrt-gdb-exploitable gdb plugin on that file. The result of +vulnerability analysis is saved in 'exploitable' file in the current directory. + +This tool requires both 'gdb' and 'eu-readelf' executables placed in PATH. If +any of the required programs is missing the tool silently exits with 0 exit +code. + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-action-analyze-xorg.txt b/doc/abrt-action-analyze-xorg.txt new file mode 100644 index 0000000..880c6fb --- /dev/null +++ b/doc/abrt-action-analyze-xorg.txt @@ -0,0 +1,47 @@ +abrt-action-analyze-xorg(1) +=========================== + +NAME +---- +abrt-action-analyze-xorg - Calculate and save UUID and duplicate hash +for a problem data directory DIR with Xorg backtrace. + +SYNOPSIS +-------- +'abrt-action-analyze-xorg' [-v] [-d DIR] + +DESCRIPTION +----------- +The tool reads the file named 'Xorg.0.log' and checks if any black listed +module was loaded. If so, 'not-reportable' file is created with an appropriate +explanation text. If no black listed module was loaded, the tool reads the +file named 'backtrace' from a problem data directory record and generates a +duplication hash and a universally unique identifier (UUID). Then it saves +this data as new elements 'duphash' and 'uuid'. + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-action-analyze-xorg' can be used to generate the duplication +hash of a newly discovered Xorg backtraces. + +------------ +EVENT=post-create analyzer=Xorg abrt-action-analyze-xorg +------------ + +OPTIONS +------- +-d DIR:: + Path to a problem directory. Current working directory is used when + this option is not provided. + +-v:: + Be more verbose. Can be given multiple times. + +FILES +----- +/etc/abrt/xorg.conf + List of modules which, when loaded, should make Xorg crashes non-reportable. + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-action-install-debuginfo.txt b/doc/abrt-action-install-debuginfo.txt new file mode 100644 index 0000000..49a0ebd --- /dev/null +++ b/doc/abrt-action-install-debuginfo.txt @@ -0,0 +1,44 @@ +abrt-action-install-debuginfo(1) +============================== + +NAME +---- +abrt-action-install-debuginfo - Install debuginfos for build-ids + +SYNOPSIS +-------- +'abrt-action-install-debuginfo' [-vy] [--ids=BUILD_IDS_FILE] [--tmpdir=TMPDIR] [--cache=CACHEDIR[:DEBUGINFODIR1:DEBUGINFODIR2...]] [--size_mb=SIZE] [-e PATH] + +DESCRIPTION +----------- +Installs debuginfos for all build-ids listed in BUILD_IDS_FILE +to CACHEDIR, using TMPDIR as temporary staging area. +Old files in CACHEDIR are deleted until it is smaller than SIZE. + +OPTIONS +------- +-v:: + Be more verbose. Can be given multiple times. + +-y:: + Noninteractive, assume 'Yes' to all questions + +--ids:: + Path to file with list of build ids. Default: build_ids + +--tmpdir:: + Path to tmp directory. Default: /tmp/abrt-tmp-debuginfo-RANDOM_SUFFIX + +--cache:: + Path to cache directory. Default: /var/cache/abrt-di + +--size_mb:: + Default: 4096 + +-e,--exact:: + Download only specified files + +AUTHORS +------- +* ABRT team + diff --git a/doc/abrt-action-perform-ccpp-analysis.txt b/doc/abrt-action-perform-ccpp-analysis.txt new file mode 100644 index 0000000..3fac30f --- /dev/null +++ b/doc/abrt-action-perform-ccpp-analysis.txt @@ -0,0 +1,40 @@ +abrt-action-perform-ccpp-analysis(1) +================================== + +NAME +---- +abrt-action-perform-ccpp-analysis - Allows users to select acceptable way of core dump analysis + +SYNOPSIS +-------- +'abrt-action-perform-ccpp-analysis' [-h] [-d PROBLEM_DIR] + +DESCRIPTION +----------- +This tool allows user to select between local and remote core dump analysis. +The local analysis may require to download huge amount of data but is +completely safe. On the contrary the remote analysis only needs to upload the +core dump to retrace server but the core dump may contain security sensitive +data. + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-action-perform-ccpp-analysis' is used in the analyze step when processing +C/C++ crashes + +------------ +EVENT=analyze_CCpp analyzer=CCpp + abrt-action-perform-ccpp-analysis +------------ + +OPTIONS +------- +-d, --problem-dir PROBLEM_DIR:: + Problem directory [Default: current directory] + +-h, --help:: + Show help message + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-action-save-kernel-data.txt b/doc/abrt-action-save-kernel-data.txt new file mode 100644 index 0000000..f82fa35 --- /dev/null +++ b/doc/abrt-action-save-kernel-data.txt @@ -0,0 +1,33 @@ +abrt-action-save-kernel-data(1) +================================ + +NAME +---- +abrt-action-save-kernel-data - Creates uReport mandatory files for kernel oopses. + +SYNOPSIS +-------- +'abrt-action-save-kernel-data' + +DESCRIPTION +----------- +The tool reads problem directory DIR. It analyzes contents of 'kernel' element, +checks database of installed packages, and creates new elements +'pkg_name', 'pkg_arch', 'pkg_version', 'pkg_release'. + +These files are required by reporter-ureporter (mandatory in uReport). + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This tool can be used as an ABRT reporter. Example +fragment for /etc/libreport/report_event.conf: + +------------ +# Determine in which package/component the crash happened (if not yet done): +EVENT=post-create analyzer=Kerneloops + abrt-action-save-kernel-data +------------ + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-applet.txt b/doc/abrt-applet.txt new file mode 100644 index 0000000..3dfc00b --- /dev/null +++ b/doc/abrt-applet.txt @@ -0,0 +1,33 @@ +abrt-applet(1) +============ + +NAME +---- +abrt-applet - Applet which notifies user when new problems are detected by ABRT + +SYNOPSIS +-------- +'abrt-applet' [-v] + +DESCRIPTION +----------- +This tool listens on 'org.freedesktop.problems' D-Bus bus and waits for 'Crash' +signal. When the tool detects the signal, it notifies user about new problem +over a desktop specific notification pop-up. + +At start-up this tool checks for new problems which occurred while the tool was +not running and if it finds any of such problem it notifies user over a desktop +specific notification pop-up. + +OPTIONS +------- +-v, --verbose:: + Be more verbose. Can be given multiple times. + +SEE ALSO +-------- +abrt-dbus(8) + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-dedup-client.txt b/doc/abrt-dedup-client.txt new file mode 100644 index 0000000..b837fcd --- /dev/null +++ b/doc/abrt-dedup-client.txt @@ -0,0 +1,52 @@ +abrt-dedup-client(1) +================== + +NAME +---- +abrt-dedup-client - The ABRT dedup server client. + +SYNOPSIS +-------- +'abrt-dedup-client' [-vsk] [--url URL] [--port PORT] [-d DIR] [--headers] + +DESCRIPTION +----------- +'abrt-dedup-client' is the command-line tool for searching for duplicates. + +OPTIONS +------- +-v, --verbose:: + be verbose + +-s, --syslog:: + log to syslog + +-k, --insecure:: + allow insecure connection to dedup server + +--url URL:: + dedup server URL [Default: retrace.fedoraproject.org] + +--port NUM:: + dedup server port [Default: 443] + +-d, --dump-dir DIR:: + problem directory [Default: current directory] + +--headers:: + (debug) show received HTTP headers + +ENVIRONMENT +----------- +DEDUP_SERVER_URL:: + dedup server URL + +DEDUP_SERVER_PORT:: + dedup server PORT + +DEDUP_SERVER_INSECURE:: + Allow insecure connection to dedup server (use 'insecure') + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-dump-oops.txt b/doc/abrt-dump-oops.txt new file mode 100644 index 0000000..f63e53a --- /dev/null +++ b/doc/abrt-dump-oops.txt @@ -0,0 +1,49 @@ +abrt-dump-oops(1) +=============== + +NAME +---- +abrt-dump-oops - Extract oops from FILE (or standard input) + +SYNOPSIS +-------- +'abrt-dump-oops' [-vusoxm] [-d DIR]/[-D] [FILE] + +DESCRIPTION +----------- +This tool creates problem directory from, updates problem directory with or +prints oops extracted from FILE or standard input. + +OPTIONS +------- +-v, --verbose:: + Be more verbose. Can be given multiple times. + +-s:: + Log to syslog + +-o:: + Print found oopses on standard output + +-d DIR:: + Create new problem directory in DIR for every oops found + +-D:: + Same as -d DumpLocation, DumpLocation is specified in abrt.conf + +-u PROBLEM:: + Save the extracted information in PROBLEM directory + +-x:: + Make the problem directory world readable. Usable only with -d/-D + +-m:: + Print search string(s) for 'abrt-watch-log' to stdout and exit + +SEE ALSO +-------- +abrt-watch-log(1), abrt.conf(5) + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-dump-xorg.txt b/doc/abrt-dump-xorg.txt new file mode 100644 index 0000000..7fe7a79 --- /dev/null +++ b/doc/abrt-dump-xorg.txt @@ -0,0 +1,46 @@ +abrt-dump-xorg(1) +=============== + +NAME +---- +abrt-dump-xorg - Extract Xorg crash from FILE (or standard input) + +SYNOPSIS +-------- +'abrt-dump-xorg' [-vsoxm] [-d DIR]/[-D] [FILE] + +DESCRIPTION +----------- +This tool creates problem directory from or prints Xorg crash extracted from FILE +or standard input. + +OPTIONS +------- +-v, --verbose:: + Be more verbose. Can be given multiple times. + +-s:: + Log to syslog + +-o:: + Print found crash data on standard output + +-d DIR:: + Create new problem directory in DIR for every crash found + +-D:: + Same as -d DumpLocation, DumpLocation is specified in abrt.conf + +-x:: + Make the problem directory world readable. Usable only with -d/-D + +-m:: + Print search string(s) for 'abrt-watch-log' to stdout and exit + +SEE ALSO +-------- +abrt-watch-log(1), abrt.conf(5) + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-harvest-uefioops.txt b/doc/abrt-harvest-uefioops.txt new file mode 100644 index 0000000..efd6f3f --- /dev/null +++ b/doc/abrt-harvest-uefioops.txt @@ -0,0 +1,25 @@ +abrt-harvest-uefioops(1) +====================== + +NAME +---- +abrt-harvest-uefioops - Reconstruct oops from /sys/fs/pstore/* files, create ABRT problems and remove the files + +SYNOPSIS +-------- +'abrt-harvest-uefioops' + +DESCRIPTION +----------- +This script is meant to be run once at system startup after abrtd is up and +running. It scans /sys/fs/pstore/*, reconstructs oops text(s) from these files, +creates ABRT problem directories from them, then removes the files (UEFI +storage is a limited resource). + +SEE ALSO +-------- +abrt-merge-uefioops(1) + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-harvest-vmcore.txt b/doc/abrt-harvest-vmcore.txt new file mode 100644 index 0000000..0902afd --- /dev/null +++ b/doc/abrt-harvest-vmcore.txt @@ -0,0 +1,32 @@ +abrt-harvest-vmcore(1) +==================== + +NAME +---- +abrt-harvest-vmcore - Converts VMCores to ABRT problems + +SYNOPSIS +-------- +'abrt-harvest-vmcore' + +DESCRIPTION +----------- +This script is meant to be run once at system startup after abrtd is up and +running. It moves all vmcore directories in /var/crash (which are presumably +created by kdump) to abrtd spool directory. + +The goal is to let abrtd notice and process them as new problem data dirs. + +FILES +----- +/etc/abrt/abrt-harvest-vmcore.conf + Configuration file where user can enable copying or moving VMcore to ABRT + problem directory + +SEE ALSO +-------- +abrt.conf(5) + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-merge-uefioops.txt b/doc/abrt-merge-uefioops.txt new file mode 100644 index 0000000..8f7de86 --- /dev/null +++ b/doc/abrt-merge-uefioops.txt @@ -0,0 +1,30 @@ +abrt-merge-uefioops(1) +==================== + +NAME +---- +abrt-merge-uefioops - Scans files for split oops message. Can print and/or delete them. + +SYNOPSIS +-------- +'abrt-merge-uefioops' [-v] [-od] FILE... + +DESCRIPTION +----------- +This tool takes list of files, reads all of the files, scans them for split +oops messages and join oops parts to original oops message. + +OPTIONS +------- +-o:: + Print found oopses + +-d:: + Delete files with found oopses + +-v, --verbose:: + Be more verbose. Can be given multiple times. + +AUTHORS +------- +* ABRT team diff --git a/doc/abrt-watch-log.txt b/doc/abrt-watch-log.txt new file mode 100644 index 0000000..c393410 --- /dev/null +++ b/doc/abrt-watch-log.txt @@ -0,0 +1,34 @@ +abrt-watch-log(1) +=============== + +NAME +---- +abrt-watch-log - Watch log file and run command when it grows or is replaced + +SYNOPSIS +-------- +'abrt-watch-log' [-vs] [-F STR] ... FILE PROG [ARGS] + +OPTIONS +------- +-F STR:: + Don't run PROG if STRs aren't found + +-v, --verbose:: + Be more verbose. Can be given multiple times. + +-s:: + Log to syslog + +FILE:: + Watched file + +PROG:: + Path to an executable + +ARGS:: + Arguments for PROG + +AUTHORS +------- +* ABRT team diff --git a/doc/system-config-abrt.txt b/doc/system-config-abrt.txt new file mode 100644 index 0000000..cf431a7 --- /dev/null +++ b/doc/system-config-abrt.txt @@ -0,0 +1,19 @@ +system-config-abrt(1) +=================== + +NAME +---- +system-config-abrt - GUI tool to configure ABRT + +SYNOPSIS +-------- +'system-config-abrt' + +DESCRIPTION +----------- +'system-config-abrt' is a graphical tool that provides to users comfortable way +for changing ABRT's configuration files from one place. + +AUTHORS +------- +* ABRT team