[deployment-guide] Updated the "ABRT" chapter for Fedora 15.
Jaromir Hradilek
jhradile at fedoraproject.org
Mon May 23 17:42:47 UTC 2011
commit 7e08e130d4d115776a437c4bf244db75a04ee61b
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Mon May 23 19:40:31 2011 +0200
Updated the "ABRT" chapter for Fedora 15.
Well, somehow. :-/
en-US/Automatic_Bug_Reporting_Tool_ABRT.xml | 228 +++++++++++----------------
en-US/images/abrt-alert.png | Bin 0 -> 4424 bytes
en-US/images/abrt-event-configuration.png | Bin 0 -> 24847 bytes
en-US/images/abrt.png | Bin 0 -> 98481 bytes
4 files changed, 95 insertions(+), 133 deletions(-)
---
diff --git a/en-US/Automatic_Bug_Reporting_Tool_ABRT.xml b/en-US/Automatic_Bug_Reporting_Tool_ABRT.xml
index a431dda..45055b6 100644
--- a/en-US/Automatic_Bug_Reporting_Tool_ABRT.xml
+++ b/en-US/Automatic_Bug_Reporting_Tool_ABRT.xml
@@ -32,22 +32,21 @@
</para>
</listitem>
</itemizedlist>
- <para>You can open the <application>ABRT</application> GUI application by clicking <menuchoice><guimenu>Applications</guimenu>
- <guisubmenu>System Tools</guisubmenu><guimenuitem>Automatic Bug Reporting Tool</guimenuitem></menuchoice>.
- </para>
- <mediaobject id="mediaobj-ABRT-Main_Window">
- <imageobject>
- <imagedata align="center" fileref="images/ABRT-Main_Window.png" format="PNG" />
- </imageobject>
- <caption>
- <para>The Automatic Bug Reporting Tool main window</para>
- </caption>
- </mediaobject>
- <para>A number of additional packages can be installed to provide <application>ABRT</application> plugins and addons. To view all the available <application>ABRT</application> packages, type the following command:
-<screen>
-<command>~]$ yum list all | grep abrt</command>
- </screen>
+ <para>You can open the <application>ABRT</application> GUI application by selecting <menuchoice><guimenu>Applications</guimenu><guisubmenu>System Tools</guisubmenu><guimenuitem>Automatic Bug Reporting Tool</guimenuitem></menuchoice> from the <guimenu>Activities</guimenu> menu.
</para>
+ <figure id="fig-ABRT-Main_Window">
+ <title>The Automatic Bug Reporting Tool main window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata align="center" fileref="images/abrt.png" format="PNG" scalefit="0" />
+ </imageobject>
+ <textobject>
+ <para>The Automatic Bug Reporting Tool main window</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>A number of additional packages can be installed to provide <application>ABRT</application> plugins and addons. To view all the available <application>ABRT</application> packages, type the following command:</para>
+ <screen><command>yum list all | grep abrt</command></screen>
</section>
<section>
<title>Installing and Running ABRT</title>
@@ -55,41 +54,34 @@
</para>
<note>
<title>Installing the ABRT packages</title>
- <para>In order to use <application>ABRT</application>, first ensure the <command>abrt-desktop</command> package is installed on your system by running, as root:
+ <para>In order to use <application>ABRT</application>, first ensure the <command>abrt-desktop</command> package is installed on your system by running, as <systemitem class="username">root</systemitem>:
</para>
- <screen>~]# <command>yum install abrt-desktop</command>
- </screen>
+ <screen><command>yum install abrt-desktop</command></screen>
<para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
</note>
<para>
- <application>ABRT</application> is typically configured to start up at boot time. You can check that the <systemitem class="daemon">abrtd</systemitem> daemon is running by running the following command, as root:</para>
- <screen>~]# <command>service abrtd status</command>
-abrt (pid 1559) is running...</screen>
+ <application>ABRT</application> is typically configured to start up at boot time. You can check that the <systemitem class="daemon">abrtd</systemitem> daemon is running by running the following command, as <systemitem class="username">root</systemitem>:</para>
+ <screen><command>systemctl is-active abrtd.service</command></screen>
<para>If you receive <computeroutput>abrt is stopped</computeroutput>, you can start the <systemitem class="daemon">abrtd</systemitem>
- service by running, as root:</para>
- <screen>~]# <command>service abrtd start</command>
-Starting abrt daemon: [ OK ]</screen>
- <para>You can ensure that the <systemitem class="daemon">abrtd</systemitem> service initializes at startup time by running the following command, as root:</para>
- <screen>~]# <command>chkconfig abrtd on</command>
- </screen>
+ service by running, as <systemitem class="username">root</systemitem>:</para>
+ <screen><command>systemctl start abrtd.service</command></screen>
+ <para>You can ensure that the <systemitem class="daemon">abrtd</systemitem> service initializes at startup time by running the following command, as <systemitem class="username">root</systemitem>:</para>
+ <screen><command>systemctl enable abrtd.service</command></screen>
<para>
- <application>ABRT</application>'s applet can be started by hand by running the <command>abrt-applet</command> program as a normal user when logged into your desktop session, or by arranging for it to be started when the GUI session is initialized. For example, on the GNOME desktop, this can be configured in <menuchoice><guimenu>System</guimenu>
- <guimenuitem>Preferences</guimenuitem>
- <guimenuitem>Startup Applications</guimenuitem>
- </menuchoice>.</para>
- <mediaobject id="mediaobj-ABRT-Notification_Area_alarm_icon">
- <imageobject>
- <imagedata align="center" fileref="images/ABRT-Notification_Area_alarm_icon.png" width="29" format="PNG" />
- </imageobject>
- <caption>
- <para>The ABRT alarm icon</para>
- </caption>
- </mediaobject>
- <para>When a crash is detected and saved, a broadcast <systemitem>D-Bus</systemitem> message is sent about this crash. If <command>abrt-applet</command> is running, it receives this message and displays a red alarm icon in the Notification Area. You can open the GUI application by clicking on this icon.</para>
- <para>Alternatively, you can open the <application>ABRT</application> GUI application by clicking <menuchoice><guimenu>Applications</guimenu>
- <guisubmenu>System Tools</guisubmenu>
- <guimenuitem>Automatic Bug Reporting Tool</guimenuitem>
- </menuchoice>.
+ <application>ABRT</application>'s applet can be started by hand by running the <command>abrt-applet</command> program as a normal user when logged into your desktop session, or by arranging for it to be started when the GUI session is initialized.</para>
+ <figure id="fig-ABRT-Notification_Area_alarm_icon">
+ <title>The ABRT problem report</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/abrt-alert.png" format="PNG" scalefit="0" />
+ </imageobject>
+ <textobject>
+ <para>The ABRT problem report</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>When a crash is detected and saved, a broadcast <systemitem>D-Bus</systemitem> message is sent about this crash. If <command>abrt-applet</command> is running, it receives this message and displays an alarm icon in the Notification Area. You can open the GUI application by clicking on this icon.</para>
+ <para>Alternatively, you can open the <application>ABRT</application> GUI application by selecting <menuchoice><guimenu>Applications</guimenu><guisubmenu>System Tools</guisubmenu><guimenuitem>Automatic Bug Reporting Tool</guimenuitem></menuchoice> from the <guimenu>Activities</guimenu> menu.
</para>
</section>
<section id="abrt-plugins">
@@ -97,9 +89,7 @@ Starting abrt daemon: [ OK ]</screen>
ABRT Plugins</title>
<para>
<application>ABRT</application> offers a variety of analyzer plugins and reporter plugins. These plugins are described in the following two sections. Not all of the plugins mentioned in the following sections are installed by default. To view all available plugins, run the following command:
- <screen>
-<command>]$ yum list all | grep abrt-plugin-*</command>
- </screen>
+ <screen><command>yum list all | grep abrt-plugin-*</command></screen>
</para>
<section id="analyzer-plugins">
<title>Analyzer Plugins</title>
@@ -190,9 +180,7 @@ Starting abrt daemon: [ OK ]</screen>
<section id="configuring-plugins-in-the-gui">
<title>Plugin Configuration in the GUI</title>
<para>
- You can override the system-wide plugin configuration in the <filename>/etc/abrt/plugins/*.conf</filename> configuration files on a per-user basis. Each of the plugins specified in section <xref linkend="reporter-plugins"/> can be configured in the <application>ABRT</application> GUI application. Open the plugins window by clicking <menuchoice><guimenu>Edit</guimenu>
- <guisubmenu>Plugins</guisubmenu>
- </menuchoice>. This window shows a list of all installed plugins. You can also view each of the plugins' details by selecting one and expanding <guimenu>Plugin Details</guimenu>. When you select one of the configurable plugins, you can click the <guibutton>Configure plugin</guibutton> button and you will be able to configure your desired plugin. If you change any of the plugins' parameters, they are saved in the Gnome keyring and will be used in the future GUI sessions.
+ You can override the system-wide plugin configuration in the <filename>/etc/abrt/plugins/*.conf</filename> configuration files on a per-user basis. Each of the plugins specified in section <xref linkend="reporter-plugins"/> can be configured in the <application>ABRT</application> GUI application. Open the plugins window by clicking <menuchoice><guimenu>Edit</guimenu><guisubmenu>Event configuration</guisubmenu></menuchoice>. This window shows a list of all installed plugins. <!-- You can also view each of the plugins' details by selecting one and expanding <guimenu>Plugin Details</guimenu>. --> When you select one of the configurable plugins, you can click the <guibutton>Configure Event</guibutton> button and you will be able to configure your desired plugin. If you change any of the plugins' parameters, they are saved in the GNOME Keyring and will be used in the future GUI sessions.
</para>
<note>
<title>Do not store sensitive data in global configuration files</title>
@@ -200,14 +188,17 @@ Starting abrt daemon: [ OK ]</screen>
All of the <filename>/etc/abrt/plugins/*.conf</filename> configuration files are world readable and are meant to be used as global settings. Thus, it is not advisable to store usernames, passwords or any other sensitive data in them. The per-user settings (set in the GUI application and readable by the owner of $HOME only) are stored in the Gnome keyring or can be stored in a text file in <filename>$HOME/.abrt/*.conf</filename> for use in <command>abrt-cli</command>.
</para>
</note>
- <mediaobject id="mediaobj-abrt-plugins">
- <imageobject>
- <imagedata align="center" fileref="images/ABRT-plugins.png" format="PNG"/>
- </imageobject>
- <caption>
- <para>ABRT plugins</para>
- </caption>
- </mediaobject>
+ <figure id="mediaobj-abrt-plugins">
+ <title>ABRT plugins</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/abrt-event-configuration.png" format="PNG" scalefit="0" />
+ </imageobject>
+ <textobject>
+ <para>ABRT plugins</para>
+ </textobject>
+ </mediaobject>
+ </figure>
<para>
The following is a list of all configuration options available for each configurable plugin in the <application>ABRT</application> GUI application.
</para>
@@ -397,17 +388,17 @@ Starting abrt daemon: [ OK ]</screen>
<itemizedlist>
<listitem>
<para>
- <command>Backtrace = <replaceable><yes/no></replaceable></command> — Enables/Disables backtrace generation.
+ <command>Backtrace = <replaceable>yes/no</replaceable></command> — Enables/Disables backtrace generation.
</para>
</listitem>
<listitem>
<para>
- <command>BacktraceRemotes = <replaceable><yes/no></replaceable></command> — For more information about this parameter, refer to <xref linkend="configuring-centralized-crash-collection"/>.
+ <command>BacktraceRemotes = <replaceable>yes/no</replaceable></command> — For more information about this parameter, refer to <xref linkend="configuring-centralized-crash-collection"/>.
</para>
</listitem>
<listitem>
<para>
- <command>InstallDebugInfo = <replaceable><yes/no></replaceable></command> — Enables/Disables the installation of <package>debuginfo</package> packages (useful if your network is not available or it is firewalled).
+ <command>InstallDebugInfo = <replaceable>yes/no</replaceable></command> — Enables/Disables the installation of <package>debuginfo</package> packages (useful if your network is not available or it is firewalled).
</para>
</listitem>
<listitem>
@@ -429,8 +420,7 @@ Starting abrt daemon: [ OK ]</screen>
<para>
The following is a typical output seen in the <guilabel>Generating backtrace</guilabel> window:
</para>
- <screen>
-Starting the debuginfo installation
+ <screen>Starting the debuginfo installation
Getting list of build IDs
12 missing debuginfos, getting package list from cache
12 missing debuginfos, getting package list from repositories
@@ -451,35 +441,28 @@ Unpacking: zlib-debuginfo-1.2.3-23.fc12.x86_64.rpm
Caching debuginfo:
usr/lib/debug/.build-id/f7/933750da80f555321576e72b375caf7a3cc075.debug
All needed debuginfos are present
-Generating backtrace
- </screen>
+Generating backtrace</screen>
<para>
This process is performed by the <application>/usr/bin/abrt-debuginfo-install</application> shell script. This script uses a temporary directory (e.g. <filename>/var/run/abrt/tmp-29177-1283344373</filename>) for its operations. Normally, this directory is removed when <application>abrt-debuginfo-install</application> exits.
</para>
<para>
If the <package>debuginfo</package> installation hangs, or is unable to download anything, you may debug the problem by editing the <application>abrt-debuginfo-install</application> script. Change the following parameters:
</para>
- <screen>
-debug=false
-keep_tmp=false
- </screen>
+ <programlisting>debug=false
+keep_tmp=false</programlisting>
<para>
at the top of the script to:
</para>
- <screen>
-debug=true
-keep_tmp=true
- </screen>
+ <programlisting>debug=true
+keep_tmp=true</programlisting>
<para>
The first parameter instructs <application>abrt-debuginfo-install</application> to be verbose, the second parameter instructs <application>abrt-debuginfo-install</application> to not delete the <filename>/var/run/abrt/tmp-NNN-NNN</filename> directory. You can examine the log files in this directory, they may contain useful error messages.
</para>
<para>
- <application>abrt-debuginfo-install</application> uses <application>yum</application> and <application>yumdownloader</application> to handle the <package>debuginfo</package> packages. In order to quickly check that your <application>yum</application> configuration does not cause any problems which prevent <application>abrt-debuginfo-install</application> from working properly, change to the <filename>/tmp</filename> directory and run the following commands, as root:
+ <application>abrt-debuginfo-install</application> uses <application>yum</application> and <application>yumdownloader</application> to handle the <package>debuginfo</package> packages. In order to quickly check that your <application>yum</application> configuration does not cause any problems which prevent <application>abrt-debuginfo-install</application> from working properly, change to the <filename>/tmp</filename> directory and run the following commands, as <systemitem class="username">root</systemitem>:
</para>
- <screen>
-tmp]# yum --enablerepo=*debuginfo* --quiet provides /usr/bin/true
-tmp]# yumdownloader --enablerepo=*debuginfo* --quiet coreutils
- </screen>
+ <screen>tmp]# <command>yum --enablerepo=*debuginfo* --quiet provides /usr/bin/true</command>
+tmp]# <command>yumdownloader --enablerepo=*debuginfo* --quiet coreutils</command></screen>
<para>
Both of these commands should complete successfully, with no error messages. The second command should download the <filename>coreutils-*.rpm</filename> file. If any error messages appear, check your <application>yum</application> configuration files in the <filename>/etc/yum.repos.d/*</filename> directory and the <filename>/etc/yum/*</filename> directory. If any of these commands hang, check that you do not have another instance of <application>yum</application> running, and that your network connection is working properly.
</para>
@@ -491,8 +474,7 @@ tmp]# yumdownloader --enablerepo=*debuginfo* --quiet coreutils
<section>
<title>Viewing Crashes</title>
<para>To get a list of all crashes, simply enter <command>abrt-cli --list</command> or <command>abrt-cli -l</command>:</para>
- <screen>
-~]$ <command>abrt-cli --list</command>
+ <screen>~]$ <command>abrt-cli --list</command>
0.
UID : 500
UUID : 784b06666020e9f43718d99bf2649f19b4f251a9
@@ -506,32 +488,27 @@ tmp]# yumdownloader --enablerepo=*debuginfo* --quiet coreutils
Package : coreutils-8.4-9.el6
Executable : /bin/sleep
Crash Time : Tue 20 Jul 2010 03:22:00 PM CEST
- Crash Count: 1
-</screen>
+ Crash Count: 1</screen>
<para>This output contains basic information for every crash. The <computeroutput>UID:</computeroutput> field shows the ID of the user which ran the program that caused the crash. The <computeroutput>Package</computeroutput> field shows the name and version of the &MAJOROS; package that contains the program, and the <computeroutput>Executable</computeroutput> field shows the location of the binary or script that crashed. The <computeroutput>Crash Count</computeroutput> field indicates how many times the same crash happened.</para>
</section>
<section>
<title>Reporting Crashes</title>
- <para>To report a certain crash, enter <command>abrt-cli --report <replaceable><UUID></replaceable></command> or <command>abrt-cli --r <replaceable><UUID></replaceable></command>, where <varname>UUID</varname> is a Universally Unique Identifier of a crash from the list of crashes; to view this list, execute the <command>abrt-cli --list</command> command. You do not need to remember the exact <varname>UUID</varname>; either use a mouse to copy and paste it, or enter a unique prefix and press <keycap function="enter"><ENTER></keycap>.</para>
- <screen>
-~]$ <command>abrt-cli --report 480</command>
- <keycap function="enter"><ENTER></keycap>
->> Starting report creation...
-</screen>
+ <para>To report a certain crash, enter <command>abrt-cli --report <replaceable>UUID</replaceable></command> or <command>abrt-cli --r <replaceable>UUID</replaceable></command>, where <varname>UUID</varname> is a Universally Unique Identifier of a crash from the list of crashes; to view this list, execute the <command>abrt-cli --list</command> command. You do not need to remember the exact <varname>UUID</varname>; either use a mouse to copy and paste it, or enter a unique prefix and press <keycap function="enter">ENTER</keycap>.</para>
+ <screen>~]$ <command>abrt-cli --report 480</command>
+<keycap function="enter"><ENTER></keycap>
+>> Starting report creation...</screen>
<para>
<application>ABRT</application> analyzes the crash and creates a report about it. This might take a while. When the report is ready, <command>abrt-cli</command> opens a text editor with the content of the report. You can see what is being reported, and you can fill in instructions on how to reproduce the crash and other comments. You should also check the backtrace, because the backtrace might be sent to a public server and viewed by anyone, depending on the plugin settings.</para>
<note>
<title>Selecting a preferred text editor</title>
<para>You can choose which text editor is used to check the reports. <command>abrt-cli</command> uses the editor defined in the <envar>ABRT_EDITOR</envar> environment variable. If the variable is not defined, it checks the <envar>VISUAL</envar> and <envar>EDITOR</envar> variables. If none of these variables is set, <command>vi</command> is used. You can set the preferred editor in your <filename>.bashrc</filename> configuration file. For example, if you prefer GNU Emacs, add the following line to the file:</para>
- <screen>
-export <varname>VISUAL</varname>=<userinput>emacs</userinput>
-</screen>
+ <programlisting>export <varname>VISUAL</varname>=<userinput>emacs</userinput></programlisting>
</note>
<para>When you are done with the report, save your changes and close the editor. You will be asked which of the enabled <application>ABRT</application> plugins you want to use to send the report. Respond <keycap>Y</keycap> to send the report using your desired plugin or <keycap>N</keycap> to skip a plugin you wish not to use.</para>
</section>
<section>
<title>Deleting Crashes</title>
- <para>If you know that you do not want to report a certain crash dump, you can delete it from the crash list. To delete a certain crash dump, enter the command: <command>abrt-cli --delete <replaceable><UUID></replaceable>
+ <para>If you know that you do not want to report a certain crash dump, you can delete it from the crash list. To delete a certain crash dump, enter the command: <command>abrt-cli --delete <replaceable>UUID</replaceable>
</command>.
</para>
<para>
@@ -545,22 +522,21 @@ export <varname>VISUAL</varname>=<userinput>emacs</userinput>
<application>ABRT</application>'s main configuration file is <filename>/etc/abrt/abrt.conf</filename>. <application>ABRT</application> plugins can be configured through their configuration files, located in the <filename>/etc/abrt/plugins/</filename> directory.</para>
<important>
<title>Restart the abrtd daemon to apply the changes</title>
- <para>After changing and saving the <filename>/etc/abrt/abrt.conf</filename> configuration file, you must restart the <systemitem class="daemon">abrtd</systemitem> daemon—as root—for the new settings to take effect:</para>
- <screen>~]# <command>service abrtd restart</command>
- </screen>
+ <para>After changing and saving the <filename>/etc/abrt/abrt.conf</filename> configuration file, you must restart the <systemitem class="daemon">abrtd</systemitem> daemon—as <systemitem class="username">root</systemitem>—for the new settings to take effect:</para>
+ <screen><command>systemctl restart abrtd.service</command></screen>
</important>
<para>The following configuration directives are currently supported in <filename>/etc/abrt/abrt.conf</filename>.</para>
<variablelist>
<title>[ Common ] Section Directives</title>
<varlistentry>
- <term>OpenGPGCheck = <replaceable><yes/no></replaceable>
+ <term>OpenGPGCheck = <replaceable>yes/no</replaceable>
</term>
<listitem>
<para>Setting the <computeroutput>OpenGPGCheck</computeroutput> directive to <userinput>yes</userinput> (the default setting) tells <application>ABRT</application> to <emphasis>only</emphasis> analyze and handle crashes in applications provided by packages which are signed by the GPG keys whose locations are listed in the <filename>/etc/abrt/gpg_keys</filename> file. Setting <parameter>OpenGPGCheck</parameter> to <userinput>no</userinput> tells <application>ABRT</application> to catch crashes in all programs.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>BlackList = nspluginwrapper, valgrind, strace, avant-window-navigator, <optional><replaceable><additional_packages></replaceable>
+ <term>BlackList = nspluginwrapper, valgrind, strace, avant-window-navigator, <optional><replaceable>additional_packages</replaceable>
</optional>
</term>
<listitem>
@@ -568,7 +544,7 @@ export <varname>VISUAL</varname>=<userinput>emacs</userinput>
</listitem>
</varlistentry>
<varlistentry>
- <term>ProcessUnpackaged = <replaceable><yes/no></replaceable>
+ <term>ProcessUnpackaged = <replaceable>yes/no</replaceable>
</term>
<listitem>
<para>
@@ -600,14 +576,14 @@ export <varname>VISUAL</varname>=<userinput>emacs</userinput>
</listitem>
</varlistentry>
<varlistentry>
- <term>MaxCrashReportsSize = <replaceable><size_in_megabytes></replaceable>
+ <term>MaxCrashReportsSize = <replaceable>size_in_megabytes</replaceable>
</term>
<listitem>
<para>This option sets the amount of storage space, in megabytes, used by <application>ABRT</application> to store all crash information from all users. The default setting is <constant>1000</constant> MB. Once the quota specified here has been met, <application>ABRT</application> will continue catching crashes, and in order to make room for the new crash dumps, it will delete the oldest and largest ones.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>ActionsAndReporters = SOSreport, <optional><replaceable><additional_plugins></replaceable>
+ <term>ActionsAndReporters = SOSreport, <optional><replaceable>additional_plugins</replaceable>
</optional>
</term>
<listitem>
@@ -645,21 +621,21 @@ export <varname>VISUAL</varname>=<userinput>emacs</userinput>
<title>[ Cron ] Section Directives</title>
<varlistentry>
<term>
- <replaceable><time></replaceable> = <replaceable><action_to_run></replaceable>
+ <replaceable>time</replaceable> = <replaceable>action_to_run</replaceable>
</term>
<listitem>
<para>The <computeroutput>[ Cron ]</computeroutput> section of <filename>abrt.conf</filename> allows you to specify the exact time, or elapsed amount of time between, when <application>ABRT</application> should run a certain action, such as scanning for kernel oopses or performing file transfers. You can list further actions to run by appending them to the end of this section.</para>
<example id="ex-_Cron__section_of__etc_abrt_abrt.conf">
<title>[ Cron ] section of /etc/abrt/abrt.conf</title>
- <screen># Which Action plugins to run repeatedly
+ <programlisting># Which Action plugins to run repeatedly
[ Cron ]
# h:m - at h:m
# s - every s seconds
120 = KerneloopsScanner
-#02:00 = FileTransfer</screen>
+#02:00 = FileTransfer</programlisting>
</example>
- <para>The format for an entry is either <userinput><time_in_seconds> = <replaceable><action_to_run></replaceable>
- </userinput> or <userinput><hh:mm> = <action_to_run> </userinput>, where <userinput>hh</userinput> (hour) is in the range <constant>00-23</constant> (all hours less than 10 should be zero-filled, i.e. preceded by a <constant>0</constant>), and <userinput>mm</userinput> (minute) is <constant>00-59</constant>, zero-filled likewise.</para>
+ <para>The format for an entry is either <userinput>time_in_seconds = <replaceable>action_to_run</replaceable>
+ </userinput> or <userinput>hh:mm = action_to_run </userinput>, where <userinput>hh</userinput> (hour) is in the range <constant>00-23</constant> (all hours less than 10 should be zero-filled, i.e. preceded by a <constant>0</constant>), and <userinput>mm</userinput> (minute) is <constant>00-59</constant>, zero-filled likewise.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -690,9 +666,7 @@ export <varname>VISUAL</varname>=<userinput>emacs</userinput>
<listitem>
<para>
In the <filename>/etc/abrt/abrt.conf</filename> configuration file, set the <varname>WatchCrashdumpArchiveDir</varname> directive to the following:
-<screen>
-WatchCrashdumpArchiveDir = /var/spool/abrt-upload/
-</screen>
+<programlisting>WatchCrashdumpArchiveDir = /var/spool/abrt-upload/</programlisting>
</para>
</listitem>
<listitem>
@@ -731,30 +705,24 @@ WatchCrashdumpArchiveDir = /var/spool/abrt-upload/
<listitem>
<para>
Modify the <filename>/etc/abrt/plugins/ReportUploader.conf</filename> configuration file so that the <application>ReportUploader</application> plugin knows where to copy the saved crash reports in the following way:
-<screen>
-Enabled = yes
+<programlisting>Enabled = yes
Upload = yes
-URL = ftp://USERNAME:PASSWORD@SERVERNAME/var/spool/abrt-upload/
-</screen>
+URL = ftp://USERNAME:PASSWORD@SERVERNAME/var/spool/abrt-upload/</programlisting>
</para>
</listitem>
<listitem>
<para>
To automatically send the crash reports to the server system immediately after the crash occurs, is detected, and saved, set the <varname>[ ActionsAndReporters ]</varname> directive in the <filename>/etc/abrt/abrt.conf</filename> configuration file to the following:
-<screen>
-ActionsAndReporters = ReportUploader
-</screen>
+<programlisting>ActionsAndReporters = ReportUploader</programlisting>
</para>
</listitem>
<listitem>
<para>
Alternatively, if user interaction is required before the crash dump is sent to the server system, set the <parameter>ReportUploader</parameter> to be a reporter plugin for a specific crash type in the <literal>[ AnalyzerActionsAndReporters ]</literal> section of the <filename>/etc/abrt/abrt.conf</filename> configuration file. The user will be required to run <application>abrt-cli</application> or <application>abrt-gui</application> and instruct the <systemitem class="daemon">abrtd</systemitem> daemon to report the crash and send it to the server system. For example, if you want all crash types to use this method, edit the <literal>[ AnalyzerActionsAndReporters ]</literal> section in your <filename>/etc/abrt/abrt.conf</filename> configuration file in the following way:
</para>
- <screen>
-Kerneloops = ReportUploader
+ <programlisting>Kerneloops = ReportUploader
CCpp = ReportUploader
-Python = ReportUploader
-</screen>
+Python = ReportUploader</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -764,11 +732,9 @@ Python = ReportUploader
<para>
After completing all the steps of the configuration process, the basic setup is finished. To test that this setup works properly use the <command>kill -s SEGV <replaceable>PID</replaceable>
</command> command to terminate a process on a client system. For example, start a <systemitem class="process">sleep</systemitem> process and terminate it with the <command>kill</command> command in the following way:
- <screen>
-~]$ sleep 100 &
+ <screen>~]$ <command>sleep 100 &</command>
[1] 2823
-~]$ kill -s SEGV 2823
- </screen>
+~]$ <command>kill -s SEGV 2823</command></screen>
<application>ABRT</application> should detect a crash shortly after executing the <command>kill</command> command. Check that the crash was detected by <application>ABRT</application> on the client system (this can be checked by examining the appropriate syslog file, by running the <command>abrt-cli --list --full</command> command, or by examining the crash dump created in the <filename>/var/spool/abrt</filename> directory), copied to the server system, unpacked on the server system and can be seen and acted upon using <command>abrt-cli</command> or <command>abrt-gui</command> on the server system.
</para></section>
<section id="testing-upload-method">
@@ -776,16 +742,14 @@ Python = ReportUploader
<para>
Test your upload method from a client system to ensure that it works. For example, upload a file using the interactive <systemitem class="protocol">FTP</systemitem> client:
</para>
- <screen>
-~]$ ftp
+ <screen>~]$ <command>ftp</command>
ftp> open SERVERNAME
Name: USERNAME
Password: PASSWORD
ftp> cd /var/spool/abrt-upload
250 Operation successful
ftp> put TESTFILE
-ftp> quit
- </screen>
+ftp> quit</screen>
<para>
Check whether <filename>TESTFILE</filename> appeared in the correct directory on the server system.
</para>
@@ -801,20 +765,18 @@ ftp> quit
<para>
In your <filename>/etc/abrt/abrt.conf</filename> configuration file, for each analyzer, change the list of reporters according to your needs, for example:
</para>
- <screen>
-[ AnalyzerActionsAndReporters ]
+ <programlisting>[ AnalyzerActionsAndReporters ]
Kerneloops = Logger
CCpp = Logger
-Python = Logger
- </screen>
+Python = Logger</programlisting>
</listitem>
<listitem>
<para>
In the configuration files corresponding to each analyzer plugin (that is, <filename>/etc/abrt/plugins/CCpp.conf</filename>, <filename>/etc/abrt/plugins/Kerneloops.conf</filename> and <filename>/etc/abrt/plugins/Python.conf</filename>), add the following line:
</para>
- <screen>AutoReportUIDs = <replaceable><USERNAME></replaceable></screen>
+ <programlisting>AutoReportUIDs = <replaceable>USERNAME</replaceable></programlisting>
<para>
- where <replaceable><USERNAME></replaceable> represents a user whose detected crashes and issues will be automatically reported via your specified reporters. You can specify multiple users by separating them with a comma (<literal>,</literal>).
+ where <replaceable>USERNAME</replaceable> represents a user whose detected crashes and issues will be automatically reported via your specified reporters. You can specify multiple users by separating them with a comma (<literal>,</literal>).
</para>
</listitem>
</orderedlist>
diff --git a/en-US/images/abrt-alert.png b/en-US/images/abrt-alert.png
new file mode 100644
index 0000000..c95a6be
Binary files /dev/null and b/en-US/images/abrt-alert.png differ
diff --git a/en-US/images/abrt-event-configuration.png b/en-US/images/abrt-event-configuration.png
new file mode 100644
index 0000000..f213180
Binary files /dev/null and b/en-US/images/abrt-event-configuration.png differ
diff --git a/en-US/images/abrt.png b/en-US/images/abrt.png
new file mode 100644
index 0000000..8a7f53d
Binary files /dev/null and b/en-US/images/abrt.png differ
More information about the docs-commits
mailing list