source: general/genlib/libatasmart.xml@ e6b445c

<?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 libatasmart-download-http "http://0pointer.de/public/libatasmart-&libatasmart-version;.tar.xz">
  <!ENTITY libatasmart-download-ftp  " ">
  <!ENTITY libatasmart-md5sum        "53afe2b155c36f658e121fe6def33e77">
  <!ENTITY libatasmart-size          "248 KB">
  <!ENTITY libatasmart-buildsize     "3 MB">
  <!ENTITY libatasmart-time          "less than 0.1 SBU">
]>

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

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

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

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

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

    <para>
      The <application>libatasmart</application> package is a disk reporting
      library. It only supports a subset of the ATA S.M.A.R.T. functionality.
    </para>

    &lfs101_checked;

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

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

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &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 docdir=/usr/share/doc/libatasmart-&libatasmart-version; install</userinput></screen>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          skdump and sktest
        </seg>
        <seg>
          libatasmart.so
        </seg>
        <seg>
          /usr/share/doc/libatasmart-&libatasmart-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="skdump">
        <term><command>skdump</command></term>
        <listitem>
          <para>
            is a utility that reports on the status of the disk
          </para>
          <indexterm zone="libatasmart skdump">
            <primary sortas="b-skdump">skdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sktest">
        <term><command>sktest</command></term>
        <listitem>
          <para>
            is a utility to issue disks tests
          </para>
          <indexterm zone="libatasmart sktest">
            <primary sortas="b-sktest">sktest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libatasmart-lib">
        <term><filename class="libraryfile">libatasmart.so</filename></term>
        <listitem>
          <para>
            contains the ATA S.M.A.R.T API functions
          </para>
          <indexterm zone="libatasmart libatasmart-lib">
            <primary sortas="c-libatasmart">libatasmart.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>