source: x/installing/libxcb.xml@ 78906650

<?xml version="1.0" encoding="UTF-8"?>
<!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://xorg.freedesktop.org/archive/individual/lib/libxcb-&libxcb-version;.tar.xz">
  <!ENTITY libxcb-download-ftp  " ">
  <!ENTITY libxcb-md5sum        "c769f93c254263077df62404661b710d">
  <!ENTITY libxcb-size          "444 KB">
  <!ENTITY libxcb-buildsize     "27 MB (with tests, add 62 MB for doxygen docs)">
  <!ENTITY libxcb-time          "0.2 SBU (with tests, add 1.4 SBU for doxygen docs)">
]>

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


  <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>

    &lfs121_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">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>

  </sect2>

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

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

<screen><userinput>./configure $XORG_CONFIG      \
            --without-doxygen \
            --docdir='${datadir}'/doc/libxcb-&libxcb-version; &amp;&amp;
LC_ALL=en_US.UTF-8 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>

    <para>
      If the package was built as a non-&root; user, the installed
      documentation is now owned by this user.  As the &root; user,
      fix the ownership:
    </para>

<screen role="root"><userinput>chown -Rv root:root $XORG_PREFIX/share/doc/libxcb-&libxcb-version;</userinput></screen>

  </sect2>

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

    <!-- https://gitlab.freedesktop.org/xorg/lib/libxcb/-/issues/72 -->
    <para>
      <envar>LC_ALL=en_US.UTF-8</envar>: Some Python 3 script in the
      building system of this package may fail with certain system
      locale settings.  This environment variable forces a locale setting
      known to work.
    </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-xf86dri.so, libxcb-xfixes.so,
          libxcb-xinerama.so, libxcb-xinput.so, libxcb-xkb.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>