source: x/installing/xcb-util.xml@ 18aa9339

<?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 xcb-util-download-http "https://xcb.freedesktop.org/dist/xcb-util-&xcb-util-version;.tar.xz">
  <!ENTITY xcb-util-download-ftp  " ">
  <!ENTITY xcb-util-md5sum        "34d749eab0fd0ffd519ac64798d79847">
  <!ENTITY xcb-util-size          "261 KB">
  <!ENTITY xcb-util-buildsize     "2.6 MB">
  <!ENTITY xcb-util-time          "less than 0.1 SBU">
]>

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


  <title>xcb-util-&xcb-util-version;</title>

  <indexterm zone="xcb-util">
    <primary sortas="a-xcb-util">xcb-util</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to xcb-util</title>

    <para>
      The <application>xcb-util</application> package provides additional
      extensions to the <application>XCB</application> library, many that were
      previously found in <application>Xlib</application>, but are not part of
      core X protocol.
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect3">xcb-util Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libxcb"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for documentation)
    </para>

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

  <sect2 role="installation">
    <title>Installation of xcb-util</title>

    <para>
      Install <application>xcb-util</application> by running the following
      commands:
    </para>

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

    <para>
      This package does not come with a test suite.
    </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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libxcb-util.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libxcb-util">
        <term><filename class="libraryfile">libxcb-util.so</filename></term>
        <listitem>
          <para>
            Provides utility functions for other XCB utilities
          </para>
          <indexterm zone="xcb-util libxcb-util">
            <primary sortas="c-libxcb-util">libxcb-util.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>