new manual pages

11 files changed, 370 insertions, 9 deletions

diff --git a/lib/Plugins/abrt-Bugzilla.7 b/lib/Plugins/abrt-Bugzilla.7
new file mode 100644
index 00000000..ec56256d
--- /dev/null
+++ b/lib/Plugins/abrt-Bugzilla.7
@@ -0,0 +1,43 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+Bugzilla 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 performs some actions according to 
+the configuration. This manual page describes the \fIBugzilla\fP plugin 
+for \fIabrt\fP.
+.P
+This plugin is used to report the crash to the Bugzilla. The plugin
+will determine the package name and distribution version. The crash
+data is attached to the bug report.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. 
+No parameters are necessary.
+.SH CONFIGURATION
+The \fIBugzilla.conf\fP configuration file contains several
+entries in a format "Option = Value". The options are:
+.SS BugzillaURL
+The URL of the Bugzilla instance you want to use, including the
+path to the xmlrpc. The default is https://bugzilla.redhat.com/xmlrpc.cgi
+.SS Login
+Your Bugzilla login. If you have no Bugzilla account, you cannot
+use the plugin.
+.SS Password
+Your Bugzilla password.
+.SH EXAMPLES
+.P
+This is a snippet from the \fIabrt.conf\fP configuration file.
+When something crashes, use the Bugzilla plugin:
+.P
+[common]
+.br
+ActionsAndReporters = Bugzilla
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Zdenek Prikryl <zprikryl@redhat.com>. 
+Manual page written by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-FileTransfer.7 b/lib/Plugins/abrt-FileTransfer.7
index 3004e88a..c2c2ac7b 100644
--- a/lib/Plugins/abrt-FileTransfer.7
+++ b/lib/Plugins/abrt-FileTransfer.7
@@ -5,7 +5,7 @@ FileTransfer plugin for abrt(8)
 .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 
+it collects the crash data and performs some actions according to 
 the configuration. This manual page describes the \fIFileTransfer\fP plugin 
 for \fIabrt\fP.
 .P
@@ -31,7 +31,8 @@ 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:
+The \fIFileTransfer.conf\fP configuration file contains 
+several entries in a format "Option = Value". The options are:
 .SS URL
 The URL of the server, where the crash should
 be transfered, specifying the protocol, the path,
@@ -60,10 +61,11 @@ option specifies the time in seconds. The default is
 .br
 RetryDelay = 20
 .SH EXAMPLES
+.P
 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
+.P
 [common]
 .br
 ActionsAndReporters = FileTransfer("store")
@@ -77,4 +79,3 @@ ActionsAndReporters = FileTransfer("store")
 .IR abrt-plugins (7)
 .SH AUTHOR
 Written by Daniel Novotny <dnovotny@redhat.com>.
