source: general/genlib/libgusb.xml@ f10c288

<?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 libgusb-download-http "https://people.freedesktop.org/~hughsient/releases/libgusb-&libgusb-version;.tar.xz">
  <!ENTITY libgusb-download-ftp  " ">
  <!ENTITY libgusb-md5sum        "3c178f1171f808785d6af971b1fdc50c">
  <!ENTITY libgusb-size          "40 KB">
  <!ENTITY libgusb-buildsize     "2.9 MB (with tests)">
  <!ENTITY libgusb-time          "less than 0.1 SBU (with tests)">
]>

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

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

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

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

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

    <para>
      The <application>libgusb</application> package contains the GObject
      wrappers for <application>libusb-1.0</application> that makes it
      easy to do asynchronous control, bulk and interrupt transfers with
      proper cancellation and integration into a mainloop.
    </para>

    &lfs82_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libusb"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gtk-doc"/>
      <xref linkend="gobject-introspection"/>,
      <xref linkend="usbutils"/> (for <filename>usb.ids</filename> data file,
      which is also required for the tests), and
      <xref linkend="vala"/>
    </para>

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

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

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

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

meson --prefix=/usr &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>

    <para>
      <option>-Ddocs=false</option>: Add this option if
      <application>gtk-doc</application> has not been installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gusbcmd
        </seg>
        <seg>
          libgusb.so
        </seg>
        <seg>
          /usr/include/gusb-1 and
          /usr/share/gtk-doc/html/gusb (if gtk-doc is used)
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gusbcmd">
        <term><command>gusbcmd</command></term>
        <listitem>
          <para>
            is a debugging tool for the libgusb library.
          </para>
          <indexterm zone="libgusb gusbcmd">
            <primary sortas="b-gusbcmd">gusbcmd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgusb-lib">
        <term><filename class="libraryfile">libgusb.so</filename></term>
        <listitem>
          <para>
            contains the <application>libgusb</application> API functions.
          </para>
          <indexterm zone="libgusb libgusb-lib">
            <primary sortas="c-libgusb">libgusb.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>