source: chapter06/tar.xml@ 2be021c

<?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;
]>

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

  <sect1info condition="script">
    <productname>tar</productname>
    <productnumber>&tar-version;</productnumber>
    <address>&tar-url;</address>
  </sect1info>

  <title>Tar-&tar-version;</title>

  <indexterm zone="ch-system-tar">
    <primary sortas="a-Tar">Tar</primary>
  </indexterm>

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

    <para>The Tar package contains an archiving program.</para>

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

      <seglistitem>
        <seg>&tar-ch6-sbu;</seg>
        <seg>&tar-ch6-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para>Add a program that generates a man page for tar from the source code:</para>
 
 <screen><userinput remap="pre">patch -Np1 -i ../&tar-manpage-patch;</userinput></screen>

    <para>Prepare Tar for compilation:</para>

<screen><userinput remap="configure">FORCE_UNSAFE_CONFIGURE=1  \
./configure --prefix=/usr \
            --bindir=/bin \
            --libexecdir=/usr/sbin</userinput></screen>

    <variablelist>
      <title>The meaning of the configure options:</title>

      <varlistentry>
        <term><envar>FORCE_UNSAFE_CONFIGURE=1</envar></term>
        <listitem>
          <para>This forces the test for <function>mknod</function> to be run
          as root.  It is generally considered dangerous to run this test as
          the root user, but as it is being run on a system that has only been
          partially built, overriding it is OK.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>Compile the package:</para>

<screen><userinput remap="make">make</userinput></screen>

    <para>To test the results (about 1 SBU), issue:</para>

<screen><userinput remap="test">make check</userinput></screen>

    <para>Install the package:</para>

<screen><userinput remap="install">make install
make -C doc install-html docdir=/usr/share/doc/tar-&tar-version;</userinput></screen>

    <para>Finally, generate the man page and place it in the proper location:</para>

<screen><userinput remap="install">perl tarman &gt; /usr/share/man/man1/tar.1</userinput></screen>

  </sect2>


  <sect2 id="contents-tar" role="content">
    <title>Contents of Tar</title>

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

      <seglistitem>
        <seg>rmt and tar</seg>
        <seg>/usr/share/doc/tar-&tar-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="rmt">
        <term><command>rmt</command></term>
        <listitem>
          <para>Remotely manipulates a magnetic
          tape drive through an interprocess communication connection</para>
          <indexterm zone="ch-system-tar rmt">
            <primary sortas="b-rmt">rmt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tar">
        <term><command>tar</command></term>
        <listitem>
          <para>Creates, extracts files from, and lists the contents of archives,
          also known as tarballs</para>
          <indexterm zone="ch-system-tar tar">
            <primary sortas="b-tar">tar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>