[deployment-guide/comm-rel: 638/727] partially updated section Log Files, added new screenshots, deleted old ones
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:19:17 UTC 2010
commit f976f914526e66138e4c7ae8ec0fca8d6b6eeed0
Author: Martin Prpic <mprpic at redhat.com>
Date: Mon Sep 13 15:47:57 2010 +0200
partially updated section Log Files, added new screenshots, deleted old ones
en-US/Log_Files.xml | 171 +++++++++++++++-----------
en-US/images/redhat-filter-enable.png | Bin 0 -> 194249 bytes
en-US/images/redhat-filter-sample.png | Bin 0 -> 16132 bytes
en-US/images/redhat-filters.png | Bin 0 -> 9495 bytes
en-US/images/redhat-logviewer-add.png | Bin 13899 -> 147036 bytes
en-US/images/redhat-logviewer-monitoring.png | Bin 0 -> 159116 bytes
en-US/images/redhat-logviewer.png | Bin 26264 -> 166037 bytes
7 files changed, 97 insertions(+), 74 deletions(-)
---
diff --git a/en-US/Log_Files.xml b/en-US/Log_Files.xml
index 3ee944e..6a6dc48 100644
--- a/en-US/Log_Files.xml
+++ b/en-US/Log_Files.xml
@@ -73,20 +73,30 @@
<application>Log Viewer</application>
</see>
</indexterm>
- <para>To view system log files in an interactive, real-time application, use the <application>System Log Viewer</application>. To start the application, go to <guimenu>Applications</guimenu> (the main menu on the panel) > <guimenuitem>System</guimenuitem> > <guimenuitem>System Logs</guimenuitem>, or type the command <command>gnome-system-log</command> at a shell prompt.</para>
+ <para>To view system log files in an interactive, real-time application, use the <application>Log File Viewer</application>.
+ </para>
+ <note>
+ <title>Note: Installing the <package>gnome-system-log</package> package</title>
+ <para>In order to use the <application>Log File Viewer</application>, first ensure the <package>gnome-system-log</package> package is installed on your system by running, as root:</para>
+ <screen>~]# <command>yum install </command></screen>
+ <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
+ </note>
+ <para>To start the <application>Log File Viewer</application>, go to <menuchoice><guimenu>Applications</guimenu><guimenuitem>System</guimenuitem><guimenuitem>Log File Viewer</guimenuitem></menuchoice>, or type the following command at a shell prompt:</para>
+<screen>~]$ <command>gnome-system-log</command>
+</screen>
<para>The application only displays log files that exist; thus, the list might differ from the one shown in <xref
linkend="fig-redhat-logviewer"/>.</para>
<indexterm
significance="normal">
<primary>
- <application>System Log Viewer</application>
+ <application>Log File Viewer</application>
</primary>
<secondary>searching</secondary>
</indexterm>
<indexterm
significance="normal">
<primary>
- <application>System Log Viewer</application>
+ <application>Log File Viewer</application>
</primary>
<secondary>filtering</secondary>
</indexterm>
@@ -94,7 +104,7 @@
float="0"
id="fig-redhat-logviewer">
<title>
- <application>System Log Viewer</application>
+ <application>Log File Viewer</application>
</title>
<mediaobject>
<imageobject>
@@ -104,7 +114,7 @@
scalefit="1"/>
</imageobject>
<textobject>
- <para>System Log Viewer</para>
+ <para>Log File Viewer</para>
</textobject>
</mediaobject>
</figure>
@@ -115,67 +125,109 @@
</primary>
<secondary>refresh rate</secondary>
</indexterm>
- <para>To filter the contents of the selected log file, click on <guimenuitem>View</guimenuitem> from the menu and select <guimenuitem>Filter</guimenuitem> as illustrated below.</para>
+ <para>The <application>Log File Viewer</application> application lets you filter any existing log file. Click on <guimenuitem>Filters</guimenuitem> from the menu and select <guimenuitem>Manage Filters</guimenuitem> to define or edit your desired filter.</para>
<figure
float="0"
- id="fig-redhat-logviewer-prefs">
+ id="fig-redhat-filters">
<title>
- <application>System Log Viewer - View Menu</application>
+ <application>Log File Viewer - Filters</application>
</title>
<mediaobject>
<imageobject>
<imagedata
- fileref="images/redhat-logviewer-prefs.png"
+ fileref="images/redhat-filters.png"
format="PNG"
scalefit="1"/>
</imageobject>
<textobject>
- <para>System Log Viewer - View Menu</para>
+ <para>Log File Viewer - Filters</para>
</textobject>
</mediaobject>
</figure>
- <indexterm
- significance="normal">
- <primary>
- <application>System Log Viewer - View Menu</application>
- </primary>
- <secondary>View Menu</secondary>
- </indexterm>
- <para>Selecting the <guilabel>Filter</guilabel> menu item will display the <guilabel>Filter</guilabel> text field where you can type the keywords you wish to use for your filter. To clear your filter click on the <guibutton>Clear</guibutton> button.The figure below illustrates a sample filter.</para>
+ <para>Adding or editing a filter lets you define its parameters as is shown in <xref linkend="fig-redhat-filter-sample"/>.</para>
<figure
float="0"
- id="fig-redhat-logviewer-sample">
+ id="fig-redhat-filter-sample">
<title>
- <application>System Log Viewer - Filter</application>
+ <application>Log File Viewer - Defining a Filter</application>
</title>
<mediaobject>
<imageobject>
<imagedata
- fileref="images/redhat-logviewer-sample.png"
+ fileref="images/redhat-filter-sample.png"
format="PNG"
scalefit="1"/>
</imageobject>
<textobject>
- <para>System Log Viewer - Filter</para>
+ <para>Log File Viewer - Defining a Filter</para>
</textobject>
</mediaobject>
</figure>
- <indexterm
- significance="normal">
- <primary>
- <application>System Log Viewer - Filter</application>
- </primary>
- <secondary>System Log Filter</secondary>
- </indexterm>
+ <para>
+ When defining a filter, you can edit the following parameters:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Name</guilabel> — Specifies the name of the filter.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Regular Expression</guilabel> — Specifies the regular expression that will be applied to the log file and will attempt to match any possible strings of text in it.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Effect</guilabel>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel>Highlight</guilabel> — If checked, the found results will be highlighted with the selected color. You may select whether to highlight the background or the foreground of the text.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <guilabel>Hide</guilabel> — If checked, the found results will be hidden from the log file you are viewing.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <para>
+ When you have at least one filter defined, you may select it from the <guilabel>Filters</guilabel> menu and it will automatically search for the strings you have defined in the filter and highlight/hide every successful match in the log file you are currently viewing.
+ </para>
+ <figure
+ float="0"
+ id="fig-redhat-filter-enable">
+ <title>
+ <application>Log File Viewer - Enabling a Filter</application>
+ </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/redhat-filter-enable.png"
+ format="PNG"
+ scalefit="1"/>
+ </imageobject>
+ <textobject>
+ <para>Log File Viewer - Enabling a Filter</para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ When you check the <guilabel>Show matches only</guilabel> option, only the matched strings will be shown in the log file you are currently viewing.
+ </para>
</section>
<section
id="s1-logfiles-adding">
<title>Adding a Log File</title>
- <para>To add a log file you wish to view in the list, select <guimenu>File</guimenu> > <guimenuitem>Open</guimenuitem>. This will display the <guimenu>Open Log</guimenu> window where you can select the directory and filename of the log file you wish to view.The figure below illustrates the <guimenu>Open Log</guimenu> window.</para>
+ <para>To add a log file you wish to view in the list, select <menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem></menuchoice>. This will display the <guilabel>Open Log</guilabel> window where you can select the directory and filename of the log file you wish to view.<xref linkend="fig-redhat-logviewer-add"/> illustrates the <guimenu>Open Log</guimenu> window.</para>
<figure
float="0"
id="fig-redhat-logviewer-add">
- <title>Adding a Log File</title>
+ <title>Log File Viewer - Adding a Log File</title>
<mediaobject>
<imageobject>
<imagedata
@@ -184,12 +236,17 @@
scalefit="1"/>
</imageobject>
<textobject>
- <para>Adding a Log File</para>
+ <para>Log File Viewer - Adding a Log File</para>
</textobject>
</mediaobject>
</figure>
- <para>Click on the <guibutton>Open</guibutton> button to open the file. The file is immediately added to the viewing list where you can select it and view the contents.</para>
- <para>Please also note that the System Log Viewer also allows you to open zipped logs whose filenames end in ".gz".</para>
+ <para>Click on the <guibutton>Open</guibutton> button to open the file. The file is immediately added to the viewing list where you can select it and view its contents.</para>
+ <note>
+ <title>Note</title>
+ <para>
+ The <application>Log File Viewer</application> also allows you to open zipped in the <literal>.gz</literal> format.
+ </para>
+ </note>
</section>
<section
id="s1-logfiles-examining">
@@ -202,59 +259,25 @@
<indexterm
significance="normal">
<primary>
- <application>System Log Viewer</application>
+ <application>Log File Viewer</application>
</primary>
<secondary>monitoring</secondary>
</indexterm>
<para>
- <application>System Log Viewer</application> monitors all opened logs by default. If a new line is added to a monitored log file, the log name appears in bold in the log list. If the log file is selected or displayed, the new lines appear in bold at the bottom of the log file and after five seconds are displayed in normal format. This is illustrated in the figures below. The figure below illustrates a new alert in the <guimenuitem>messages</guimenuitem> log file. The log file is listed in bold text.</para>
- <figure
- float="0"
- id="fig-redhat-logviewer-monitoring1">
- <title>Log File Alert</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/redhat-logviewer-monitoring1.png"
- format="PNG"
- scalefit="1"/>
- </imageobject>
- <textobject>
- <para>Log File Alert</para>
- </textobject>
- </mediaobject>
- </figure>
- <para>Clicking on the <guimenuitem>messages</guimenuitem> log file displays the logs in the file with the new lines in bold as illustrated below.</para>
- <figure
- float="0"
- id="fig-redhat-logviewer-monitoring2">
- <title>Log file contents</title>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/redhat-logviewer-monitoring2.png"
- format="PNG"
- scalefit="1"/>
- </imageobject>
- <textobject>
- <para>Log file contents</para>
- </textobject>
- </mediaobject>
- </figure>
- <para>The new lines are displayed in bold for five seconds after which they are displayed in normal font.</para>
+ <application>Log File Viewer</application> monitors all opened logs by default. If a new line is added to a monitored log file, the log name appears in bold in the log list. If the log file is selected or displayed, the new lines appear in bold at the bottom of the log file. <xref linkend="fig-redhat-logviewer-monitoring"/> illustrates a new alert in the <guilabel>cron</guilabel> log file and in the <guilabel>messages</guilabel> log file. Clicking on the <guimenuitem>cron</guimenuitem> log file displays the logs in the file with the new lines in bold.</para>
<figure
float="0"
- id="fig-redhat-logviewer-monitoring3">
- <title>Log file contents after five seconds</title>
+ id="fig-redhat-logviewer-monitoring">
+ <title>Log File Viewer - New Log Alert</title>
<mediaobject>
<imageobject>
<imagedata
- fileref="images/redhat-logviewer-monitoring3.png"
+ fileref="images/redhat-logviewer-monitoring.png"
format="PNG"
scalefit="1"/>
</imageobject>
<textobject>
- <para>Log file contents after five seconds</para>
+ <para>Log File Viewer - New Log Alert</para>
</textobject>
</mediaobject>
</figure>
diff --git a/en-US/images/redhat-filter-enable.png b/en-US/images/redhat-filter-enable.png
new file mode 100644
index 0000000..3c0c2f0
Binary files /dev/null and b/en-US/images/redhat-filter-enable.png differ
diff --git a/en-US/images/redhat-filter-sample.png b/en-US/images/redhat-filter-sample.png
new file mode 100644
index 0000000..7d349d6
Binary files /dev/null and b/en-US/images/redhat-filter-sample.png differ
diff --git a/en-US/images/redhat-filters.png b/en-US/images/redhat-filters.png
new file mode 100644
index 0000000..3c91d0d
Binary files /dev/null and b/en-US/images/redhat-filters.png differ
diff --git a/en-US/images/redhat-logviewer-add.png b/en-US/images/redhat-logviewer-add.png
index 7df9952..07962eb 100644
Binary files a/en-US/images/redhat-logviewer-add.png and b/en-US/images/redhat-logviewer-add.png differ
diff --git a/en-US/images/redhat-logviewer-monitoring.png b/en-US/images/redhat-logviewer-monitoring.png
new file mode 100644
index 0000000..01e826b
Binary files /dev/null and b/en-US/images/redhat-logviewer-monitoring.png differ
diff --git a/en-US/images/redhat-logviewer.png b/en-US/images/redhat-logviewer.png
index e12c3ac..b24be71 100644
Binary files a/en-US/images/redhat-logviewer.png and b/en-US/images/redhat-logviewer.png differ
More information about the docs-commits
mailing list