[d6da5da] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[00cb5039] | 7 | <!ENTITY libgusb-download-http "https://people.freedesktop.org/~hughsient/releases/libgusb-&libgusb-version;.tar.xz">
|
---|
[d6da5da] | 8 | <!ENTITY libgusb-download-ftp " ">
|
---|
[16c3f25] | 9 | <!ENTITY libgusb-md5sum "32367173c06f1837e9cb943e778764cd">
|
---|
| 10 | <!ENTITY libgusb-size "48 KB">
|
---|
[7bec8adf] | 11 | <!ENTITY libgusb-buildsize "2.0 MB (with tests)">
|
---|
[e20b59be] | 12 | <!ENTITY libgusb-time "less than 0.1 SBU (with tests)">
|
---|
[d6da5da] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libgusb" xreflabel="libgusb-&libgusb-version;">
|
---|
| 16 | <?dbhtml filename="libgusb.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>libgusb-&libgusb-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="libgusb">
|
---|
| 25 | <primary sortas="a-libgusb">libgusb</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to libgusb</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | The <application>libgusb</application> package contains the GObject
|
---|
| 33 | wrappers for <application>libusb-1.0</application> that makes it
|
---|
| 34 | easy to do asynchronous control, bulk and interrupt transfers with
|
---|
| 35 | proper cancellation and integration into a mainloop.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[0ddf4e7] | 38 | &lfs112_checked;
|
---|
[d6da5da] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&libgusb-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&libgusb-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &libgusb-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &libgusb-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &libgusb-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &libgusb-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">libgusb Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[3c3e0ffb] | 78 | <xref linkend="json-glib"/> and
|
---|
[c9350821] | 79 | <xref linkend="libusb"/>
|
---|
[d6da5da] | 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 83 | <para role="recommended">
|
---|
[3c3e0ffb] | 84 | <!-- broken, needs gtkdoc-scan which is not in recent versions
|
---|
[978cd74] | 85 | <xref linkend="gtk-doc"/>,
|
---|
[3c3e0ffb] | 86 | --> <xref linkend="gobject-introspection"/>,
|
---|
[b1092d9] | 87 | <xref linkend="usbutils"/> (for <filename>usb.ids</filename> data file,
|
---|
| 88 | which is also required for the tests), and
|
---|
[d6da5da] | 89 | <xref linkend="vala"/>
|
---|
| 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <para condition="html" role="usernotes">
|
---|
| 93 | User Notes: <ulink url="&blfs-wiki;/libgusb"/>
|
---|
| 94 | </para>
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of libgusb</title>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | Install <application>libgusb</application> by running the following
|
---|
| 102 | commands:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
[345c66e] | 105 | <screen><userinput>mkdir build &&
|
---|
[eb656edc] | 106 | cd build &&
|
---|
[345c66e] | 107 |
|
---|
[20f070d8] | 108 | meson --prefix=/usr --buildtype=release -Ddocs=false .. &&
|
---|
[345c66e] | 109 | ninja</userinput></screen>
|
---|
[d6da5da] | 110 |
|
---|
| 111 | <para>
|
---|
[345c66e] | 112 | To test the results, issue: <command>ninja test</command>.
|
---|
[d6da5da] | 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <para>
|
---|
| 116 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
[345c66e] | 119 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[d6da5da] | 120 | </sect2>
|
---|
[f10c2880] | 121 |
|
---|
[d6da5da] | 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
| 124 |
|
---|
[20f070d8] | 125 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 126 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 127 |
|
---|
[f10c2880] | 128 | <para>
|
---|
[3c3e0ffb] | 129 | <parameter>-Ddocs=false</parameter>: building documentation needs an old
|
---|
| 130 | version of <application>GTK-Doc</application>, so it has to be disabled.
|
---|
[f10c2880] | 131 | </para>
|
---|
[d6da5da] | 132 |
|
---|
| 133 | </sect2>
|
---|
[f10c2880] | 134 |
|
---|
[d6da5da] | 135 | <sect2 role="content">
|
---|
| 136 | <title>Contents</title>
|
---|
| 137 |
|
---|
| 138 | <segmentedlist>
|
---|
| 139 | <segtitle>Installed Programs</segtitle>
|
---|
| 140 | <segtitle>Installed Library</segtitle>
|
---|
| 141 | <segtitle>Installed Directories</segtitle>
|
---|
| 142 |
|
---|
| 143 | <seglistitem>
|
---|
| 144 | <seg>
|
---|
[e58667e] | 145 | gusbcmd
|
---|
[d6da5da] | 146 | </seg>
|
---|
| 147 | <seg>
|
---|
| 148 | libgusb.so
|
---|
| 149 | </seg>
|
---|
| 150 | <seg>
|
---|
| 151 | /usr/include/gusb-1 and
|
---|
[f10c2880] | 152 | /usr/share/gtk-doc/html/gusb (if gtk-doc is used)
|
---|
[d6da5da] | 153 | </seg>
|
---|
| 154 | </seglistitem>
|
---|
| 155 | </segmentedlist>
|
---|
| 156 |
|
---|
| 157 | <variablelist>
|
---|
| 158 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 159 | <?dbfo list-presentation="list"?>
|
---|
| 160 | <?dbhtml list-presentation="table"?>
|
---|
| 161 |
|
---|
[e58667e] | 162 | <varlistentry id="gusbcmd">
|
---|
| 163 | <term><command>gusbcmd</command></term>
|
---|
| 164 | <listitem>
|
---|
| 165 | <para>
|
---|
[4c24eb0a] | 166 | is a debugging tool for the libgusb library
|
---|
[e58667e] | 167 | </para>
|
---|
| 168 | <indexterm zone="libgusb gusbcmd">
|
---|
| 169 | <primary sortas="b-gusbcmd">gusbcmd</primary>
|
---|
| 170 | </indexterm>
|
---|
| 171 | </listitem>
|
---|
| 172 | </varlistentry>
|
---|
| 173 |
|
---|
[d6da5da] | 174 | <varlistentry id="libgusb-lib">
|
---|
| 175 | <term><filename class="libraryfile">libgusb.so</filename></term>
|
---|
| 176 | <listitem>
|
---|
| 177 | <para>
|
---|
[4c24eb0a] | 178 | contains the <application>libgusb</application> API functions
|
---|
[d6da5da] | 179 | </para>
|
---|
| 180 | <indexterm zone="libgusb libgusb-lib">
|
---|
| 181 | <primary sortas="c-libgusb">libgusb.so</primary>
|
---|
| 182 | </indexterm>
|
---|
| 183 | </listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | </variablelist>
|
---|
| 187 |
|
---|
| 188 | </sect2>
|
---|
| 189 |
|
---|
| 190 | </sect1>
|
---|