source: general/genlib/libgudev.xml

<?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 libgudev-download-http
           "&gnome-download-http;/libgudev/&libgudev-version;/libgudev-&libgudev-version;.tar.xz">
  <!ENTITY libgudev-download-ftp  " ">
  <!ENTITY libgudev-md5sum        "46da30a1c69101c3a13fa660d9ab7b73">
  <!ENTITY libgudev-size          "32 KB">
  <!ENTITY libgudev-buildsize     "2.0 MB">
  <!ENTITY libgudev-time          "less than 0.1 SBU">
]>

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


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

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

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

    <para>
      The <application>libgudev</application> package contains
      GObject bindings for libudev.
    </para>

    &lfs121_checked;

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> (GObject Introspection required for GNOME)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <xref linkend="umockdev"/> (for testing)
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

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

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

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

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <option>-Dgtk_doc=true</option>: Use this option if GTK-Doc is installed
      and you wish to build and install the API documentation.
    </para>

    <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>-->

<!-- With meson, the tests will be disabled automatically without umockdev present.
    <para>
      <parameter>- -disable-umockdev</parameter>: Disables the usage of
      <xref role="nodep" linkend="umockdev"/>. Omit this switch if you
      wish to run the test suite.
    </para>
-->
  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgudev-1.0.so
        </seg>
        <seg>
          /usr/include/gudev-1.0 and
          /usr/share/gtk-doc/html/gudev
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgudev-1.0">
        <term><filename class="libraryfile">libgudev-1.0.so</filename></term>
        <listitem>
          <para>
            is a GObject-based wrapper library for libudev
          </para>
          <indexterm zone="libgudev libgudev-1.0">
            <primary sortas="c-libgudev-1.0">libgudev-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>