source: chapter06/sysklogd.xml@ 3685bb6

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-sysklogd" role="wrap">
  <?dbhtml filename="sysklogd.html"?>

  <title>Sysklogd-&sysklogd-version;</title>

  <indexterm zone="ch-system-sysklogd">
    <primary sortas="a-Sysklogd">Sysklogd</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Sysklogd package contains programs for logging system messages,
    such as those given by the kernel when unusual things happen.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>0.1 SBU</seg>
        <seg>704 KB</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Binutils, Coreutils, GCC, Glibc, Make, and Patch</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Sysklogd</title>

    <para>The following patch fixes various issues, including a problem building
    Sysklogd with Linux 2.6 series kernels</para>

<screen><userinput>patch -Np1 -i ../&sysklogd-fixes-patch;</userinput></screen>

    <para>The following patch makes sysklogd treat bytes in the 0x80--0x9f range
    literally in the messages being logged, instead of replacing them with octal
    codes. Unpatched sysklogd would damage messages in the UTF-8 encoding.</para>

<screen><userinput>patch -Np1 -i ../&sysklogd-8bit-patch;</userinput></screen>

    <para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Install the package:</para>

<screen><userinput>make install</userinput></screen>

  </sect2>

  <sect2 id="conf-sysklogd" role="configuration">
    <title>Configuring Sysklogd</title>

    <indexterm zone="conf-sysklogd">
      <primary sortas="a-Sysklogd">Sysklogd</primary>
      <secondary>configuring</secondary>
    </indexterm>

    <indexterm zone="conf-sysklogd">
      <primary sortas="e-/etc/syslog.conf">/etc/syslog.conf</primary>
    </indexterm>

    <para>Create a new <filename>/etc/syslog.conf</filename> file by running the
    following:</para>

<screen><userinput>cat &gt; /etc/syslog.conf &lt;&lt; "EOF"
<literal># Begin /etc/syslog.conf

auth,authpriv.* -/var/log/auth.log
*.*;auth,authpriv.none -/var/log/sys.log
daemon.* -/var/log/daemon.log
kern.* -/var/log/kern.log
mail.* -/var/log/mail.log
user.* -/var/log/user.log
*.emerg *

# log the bootscript output:
local2.* -/var/log/boot.log

# End /etc/syslog.conf</literal>
EOF</userinput></screen>

  </sect2>

  <sect2 id="contents-sysklogd" role="content">
    <title>Contents of Sysklogd</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>klogd and syslogd</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="klogd">
        <term><command>klogd</command></term>
        <listitem>
          <para>A system daemon for intercepting and logging kernel messages</para>
          <indexterm zone="ch-system-sysklogd klogd">
            <primary sortas="b-klogd">klogd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="syslogd">
        <term><command>syslogd</command></term>
        <listitem>
          <para>Logs the messages that system programs offer for logging. Every
          logged message contains at least a date stamp and a hostname, and
          normally the program's name too, but that depends on how trusting the
          logging daemon is told to be</para>
          <indexterm zone="ch-system-sysklogd syslogd">
            <primary sortas="b-syslogd">syslogd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>