[deployment-guide/comm-rel: 700/727] updates to the rsyslog section, replaced "hash mark" by "hash sign"
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 13:24:38 UTC 2010
commit 39a07105ead7858100edb37d2f0ba2c44c5c85f5
Author: Martin Prpic <mprpic at redhat.com>
Date: Thu Sep 30 18:27:31 2010 +0200
updates to the rsyslog section, replaced "hash mark" by "hash sign"
en-US/Automated_Tasks.xml | 4 +-
en-US/Dynamic_Host_Configuration_Protocol_DHCP.xml | 2 +-
en-US/FTP.xml | 4 +-
.../Lightweight_Directory_Access_Protocol_LDAP.xml | 4 +-
en-US/Log_Files.xml | 405 +++++++++++---------
en-US/RPM.xml | 2 +-
en-US/The_X_Window_System.xml | 2 +-
7 files changed, 240 insertions(+), 183 deletions(-)
---
diff --git a/en-US/Automated_Tasks.xml b/en-US/Automated_Tasks.xml
index 182b3b4..42dbb6f 100644
--- a/en-US/Automated_Tasks.xml
+++ b/en-US/Automated_Tasks.xml
@@ -99,7 +99,7 @@ period in days delay in minutes job-identifier command
</para>
</listitem>
</itemizedlist>
- <para>Any lines that begin with a hash mark (#) are comments and are not processed.</para>
+ <para>Any lines that begin with a hash sign (#) are comments and are not processed.</para>
<section id="s3-anacron-examples">
<title>Examples of Anacron Jobs </title>
<para>The following example shows a simple <filename>/etc/anacrontab</filename> file:</para>
@@ -213,7 +213,7 @@ minute hour day month day of week user command
<para>A hyphen (-) between integers specifies a range of integers. For example, <userinput>1-4</userinput> means the integers 1, 2, 3, and 4.</para>
<para>A list of values separated by commas (,) specifies a list. For example, <userinput>3, 4, 6, 8</userinput> indicates those four specific integers.</para>
<para>The forward slash (/) can be used to specify step values. The value of an integer can be skipped within a range by following the range with <userinput>/<<replaceable>integer</replaceable>></userinput>. For example, <userinput>0-59/2</userinput> can be used to define every other minute in the minute field. Step values can also be used with an asterisk. For instance, the value <userinput>*/3</userinput> can be used in the month field to run the task every third month.</para>
- <para>Any lines that begin with a hash mark (#) are comments and are not processed.</para>
+ <para>Any lines that begin with a hash sign (#) are comments and are not processed.</para>
<para>Users other than root can configure cron tasks by using the <command>crontab</command> utility. All user-defined crontabs are stored in the <filename>/var/spool/cron/</filename> directory and are executed using the usernames of the users that created them. To create a crontab as a user, login as that user and type the command <command>crontab -e</command> to edit the user's crontab using the editor specified by the <computeroutput>VISUAL</computeroutput> or <computeroutput>EDITOR</computeroutput> environment variable. The file uses the same format as <filename>/etc/crontab</filename>. When the changes to the crontab are saved, the crontab is stored according to username and written to the file <filename>/var/spool/cron/<replaceable>username</replaceable>
</filename>. To list the contents of your own personal crontab file, use the <command>crontab -l</command> command. </para>
<note>
diff --git a/en-US/Dynamic_Host_Configuration_Protocol_DHCP.xml b/en-US/Dynamic_Host_Configuration_Protocol_DHCP.xml
index 123bf8f..0ebc2ca 100644
--- a/en-US/Dynamic_Host_Configuration_Protocol_DHCP.xml
+++ b/en-US/Dynamic_Host_Configuration_Protocol_DHCP.xml
@@ -58,7 +58,7 @@
<primary>dhcpd.conf</primary>
</indexterm>
<para>The first step in configuring a DHCP server is to create the configuration file that stores the network information for the clients. Use this file to declare options and global options for client systems.</para>
- <para>The configuration file can contain extra tabs or blank lines for easier formatting. Keywords are case-insensitive and lines beginning with a hash mark (#) are considered comments.</para>
+ <para>The configuration file can contain extra tabs or blank lines for easier formatting. Keywords are case-insensitive and lines beginning with a hash sign (#) are considered comments.</para>
<para>There are two types of statements in the configuration file:</para>
<itemizedlist>
<listitem>
diff --git a/en-US/FTP.xml b/en-US/FTP.xml
index c327b83..03756fa 100644
--- a/en-US/FTP.xml
+++ b/en-US/FTP.xml
@@ -369,7 +369,7 @@
<title>Important</title>
<para>There must not be any spaces between the <replaceable><directive></replaceable>, equal symbol, and the <replaceable><value></replaceable> in a directive.</para>
</important>
- <para>Comment lines must be preceded by a hash mark (<command>#</command>) and are ignored by the daemon.</para>
+ <para>Comment lines must be preceded by a hash sign (<command>#</command>) and are ignored by the daemon.</para>
<para>For a complete list of all directives available, refer to the man page for <filename>vsftpd.conf</filename>.</para>
<important>
<title>Important</title>
@@ -767,7 +767,7 @@
<title>Important</title>
<para>To maintain compatibility with log files written by the older <command>wu-ftpd</command> <systemitem class="protocol">FTP</systemitem> server, the <command>xferlog_std_format</command> directive is set to <command>YES</command> under &MAJOROS;. However, this setting means that connections to the server are not logged.</para>
<para>To both log connections in <command>vsftpd</command> format and maintain a <command>wu-ftpd</command>-compatible file transfer log, set <command>dual_log_enable</command> to <command>YES</command>.</para>
- <para>If maintaining a <command>wu-ftpd</command>-compatible file transfer log is not important, either set <command>xferlog_std_format</command> to <command>NO</command>, comment the line with a hash mark (<command>#</command>), or delete the line entirely.</para>
+ <para>If maintaining a <command>wu-ftpd</command>-compatible file transfer log is not important, either set <command>xferlog_std_format</command> to <command>NO</command>, comment the line with a hash sign (<command>#</command>), or delete the line entirely.</para>
</important>
</section>
<section
diff --git a/en-US/Lightweight_Directory_Access_Protocol_LDAP.xml b/en-US/Lightweight_Directory_Access_Protocol_LDAP.xml
index 10490cb..9c8ac06 100644
--- a/en-US/Lightweight_Directory_Access_Protocol_LDAP.xml
+++ b/en-US/Lightweight_Directory_Access_Protocol_LDAP.xml
@@ -439,7 +439,7 @@ include /etc/openldap/schema/redhat/autofs.schema</screen>
When prompted, type and then re-type a password. The program prints the resulting encrypted password to the shell prompt.
</para>
<para>
- Next, copy the newly created encrypted password into the <filename>/etc/openldap/slapd.conf</filename> on one of the <command>rootpw</command> lines and remove the hash mark (<command>#</command>).
+ Next, copy the newly created encrypted password into the <filename>/etc/openldap/slapd.conf</filename> on one of the <command>rootpw</command> lines and remove the hash sign (<command>#</command>).
</para>
<para>
When finished, the line should look similar to the following example:
@@ -455,7 +455,7 @@ include /etc/openldap/schema/redhat/autofs.schema</screen>
</para>
</warning>
<para>
- For added security, the <command>rootpw</command> directive should be commented out after populating the LDAP directory by preceding it with a hash mark (<command>#</command>).
+ For added security, the <command>rootpw</command> directive should be commented out after populating the LDAP directory by preceding it with a hash sign (<command>#</command>).
</para>
<para>
When using the <command>/usr/sbin/slapadd</command> command line tool locally to populate the LDAP directory, use of the <command>rootpw</command> directive is not necessary.
diff --git a/en-US/Log_Files.xml b/en-US/Log_Files.xml
index 81ecdb7..f1ece10 100644
--- a/en-US/Log_Files.xml
+++ b/en-US/Log_Files.xml
@@ -1,183 +1,273 @@
<?xml version='1.0'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
]>
-<chapter
- id="ch-Log_Files">
+<chapter id="ch-Log_Files">
<title>Log Files</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<seealso>
<application>Log Viewer</application>
</seealso>
</indexterm>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>description</secondary>
</indexterm>
<para>
<firstterm>Log files</firstterm> are files that contain messages about the system, including the kernel, services, and applications running on it. There are different log files for different information. For example, there is a default system log file, a log file just for security messages, and a log file for cron tasks.</para>
<para>Log files can be very useful when trying to troubleshoot a problem with the system such as trying to load a kernel driver or when looking for unauthorized log in attempts to the system. This chapter discusses where to find log files, how to view log files, and what to look for in log files.</para>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>
<command>rsyslod daemon</command>
</secondary>
</indexterm>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<command>rsyslog</command>
</primary>
</indexterm>
<para>Some log files are controlled by a daemon called <systemitem class="daemon">rsyslogd</systemitem>. A list of log messages maintained by <systemitem class="daemon">rsyslogd</systemitem> can be found in the <filename>/etc/rsyslog.conf</filename> configuration file.</para>
<para>
- <command>rsyslog</command> replaced <command>syslogd</command> as the default program for forwarding log messages over the network. <command>rsyslog</command> uses the basic <command>syslog</command> protocol and extends its functionality with enhanced filtering, encryption protected relaying of messages, various configuration options, or support for transportation via the <systemitem class="protocol">TCP</systemitem> or <systemitem class="protocol">UDP</systemitem> protocols.
+ <command>rsyslog</command> replaced <command>syslogd</command> as the default program for forwarding syslog messages over the network. <command>rsyslog</command> uses the basic <command>syslog</command> protocol and extends its functionality with enhanced filtering, encryption protected relaying of messages, various configuration options, or support for transportation via the <systemitem class="protocol">TCP</systemitem> or <systemitem class="protocol">UDP</systemitem> protocols.
</para>
<section id="s1-configuring-rsyslog">
- <title>Configuring <command>rsyslog</command></title>
+ <title>Configuring <command>rsyslog</command>
+ </title>
<para>
The main configuration file for <command>rsyslog</command> is <filename>/etc/rsyslog.conf</filename>. It is essentially divided in the following parts:
</para>
<itemizedlist>
<listitem>
<para>
- Modules — Due to its modular design, <command>rsyslog</command> offers a variety of modules which provide dynamic functionality. Note that modules can be written by third parties. Essentially, modules are comprised of various configuration directives that become available when a module is loaded. To load a module, use the following syntax:
+ Modules
</para>
- <screen>
+ </listitem>
+ <listitem>
+ <para>
+ Global directives
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Rules
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Templates
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Filter conditions
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Output channels
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Each of these segments of the <filename>/etc/rsyslog.conf</filename> configuration file is described in the sections below.
+ </para>
+ <section id="s2-modules">
+ <title>Modules</title>
+ <para>
+ Due to its modular design, <command>rsyslog</command> offers a variety of modules which provide dynamic functionality. Note that modules can be written by third parties. Essentially, modules are comprised of various configuration directives that become available when a module is loaded. To load a module, use the following syntax:
+ </para>
+ <screen>
$ModLoad <replaceable><MODULE></replaceable>
</screen>
- <para>
+ <para>
where <replaceable><MODULE></replaceable> represents your desired module. For example, if you want to load the <literal>Text File Input Module</literal> (<command>imfile</command> — enables <command>rsyslog</command> to convert any standard text files into a syslog messages), specify the following line in your <filename>/etc/rsyslog.conf</filename> configuration file:
</para>
- <screen>
+ <screen>
$ModLoad imfile
</screen>
- <para>
- <command>rsyslog</command> offers a number of modules which are split into these main categories:
+ <para>
+ <command>rsyslog</command> offers a number of modules which are split into these main categories:
</para>
- <itemizedlist>
- <listitem>
- <para>
+ <itemizedlist>
+ <listitem>
+ <para>
Input Modules — Input modules gather messages from various sources. The name of an input module always starts with the <literal>im</literal> prefix, such as <command>imfile</command>, <command>imrelp</command>, etc.
</para>
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Output Modules — Output modules process messages into different formats or perform various actions on them. The name of an output module always starts with the <literal>om</literal> prefix, such as <command>omsnmp</command>, <command>omrelp</command>, etc.
</para>
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Filter Modules — Filter modules provide the ability to filter messages according to specified rules. The name of a filter module always starts with the <literal>fm</literal> prefix.
</para>
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Parser Modules — Parser modules use the message parsers to parse message content of any received messages. The name of a parser module always starts with the <literal>pm</literal> prefix, such as <command>pmrfc5424</command>, <command>pmrfc3164</command>, etc.
</para>
- </listitem>
- <listitem>
- <para>
- Message Modification Modules — Message modification modules change the content of a log message. The message modification modules only differ in their implementation from the output and filter modules but share the same interface.
+ </listitem>
+ <listitem>
+ <para>
+ Message Modification Modules — Message modification modules change the content of asyslog message. The message modification modules only differ in their implementation from the output and filter modules but share the same interface.
</para>
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
String Generator Modules — String generator modules generate strings based on the message content and strongly cooperate with the template feature provided by <command>rsyslog</command>. For more information on templates, refer to . The name of a string generator module always starts with the <literal>sm</literal> prefix, such as <command>smfile</command>, <command>smtradfile</command>, etc.
</para>
- </listitem>
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Library Modules — Library modules provide the ability to load and handle other loadable modules. These modules are loaded automatically by <command>rsyslog</command> when needed and cannot be configured by the user.
</para>
- </listitem>
- </itemizedlist>
- <para>
+ </listitem>
+ </itemizedlist>
+ <para>
A comprehensive list of all available modules and their detailed description can be found at <ulink url="http://www.rsyslog.com/doc/rsyslog_conf_modules.html/">http://www.rsyslog.com/doc/rsyslog_conf_modules.html</ulink>
- </para>
- <warning>
- <title>Warning</title>
- <para>
+ </para>
+ <warning>
+ <title>Warning</title>
+ <para>
Note that when <command>rsyslog</command> loads any modules, it provides them with access to some of its functions and data. This poses a possible security threat. To minimize security risks, use trustworthy modules only.
</para>
- </warning>
- </listitem>
- <listitem>
- <para>
- Global Directives — Global directives specify configuration options that apply to the <systemitem class="daemon">rsyslogd</systemitem> daemon. All of the global directives must start with a dollar sign (<literal>$</literal>). Only one directive can be specified per line. The following is an example of a global directive that specifies the maximum size of the log message queue:</para>
- <screen>
+ </warning>
+ </section>
+ <section id="bh-global-directives">
+ <title>Global Directives</title>
+ <para>
+ Global directives specify configuration options that apply to the <systemitem class="daemon">rsyslogd</systemitem> daemon. All of the global directives must start with a dollar sign (<literal>$</literal>). Only one directive can be specified per line. The following is an example of a global directive that specifies the maximum size of the syslog message queue:</para>
+ <screen>
$MainMsgQueueSize
</screen>
- <para>
+ <para>
The default size defined for this directive (<constant>10,000</constant> messages) can be overridden by specifying a different value.
</para>
- <para>
+ <para>
A comprehensive list of all available configuration directives and their detailed description can be found in <filename>/usr/share/doc/rsyslog-4.4.2/rsyslog_conf_global.html</filename> or online at <ulink url="http://www.rsyslog.com/doc/rsyslog_conf_global.html">http://www.rsyslog.com/doc/rsyslog_conf_global.html</ulink>.
</para>
- </listitem>
- <listitem>
- <para>
- Rules — A rule specifies the cooperation of a selector with an action. To define a rule in your <filename>/etc/rsyslog.conf</filename> configuration file, define both, a selector and an action, on one line and separate them with one or more spaces or tabs.
+ </section>
+ <section id="bh-rules">
+ <title>Rules</title>
+ <para>
+ A rule specifies the cooperation of a selector with an action. To define a rule in your <filename>/etc/rsyslog.conf</filename> configuration file, define both, a selector and an action, on one line and separate them with one or more spaces or tabs.
+ </para>
<itemizedlist>
<listitem>
<para>
- Selectors —
+ Selectors — Selectors filter syslog messages based on two conditions: facility and priority. The following is an example of a selector:
</para>
+ <screen>
+<replaceable><FACILITY></replaceable>.<replaceable><PRIORITY></replaceable>
+ </screen>
+ <para>
+ where:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <replaceable><FACILITY></replaceable> specifies the subsystem that produces a specific syslog message. For example, the <command>mail</command> subsystem handles all mail related syslog messages. <replaceable><FACILITY></replaceable> can be represented by one of these keywords: <command>auth</command>, <command>authpriv</command>, <command>cron</command>, <command>daemon</command>, <command>kern</command>, <command>lpr</command>, <command>mail</command>, <command>news</command>, <command>syslog</command>, <command>user</command>, <command>uucp</command>, and <command>local0</command> through <command>local7</command>.
+ </para>
</listitem>
<listitem>
<para>
- Actions —
+ <replaceable><PRIORITY></replaceable> specifies a priority of a syslog message. <replaceable><PRIORITY></replaceable> can be represented by one of these keywords: <command>debug</command>, <command>info</command>, <command>notice</command>, <command>warning</command>, <command>err</command>, <command>crit</command>, <command>alert</command>, and <command>emerg</command>.
+ </para>
+ <para>
+ By preceding any priority with an equal sign (<literal>=</literal>), you specify that only syslog messages with that priority will be selected. All other priorities will be ignored. Conversely, preceding a priority with an exclamation mark (<literal>!</literal>) selects all syslog messages but those with the defined priority. By not using either of these two extensions, you specify a selection of syslog messages with the defined priority and higher.
</para>
</listitem>
</itemizedlist>
- </para>
- </listitem>
- <listitem>
- <para>
- Templates —
- </para>
- </listitem>
- <listitem>
- <para>
- Filter Conditions —
- </para>
- </listitem>
- <listitem>
- <para>
- Output Channels —
- </para>
- </listitem>
- </itemizedlist>
+ <para>
+ In addition to the keywords specified above, you may also use an asterisk (<literal>*</literal>) to define all facilities or priorities (depending on where you place the asterisk, before or after the dot). Specifying the keyword <literal>none</literal> serves for facilities with no given priorities.
+ </para>
+ <para>
+ You may also define multiple facilities and priorities simply by separating them with a comma (<literal>,</literal>). To define multiple selectors on one line, separate them with a semi-colon (<literal>;</literal>).
+ </para>
+ <para>
+ The following are a few examples of selectors:
+ </para>
+ <screen>
+kern.*
+ </screen>
+ <para>
+ Select all kernel syslog messages with any priority.
+ </para>
+ <screen>
+mail.crit
+ </screen>
+ <para>
+ Select all mail syslog messages with priority <command>crit</command> and higher.
+ </para>
+ <screen>
+cron.!info,!debug
+ </screen>
+ <para>
+ Select all cron messages but those with the <command>info</command> or <command>debug</command> priority.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Actions — Actions specify what is to be done with the messages filtered out by the defined selector.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="bh-templates">
+ <title>Templates</title>
+ <para>
+
+ </para>
+ </section>
+ <section id="bh-filter-conditions">
+ <title>Filter Conditions</title>
<para>
- Note that any empty lines or lines that begin with a hash mark (<literal>#</literal>) are comments and are not processed.
+
</para>
+ </section>
+ <section id="bh-output-channels">
+ <title>Output Channels</title>
+ <para>
+
+ </para>
+ </section>
+<!-- <note>
+ <title>Note</title>
+ <para>
+ Any empty lines or lines that begin with a hash sign (#) are comments and are not processed.
+ </para>
+ </note> -->
+ </section>
+ <section id="s1-rsyslog-performance">
+ <title><command>rsyslog</command> Performance</title>
+ <para>
+
+ </para>
+
</section>
- <section
- id="s1-logfiles-locating">
+ <section id="s1-logfiles-locating">
<title>Locating Log Files</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>locating</secondary>
</indexterm>
<para>Most log files are located in the <filename>/var/log/</filename> directory. Some applications such as <command>httpd</command> and <command>samba</command> have a directory within <filename>/var/log/</filename> for their log files.</para>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>rotating</secondary>
</indexterm>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<command>logrotate</command>
</primary>
</indexterm>
<para>You may notice multiple files in the <filename>/var/log/</filename> directory with numbers after them (e.g.: <filename>cron-20100906</filename>). These numbers represent a timestamp that has been added to a rotated log file. Log files are rotated so their file sizes do not become too large. The <filename>logrotate</filename> package contains a cron task that automatically rotates log files according to the <filename>/etc/logrotate.conf</filename> configuration file and the configuration files in the <filename>/etc/logrotate.d/</filename> directory.</para>
<section id="configuring-logrotate">
- <title>Configuring <package>logrotate</package></title>
+ <title>Configuring <package>logrotate</package>
+ </title>
<para>
The following is a sample <filename>/etc/logrotate.conf</filename> configuration file:
</para>
@@ -190,7 +280,7 @@ rotate 4
compress
</screen>
<para>
- All of the lines in the sample configuration file define global options that apply to every log file. In our example, log files are rotated weekly, rotated log files are kept for the duration of 4 weeks, and all rotated log files are compressed by <application>gzip</application> into the <literal>.gz</literal> format. Any lines that begin with a hash mark (#) are comments and are not processed</para>
+ All of the lines in the sample configuration file define global options that apply to every log file. In our example, log files are rotated weekly, rotated log files are kept for the duration of 4 weeks, and all rotated log files are compressed by <application>gzip</application> into the <literal>.gz</literal> format. Any lines that begin with a hash sign (#) are comments and are not processed</para>
<para>
You may define configuration options for a specific log file and place it under the global options. However, it is advisable to create a separate configuration file for any specific log file in the <filename>/etc/logrotate.d/</filename> directory and define any configuration options there.
</para>
@@ -274,12 +364,14 @@ compress
</listitem>
<listitem>
<para>
- <parameter>rotate <replaceable><INTEGER></replaceable></parameter> — Specifies the number of rotations a log file undergoes before it is removed or mailed to a specific address. If the value <constant>0</constant> is specified, old log files are removed instead of rotated.
+ <parameter>rotate <replaceable><INTEGER></replaceable>
+ </parameter> — Specifies the number of rotations a log file undergoes before it is removed or mailed to a specific address. If the value <constant>0</constant> is specified, old log files are removed instead of rotated.
</para>
</listitem>
<listitem>
<para>
- <parameter>mail <replaceable><ADDRESS></replaceable></parameter> — This option enables mailing of log files that have been rotated as many times as is defined by the <parameter>rotate</parameter> directive to the specified address. Similar directives include:
+ <parameter>mail <replaceable><ADDRESS></replaceable>
+ </parameter> — This option enables mailing of log files that have been rotated as many times as is defined by the <parameter>rotate</parameter> directive to the specified address. Similar directives include:
</para>
<itemizedlist>
<listitem>
@@ -305,17 +397,14 @@ compress
</para>
</section>
</section>
- <section
- id="s1-logfiles-viewing">
+ <section id="s1-logfiles-viewing">
<title>Viewing Log Files</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>viewing</secondary>
</indexterm>
<para>Most log files are in plain text format. You can view them with any text editor such as <command>Vi</command> or <application>Emacs</application>. Some log files are readable by all users on the system; however, root privileges are required to read most log files.</para>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<command>gnome-system-log</command>
</primary>
@@ -326,66 +415,58 @@ compress
<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 gnome-system-log</command></screen>
- <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
+ <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 gnome-system-log</command>
+ </screen>
+ <para>For more information on installing packages with Yum, refer to <xref linkend="sec-Installing"/>.</para>
</note>
- <para>After you have installed the <package>gnome-system-log</package> package, you can open the <application>Log File Viewer</application> by clicking on <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">
+ <para>After you have installed the <package>gnome-system-log</package> package, you can open the <application>Log File Viewer</application> by clicking on <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>Log File Viewer</application>
</primary>
<secondary>searching</secondary>
</indexterm>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<application>Log File Viewer</application>
</primary>
<secondary>filtering</secondary>
</indexterm>
- <figure
- id="fig-redhat-logviewer">
+ <figure id="fig-redhat-logviewer">
<title>
<application>Log File Viewer</application>
</title>
<mediaobject>
<imageobject>
- <imagedata
- align="center"
- fileref="images/redhat-logviewer.png"
- format="PNG"/>
+ <imagedata align="center" fileref="images/redhat-logviewer.png" format="PNG"/>
</imageobject>
<textobject>
<para>Log File Viewer</para>
</textobject>
</mediaobject>
</figure>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<application>Log Viewer</application>
</primary>
<secondary>refresh rate</secondary>
</indexterm>
<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
- id="fig-redhat-filters">
+ <figure id="fig-redhat-filters">
<title>
<application>Log File Viewer - Filters</application>
</title>
<mediaobject>
<imageobject>
- <imagedata
- fileref="images/redhat-filters.png"
- format="PNG"
- align="center"/>
+ <imagedata fileref="images/redhat-filters.png" format="PNG" align="center"/>
</imageobject>
<textobject>
<para>Log File Viewer - Filters</para>
@@ -393,17 +474,13 @@ compress
</mediaobject>
</figure>
<para>Adding or editing a filter lets you define its parameters as is shown in <xref linkend="fig-redhat-filter-sample"/>.</para>
- <figure
- id="fig-redhat-filter-sample">
+ <figure id="fig-redhat-filter-sample">
<title>
<application>Log File Viewer - Defining a Filter</application>
</title>
<mediaobject>
<imageobject>
- <imagedata
- fileref="images/redhat-filter-sample.png"
- format="PNG"
- align="center"/>
+ <imagedata fileref="images/redhat-filter-sample.png" format="PNG" align="center"/>
</imageobject>
<textobject>
<para>Log File Viewer - Defining a Filter</para>
@@ -445,17 +522,13 @@ compress
<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
- id="fig-redhat-filter-enable">
+ <figure 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"
- align="center"/>
+ <imagedata fileref="images/redhat-filter-enable.png" format="PNG" align="center"/>
</imageobject>
<textobject>
<para>Log File Viewer - Enabling a Filter</para>
@@ -466,19 +539,16 @@ compress
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">
+ <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 <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
- id="fig-redhat-logviewer-add">
+ <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 id="fig-redhat-logviewer-add">
<title>Log File Viewer - Adding a Log File</title>
<mediaobject>
<imageobject>
- <imagedata
- fileref="images/redhat-logviewer-add.png"
- format="PNG"
- align="center"/>
+ <imagedata fileref="images/redhat-logviewer-add.png" format="PNG" align="center"/>
</imageobject>
<textobject>
<para>Log File Viewer - Adding a Log File</para>
@@ -488,21 +558,18 @@ compress
<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>
+ <para>
The <application>Log File Viewer</application> also allows you to open log files zipped in the <literal>.gz</literal> format.
</para>
</note>
</section>
- <section
- id="s1-logfiles-examining">
+ <section id="s1-logfiles-examining">
<title>Monitoring Log Files</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>monitoring</secondary>
</indexterm>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>
<application>Log File Viewer</application>
</primary>
@@ -510,15 +577,11 @@ compress
</indexterm>
<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
- id="fig-redhat-logviewer-monitoring">
+ <figure id="fig-redhat-logviewer-monitoring">
<title>Log File Viewer - New Log Alert</title>
<mediaobject>
<imageobject>
- <imagedata
- fileref="images/redhat-logviewer-monitoring.png"
- format="PNG"
- align="center"/>
+ <imagedata fileref="images/redhat-logviewer-monitoring.png" format="PNG" align="center"/>
</imageobject>
<textobject>
<para>Log File Viewer - New Log Alert</para>
@@ -526,15 +589,12 @@ compress
</mediaobject>
</figure>
</section>
- <section
- id="s1-log-files-additional-resources">
+ <section id="s1-log-files-additional-resources">
<title>Additional Resources</title>
<para>To learn more about <application>rsyslog</application>, <application>logrotate</application>, and log files in general, refer to the following resources.</para>
- <section
- id="s2-log-files-installed-docs">
+ <section id="s2-log-files-installed-docs">
<title>Installed Documentation</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>additional resources</secondary>
<tertiary>installed documentation</tertiary>
@@ -550,7 +610,8 @@ compress
</listitem>
<listitem>
<para>
- <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable></filename> — After installing the <package>rsyslog</package> package, this directory contains extensive documentation in the <systemitem class="protocol">html</systemitem> format.</para>
+ <filename>/usr/share/doc/rsyslog-<replaceable><version-number></replaceable>
+ </filename> — After installing the <package>rsyslog</package> package, this directory contains extensive documentation in the <systemitem class="protocol">html</systemitem> format.</para>
</listitem>
<listitem>
<para>
@@ -558,11 +619,9 @@ compress
</listitem>
</itemizedlist>
</section>
- <section
- id="s2-log-files-useful-websites">
+ <section id="s2-log-files-useful-websites">
<title>Useful Websites</title>
- <indexterm
- significance="normal">
+ <indexterm significance="normal">
<primary>log files</primary>
<secondary>additional resources</secondary>
<tertiary>useful websites</tertiary>
@@ -570,13 +629,11 @@ compress
<itemizedlist>
<listitem>
<para>
- <ulink
- url="http://www.rsyslog.com/">http://www.rsyslog.com/</ulink> — Offers a thorough technical breakdown of <package>rsyslog</package> features, documentation, configuration examples, and video tutorials.</para>
+ <ulink url="http://www.rsyslog.com/">http://www.rsyslog.com/</ulink> — Offers a thorough technical breakdown of <package>rsyslog</package> features, documentation, configuration examples, and video tutorials.</para>
</listitem>
<listitem>
<para>
- <ulink
- url="http://wiki.rsyslog.com/index.php/Main_Page">http://wiki.rsyslog.com/index.php/Main_Page</ulink> — Contains useful <filename>/etc/rsyslog.conf</filename> configuration examples.</para>
+ <ulink url="http://wiki.rsyslog.com/index.php/Main_Page">http://wiki.rsyslog.com/index.php/Main_Page</ulink> — Contains useful <filename>/etc/rsyslog.conf</filename> configuration examples.</para>
</listitem>
</itemizedlist>
</section>
diff --git a/en-US/RPM.xml b/en-US/RPM.xml
index 3584a79..29e60b7 100644
--- a/en-US/RPM.xml
+++ b/en-US/RPM.xml
@@ -202,7 +202,7 @@
<note
id="note-Use_-Uvh_for_nicely-formatted_RPM_installs">
<title>Use -Uvh for nicely-formatted RPM installs</title>
- <para>The <option>-v</option> and <option>-h</option> options (which are combined with <option>-U</option>) cause <application>rpm</application> to print more verbose output and display a progress meter using hash marks.</para>
+ <para>The <option>-v</option> and <option>-h</option> options (which are combined with <option>-U</option>) cause <application>rpm</application> to print more verbose output and display a progress meter using hash signs.</para>
</note>
<para>If the upgrade/installation is successful, the following output is displayed:</para>
<screen>Preparing... ########################################### [100%]
diff --git a/en-US/The_X_Window_System.xml b/en-US/The_X_Window_System.xml
index 9ef1efb..f4cc728 100644
--- a/en-US/The_X_Window_System.xml
+++ b/en-US/The_X_Window_System.xml
@@ -412,7 +412,7 @@
<para>Each section begins with a <command>Section "<replaceable><section-name></replaceable>"</command> line (where <replaceable><section-name></replaceable> is the title for the section) and ends with an
<command>EndSection</command> line. Within each of the sections are lines containing option names and at least one option value, sometimes surrounded with double quotes (<command>"</command>).</para>
-->
- <para>Lines beginning with a hash mark (<command>#</command>) are not read by the X server and are used for human-readable comments.</para>
+ <para>Lines beginning with a hash sign (<command>#</command>) are not read by the X server and are used for human-readable comments.</para>
<para>Some options within the <filename>/etc/X11/xorg.conf</filename> file accept a boolean switch which turns the feature on or off. Acceptable boolean values are:</para>
<itemizedlist>
<listitem>
More information about the docs-commits
mailing list