new man pages

3 files changed, 187 insertions, 0 deletions

diff --git a/lib/Plugins/abrt-FileTransfer.7 b/lib/Plugins/abrt-FileTransfer.7
new file mode 100644
index 0000000..3004e88
--- /dev/null
+++ b/lib/Plugins/abrt-FileTransfer.7
@@ -0,0 +1,80 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+FileTransfer plugin for abrt(8)
+.SH DESCRIPTION
+.P
+.I abrt
+is a daemon which watches for application crashes. When a crash occurs,
+it collects the crash data and does some actions according to 
+the configuration. This manual page describes the \fIFileTransfer\fP plugin 
+for \fIabrt\fP.
+.P
+This plugin is used to transfer the crash report to another
+machine via some file transfer protocol. Supported protocols
+are FTP, FTPS, HTTP, HTTPS, SCP, SFTP and TFTP. 
+.SH INVOCATION
+.P
+The plugin is invoked in the \fIabrt.conf\fP file, usually in the
+\fIActionsAndReporters\fP option and/or the \fI[cron]\fP section.
+There are two modes of invocation: either you use the parameter
+\fI"store"\fP: in this case, the plugin stores the information,
+that the crash occurs, in its internal list.
+.P
+If you use some other parameter, or no parameter at all, the
+plugin will iterate through the internal list and will send
+every recorded crash to the server specified in the \fIFileTransfer.conf\fP
+configuration file. After that, the internal list is cleared.
+.P
+The rationale of this behavior is this: on a production
+machine, you probably don't want the crash data to be
+sent in the time the machine is busy working, you want
+to send everything in some more quiet time (at night, perhaps)
+and schedule this in the \fI[cron]\fP section of \fIabrt.conf\fP.
+.SH CONFIGURATION
+The \fIFileTransfer.conf\fP configuration file contains the following:
+.SS URL
+The URL of the server, where the crash should
+be transfered, specifying the protocol, the path,
+the user name and the password, for example
+.br
+URL = ftp://user:passwd@server.com/path
+.SS ArchiveType
+The type of the archive, where the crash data will be packed. 
+Currently supporting \fI.tar.gz\fP, \fI.tar.bz2\fP and \fI.zip\fP
+The plugin currently relies on external file archiving
+commandline utilities, which will create the archive.
+The default is
+.br
+ArchiveType = .tar.gz
+.SS RetryCount
+This specifies, how many times will the plugin try to resend
+the file in the case the transfer was not succesful. The plugin
+waits a while before it retries the transfer: see \fIRetryDelay\fP
+The default is
+.br
+RetryCount = 3
+.SS RetryDelay
+In the case the transfer was not succesful, the plugin will
+wait some time before sending the file again. This configuration
+option specifies the time in seconds. The default is
+.br
+RetryDelay = 20
+.SH EXAMPLES
+Typical configuration in \fIabrt.conf\fP. The crash is stored
+each time it happens and on midnight, all the crash data
+is transferred to a central server.
+.br
+[common]
+.br
+ActionsAndReporters = FileTransfer("store")
+.br
+[cron]
+.br
+00:00 = FileTransfer
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Daniel Novotny <dnovotny@redhat.com>.
+
diff --git a/src/Daemon/abrt.8 b/src/Daemon/abrt.8
new file mode 100644
index 0000000..a90636b
--- /dev/null
+++ b/src/Daemon/abrt.8
@@ -0,0 +1,31 @@
+.TH abrt "8" "28 May 2009" ""
+.SH NAME
+abrt \- an automated bug-reporting tool
+.SH SYNOPSIS
+.B abrt [ -d ]
+.SH DESCRIPTION
+.I abrt
+is a daemon which watches for application crashes. When a crash occurs,
+it collects the crash data (core file, application's command line etc.)
+and does some actions according to the type of application that
+crashed and according to configuration in the
+.I abrt.conf
+config file. There are plugins for various actions: for example reporting
+the crash to Bugzilla, mailing the report, transfering the
+report via FTP or SCP. See the manual pages for the
+respective plugins.
+.SH OPTIONS
+
+.TP
+
+.B "\-d"
+
+This option causes
+.I abrt
+to print some more debugging information, when the daemon is started.
+.SH "SEE ALSO"
+.IR abrt.conf(5)
+.SH AUTHOR
+Written by Zdeněk Přikryl <zprikryl@redhat.com> and
+Jiří Moskovčák <jmoskovc@redhat.com>. Manual page written by Daniel
+Novotný <dnovotny@redhat.com>.
diff --git a/src/Daemon/abrt.conf.5 b/src/Daemon/abrt.conf.5
new file mode 100644
index 0000000..57bd28e
--- /dev/null
+++ b/src/Daemon/abrt.conf.5
@@ -0,0 +1,76 @@
+.TH "abrt.conf" "5" "28 May 2009" ""
+.SH NAME
+abrt.conf \- configuration file for abrt
+.SH DESCRIPTION
+The configuration file consists of sections, each section contains 
+several items in a format "Option = Value". The description of each
+section follows:
+.SS [Common]
+.TP
+.B EnableOpenGPG =  \fIyes\fP | \fIno\fP
+When set to "yes",
+.I abrt
+will report crashes only in GPG signed packages. When set to "no",
+it will report crashes also in unsigned packages.
+.TP
+.B OpenGPGPublicKeys =  \fIfilename\fP , \fIfilename\fP ...
+This is the place, where you specify the trusted GPG keys, with
+which the packages have to be signed for "EnableOpenGPG = yes".
+.TP
+.B BlackList = \fIpackageName\fP, \fIpackageName\fP ...
+Packages in this list will be ignored (i.e. their crashes will
+not be handled by
+.I abrt
+).
+.TP
+.B EnabledPlugins = \fIplugin\fP, \fIplugin\fP ...
+Only plugins in EnabledPlugins are loaded.
+.TP
+.B Database = \fIdatabasePlugin\fP
+This specifies which database plugin is used to store
+the metadata about the crash.
+.TP
+.B MaxCrashReportsSize = \fInumber\fP
+You can specify here, how much disk space will maximally be
+used for all the crash dumps, to ensure
+that the crash dumps won't take
+all the HDD space. The number is specified in megabytes.
+.TP
+.B ActionsAndReporters = \fIplugin\fP, \fIplugin(parameters)\fP
+List of reporter and action plugins, which will be
+run at crash time.
+.SS [ AnalyzerActionsAndReporters ]
+This section contains associations between analyzers and action
+or reporter plugins.
+.TP
+.B CCpp = \fIplugin\fP
+This plugin will be used when a C/C++ program crashes.
+You can specify a plugin for specific program, for example
+.br
+CCpp:bind = Mailx("[abrt] Bind crashed")
+.br
+The Mailx plugin will run, when bind crashes, instead of the plugin specified for
+all the C/C++ programs.
+.TP
+.B Kerneloops = \fIplugin\fP
+This plugin will be used in the case of kernel crashes.
+.SS [ Cron ]
+This section specifies tasks, which will be run at some time. You can specify
+either a time of the day in the format
+.br
+.B hh:mm = \fIplugin\fP
+.br
+or an interval
+.br
+.B ss = \fIplugin2\fP
+.br
+in this case, \fIplugin2\fP will be run every \fIss\fP seconds (this number
+can be greater than 60).
+.SH "SEE ALSO"
+.IR abrt(8)
+.SH AUTHOR
+Written by Zdeněk Přikryl <zprikryl@redhat.com> and
+Jiří Moskovčák <jmoskovc@redhat.com>. Manual page written by Daniel
+Novotný <dnovotny@redhat.com>.
+
+