source: postlfs/filesystems/smartmontools.xml@ b5645ad

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

  <!ENTITY smartmontools-download-http "&sourceforge-dl;/smartmontools/smartmontools-&smartmontools-version;.tar.gz">
  <!ENTITY smartmontools-download-ftp  " ">
  <!ENTITY smartmontools-md5sum        "e8d134c69ae4959a05cb56b31172ffb1">
  <!ENTITY smartmontools-size          "972 KB">
  <!ENTITY smartmontools-buildsize     "24 MB">
  <!ENTITY smartmontools-time          "0.2 SBU">
]>

<sect1 id="smartmontools" xreflabel="smartmontools-&smartmontools-version;">
  <?dbhtml filename="smartmontools.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>smartmontools-&smartmontools-version;</title>

  <indexterm zone="smartmontools">
    <primary sortas="a-smartmontools">smartmontools</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to smartmontools</title>

    <para>
      The <application>smartmontools</application> package contains utility
      programs (smartctl, smartd) to control/monitor storage systems using the
      Self-Monitoring, Analysis and Reporting Technology System (S.M.A.R.T.)
      built into most modern ATA and SCSI disks. 
    </para>

    &lfs110a_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&smartmontools-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&smartmontools-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &smartmontools-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &smartmontools-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &smartmontools-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &smartmontools-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">smartmontools Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional (runtime)</bridgehead>
    <para role="optional">
      <xref role="runtime" linkend="curl"/> or
      <xref role="runtime" linkend="lynx"/> or
      <xref role="runtime" linkend="wget"/> (download tools), and
      <xref role="runtime" linkend="gnupg2"/> (encrypted hard disks)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/smartmontools"/>
    </para>
  </sect2>

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

    <para>
      Install <application>smartmontools</application> by running the 
      following commands:
    </para>

<screen revision="sysv"><userinput>./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --with-initscriptdir=no \
            --with-libsystemd=no    \
            --docdir=/usr/share/doc/smartmontools-&smartmontools-version; &amp;&amp;
make</userinput></screen>

<screen revision="systemd"><userinput>./configure --prefix=/usr           \
            --sysconfdir=/etc       \
            --docdir=/usr/share/doc/smartmontools-&smartmontools-version; &amp;&amp;
make</userinput></screen>

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

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands" revision="sysv">
    <title>Command Explanations</title>

    <para>
      <parameter>--with-initscriptdir=no</parameter>: This switch suppresses
      the default initialization script.  See below for the BLFS script.
    </para>

    <para>
      <parameter>--with-libsystemd=no</parameter>: This switch disables support
      for the sd-notify notification system provided by systemd.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring smartmontools</title>

    <sect3 id="smartmontools-config">
      <title>Config File</title>
      <para>
        <filename>/etc/smartd.conf</filename>
      </para>

      <indexterm zone="smartmontools smartmontools-config">
        <primary sortas="e-etc-smartd.conf">/etc/smartd.conf</primary>
      </indexterm>
    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>
        See the embedded comments in <filename>/etc/smartd.conf</filename>
        for detailed instructions on customizing the
        <application>smartd</application> darmon.
      </para>

    </sect3>

    <sect3  id="smartmontoools-init">
       <title><phrase revision="sysv">Boot Script</phrase>
              <phrase revision="systemd">Systemd Unit</phrase></title>

      <para revision="sysv">
        If you want the <application>smartd</application> daemon to
        start automatically when the system is booted, install the
        <filename>/etc/rc.d/init.d/smartd</filename> init script included
        in the <xref linkend="bootscripts"/> package.
      </para>


      <para revision="systemd">
        If you want the <application>smartd</application> daemon to
        start automatically when the system is booted, enable the
        systemd unit provided by the package by executing the
        following command as the
        <systemitem class="username">root</systemitem> user:
      </para>

      <indexterm zone="smartmontools smartmontoools-init">
        <primary sortas="f-smartd">smartd</primary>
      </indexterm>

<screen role="root" revision="sysv"><userinput>make install-smartd</userinput></screen>

<screen role="root" revision="systemd"><userinput>systemctl enable smartd</userinput></screen>
    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          smartctl, smartd, and update-smart-drivedb
        </seg>

        <seg>
          None
        </seg>

        <seg>
          /usr/share/smartmontools, /usr/share/doc/smartmontools-6.4, and
          /etc/smartd_warning.d
        </seg>

      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="smartctl">
        <term><command>smartctl</command></term>
        <listitem>
          <para>
            is the control and monitor utility for SMART Disks
          </para>
          <indexterm zone="smartmontools smartctl">
            <primary sortas="b-smartctl">smartctl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="smartd">
        <term><command>smartd</command></term>
        <listitem>
          <para>
            is the SMART disk monitoring daemon
          </para>
          <indexterm zone="smartmontools smartd">
            <primary sortas="b-smartd">smartd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="update-smart-drivedb">
        <term><command>update-smart-drivedb</command></term>
        <listitem>
          <para>
            is the update tool for the smartmontools drive database
          </para>
          <indexterm zone="smartmontools update-smart-drivedb">
            <primary sortas="b-update-smart-drivedb">update-smart-drivedb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
  </sect2>

</sect1>