[LIBREPORT PATCH 2/7] add all missing manual pages for configuration files

Jakub Filak jfilak at redhat.com
Thu Jul 18 11:35:26 UTC 2013


Related to rhbz#881305

Signed-off-by: Jakub Filak <jfilak at redhat.com>
---
 doc/Makefile.am                          | 22 ++++++++
 doc/anaconda_event.conf.txt              | 41 ++++++++++++++
 doc/bugzilla.conf.txt                    | 18 ++++++
 doc/bugzilla_anaconda_event.conf.txt     | 19 +++++++
 doc/bugzilla_event.conf.txt              | 21 +++++++
 doc/bugzilla_format.conf.txt             | 18 ++++++
 doc/bugzilla_format_anaconda.conf.txt    | 19 +++++++
 doc/bugzilla_format_kernel.conf.txt      | 19 +++++++
 doc/bugzilla_format_libreport.conf.txt   | 19 +++++++
 doc/bugzilla_formatdup.conf.txt          | 20 +++++++
 doc/bugzilla_formatdup_anaconda.conf.txt | 19 +++++++
 doc/emergencyanalysis_event.conf.txt     | 51 +++++++++++++++++
 doc/forbidden_words.conf.txt             | 38 +++++++++++++
 doc/mailx.conf.txt                       | 18 ++++++
 doc/mailx_event.conf.txt                 | 42 ++++++++++++++
 doc/print_event.conf.txt                 | 21 +++++++
 doc/report-gtk.txt                       | 52 +++++++++++++++++
 doc/report_Bugzilla.conf.txt             | 45 +++++++++++++++
 doc/report_Logger.conf.txt               | 27 +++++++++
 doc/report_event.conf.txt                | 87 ++++++++++++++++++++++++++++
 doc/report_fedora.conf.txt               | 40 +++++++++++++
 doc/report_rhel.conf.txt                 | 40 +++++++++++++
 doc/reporter-bugzilla.txt                | 97 ++++++++++++++++++++++++++++++--
 doc/rhtsupport.conf.txt                  | 18 ++++++
 doc/rhtsupport_event.conf.txt            | 42 ++++++++++++++
 doc/uploader_event.conf.txt              | 42 ++++++++++++++
 26 files changed, 891 insertions(+), 4 deletions(-)
 create mode 100644 doc/anaconda_event.conf.txt
 create mode 100644 doc/bugzilla.conf.txt
 create mode 100644 doc/bugzilla_anaconda_event.conf.txt
 create mode 100644 doc/bugzilla_event.conf.txt
 create mode 100644 doc/bugzilla_format.conf.txt
 create mode 100644 doc/bugzilla_format_anaconda.conf.txt
 create mode 100644 doc/bugzilla_format_kernel.conf.txt
 create mode 100644 doc/bugzilla_format_libreport.conf.txt
 create mode 100644 doc/bugzilla_formatdup.conf.txt
 create mode 100644 doc/bugzilla_formatdup_anaconda.conf.txt
 create mode 100644 doc/emergencyanalysis_event.conf.txt
 create mode 100644 doc/forbidden_words.conf.txt
 create mode 100644 doc/mailx.conf.txt
 create mode 100644 doc/mailx_event.conf.txt
 create mode 100644 doc/print_event.conf.txt
 create mode 100644 doc/report_Bugzilla.conf.txt
 create mode 100644 doc/report_Logger.conf.txt
 create mode 100644 doc/report_fedora.conf.txt
 create mode 100644 doc/report_rhel.conf.txt
 create mode 100644 doc/rhtsupport.conf.txt
 create mode 100644 doc/rhtsupport_event.conf.txt
 create mode 100644 doc/uploader_event.conf.txt

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 11e2c4d..b2bb86d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -25,7 +25,29 @@ MAN1_TXT += reporter-upload.txt
 MAN1_TXT += reporter-ureport.txt
 
 MAN5_TXT =
