source: general/sysutils/pax.xml@ 96ed758

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

  <!-- Place this in the general.ent file
  <!ENTITY pax-version "070715">
  -->

  <!ENTITY pax-download-http "&sourceforge-repo;/heirloom/heirloom-&pax-version;.tar.bz2">
  <!ENTITY pax-download-ftp  " ">
  <!ENTITY pax-md5sum        "d846be4b268b1d55b6ffcef847f09979">
  <!ENTITY pax-size          "977 KB">
  <!ENTITY pax-buildsize     "9.2 MB">
  <!ENTITY pax-time          "less than 0.1 SBU">
]>

<!-- Try to keep the indentation used in this file-->
<sect1 id="pax" xreflabel="Pax-&pax-version;">
  <?dbhtml filename="pax.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <!-- No other tags inside any title.
       Use Title Case in All Titles -->
  <title>Pax-&pax-version;</title>

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

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to Pax</title>

    <para>
      <application>pax</application> is an archiving utility created by POSIX
      and defined by the POSIX.1-2001 standard. Rather than sort out the
      incompatible options that have crept up between
      <application>tar</application> and <application>cpio</application>,
      along with their implementations across various versions of UNIX, the
      IEEE designed a new archive utility. The name <quote>pax</quote> is
      an acronym for portable archive exchange. Furthermore,
      <quote>pax</quote> means <quote>peace</quote> in Latin, so its name
      implies that it shall create peace between the
      <application>tar</application> and <application>cpio</application>
      format supporters. The command invocation and command structure is
      somewhat a unification of both <application>tar</application> and
      <application>cpio</application>.
    </para>
    <para>
      <application>pax</application> has been required to be present in LSB
      conformant systems since LSB version 3.0.
    </para>

    &lfs77_checked;

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

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

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

    <para>
      This package has somewhat unusual installation instructions, because
      <application>pax</application> is part of a larger set of utilities
      included in the same tarball. Issue the following commands:
    </para>

<screen><userinput>sed -i build/mk.config                   \
    -e '/LIBZ/s@ -Wl[^ ]*@@g'            \
    -e '/LIBBZ2/{s@^#@@;s@ -Wl[^ ]*@@g}' \
    -e '/BZLIB/s@0@1@'                   &amp;&amp;

make makefiles                           &amp;&amp;
make -C libcommon                        &amp;&amp;
make -C libuxre                          &amp;&amp;
make -C cpio</userinput></screen>

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

<screen role="root"><userinput>install -v -m755 cpio/pax_su3 /usr/bin/pax &amp;&amp;
install -v -m644 cpio/pax.1 /usr/share/man/man1</userinput></screen>
  </sect2>

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

    <para>
      <command>sed ...</command>: This changes the configuration file
      <filename>build/mk.config</filename> so that the system zlib and
      libbz2 are used and linked as shared libraries.
    </para>

    <para>
      <command>make makefiles</command>: This command builds all the
      makefiles.
    </para>

    <para>
      <command>make -C lib...</command>: First builds the necessary libraries.
    </para>

    <para>
      <command>make -C cpio</command>: Then builds the archive utilities.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>

      <seglistitem>
        <seg>
          pax.
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="pax-prog">
        <term><command>pax</command></term>
        <listitem>
          <para>
            copies files to and from archives in several formats.
          </para>
          <indexterm zone="pax pax-prog">
            <primary sortas="b-pax">pax</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>