source: x/installing/x7util.xml@ 4487494

<?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 x7utils-download-http "http://xorg.freedesktop.org/releases/individual/util/">
  <!ENTITY x7utils-download-ftp  "ftp://ftp.x.org/pub/individual/util/">
  <!ENTITY x7utils-wget          "&files-anduin;/xorg/util-&xorg7-version;.wget">
  <!ENTITY x7utils-md5sum        "&files-anduin;/xorg/md5sums-&xorg7-version;">
  <!ENTITY x7utils-size          "664 KB">
  <!ENTITY x7utils-buildsize     "5.2 MB">
  <!ENTITY x7utils-time          "0.1 SBU">

]>

<sect1 id="xorg7-util" xreflabel="Xorg Utilities">
  <?dbhtml filename="x7util.html"?>

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

  <title>Xorg Utilities</title>

  <indexterm zone="xorg7-util">
    <primary sortas="a-xorg7-util">Xorg Utilities</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Xorg Utilities</title>

    <para>The <application>Xorg</application> utility packages provide
    needed utilities, not for the <application>Xorg</application>
    installation itself, but for other applications that make use of
    legacy X11R6 installation methods.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required download list: <ulink url="&x7utils-wget;"/></para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Xorg Utilities Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="pkgconfig"/> and
    <xref linkend="xorg7-proto"/></para>

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

  </sect2>

  <sect2>
    <title>Downloading Xorg Utilities</title>

    <para>To download the needed files using <application>wget</application>,
    use the following commands:</para>

<screen><userinput>mkdir util &amp;&amp;
cd util &amp;&amp;
grep -v '^#' ../util-&xorg7-version;.wget | wget -i- \
    -B http://xorg.freedesktop.org/releases/individual/util/</userinput></screen>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Xorg Utilities</title>

    <para>Install the Xorg utilities by running the following commands for
    each package:</para>

<screen><userinput>./configure $XORG_CONFIG &amp;&amp;
make</userinput></screen>

    <para>These packages do not provide test suites.</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>ccmakedep, cleanlinks, gccmakedep, imake, lndir, makedepend,
        makeg, mergelib, mkdirhier, mkhtmlindex, revpath, xmkmf</seg>
        <seg>None</seg>
        <seg>The following subdirectories of <envar>$XORG_PREFIX</envar>/:
        bin, lib/X11/config, share/aclocal, and share/man</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ccmakedep-x7">
        <term><command>ccmakedep</command></term>
        <listitem>
          <para>creates dependencies in makefiles using a C compiler.</para>
          <indexterm zone="xorg7-util ccmakedep-x7">
            <primary sortas="b-ccmakedep">ccmakedep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cleanlinks-x7">
        <term><command>cleanlinks</command></term>
        <listitem>
          <para>removes dangling symbolic links and empty directories.</para>
          <indexterm zone="xorg7-util cleanlinks-x7">
            <primary sortas="b-cleanlinks">cleanlinks</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gccmakedep-x7">
        <term><command>gccmakedep</command></term>
        <listitem>
          <para>creates dependencies in makefiles using
          <command>gcc -M</command>.</para>
          <indexterm zone="xorg7-util gccmakedep-x7">
            <primary sortas="b-gccmakedep">gccmakedep</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="imake-x7">
        <term><command>imake</command></term>
        <listitem>
          <para>is a C preprocessor interface to the make utility.</para>
          <indexterm zone="xorg7-util imake-x7">
            <primary sortas="b-imake">imake</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lndir-x7">
        <term><command>lndir</command></term>
        <listitem>
          <para>creates a shadow directory of symbolic links to another
          directory tree.</para>
          <indexterm zone="xorg7-util lndir-x7">
            <primary sortas="b-lndir">lndir</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="makedepend-x7">
        <term><command>makedepend</command></term>
        <listitem>
          <para>creates dependencies in makefiles.</para>
          <indexterm zone="xorg7-util makedepend-x7">
            <primary sortas="b-makedepend">makedepend</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="makeg-x7">
        <term><command>makeg</command></term>
        <listitem>
          <para>makes a debuggable executable.</para>
          <indexterm zone="xorg7-util makeg-x7">
            <primary sortas="b-makeg">makeg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mergelib-x7">
        <term><command>mergelib</command></term>
        <listitem>
          <para>merges one library into another.</para>
          <indexterm zone="xorg7-util mergelib-x7">
            <primary sortas="b-mergelib">mergelib</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkdirhier-x7">
        <term><command>mkdirhier</command></term>
        <listitem>
          <para>makes a directory hierarchy.</para>
          <indexterm zone="xorg7-util mkdirhier-x7">
            <primary sortas="b-mkdirhier">mkdirhier</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkhtmlindex-x7">
        <term><command>mkhtmlindex</command></term>
        <listitem>
          <para>generates index files for HTML man pages.</para>
          <indexterm zone="xorg7-util mkhtmlindex-x7">
            <primary sortas="b-mkhtmlindex">mkhtmlindex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="revpath-x7">
        <term><command>revpath</command></term>
        <listitem>
          <para>generates a relative path that can be used to undo a
          changedirectory.</para>
          <indexterm zone="xorg7-util revpath-x7">
            <primary sortas="b-revpath">revpath</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xmkmf-x7">
        <term><command>xmkmf</command></term>
        <listitem>
          <para>creates a Makefile from an Imakefile.</para>
          <indexterm zone="xorg7-util xmkmf-x7">
            <primary sortas="b-xmkmf">xmkmf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>