source: x/installing/libxcb.xml@ 24e5f9d

<?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 libxcb-download-http "https://xcb.freedesktop.org/dist/libxcb-&libxcb-version;.tar.bz2">
  <!ENTITY libxcb-download-ftp  " ">
  <!ENTITY libxcb-md5sum        "28e552bd78bc1050b6b26ca1db0e5bb6">
  <!ENTITY libxcb-size          "600 KB">
  <!ENTITY libxcb-buildsize     "28 MB (with tests, add 62 MB for doxygen docs)">
  <!ENTITY libxcb-time          "0.3 SBU (with tests, add 1.4 SBU for doxygen docs)">
]>

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

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

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

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

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

    <para>The <application>libxcb</application> package provides an interface
    to the X Window System protocol, which replaces the current Xlib interface.
    Xlib can also use XCB as a transport layer, allowing software to make
    requests and receive responses with both.</para>

    &lfs81_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch (for Python 3): <ulink
          url="&patch-root;/libxcb-&libxcb-version;-python3-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libxcb Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libXdmcp"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (to generate API documentation) and
      <xref linkend="libxslt"/>
    </para>

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

  </sect2>

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

    <para>
      If building with Python 3, issue the following command:
    </para>

<screen><userinput>patch -Np1 -i ../libxcb-&libxcb-version;-python3-1.patch</userinput></screen>

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

<screen><userinput>sed -i "s/pthread-stubs//" configure &amp;&amp;

./configure $XORG_CONFIG      \
            --enable-xinput   \
            --without-doxygen \
            --docdir='${datadir}'/doc/libxcb-&libxcb-version; &amp;&amp;
make</userinput></screen>

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

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed "s/pthread-stubs//" -i configure</command>: This
    sed removes dependency on libpthread-stubs package which is useless on
    Linux.</para>

    <para><parameter>--enable-xinput</parameter>: This switch enables XCB Xinput
    extension.</para>

    <para><parameter>--without-doxygen</parameter>: Do not use doxygen to
    generate API documentation (default: auto). Without it, if
    <xref linkend="doxygen"/> is installed, the API documentation will be
    generated and installed.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libxcb.so, libxcb-composite.so, libxcb-damage.so, libxcb-dpms.so,
          libxcb-dri2.so, libxcb-dri3.so, libxcb-glx.so, libxcb-present.so,
          libxcb-randr.so, libxcb-record.so, libxcb-render.so, libxcb-res.so,
          libxcb-screensaver.so, libxcb-shape.so, libxcb-shm.so, libxcb-sync.so,
          libxcb-xevie.so, libxcb-xf86dri.so, libxcb-xfixes.so,
          libxcb-xinerama.so, libxcb-xinput.so, libxcb-xkb.so,
          libxcb-xprint.so, libxcb-xtest.so, libxcb-xvmc.so, and libxcb-xv.so
        </seg>
        <seg>
          <envar>$XORG_PREFIX</envar>/include/xcb and
          <envar>$XORG_PREFIX</envar>/share/doc/libxcb-&libxcb-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libxcb-lib">
        <term><filename class="libraryfile">libxcb.so</filename></term>
        <listitem>
          <para>is an interface to the X Window System protocol.</para>
          <indexterm zone="libxcb libxcb-lib">
            <primary sortas="c-libxcb">libxcb.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>