source: final-system/common/gawk.xml@ 2ed9444

<?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">
  %general-entities;
]>

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

  <title>Gawk-&gawk-version;</title>

  <indexterm zone="ch-system-gawk">
    <primary sortas="a-Gawk">Gawk</primary>
  </indexterm>

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

    <para>The Gawk package contains programs for manipulating text
    files.</para>

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

      <seglistitem>
        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Gettext,
        Glibc, Grep, Make, Patch, and Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

    <para os="a">Patch Gawk to fix a bug which causes it to
    segfault when invoked on a non-existent file:</para>

<screen os="b"><userinput>patch -Np1 -i ../&gawk-segfault-patch;</userinput></screen>

    <para os="c">Prepare Gawk for compilation:</para>

<screen os="d"><userinput>./configure --prefix=/usr --libexecdir=/usr/lib</userinput></screen>

    <para os="h1">Now we will fix an issue that will cause the gettext testsuite's
    to fail:</para>

<screen os="h2"><userinput>echo '#define HAVE_LC_MESSAGES 1' >> config.h</userinput></screen>

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

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

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

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

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

  </sect2>

  <sect2 id="contents-gawk" role="content">
    <title>Contents of Gawk</title>

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

      <seglistitem>
        <seg>awk (link to gawk), gawk, gawk-&gawk-version;, grcat, igawk,
        pgawk, pgawk-&gawk-version;, and pwcat</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="awk">
        <term><command>awk</command></term>
        <listitem>
          <para>A link to <command>gawk</command></para>
          <indexterm zone="ch-system-gawk awk">
            <primary sortas="b-awk">awk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gawk">
        <term><command>gawk</command></term>
        <listitem>
          <para>A program for manipulating text files; it is the GNU
          implementation of <command>awk</command></para>
          <indexterm zone="ch-system-gawk gawk">
            <primary sortas="b-gawk">gawk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gawk-version">
        <term><command>gawk-&gawk-version;</command></term>
          <listitem>
          <para>A hard link to <command>gawk</command></para>
          <indexterm zone="ch-system-gawk gawk-version">
            <primary sortas="b-gawk-&gawk-version;">gawk-&gawk-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="grcat">
        <term><command>grcat</command></term>
        <listitem>
          <para>Dumps the group database <filename>/etc/group</filename></para>
          <indexterm zone="ch-system-gawk grcat">
            <primary sortas="b-grcat">grcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="igawk">
        <term><command>igawk</command></term>
        <listitem>
          <para>Gives <command>gawk</command> the ability to include files</para>
          <indexterm zone="ch-system-gawk igawk">
            <primary sortas="b-igawk">igawk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pgawk">
        <term><command>pgawk</command></term>
        <listitem>
          <para>The profiling version of <command>gawk</command></para>
          <indexterm zone="ch-system-gawk pgawk">
            <primary sortas="b-pgawk">pgawk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pgawk-version">
        <term><command>pgawk-&gawk-version;</command></term>
        <listitem>
          <para>Hard link to <command>pgawk</command></para>
          <indexterm zone="ch-system-gawk pgawk-version">
            <primary sortas="b-pgawk-&gawk-version;">pgawk-&gawk-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pwcat">
        <term><command>pwcat</command></term>
        <listitem>
          <para>Dumps the password database <filename>/etc/passwd</filename></para>
          <indexterm zone="ch-system-gawk pwcat">
            <primary sortas="b-pwcat">pwcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>