+MAN5_TXT += anaconda_event.conf.txt
+MAN5_TXT += bugzilla_anaconda_event.conf.txt
+MAN5_TXT += bugzilla.conf.txt
+MAN5_TXT += bugzilla_event.conf.txt
+MAN5_TXT += bugzilla_format_anaconda.conf.txt
+MAN5_TXT += bugzilla_format.conf.txt
+MAN5_TXT += bugzilla_formatdup_anaconda.conf.txt
+MAN5_TXT += bugzilla_formatdup.conf.txt
+MAN5_TXT += bugzilla_format_kernel.conf.txt
+MAN5_TXT += bugzilla_format_libreport.conf.txt
+MAN5_TXT += emergencyanalysis_event.conf.txt
+MAN5_TXT += forbidden_words.conf.txt
+MAN5_TXT += mailx.conf.txt
+MAN5_TXT += mailx_event.conf.txt
+MAN5_TXT += print_event.conf.txt
+MAN5_TXT += report_Bugzilla.conf.txt
 MAN5_TXT += report_event.conf.txt
+MAN5_TXT += report_fedora.conf.txt
+MAN5_TXT += report_Logger.conf.txt
+MAN5_TXT += report_rhel.conf.txt
+MAN5_TXT += rhtsupport.conf.txt
+MAN5_TXT += rhtsupport_event.conf.txt
+MAN5_TXT += uploader_event.conf.txt
 
 # Manual pages are generated from .txt via Docbook
 man1_MANS = ${MAN1_TXT:%.txt=%.1}