-
diff --git a/lib/Plugins/abrt-KerneloopsReporter.7 b/lib/Plugins/abrt-KerneloopsReporter.7
new file mode 100644
index 00000000..a0c2341d
--- /dev/null
+++ b/lib/Plugins/abrt-KerneloopsReporter.7
@@ -0,0 +1,40 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+KerneloopsReporter 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 performs some actions according to 
+the configuration. This manual page describes the \fIKerneloopsReporter\fP 
+plugin for \fIabrt\fP.
+.P
+This plugin is used to report the crash to the Kerneloops tracker.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. 
+No parameters are necessary.
+.SH CONFIGURATION
+The \fIKerneloopsReporter.conf\fP configuration file contains one entry:
+.SS SubmitURL
+The URL of the kerneloops tracker, the default is
+.br
+SubmitURL = http://submit.kerneloops.org/submitoops.php
+.SH EXAMPLES
+.P
+This is a snippet from the \fIabrt.conf\fP configuration file.
+Each time a kernel oops is detected, run KerneloopsReporter:
+.P
+[common]
+.br
+ActionsAndReporters = Kerneloops, KerneloopsReporter
+.br
+[AnalyzerActionsAndReporters]
+.br
+Kerneloops = KerneloopsReporter
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Anton Arapov <anton@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-KerneloopsScanner.7 b/lib/Plugins/abrt-KerneloopsScanner.7
new file mode 100644
index 00000000..0cbc1dcc
--- /dev/null
+++ b/lib/Plugins/abrt-KerneloopsScanner.7
@@ -0,0 +1,46 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+KerneloopsScanner 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 performs some actions according to 
+the configuration. This manual page describes the \fIKerneloopsScanner\fP 
+plugin for \fIabrt\fP.
+.P
+This plugin reads the system log file (default /var/log/messages)
+and stores the kernel oops crashes, which were not already
+reported, to the abrt's debug dump directory.
+.P
+In order to distinguish between new crashes and the crashes
+that were already reported, the plugin makes its own entry
+in the log file, which acts as a separator.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. 
+No parameters are necessary.
+.SH CONFIGURATION
+The \fIKerneloopsScanner.conf\fP configuration file contains one entry:
+.SS SysLogFile
+The file to scan. The default is 
+.br
+SysLogFile = /var/log/messages
+.SH EXAMPLES
+.P
+This is a snippet from the \fIabrt.conf\fP configuration file.
+Every 10 seconds look if there were any kernel crashes:
+.P
+[common]
+.br
+ActionsAndReporters = Kerneloops, KerneloopsScanner
+.br
+[cron]
+.br
+10 = KerneloopsScanner
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Anton Arapov <anton@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-Logger.7 b/lib/Plugins/abrt-Logger.7
new file mode 100644
index 00000000..6541c104
--- /dev/null
+++ b/lib/Plugins/abrt-Logger.7
@@ -0,0 +1,44 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+Logger 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 performs some actions according to 
+the configuration. This manual page describes the \fILogger\fP plugin 
+for \fIabrt\fP.
+.P
+This plugin is used to log the crash to a file.
+.P
+The log will contain all the file names as well as their
+content. It also contains "duplicity check": the ID
+of the crash, which is used to tell, if the same
+crash already happened.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. 
+No parameters are necessary.
+.SH CONFIGURATION
+The \fILogger.conf\fP configuration file contains
+several entries in a format "Option = Value". The options are:
+.SS LogPath
+The path to the log file.
+.SS AppendLogs
+If set to "yes", which is the default, \fILogger\fP will append
+the report to the file, otherwise it will overwrite the file (so
+only the last crash will be stored).
+.SH EXAMPLES
+.P
+This is a snippet from the \fIabrt.conf\fP configuration file.
+Log all the C/C++ application crashes:
+.P
+[AnalyzerActionsAndReporters]
+.br
+CCpp = Logger
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Zdenek Prikryl <zprikryl@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-Mailx.7 b/lib/Plugins/abrt-Mailx.7
new file mode 100644
index 00000000..43790f24
--- /dev/null
+++ b/lib/Plugins/abrt-Mailx.7
@@ -0,0 +1,57 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+Mailx 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 performs some actions according to 
+the configuration. This manual page describes the \fIMailx\fP plugin 
+for \fIabrt\fP.
+.P
+This plugin is used to mail the data about the crash
+to a specified mail address.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. It can take
+one parameter, a subject of the mail (if it differs from the
+one specified in the \fIMailx.conf\fP configuration file).
+.SH CONFIGURATION
+The \fIMailx.conf\fP configuration file contains
+several entries in a format "Option = Value". The options are:
+.SS Subject
+The subject of the mail.
+.SS Parameters
+The \fIMailx\fP plugin executes the external "mailx" command to
+send the mail. This option defines some additional command line
+parameters, which should be added to the program invocation, if any.
+.SS EmailFrom
+The address, from which the e-mail is sent.
+.SS EmailTo
+The address, to which the e-mail is sent.
+.SS SendBinaryData
+Can be "yes" or "no". If set to "yes", the e-mail will contain
+also the binary files associated with the crash. Warning:
+this can cause the e-mails to be large! (several MB)
+.SH EXAMPLES
+.P
+These are snippets from the \fIabrt.conf\fP configuration file.
+.P
+1) Each time a crash happens, a mail is sent
+.PP
+[common]
+.br
+ActionsAndReporters = Mailx("[abrt] a crash occurs")
+.P
+2) When a program in a specific package (in this case "httpd") crashes, 
+send a mail about it.
+.PP
+[AnalyzerActionsAndReporters]
+.br
+CCpp:httpd = Mailx("[abrt] Apache crash")
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Zdenek Prikryl <zprikryl@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-RunApp.7 b/lib/Plugins/abrt-RunApp.7
new file mode 100644
index 00000000..2128cf8a
--- /dev/null
+++ b/lib/Plugins/abrt-RunApp.7
@@ -0,0 +1,43 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+RunApp 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 performs some actions according to 
+the configuration. This manual page describes the \fIRunApp\fP plugin 
+for \fIabrt\fP.
+.P
+This plugin is used to run an arbitrary application, when the crash occurs.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file. 
+The first parameter is the command to run, the second, optional
+parameter specifies an output file, to which the standard
+output of the program is saved.
+.SH CONFIGURATION
+There is no configuration file, the plugin parameters are
+sufficient.
+.SH EXAMPLES
+.P
+These are snippets from the \fIabrt.conf\fP configuration file.
+.P
+1) each time something crashes, print (and save in a text file)
+which processes are running on the system.
+.PP
+[common]
+.br
+ActionsAndReporters = RunApp("ps ax","processes.txt")
+.P
+2) When proftpd crashes, restart it.
+.PP
+[AnalyzerActionsAndReporters]
+.br
+CCpp:proftpd = RunApp("/etc/init.d/proftpd restart")
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Zdenek Prikryl <zprikryl@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-SQLite3.7 b/lib/Plugins/abrt-SQLite3.7
new file mode 100644
index 00000000..86b5097f
--- /dev/null
+++ b/lib/Plugins/abrt-SQLite3.7
@@ -0,0 +1,36 @@
+.TH abrt "7" "1 Jun 2009" ""
+.SH NAME
+SQLite3 database 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 performs some actions according to 
+the configuration. This manual page describes the \fISQLite3\fP database plugin 
+for \fIabrt\fP.
+.P
+This is a database plugin: \fIabrt\fP needs some database to store
+its metadata. You can choose which one, specifying "Database" in
+the \fIabrt.conf\fP configuration file. Currently SQLite3 is
+the only choice.
+.SH INVOCATION
+The plugin is invoked in the \fIabrt.conf\fP configuration file, like
+this:
+.br
+[common]
+.br
+Database = SQLite3
+.SH CONFIGURATION
+The \fISQLite3.conf\fP configuration file contains one entry:
+.SS DBPath
+The path to the database.
+.SH EXAMPLES
+see \fBINVOCATION\fP
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
+.SH AUTHOR
+Written by Zdenek Prikryl <zprikryl@redhat.com> and Jiri
+Moskovcak <jmoskovc@redhat.com>. Manual
+page by Daniel Novotny <dnovotny@redhat.com>.
diff --git a/lib/Plugins/abrt-plugins.7 b/lib/Plugins/abrt-plugins.7
new file mode 100644
index 00000000..22f89d68
--- /dev/null
+++ b/lib/Plugins/abrt-plugins.7
@@ -0,0 +1,44 @@
+.TH abrt "8" "28 May 2009" ""
+.SH NAME
+abrt-plugins \- plugins for the abrt crash reporter program
+.SH DESCRIPTION
+.P
+.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 performs some actions according to the type of application that
+crashed and according to configuration in the
+.I abrt.conf
+configuration file. 
+.P
+There are plugins for various actions: for example reporting
+the crash to Bugzilla, mailing the report, transfering the
+report via FTP or SCP, or running an arbitrary program.
+.P
+This manual page provides a list of all manual pages of
+the plugins.
+.P
+If you want to create your own plugin, there's a PLUGINS-HOWTO
+file in the documentation directory.
+.SH INVOCATION
+Each plugin is invoked in the \fIabrt.conf\fP configuration
+file, in the section, which is appropriate to what you
+want to do.
+.SH CONFIGURATION
+Almost each plugin has its configuration file,
+stored in the \fI/etc/abrt/plugins\fP directory.
+.SH "SEE ALSO"
+.IR abrt (8),
+.IR abrt.conf (5),
+.IR abrt-Bugzilla (7),
+.IR abrt-FileTransfer (7),
+.IR abrt-KerneloopsReporter (7),
+.IR abrt-KerneloopsScanner (7),
+.IR abrt-Logger (7),
+.IR abrt-Mailx (7),
+.IR abrt-RunApp (7),
+.IR abrt-SQLite3 (7)
+.SH AUTHOR
+\fIabrt\fP 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.8 b/src/Daemon/abrt.8
index a90636ba..641fcdb6 100644
--- a/src/Daemon/abrt.8
+++ b/src/Daemon/abrt.8
@@ -7,7 +7,7 @@ abrt \- an automated bug-reporting tool
 .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
