source: general/prog/unifdef.xml@ e962ced

<?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 unifdef-download-http "https://dotat.at/prog/unifdef/unifdef-&unifdef-version;.tar.gz">
  <!ENTITY unifdef-download-ftp  " ">
  <!ENTITY unifdef-md5sum        "b225312c110cd2600ca7166bd0419751">
  <!ENTITY unifdef-size          "88 KB">
  <!ENTITY unifdef-buildsize     "1.9 MB">
  <!ENTITY unifdef-time          "less than 0.1 SBU">
]>

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

  <title>unifdef-&unifdef-version;</title>

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

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

    <para>
      The <application>unifdef</application> package contains a utility that
      is useful for removing preprocessor conditionals from code.
    </para>

    &lfs113_checked;

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

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

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

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

<screen><userinput>make</userinput></screen>

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

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

<screen role="root"><userinput>make prefix=/usr 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>
          unifdef and unifdefall
        </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="unifdef-prog">
        <term><command>unifdef</command></term>
        <listitem>
          <para>
            removes preprocessor conditionals from code
          </para>
          <indexterm zone="unifdef unifdef-prog">
            <primary sortas="b-unifdef">unifdef</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unifdefall">
        <term><command>unifdefall</command></term>
        <listitem>
          <para>
            removes preprocessor conditionals from code across a whole tree
          </para>
          <indexterm zone="unifdef unifdefall">
            <primary sortas="b-unifdefall">unifdefall</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>