source: x/installing/xcb-proto.xml@ ba4e992

<?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-proto-download-http "https://xcb.freedesktop.org/dist/xcb-proto-&xcb-proto-version;.tar.bz2">
  <!ENTITY xcb-proto-download-ftp  " ">
  <!ENTITY xcb-proto-md5sum        "abe9aa4886138150bbc04ae4f29b90e3">
  <!ENTITY xcb-proto-size          "148 KB">
  <!ENTITY xcb-proto-buildsize     "2.2 MB">
  <!ENTITY xcb-proto-time          "less than 0.1 SBU">
]>

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

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

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

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

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

    <para>The <application>xcb-proto</application> package provides the
    XML-XCB protocol descriptions that <application>libxcb</application>
    uses to generate the majority of its code and API.</para>

    &lfs84_checked;

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

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="xorg-env"/> (should be set for the following instructions
      to work)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="python2"/> and
      <xref linkend="libxml2"/> (required to run the tests)
     </para>

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

  </sect2>

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

<!--
    <para>First, fix a file that allows the checks to run properly:</para>

<screen><userinput>patch -Np1 -i ../xcb-proto-&xcb-proto-version;-schema-1.patch</userinput></screen>

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

<screen><userinput>patch -Np1 -i ../xcb-proto-&xcb-proto-version;-python3-1.patch</userinput></screen>
-->
    <para>Install <application>xcb-proto</application> by running the following
    commands:</para>

<screen><userinput>./configure $XORG_CONFIG</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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>None</seg>
        <seg>None</seg>
        <seg><envar>$XORG_PREFIX</envar>/share/xcb and
             <envar>$XORG_PREFIX</envar>/lib/python&python2-majorver;/site-packages/xcbgen or
             <envar>$XORG_PREFIX</envar>/lib/python&python3-majorver;/site-packages/xcbgen</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>