source: final-system/common/bash.xml@ 98b2c00

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

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

  <title>Bash-&bash-version;</title>

  <indexterm zone="ch-system-bash">
    <primary sortas="a-Bash">Bash</primary>
  </indexterm>

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

    <para>The Bash package contains the Bourne-Again SHell.</para>

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

      <seglistitem>
        <seg>Not checked yet</seg>
        <seg>Not checked yet</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Binutils, Coreutils, Diffutils, Gawk, GCC, Glibc, Grep, Make,
        Ncurses, and Sed.</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para os="a">If you downloaded the Bash documentation tarball and wish to
    install HTML documentation, issue the following commands:</para>

<screen os="b"><userinput>tar -zxf ../bash-doc-&bash-doc-version;.tar.gz &amp;&amp;
sed -i "s|htmldir = @htmldir@|htmldir = /usr/share/doc/bash-&bash-version;|" \
    Makefile.in</userinput></screen>

    <para os="c">The following patch fixes various issues, including a problem where
    Bash will sometimes only show 33 characters on a line, then wrap to the
    next:</para>

<screen os="d"><userinput>patch -Np1 -i ../&bash-fixes-patch;</userinput></screen>

    <para os="e">Bash also has issues when compiled against newer versions of Glibc.
    The following patch resolves this problem:</para>

<screen os="f"><userinput>patch -Np1 -i ../&bash-avoid_WCONTINUED-patch;</userinput></screen>

    <para os="g">Prepare Bash for compilation:</para>

<screen><userinput>./configure --prefix=/usr --bindir=/bin \
    --without-bash-malloc --with-installed-readline</userinput></screen>

    <variablelist os="h">
      <title>The meaning of the configure option:</title>

      <varlistentry>
        <term><parameter>--with-installed-readline</parameter></term>
        <listitem>
          <para>This option tells Bash to use the
          <filename class="libraryfile">readline</filename> library that is
          already installed on the system rather than using its own readline
          version.</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para os="i">Compile the package:</para>

<screen os="j"><userinput>make</userinput></screen>

    <para os="k">To test the results, issue:
    <userinput>make tests</userinput>.</para>

    <para os="l">Install the package:</para>

<screen os="m"><userinput>make install</userinput></screen>

    <para os="n">Run the newly compiled <command>bash</command> program (replacing
    the one that is currently being executed):</para>

<screen os="o"><userinput>exec /bin/bash --login +h</userinput></screen>

    <note os="p">
      <para>The parameters used make the <command>bash</command>
      process an interactive login shell and continue to disable hashing so
      that new programs are found as they become available.</para>
    </note>

  </sect2>

  <sect2 id="contents-bash" role="content">
    <title>Contents of Bash</title>

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

      <seglistitem>
        <seg>bash, bashbug, and sh (link to bash)</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="bash">
        <term><command>bash</command></term>
        <listitem>
          <para>A widely-used command interpreter; it performs many types of
          expansions and substitutions on a given command line before executing
          it, thus making this interpreter a powerful tool</para>
          <indexterm zone="ch-system-bash bash">
            <primary sortas="b-bash">bash</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="bashbug">
        <term><command>bashbug</command></term>
        <listitem>
          <para>A shell script to help the user compose and mail standard
          formatted bug reports concerning <command>bash</command></para>
          <indexterm zone="ch-system-bash bashbug">
            <primary sortas="b-bashbug">bashbug</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sh">
        <term><command>sh</command></term>
        <listitem>
          <para>A symlink to the <command>bash</command> program; when invoked
          as <command>sh</command>, <command>bash</command> tries to mimic the
          startup behavior of historical versions of <command>sh</command> as
          closely as possible, while conforming to the POSIX standard as
          well</para>
          <indexterm zone="ch-system-bash sh">
            <primary sortas="b-sh">sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>