diff --git a/doc/anaconda_event.conf.txt b/doc/anaconda_event.conf.txt
new file mode 100644
index 0000000..5582843
--- /dev/null
+++ b/doc/anaconda_event.conf.txt
@@ -0,0 +1,41 @@
+anaconda_event.conf(5)
+======================
+
+NAME
+----
+anaconda_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file specifies which of the reporting work flow definitions
+are applicable for a particular problem data for problems in 'anaconda'
+package.
+
+All applicable reporting work flows are presented to users in User Interface as
+possibilities for processing of particular problem in 'anaconda' package.
+
+This configuration file consists from one condition per line.
+
+Each condition line must start with EVENT=workflow_NAME where "workflow_" is
+constant prefix and "workflow_NAME" is base name of path to reporting work flow
+configuration file.
+
+The rest of condition line has form VAR=VAL, VAR!=VAL or VAL~=REGEX, where VAR
+is a name of problem directory element to be checked (for example,
+"executable", "package", hostname" etc). The condition may consists
+from as many element checks as it is necessary.
+
+EXAMPLES
+--------
+Condition line::
+    EVENT=workflow_Anaconda component=anaconda
+
+The condition line above expects existence of /usr/share/libreport/workflows/workflow_Anaconda.xml
+
+SEE ALSO
+--------
+report-gtk(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/bugzilla.conf.txt b/doc/bugzilla.conf.txt
new file mode 100644
index 0000000..de4f9c5
--- /dev/null
+++ b/doc/bugzilla.conf.txt
@@ -0,0 +1,18 @@
+bugzilla.conf(5)
+===============
+
+NAME
+----
+bugzilla.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides default configuration for 'reporter-bugzilla'.
+
+SEE ALSO
+--------
+reporter-bugzilla(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/bugzilla_anaconda_event.conf.txt b/doc/bugzilla_anaconda_event.conf.txt
new file mode 100644
index 0000000..421b338
--- /dev/null
+++ b/doc/bugzilla_anaconda_event.conf.txt
@@ -0,0 +1,19 @@
+bugzilla_anaconda_event.conf(5)
+===============================
+
+NAME
+----
+bugzilla_anaconda_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions of events specific for problems in
+'anaconda' package.
+
+SEE ALSO
+--------
+report_event.conf(5), report_Bugzilla.conf(5)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/bugzilla_event.conf.txt b/doc/bugzilla_event.conf.txt
new file mode 100644
index 0000000..e0a527f
--- /dev/null
+++ b/doc/bugzilla_event.conf.txt
@@ -0,0 +1,21 @@
+bugzilla_event.conf(5)
+=====================
+
+NAME
+----
+bugzilla_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions for events which uses
+'reporter-bugzilla'.
+
+By default the file contains definition for 'report_Bugzilla' event.
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-bugzilla(1), report_Bugzilla(5)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/bugzilla_format.conf.txt b/doc/bugzilla_format.conf.txt
new file mode 100644
index 0000000..e51a965
--- /dev/null
+++ b/doc/bugzilla_format.conf.txt
@@ -0,0 +1,18 @@
+bugzilla_format.conf(5)
+=======================
+
+NAME
+----
+bugzilla_format.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of general formatting for new Bugzilla bugs.
+
+SEE ALSO
+--------
+reporter-bugzilla(1)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/bugzilla_format_anaconda.conf.txt b/doc/bugzilla_format_anaconda.conf.txt
new file mode 100644
index 0000000..f7ca47b
--- /dev/null
+++ b/doc/bugzilla_format_anaconda.conf.txt
@@ -0,0 +1,19 @@
+bugzilla_format_anaconda.conf(5)
+================================
+
+NAME
+----
+bugzilla_format_anaconda.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of formatting for new Bugzilla bugs
+for problems in 'anaconda' package.
+
+SEE ALSO
+--------
+reporter-bugzilla(1), bugzilla_anaconda_events.conf(5)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/bugzilla_format_kernel.conf.txt b/doc/bugzilla_format_kernel.conf.txt
new file mode 100644
index 0000000..1aa8e54
--- /dev/null
+++ b/doc/bugzilla_format_kernel.conf.txt
@@ -0,0 +1,19 @@
+bugzilla_format_kernel.conf(5)
+==============================
+
+NAME
+----
+bugzilla_format_kernel.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of formatting for new Bugzilla bugs
+for Kernel oopses.
+
+SEE ALSO
+--------
+reporter-bugzilla(1), bugzilla_format.conf(5)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/bugzilla_format_libreport.conf.txt b/doc/bugzilla_format_libreport.conf.txt
new file mode 100644
index 0000000..80fcb33
--- /dev/null
+++ b/doc/bugzilla_format_libreport.conf.txt
@@ -0,0 +1,19 @@
+bugzilla_format_libreport.conf(5)
+================================
+
+NAME
+----
+bugzilla_format_libreport.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of formatting for new Bugzilla bugs
+for arbitrary problems reported over libreport.
+
+SEE ALSO
+--------
+reporter-bugzilla(1), bugzilla_format.conf(5), bugzilla_event.conf(5)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/bugzilla_formatdup.conf.txt b/doc/bugzilla_formatdup.conf.txt
new file mode 100644
index 0000000..7eadbc6
--- /dev/null
+++ b/doc/bugzilla_formatdup.conf.txt
@@ -0,0 +1,20 @@
+bugzilla_formatdup.conf(5)
+==========================
+
+NAME
+----
+bugzilla_formatdup.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of general formatting for
+additional comments to Bugzilla bugs which are found as duplicates of currently
+reported problem.
+
+SEE ALSO
+--------
+reporter-bugzilla(1)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/bugzilla_formatdup_anaconda.conf.txt b/doc/bugzilla_formatdup_anaconda.conf.txt
new file mode 100644
index 0000000..dd84f89
--- /dev/null
+++ b/doc/bugzilla_formatdup_anaconda.conf.txt
@@ -0,0 +1,19 @@
+bugzilla_formatdup_anaconda.conf(5)
+==================================
+
+NAME
+----
+bugzilla_formatdup_anaconda.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definition of formatting for additional
+comments of Bugzilla bugs for problems in 'anaconda' package.
+
+SEE ALSO
+--------
+reporter-bugzilla(1), bugzilla_anaconda_events.conf(5)
+
+AUTHOR
+------
+* ABRT Team
diff --git a/doc/emergencyanalysis_event.conf.txt b/doc/emergencyanalysis_event.conf.txt
new file mode 100644
index 0000000..fe36cc5
--- /dev/null
+++ b/doc/emergencyanalysis_event.conf.txt
@@ -0,0 +1,51 @@
+emergencyanalysis_event.conf(5)
+==============================
+
+NAME
+----
+emergencyanalysis_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file defines events for the emergency analysis. These events
+are supposed to be used when the standard reporting process fails.
+
+By default the file contains definition for 'report_EmergencyAnalysis' event
+applicable for all problem types.
+
+report_EmergencyAnalysis event configuration file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The configuration for report_EmergencyAnalysis event is read from /etc/libreport/events/report_EmergencyAnalysis.conf file if exists.
+
+The configuration file contains values for options defined in /usr/share/libreport/events/report_EmergencyAnalysis.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'Upload_URL'::
+	Configured upload URL
+
+'http_proxy'::
+	the proxy server to use for HTTP
+
+'HTTPS_PROXY'::
+	the proxy server to use for HTTPS
+
+'FTP_PROXY'::
+	the proxy server to use for FTP
+
+EXAMPLE
+-------
+The following example shows a possible configuration of
+'report_EmergencyAnalysis' event. In this particular case the event execution
+uploads an archive with all problem data to configured URL.
+
+EVENT=report_EmergencyAnalysis
+    reporter-upload
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-upload(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/forbidden_words.conf.txt b/doc/forbidden_words.conf.txt
new file mode 100644
index 0000000..2aa2044
--- /dev/null
+++ b/doc/forbidden_words.conf.txt
@@ -0,0 +1,38 @@
+forbidden_words.conf(5)
+=======================
+
+NAME
+----
+forbidden_words.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file specifies which words are highlighted in User Interface
+during the process of reporting a problem for the purpose of warning a user and
+getting his attention before he publish security sensitive data.
+
+The configuration format is one line per forbidden word.
+
+Users can provide own file with the list of forbidden words which will be
+appended to the list of forbidden words loaded from
+/etc/libreport/forbidden_words.conf
+
+EXAMPLES
+--------
+System configuration:
+
+/etc/libreport/forbidden_words.conf
+
+    password
+    login
+    mastercard
+
+User configuration:
+
+$XDG_CONFIG_HOME/abrt/settings/forbidden_words.conf
+
+    usersecretpassword
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/mailx.conf.txt b/doc/mailx.conf.txt
new file mode 100644
index 0000000..7c2c03b
--- /dev/null
+++ b/doc/mailx.conf.txt
@@ -0,0 +1,18 @@
+mailx.conf(5)
+===============
+
+NAME
+----
+mailx.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides default configuration for 'reporter-mailx'.
+
+SEE ALSO
+--------
+reporter-mailx(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/mailx_event.conf.txt b/doc/mailx_event.conf.txt
new file mode 100644
index 0000000..4393fd1
--- /dev/null
+++ b/doc/mailx_event.conf.txt
@@ -0,0 +1,42 @@
+mailx_event.conf(5)
+=====================
+
+NAME
+----
+mailx_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions for events which uses
+'reporter-mailx'.
+
+By default the file contains definition for 'report_Mailx', 'notify' and
+'notify-dup' events for all problem types.
+
+report_Mailx event configuration file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The configuration for report_Mailx event is read from /etc/libreport/events/report_Mailx.conf file if exists.
+
+The configuration file contains values for options defined in /usr/share/libreport/events/report_Mailx.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'Mailx_Subject'::
+   Message subject
+
+'Mailx_EmailFrom'::
+   Sender's email
+
+'Mailx_EmailTo'::
+   Recipient's email
+
+'Mailx_SendBinaryData'::
+   Send binary files like coredump
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-mailx(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/print_event.conf.txt b/doc/print_event.conf.txt
new file mode 100644
index 0000000..f8f8113
--- /dev/null
+++ b/doc/print_event.conf.txt
@@ -0,0 +1,21 @@
+print_event.conf(5)
+=====================
+
+NAME
+----
+print_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions for events which reports problems
+to file or standard output.
+
+By default the file contains definition only for 'report_Logger' event.
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-print(1), report_Logger.conf(5)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/report-gtk.txt b/doc/report-gtk.txt
index 20e3685..e1e1907 100644
--- a/doc/report-gtk.txt
+++ b/doc/report-gtk.txt
@@ -39,6 +39,58 @@ OPTIONS
 -x, --expert::
     Enabled advanced features
 
+CONFIGURATION
+-------------
+
+Reporting work flow configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These configuration files are placed in /usr/share/libreport/workflows.
+
+Each file has XML formatting with the following DTD:
+
+------------
+<!ELEMENT workflow    (name+,description+,events*)>
+<!ELEMENT name        (#PCDATA)>
+<!ATTLIST name         xml:lang CDATA #IMPLIED>
+<!ELEMENT description (#PCDATA)>
+<!ATTLIST description  xml:lang CDATA #IMPLIED>
+<!ELEMENT events =    (event)+>
+<!ELEMENT event =     (#PCDATA)>
+------------
+
+name::
+   User visible name
+
+description::
+   User visible description
+
+events::
+   List of executed events
+
+event::
+   Name of event. If event is not applicable on the problem data or if it is
+   not defined then process continues with next event sibling.
+
+EXAMPLES
+--------
+
+Simple reporting work flow
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+------------
+<workflow>
+  <name xml:lang="en">Example</name>
+  <name xml:lang="cs">Příklad</name>
+  <description xml:lang="en">Example description</description>
+  <description xml:lang="cs">Příklad popisu</description>
+  <evetns>
+     <event>analyze_example</event>
+     <event>collect_example</event>
+     <event>report_example</event>
+  </events>
+</workflow>
+------------
+
 AUTHORS
 -------
 * ABRT team
diff --git a/doc/report_Bugzilla.conf.txt b/doc/report_Bugzilla.conf.txt
new file mode 100644
index 0000000..ddcb452
--- /dev/null
+++ b/doc/report_Bugzilla.conf.txt
@@ -0,0 +1,45 @@
+report_Bugzilla.conf(5)
+=====================
+
+NAME
+----
+report_Bugzilla.conf - libreport's configuration file for 'report_Bugzilla' events.
+
+DESCRIPTION
+-----------
+This configuration file contains values for options defined in
+/usr/share/libreport/events/report_Bugzilla.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'Bugzilla_Login'::
+	Login to Bugzilla account.
+
+'Bugzilla_Password'::
+	Password to Bugzilla account.
+
+'Bugzilla_BugzillaURL'::
+	Bugzilla HTTP(S) address. (default: https://bugzilla.redhat.com)
+
+'Bugzilla_SSLVerify'::
+	Use yes/true/on/1 to verify server's SSL certificate. (default: yes)
+
+'Bugzilla_Product'::
+	Product bug field value. Useful if you needed different product than specified in /etc/os-release
+
+'Bugzilla_ProductVersion'::
+	Version bug field value. Useful if you needed different product version than specified in /etc/os-release
+
+'http_proxy'::
+	the proxy server to use for HTTP
+
+'HTTPS_PROXY'::
+	the proxy server to use for HTTPS
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-bugzilla(1), bugzilla_event.conf(5)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/report_Logger.conf.txt b/doc/report_Logger.conf.txt
new file mode 100644
index 0000000..8a10cd9
--- /dev/null
+++ b/doc/report_Logger.conf.txt
@@ -0,0 +1,27 @@
+report_Logger.conf(5)
+=====================
+
+NAME
+----
+report_Logger.conf - libreport's configuration file for 'report_Logger' events.
+
+DESCRIPTION
+-----------
+This configuration file contains values for options defined in
+/usr/share/libreport/events/report_Logger.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'Logger_Log_File'::
+	Name of the logfile.
+
+'Logger_Append'::
+	Append new reports or overwrite the old one.
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-print(1), print_event.conf(5)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/report_event.conf.txt b/doc/report_event.conf.txt
index 67e12e1..887c3e8 100644
--- a/doc/report_event.conf.txt
+++ b/doc/report_event.conf.txt
@@ -52,12 +52,99 @@ and may be used by abrt as such.
 If the program terminates successfully, next rule is read
 and processed. This process is repeated until the end of this file.
 
+Event XML configuration
+~~~~~~~~~~~~~~~~~~~~~~~
+These configuration files provides event meta data.
+
+Each file has XML formatting with the following DTD:
+
+-------------
+<!ELEMENT event            (name+,description+,requires-items?,exclude-items-by-default?,exclude-items-always?,exclude-binary-items?,include-items-by-default?,minimal-rating?,gui-review-elements?,options?)>
+<!ELEMENT name             (#PCDATA)>
+<!ATTLIST name             xml:lang CDATA #IMPLIED>
+<!ELEMENT description      (#PCDATA)>
+<!ATTLIST description      xml:lang CDATA #IMPLIED>
+<!ELEMENT requires-items           (#PCDATA)>
+<!ELEMENT exclude-items-by-default (#PCDATA)>
+<!ELEMENT include-items-by-default (#PCDATA)>
+<!ELEMENT exclude-items-always     (#PCDATA)>
+<!ELEMENT exclude-binary-items     ("yes"|"no")>
+<!ELEMENT minimal-rating           ("0"|"1"|"2"|"3"|"4")>
+<!ELEMENT gui-review-elements      ("yes"|"no")>
+<!ELEMENT options          (option*,advanced-options)>
+<!ELEMENT advanced-options (option)*>
+<!ELEMENT option           (label+,description+,note-html+,allow-empty?,default-value?)>
+<!ATTLIST option           type (text|bool|password|number|hint-html) #REQUIRED
+                           name CDATA #REQUIRED>
+<!ELEMENT label            (#PCDATA)>
+<!ATTLIST label            xml:lang CDATA #IMPLIED>
+<!ELEMENT note-html        (#PCDATA)>
+<!ATTLIST note-html        xml:lang CDATA #IMPLIED>
+<!ELEMENT allow-empty      ("yes"|"no")>
+<!ELEMENT default-value    (#PCDATA)>
+-------------
+
+name::
+    User visible name of event
+
+description::
+    User visible description
+
+exclude-items-by-default::
+    Comma separated names of excluded problem elements. User can include any
+    of these elements if he wishes it.
+
+include-items-by-default::
+    Comma separated names of included problem elements. User can exclude any
+    of these elements if he wishes it.
+
+exclude-items-always::
+    Comma separated names of included problem elements. User cannot include
+    any of these elements.
+
+exclude-binary-items::
+    If "yes" then all binary problem elements are excluded. User can include
+    them if he wishes it.
+
+minimal-rating::
+    Minimal backtrace rating required for executing the event. Backtrace rating
+    is a measure of backtrace usability and understandability. With an
+    increasing number of unresolved frames the backtrace rating gets lower
+    values.
+
+gui-review-elements::
+    If "yes", user must explicitly approve that all included problem elements
+    can be published. If "no", the event is executed automatically. If not
+    provided, "yes" is expected.
+
+advanced-options::
+    List of options which are hidden in the default view.
+
+label::
+    Event option label
+
+note-html::
+    Event option HTML formatted description
+
+allow-empty::
+    Determines if user can leave the option empty
+
+default-value::
+    A value which is used by default
+
+option:name::
+    Name of exported environment variable name. libreport tools communicate
+    through Environment Variables.
+
 EXAMPLES
 --------
+
+------------
 EVENT=post-create analyzer=Python   abrt-action-analyze-python
 
 EVENT=post-create
         getent passwd "`cat uid`" | cut -d: -f1 >username
+------------
 
 SEE ALSO
 --------
diff --git a/doc/report_fedora.conf.txt b/doc/report_fedora.conf.txt
new file mode 100644
index 0000000..125bd71
--- /dev/null
+++ b/doc/report_fedora.conf.txt
@@ -0,0 +1,40 @@
+report_fedora.conf(5)
+=====================
+
+NAME
+----
+report_fedora.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file specifies which of the reporting work flow definitions
+are applicable for all problems types on Fedora.
+
+All applicable reporting work flows are presented to users in User Interface as
+possibilities for processing of particular problem in 'anaconda' package.
+
+This configuration file consists from one condition per line.
+
+Each condition line must start with EVENT=workflow_NAME where "workflow_" is
+constant prefix and "workflow_NAME" is base name of path to reporting work flow
+configuration file.
+
+The rest of condition line has form VAR=VAL, VAR!=VAL or VAL~=REGEX, where VAR
+is a name of problem directory element to be checked (for example,
+"executable", "package", hostname" etc). The condition may consists
+from as many element checks as it is necessary.
+
+EXAMPLES
+--------
+Condition line::
+    EVENT=workflow_FedoraCCpp analyzer=CCpp
+
+The condition line above expects existence of /usr/share/libreport/workflows/workflow_FedoraCCpp.xml
+
+SEE ALSO
+--------
+report-gtk(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/report_rhel.conf.txt b/doc/report_rhel.conf.txt
new file mode 100644
index 0000000..e2e5b0e
--- /dev/null
+++ b/doc/report_rhel.conf.txt
@@ -0,0 +1,40 @@
+report_rhel.conf(5)
+=====================
+
+NAME
+----
+report_rhel.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file specifies which of the reporting work flow definitions
+are applicable for all problems types on Red Hat Enterprise Linux.
+
+All applicable reporting work flows are presented to users in User Interface as
+possibilities for processing of particular problem in 'anaconda' package.
+
+This configuration file consists from one condition per line.
+
+Each condition line must start with EVENT=workflow_NAME where "workflow_" is
+constant prefix and "workflow_NAME" is base name of path to reporting work flow
+configuration file.
+
+The rest of condition line has form VAR=VAL, VAR!=VAL or VAL~=REGEX, where VAR
+is a name of problem directory element to be checked (for example,
+"executable", "package", hostname" etc). The condition may consists
+from as many element checks as it is necessary.
+
+EXAMPLES
+--------
+Condition line::
+    EVENT=workflow_RHELCCpp analyzer=CCpp
+
+The condition line above expects existence of /usr/share/libreport/workflows/workflow_RHELCCpp.xml
+
+SEE ALSO
+--------
+report-gtk(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/reporter-bugzilla.txt b/doc/reporter-bugzilla.txt
index e4fa996..e9e9051 100644
--- a/doc/reporter-bugzilla.txt
+++ b/doc/reporter-bugzilla.txt
@@ -7,7 +7,7 @@ reporter-bugzilla - Reports problem to Bugzilla.
 
 SYNOPSIS
 --------
-'reporter-bugzilla' [-vbf] [-g GROUP]... [-c CONFFILE]... -d DIR
+'reporter-bugzilla' [-vbf] [-g GROUP]... [-c CONFFILE]... [-F FMTFILE] [-A FMTFILE2] -d DIR
 
 Or:
 
@@ -15,6 +15,10 @@ Or:
 
 Or:
 
+'reporter-bugzilla' [-v] [-c CONFFILE]... [-d DIR] -t[ID] -w
+
+Or:
+
 'reporter-bugzilla' [-v] [-c CONFFILE]... -h DUPHASH
 
 DESCRIPTION
@@ -40,6 +44,8 @@ If problem data in DIR was never reported to Bugzilla, upload will fail.
 Option -tID uploads FILEs to the bug with specified ID on Bugzilla site.
 -d DIR is ignored.
 
+Option -w adds bugzilla user to bug's CC list.
+
 Configuration file
 ~~~~~~~~~~~~~~~~~~
 If not specified, CONFFILE defaults to /etc/libreport/plugins/bugzilla.conf.
@@ -57,11 +63,56 @@ Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
 'SSLVerify'::
 	Use yes/true/on/1 to verify server's SSL certificate. (default: yes)
 
-'OSRelease'::
-	OS release string. Useful if your /etc/system-release is non-standard.
+'Product'::
+	Product bug field value. Useful if you needed different product than specified in /etc/os-release
+
+'ProductVersion'::
+	Version bug field value. Useful if you needed different product version than specified in /etc/os-release
 
 Parameters can be overridden via $Bugzilla_PARAM environment variables.
 
+Formatting configuration files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Lines starting with # are ignored.
+
+Lines can be continued on the next line using trailing backslash.
+
+Format:
+
+   "%summary:: summary format"
+   "section:: element1[,element2]..."
+   The literal text line to be added to Bugzilla comment. Can be empty.
+   (Empty lines are NOT ignored!)
+
+   Summary format is a line of text, where %element% is replaced by
+   text element's content, and [[...%element%...]] block is used only if
+   %element% exists. [[...]] blocks can nest.
+
+   Sections can be:
+   - %summary: bug summary format string.
+   - %attach: a list of elements to attach.
+   - text, double colon (::) and the list of comma-separated elements.
+
+   Elements can be:
+   - problem directory element names, which get formatted as
+     <element_name>: <contents>
+     or
+     <element_name>:
+     :<contents>
+     :<contents>
+     :<contents>
+   - problem directory element names prefixed by "%bare_",
+     which is formatted as-is, without "<element_name>:" and colons
+   - %oneline, %multiline, %text wildcards, which select all corresponding
+     elements for output or attachment
+   - %binary wildcard, valid only for %attach section, instructs to attach
+     binary elements
+   - problem directory element names prefixed by "-",
+     which excludes given element from all wildcards
+
+     Nonexistent elements are silently ignored.
+     If none of elements exists, the section will not be created.
+
 Integration with ABRT events
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 'reporter-bugzilla' can be used as an ABRT reporter. Example
@@ -87,9 +138,18 @@ OPTIONS
 -f::
    Force reporting even if this problem is already reported.
 
+-F CONF_FORMAT_FILE::
+   Formatting file for initial comment. Default: /etc/libreport/plugins/bugzilla_format.conf
+
+-A CONF_FORMAT_FILE::
+   Formatting file for duplicates. Default: /etc/libreport/plugins/bugzilla_format.conf
+
 -t[ID]::
    Upload FILEs to the already created bug on Bugzilla site.
 
+-w::
+   Add bugzilla user to CC list [of bug with this ID]. Applicable only with -t.
+
 -h::
 --duphash DUPHASH::
    Search in Bugzilla by abrt's DUPHASH and print BUG_ID.
@@ -98,9 +158,38 @@ OPTIONS
 --group GROUP::
    When creating a new ticket restrict access to this group only.
 
+ENVIRONMENT VARIABLES
+---------------------
+Environment variables take precedence over values provided in
+the configuration file.
+
+'Bugzilla_Login'::
+	Login to Bugzilla account.
+
+'Bugzilla_Password'::
+	Password to Bugzilla account.
+
+'Bugzilla_BugzillaURL'::
+	Bugzilla HTTP(S) address. (default: https://bugzilla.redhat.com)
+
+'Bugzilla_SSLVerify'::
+	Use yes/true/on/1 to verify server's SSL certificate. (default: yes)
+
+'Bugzilla_Product'::
+	Product bug field value. Useful if you needed different product than specified in /etc/os-release
+
+'Bugzilla_ProductVersion'::
+	Version bug field value. Useful if you needed different product version than specified in /etc/os-release
+
+'http_proxy'::
+	the proxy server to use for HTTP
+
+'HTTPS_PROXY'::
+	the proxy server to use for HTTPS
+
 SEE ALSO
 --------
-abrt_event.conf
+report_event.conf, bugzilla_format.conf
 
 AUTHORS
 -------
diff --git a/doc/rhtsupport.conf.txt b/doc/rhtsupport.conf.txt
new file mode 100644
index 0000000..87014fe
--- /dev/null
+++ b/doc/rhtsupport.conf.txt
@@ -0,0 +1,18 @@
+rhtsupport.conf(5)
+=================
+
+NAME
+----
+rhtsupport.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides default configuration for 'reporter-rhtsupport'.
+
+SEE ALSO
+--------
+reporter-rhtsupport(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/rhtsupport_event.conf.txt b/doc/rhtsupport_event.conf.txt
new file mode 100644
index 0000000..d8d522c
--- /dev/null
+++ b/doc/rhtsupport_event.conf.txt
@@ -0,0 +1,42 @@
+rhtsupport_event.conf(5)
+=======================
+
+NAME
+----
+rhtsupport_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions for events which use
+'reporter-rhtsupport'.
+
+By default the file contains definition for single 'report_RHTSupport' event
+applicable for all problem types.
+
+report_RHTSupport event configuration file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The configuration for report_RHTSupport event is read from /etc/libreport/events/report_RHTSupport.conf file if exists.
+
+The configuration file contains values for options defined in /usr/share/libreport/events/report_RHTSupport.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'RHTSupport_URL'::
+	Address of the Red Hat support portal
+
+'RHTSupport_Login'::
+	Red Hat customer user name
+
+'RHTSupport_Password'::
+	Red Hat customer user password
+
+'RHTSupport_SSLVerify'::
+	Use yes/true/on/1 to verify server's SSL certificate. (default: yes)
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-rhtsupport(1)
+
+AUTHOR
+------
+* ABRT team
diff --git a/doc/uploader_event.conf.txt b/doc/uploader_event.conf.txt
new file mode 100644
index 0000000..33cfe10
--- /dev/null
+++ b/doc/uploader_event.conf.txt
@@ -0,0 +1,42 @@
+uploader_event.conf(5)
+=====================
+
+NAME
+----
+uploader_event.conf - configuration file for libreport.
+
+DESCRIPTION
+-----------
+This configuration file provides definitions for events which use
+'reporter-uploader'.
+
+By default the file contains definition for single 'report_Uploader' event
+applicable for all problem types.
+
+report_Uploader event configuration file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The configuration for report_Uploader event is read from /etc/libreport/events/report_Uploader.conf file if exists.
+
+The configuration file contains values for options defined in /usr/share/libreport/events/report_Uploader.xml
+
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
+
+'Upload_URL'::
+	Configured upload URL
+
+'http_proxy'::
+	the proxy server to use for HTTP
+
+'HTTPS_PROXY'::
+	the proxy server to use for HTTPS
+
+'FTP_PROXY'::
+	the proxy server to use for FTP
+
+SEE ALSO
+--------
+report_event.conf(5), reporter-uploader(1)
+
+AUTHOR
+------
+* ABRT team
-- 
1.8.3.1



More information about the Crash-catcher mailing list