summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorDenys Vlasenko <vda.linux@googlemail.com>2010-01-26 16:39:29 +0100
committerDenys Vlasenko <vda.linux@googlemail.com>2010-01-26 16:39:29 +0100
commit04aab9deefe0dfdaeba4cdba11f81ee6177294e9 (patch)
treea622a9ac17b127a3cb5a72a8ee965831c808683a /lib
parentfaf415ae470e4449880cf0377b8186382682c5ae (diff)
downloadabrt-04aab9deefe0dfdaeba4cdba11f81ee6177294e9.tar.gz
abrt-04aab9deefe0dfdaeba4cdba11f81ee6177294e9.tar.xz
abrt-04aab9deefe0dfdaeba4cdba11f81ee6177294e9.zip
FileTransfer.conf, TicketUploader.conf: better comments
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/Plugins/FileTransfer.conf30
-rw-r--r--lib/Plugins/TicketUploader.conf15
2 files changed, 31 insertions, 14 deletions
diff --git a/lib/Plugins/FileTransfer.conf b/lib/Plugins/FileTransfer.conf
index d75488c1..5e231403 100644
--- a/lib/Plugins/FileTransfer.conf
+++ b/lib/Plugins/FileTransfer.conf
@@ -1,22 +1,36 @@
Enabled = yes
-# Configuration of the file transfer reporter plugin
-# it takes one parameter:
-# store - just save information about crash
-# upload - upload new crash or saved crashes to the specified url
+# Configuration of the FileTransfer reporter plugin.
+
+# The plugin is invoked in the abrt.conf file, usually in the
+# ActionsAndReporters option and/or the [cron] section.
+# There are two modes of invocation:
+#
+# * Specify FileTransfer(one) in ActionsAndReporters directive.
+# Immediately after crash is detected, the plugin transfers
+# crash data to the server specified via URL directive in this file.
+#
+# * Specify FileTransfer(store) in ActionsAndReporters directive
+# and add "HH:MM = FileTransfer" line in [cron] section.
+# At the time of the crash, the plugin stores a record of it
+# in its internal list. When specified time is reached,
+# the plugin iterates through its internal list and sends
+# every recorded crash to the specified URL.
+# After that, the internal list is cleared.
+
# URL to upload the files to
# supported: ftp, ftps, http, https, scp, sftp, tftp, file
# for example: ftp://user:password@server.name/directory
# or: scp://user:password@server.name:port/directory etc.
-# for testing: file:///tmp
+# for testing: file:///tmp/test_directory
URL =
-#archive type, one of .zip, .tar.gz or .tar.bz2
+# Archive type, one of .zip, .tar.gz or .tar.bz2
ArchiveType = .tar.gz
-#how many times we try to upload the file
+# How many times we try to upload the file
RetryCount = 3
-#how long we wait between we retry the upload (in seconds)
+# How long we wait between we retry the upload (in seconds)
RetryDelay = 20
diff --git a/lib/Plugins/TicketUploader.conf b/lib/Plugins/TicketUploader.conf
index b6e9c5f3..d851a167 100644
--- a/lib/Plugins/TicketUploader.conf
+++ b/lib/Plugins/TicketUploader.conf
@@ -1,16 +1,19 @@
# Customer = "Example Inc."
# Ticket = IT12345
# Encrypt = yes
+# If set to "no" or commented out,
+# compressed ticket data will be copied to /tmp:
# Upload = yes
-# URL to upload the files to
-# supported: ftp, ftps, http, https, scp, sftp, tftp
+# If "Upload = yes", URL to upload the files to.
+# supported: ftp, ftps, http, https, scp, sftp, tftp, file
# for example: ftp://user:password@server.name/directory
# or: scp://user:password@server.name:port/directory etc.
+# for testing: file:///tmp/test_directory
# URL =
-#how many times we try to upload the file
-#RetryCount = 3
+# How many times we try to upload the file
+# RetryCount = 3
-#how long we wait between we retry the upload (in seconds)
-#RetryDelay = 20
+# How long we wait between we retry the upload (in seconds)
+# RetryDelay = 20