diff options
author | Denys Vlasenko <dvlasenk@redhat.com> | 2011-05-02 19:52:39 +0200 |
---|---|---|
committer | Denys Vlasenko <dvlasenk@redhat.com> | 2011-05-02 19:52:39 +0200 |
commit | f06cd3a1382110566dd4a834a951a09d34eae0d8 (patch) | |
tree | 616b9242f98af23af913fb6794e1878ab88c3f42 /src/plugins/abrt-action-mailx.txt | |
parent | 83514402882c80fe6bc7ac989ca78ad3cb122464 (diff) | |
parent | cdec5d0d390d8f77230a5cb6b8872e7bf7e92ea1 (diff) | |
download | abrt-f06cd3a1382110566dd4a834a951a09d34eae0d8.tar.gz abrt-f06cd3a1382110566dd4a834a951a09d34eae0d8.tar.xz abrt-f06cd3a1382110566dd4a834a951a09d34eae0d8.zip |
Merge branch 'master' of ssh://git.fedorahosted.org/git/abrt
Diffstat (limited to 'src/plugins/abrt-action-mailx.txt')
-rw-r--r-- | src/plugins/abrt-action-mailx.txt | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/src/plugins/abrt-action-mailx.txt b/src/plugins/abrt-action-mailx.txt new file mode 100644 index 00000000..2fb11bef --- /dev/null +++ b/src/plugins/abrt-action-mailx.txt @@ -0,0 +1,91 @@ +abrt-action-mailx(1) +==================== + +NAME +---- +abrt-action-mailx - Sends contents of a dump directory via email. + +SYNOPSIS +-------- +'abrt-action-mailx' [-v] -d DIR [-c CONFFILE] + +DESCRIPTION +----------- +The tool reads a problem dump directory, composes an email message +from the directory contents, and uses mailx to send the message to +specified recipient. + +Properties of email messages can be specified in a configuration file, +and via environment variables. + +Configuration file +~~~~~~~~~~~~~~~~~~ +Configuration file contains entries in a format "Option = Value". + +The options are: + +'Subject':: + The subject of the email message. + +'EmailFrom':: + The sender of the email message. + +'EmailTo':: + The recipient of the email message. + +'SendBinaryData':: + Use yes/true/on/1 to attach all binary files from the dump + directory to the email. This can cause the emails to be very + large. + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-action-mailx' can be used as a reporter, to allow users report +problems via email when they decide to do it. This usage is +pre-configured in /etc/abrt/events.d/mailx_events.conf: + +------------ +EVENT=report_Mailx abrt-action-mailx +------------ + +It can also be used to notify administrator automatically when a +problem happens. When this is desired, modify the event configuration +file to run the tool on the 'post-create' event: + +------------ +EVENT=post-create abrt-action-mailx +------------ + +OPTIONS +------- +-d DIR:: + Path to dump directory. + +-c CONFFILE:: + Path to configration file. When used in ABRT event system, the file + contains site-wide configuration. Users can change the values via + environment variables. + +ENVIRONMENT VARIABLES +--------------------- +Environment variables take precedence over values provided in +the configuration file. + +'Mailx_Subject':: + Subject of the email message. + +'Mailx_EmailFrom':: + Sender of the email message. + +'Mailx_EmailTo':: + Recipient of the email message. If nor the environment variable + nor the corresponding option is defined, the message is send to + "root@localhost". + +'Mailx_SendBinaryData':: + Use yes/true/on/1 to attach all binary files from the dump + directory to the email. + +AUTHORS +------- +* ABRT team |