summaryrefslogtreecommitdiffstats
path: root/src/daemon
diff options
context:
space:
mode:
authorDenys Vlasenko <dvlasenk@redhat.com>2011-04-21 11:49:10 +0200
committerDenys Vlasenko <dvlasenk@redhat.com>2011-04-21 11:49:10 +0200
commit48660b80feead608d60bdbabd8f98a50652b0a06 (patch)
treeb57d66ba9ceb5ef7701dbcaa8aff0546c8d43dfb /src/daemon
parent884c0aed054302cb1cbb71c2b21c12df92a7e6e4 (diff)
downloadabrt-48660b80feead608d60bdbabd8f98a50652b0a06.zip
abrt-48660b80feead608d60bdbabd8f98a50652b0a06.tar.gz
abrt-48660b80feead608d60bdbabd8f98a50652b0a06.tar.xz
abrt_event.conf.5: new manpage. closes #132
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
Diffstat (limited to 'src/daemon')
-rw-r--r--src/daemon/Makefile.am7
-rw-r--r--src/daemon/abrt.conf.524
-rw-r--r--src/daemon/abrt_event.conf21
-rw-r--r--src/daemon/abrt_event.conf.562
4 files changed, 82 insertions, 32 deletions
diff --git a/src/daemon/Makefile.am b/src/daemon/Makefile.am
index 6bb71b7..63d1d78 100644
--- a/src/daemon/Makefile.am
+++ b/src/daemon/Makefile.am
@@ -105,13 +105,16 @@ dist_daemonconf_DATA = \
comredhatabrtservicedir = ${datadir}/dbus-1/system-services
dist_comredhatabrtservice_DATA = com.redhat.abrt.service
-man_MANS = abrtd.8 abrt.conf.5
+man_MANS = \
+ abrtd.8 \
+ abrt.conf.5 \
+ abrt_event.conf.5
EXTRA_DIST = $(man_MANS) abrt-handle-upload
if HAVE_SYSTEMD
dist_systemdsystemunit_DATA = \
- abrtd.service
+ abrtd.service
endif
DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@
diff --git a/src/daemon/abrt.conf.5 b/src/daemon/abrt.conf.5
index 84c8f00..87bbdb7 100644
--- a/src/daemon/abrt.conf.5
+++ b/src/daemon/abrt.conf.5
@@ -9,10 +9,8 @@ it collects the crash data and takes action according to
its configuration. This manual page describes \fIabrt\fP's configuration
file.
.P
-The configuration file consists of sections, each section contains
-several items in the format "Option = Value". A description of each
-section follows:
-.SS [Common]
+The configuration file consists of items in the format "Option = Value".
+A description of each item follows:
.TP
.B OpenGPGCheck = \fIyes\fP | \fIno\fP
When set to "yes",
@@ -20,7 +18,7 @@ When set to "yes",
will report crashes only in GPG signed packages. When set to "no",
it will report crashes also in unsigned packages. The default is "no".
.TP
-.B OpenGPGPublicKeys = \fIfilename\fP , \fIfilename\fP ...
+.B OpenGPGPublicKeys = \fIfilename\fP, \fIfilename\fP ...
These are the trusted GPG keys with which packages have to be
signed for
.I abrt
@@ -49,22 +47,6 @@ will catch all crashes in the system. When set to "no",
it will catch crashes only in Fedora packages.
The default is "no".
-.SS [ AnalyzerActionsAndReporters ]
-This section contains associations between analyzers and action
-or reporter plugins.
-.TP
-.B CCpp = \fIplugin\fP
-.I abrt
-will use this plugin 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.
.SH "SEE ALSO"
.IR abrtd (8),
.IR abrt-plugins (7)
diff --git a/src/daemon/abrt_event.conf b/src/daemon/abrt_event.conf
index aa57820..73bfd63 100644
--- a/src/daemon/abrt_event.conf
+++ b/src/daemon/abrt_event.conf
@@ -1,8 +1,15 @@
# This configuration file specifies which programs should be run
-# when the specified event occurs in crash dump lifetime.
+# when the specified event occurs in dump directory lifetime.
#
-# Example:
-# EVENT=post-create { pwd; date; }>/tmp/dt; echo $HOSTNAME `uname -r`
+# It consists of directives and rules.
+#
+# Directives start with a reserved word. Currently, there is only one
+# directive, "include". Its format is "include FILE".
+# It causes files which match FILE to be read and
+# parsed as if they are inserted textually where this directive
+# occurs. FILE can use shell pattern metacharacters (*,?,etc) to
+# specify multiple files. Relative paths are interpreted relative
+# to current file.
#
# Rule starts with a line with non-space leading character.
# All subsequent lines which start with space or tab form one rule.
@@ -13,15 +20,11 @@
# Rules may be commented out with #. One # is sufficient to comment out
# even a multi-line rule (no need to comment out every line).
#
-# Rule of the form "include GLOB_PATTERN" recurses to each file which matches
-# GLOB_PATTERN. Example: "include post-create.d/*.conf"
-#
-# Any other rules specify which programs to run on the crash dump.
-#
+# Rules specify which programs to run on the dump directory.
# Each rule may have conditions to be checked before the program is run.
#
# Conditions have form VAR=VAL, where VAR is either word "EVENT"
-# or a name of crash dump element to be checked (for example,
+# or a name of dump directory element to be checked (for example,
# "executable", "package", hostname" etc).
#
# If all conditions match, the remaining part of the rule
diff --git a/src/daemon/abrt_event.conf.5 b/src/daemon/abrt_event.conf.5
new file mode 100644
index 0000000..fbf1514
--- /dev/null
+++ b/src/daemon/abrt_event.conf.5
@@ -0,0 +1,62 @@
+.TH "abrt.conf" "5" "28 May 2009" ""
+.SH NAME
+abrt_event.conf \- configuration file for ABRT
+.SH DESCRIPTION
+.P
+This configuration file specifies which programs should be run
+when the specified event occurs in dump directory lifetime.
+.P
+It consists of directives and rules.
+.P
+Directives start with a reserved word. Currently, there is
+only one directive, "include".
+.TP
+.B include \fIFILE\fP
+This directive causes files which match FILE to be read
+and parsed as if they are inserted textually where this directive
+occurs.
+FILE can use shell pattern metacharacters (*,?,etc) to specify
+multiple files. Relative paths are interpreted relative to current
+file.
+.P
+Rule starts with a line with non-space leading character.
+All subsequent lines which start with space or tab form one rule.
+Note that separating newline is retained.
+.P
+Rules may be commented out with #. One # is sufficient to comment out
+even a multi-line rule (no need to comment out every line).
+.P
+Rules specify which programs to run on the dump directory.
+Each rule may have conditions to be checked before the program is run.
+.P
+Conditions have form VAR=VAL, where VAR is either word "EVENT"
+or a name of dump directory element to be checked (for example,
+"executable", "package", hostname" etc).
+.P
+If all conditions match, the remaining part of the rule
+(the "program" part) is run in the shell.
+All shell language constructs are valid.
+All stdout and stderr output is captured and passed to ABRT
+and possibly to ABRT's frontends and shown to the user.
+.P
+If the program terminates with nonzero exit code,
+the event processing is considered unsuccessful and is stopped.
+Last captured output line, if any, is considered to be
+the error message indicating the reason of the failure,
+and may be used by abrt as such.
+.P
+If the program terminates successfully, next rule is read
+and processed. This process is repeated until the end of this file.
+.SH EXAMPLES
+.P
+EVENT=post-create analyzer=Python abrt-action-analyze-python
+.P
+EVENT=post-create
+ getent passwd "`cat uid`" | cut -d: -f1 >username
+.SH "SEE ALSO"
+.IR abrtd (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>.