From 8ace37f5d86a5ccd3277fe537b8641144409338b Mon Sep 17 00:00:00 2001 From: Miroslav Lichvar Date: Wed, 18 May 2011 13:15:08 +0200 Subject: add abrt-action-upload man page (trac#245) --- abrt.spec.in | 1 + src/plugins/Makefile.am | 1 + src/plugins/abrt-action-upload.txt | 67 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+) create mode 100644 src/plugins/abrt-action-upload.txt diff --git a/abrt.spec.in b/abrt.spec.in index 600a142c..9b059894 100644 --- a/abrt.spec.in +++ b/abrt.spec.in @@ -568,6 +568,7 @@ gtk-update-icon-cache %{_datadir}/icons/hicolor &>/dev/null || : %defattr(-,root,root,-) %config(noreplace) %{_sysconfdir}/%{name}/plugins/Upload.conf %{_mandir}/man7/abrt-Upload.7.gz +%{_mandir}/man*/abrt-action-upload.* %{_bindir}/abrt-action-upload %files addon-python diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am index 59da3702..3fccf76b 100644 --- a/src/plugins/Makefile.am +++ b/src/plugins/Makefile.am @@ -69,6 +69,7 @@ MAN_TXT = \ abrt-action-bugzilla.txt \ abrt-action-list-dsos.txt \ abrt-action-kerneloops.txt \ + abrt-action-upload.txt \ abrt-retrace-client.txt # Manual pages are generated from .txt via Docbook diff --git a/src/plugins/abrt-action-upload.txt b/src/plugins/abrt-action-upload.txt new file mode 100644 index 00000000..901c1081 --- /dev/null +++ b/src/plugins/abrt-action-upload.txt @@ -0,0 +1,67 @@ +abrt-action-upload(1) +===================== + +NAME +---- +abrt-action-upload - Uploads compressed tarball of dump directory. + +SYNOPSIS +-------- +'abrt-action-upload' [-c CONFFILE]... [ -d DIR ] [ -u URL ] + +DESCRIPTION +----------- +The tool is used to create a compressed tarball of the dump directory and +upload it to a URL. Supported protocols include FTP, FTPS, HTTP, HTTPS, SCP, +SFTP, TFTP and FILE. + +Configuration file +~~~~~~~~~~~~~~~~~~ +Configuration file contains entries in a format "Option = Value". + +The options are: + +'URL':: + The URL where should be the tarball uploaded. + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-action-upload' can be used as a reporter, to allow users to upload +compressed tarballs of dump directiories to a configured URL. This usage can be +configured in /etc/abrt/events.d/upload_events.conf: + +------------ +EVENT=report_Upload abrt-action-upload +------------ + +It can be also used on the 'post-create' event to upload it automatically. + +------------ +EVENT=post-create abrt-action-upload +------------ + +OPTIONS +------- + +-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. + +-u URL:: + The URL where should be the tarball uploaded. + +ENVIRONMENT VARIABLES +--------------------- +Environment variables take precedence over values provided in +the configuration file. + +'Upload_URL':: + The URL where should be the tarball uploaded. + +AUTHORS +------- +* ABRT team -- cgit