source: general/genutils/sharutils.xml@ 1760143

<?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 sharutils-download-http "&gnu-http;/sharutils/sharutils-&sharutils-version;.tar.xz">
  <!ENTITY sharutils-download-ftp  "&gnu-ftp;/sharutils/sharutils-&sharutils-version;.tar.xz">
  <!ENTITY sharutils-md5sum        "5975ce21da36491d7aa6dc2b0d9788e0">
  <!ENTITY sharutils-size          "1.1 MB">
  <!ENTITY sharutils-buildsize     "22 MB (with the test suite)">
  <!ENTITY sharutils-time          "0.4 SBU (with the test suite)">
]>

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


  <title>Sharutils-&sharutils-version;</title>

  <indexterm zone="sharutils">
    <primary sortas="a-Sharutils">Sharutils</primary>
  </indexterm>

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

    <para>
      The <application>Sharutils</application> package contains
      utilities that can create 'shell' archives.
    </para>

    &lfs113_checked;

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

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

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

    <para>
      Fix a heap buffer overflow, and an issue exposed by GCC-10:
    </para>

<screen><userinput>sed -i 's/BUFSIZ/rw_base_size/' src/unshar.c &amp;&amp;
sed -i '/program_name/s/^/extern /' src/*opts.h</userinput></screen>

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

<screen><userinput>sed -i 's/IO_ftrylockfile/IO_EOF_SEEN/' lib/*.c        &amp;&amp;
echo "#define _IO_IN_BACKUP 0x100" >> lib/stdio-impl.h &amp;&amp;

./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue <command>make check</command>.
    </para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          shar, unshar, uudecode and uuencode
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="shar">
        <term><command>shar</command></term>
        <listitem>
          <para>
            creates "shell archives" (or shar files) which are in
            text format and can be mailed
          </para>
          <indexterm zone="sharutils shar">
            <primary sortas="b-shar">shar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unshar">
        <term><command>unshar</command></term>
        <listitem>
          <para>
            unpacks a shar file
          </para>
          <indexterm zone="sharutils unshar">
            <primary sortas="b-unshar">unshar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uudecode">
        <term><command>uudecode</command></term>
        <listitem>
          <para>
            reads a file (or by default the standard input) and writes an
            encoded  version to the standard output. The encoding uses only
            printing ASCII characters
          </para>
          <indexterm zone="sharutils uudecode">
            <primary sortas="b-uudecode">uudecode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uuencode">
        <term><command>uuencode</command></term>
        <listitem>
          <para>
            reads a file (or by default the standard input) and decodes
            the uuencoded version to the standard output
          </para>
          <indexterm zone="sharutils uuencode">
            <primary sortas="b-uuencode">uuencode</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>