+and performs 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
@@ -24,7 +24,8 @@ This option causes
 .I abrt
 to print some more debugging information, when the daemon is started.
 .SH "SEE ALSO"
-.IR abrt.conf(5)
+.IR abrt.conf (5),
+.IR abrt-plugins (7)
 .SH AUTHOR
 Written by Zdeněk Přikryl <zprikryl@redhat.com> and
 Jiří Moskovčák <jmoskovc@redhat.com>. Manual page written by Daniel
diff --git a/src/Daemon/abrt.conf.5 b/src/Daemon/abrt.conf.5
index 57bd28eb..481b4f5f 100644
--- a/src/Daemon/abrt.conf.5
+++ b/src/Daemon/abrt.conf.5
@@ -2,6 +2,13 @@
 .SH NAME
 abrt.conf \- configuration file for abrt
 .SH DESCRIPTION
+.P
+.I abrt
+is a daemon which watches for application crashes. When a crash occurs,
+it collects the crash data and performs some actions according to 
+the configuration. This manual page describes \fIabrt\fP's configuration
+file.
+.P
 The configuration file consists of sections, each section contains 
 several items in a format "Option = Value". The description of each
 section follows:
@@ -67,10 +74,9 @@ or an interval
 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)
+.IR abrt (8),
+.IR abrt-plugins (7)
 .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>.
-
-