source: x/installing/xorgproto.xml@ 3354477

<?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 xorgproto-download-http "https://xorg.freedesktop.org/archive/individual/proto/xorgproto-&xorgproto-version;.tar.bz2">
  <!ENTITY xorgproto-download-ftp  " ">
  <!ENTITY xorgproto-md5sum        "c29f4fa78f53b52b3efdc71ebd9506b6">
  <!ENTITY xorgproto-size          "832 KB">
  <!ENTITY xorgproto-buildsize     "8.2 MB">
  <!ENTITY xorgproto-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy: bdubbs $</othername>
    <date>$Date: 2018-02-18 22:04:14 +0100 (dim. 18 févr. 2018) $</date>
  </sect1info>

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

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

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

    <para>
      The <application>xorgproto</application> package provides the
      header files required to build the X Window system, and to allow other
      applications to build against the installed X Window system.
    </para>

    &lfs91_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="util-macros"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="fop"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="xmlto"/> and
      <xref linkend="asciidoc"/> (to build additional documentation)
    </para>

    <note>
      <para>
        There is a reciprocal dependency with <xref linkend="fop"/>. If
        you wish to build the documentation, you'll need to re-install the
        Protocol Headers after the installation is complete and
        <xref linkend="fop"/> has been installed.
      </para>
    </note>

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

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=$XORG_PREFIX .. &amp;&amp;
ninja</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>ninja install &amp;&amp;

install -vdm 755 $XORG_PREFIX/share/doc/xorgproto-&xorgproto-version; &amp;&amp;
install -vm 644 ../[^m]*.txt ../PM_spec $XORG_PREFIX/share/doc/xorgproto-&xorgproto-version;</userinput></screen>

  </sect2>

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

    <para>
      <command>install -vm 644 ../[^m]*.txt ../PM_spec ...</command>: The meson
      build system does not install the text files into <filename
      class="directory">/usr/share/doc</filename>. The <command>[^m]</command>
      part prevents copying the <filename>meson_options.txt</filename> file.
    </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>None</seg>
        <seg>
          <envar>$XORG_PREFIX</envar>/include/GL,
          <envar>$XORG_PREFIX</envar>/include/X11, and
          <envar>$XORG_PREFIX</envar>/share/doc/xorgproto-&xorgproto-version;
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>