[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 |
|
---|
[bf565e06] | 7 | <!ENTITY libgusb-download-http "https://github.com/hughsie/libgusb/releases/download/&libgusb-version;/libgusb-&libgusb-version;.tar.xz">
|
---|
[d6da5da] | 8 | <!ENTITY libgusb-download-ftp " ">
|
---|
[bf565e06] | 9 | <!ENTITY libgusb-md5sum "9d7c0ee15b25809a2b0213246a5d4944">
|
---|
| 10 | <!ENTITY libgusb-size "47 KB">
|
---|
| 11 | <!ENTITY libgusb-buildsize "2.4 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 |
|
---|
| 19 | <title>libgusb-&libgusb-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libgusb">
|
---|
| 22 | <primary sortas="a-libgusb">libgusb</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libgusb</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>libgusb</application> package contains the GObject
|
---|
| 30 | wrappers for <application>libusb-1.0</application> that makes it
|
---|
| 31 | easy to do asynchronous control, bulk and interrupt transfers with
|
---|
| 32 | proper cancellation and integration into a mainloop.
|
---|
| 33 | </para>
|
---|
| 34 |
|
---|
[0ddf4e7] | 35 | &lfs112_checked;
|
---|
[d6da5da] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&libgusb-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&libgusb-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &libgusb-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &libgusb-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &libgusb-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &libgusb-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">libgusb Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
[3c3e0ffb] | 75 | <xref linkend="json-glib"/> and
|
---|
[c9350821] | 76 | <xref linkend="libusb"/>
|
---|
[d6da5da] | 77 | </para>
|
---|
| 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 80 | <para role="recommended">
|
---|
[bf565e06] | 81 | <xref linkend="gobject-introspection"/>,
|
---|
[b1092d9] | 82 | <xref linkend="usbutils"/> (for <filename>usb.ids</filename> data file,
|
---|
| 83 | which is also required for the tests), and
|
---|
[d6da5da] | 84 | <xref linkend="vala"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
[bf565e06] | 87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
[f56d2e7] | 89 | <xref linkend="gi-docgen"/>
|
---|
[bf565e06] | 90 | </para>
|
---|
| 91 |
|
---|
[d6da5da] | 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>
|
---|
[bf565e06] | 129 | <parameter>-Ddocs=false</parameter>: building documentation needs
|
---|
[f56d2e7] | 130 | <xref linkend="gi-docgen"/>. Remove this switch if you have
|
---|
[bf565e06] | 131 | installed <application>gi-docgen</application>, and you wish to build
|
---|
| 132 | the API documentation.
|
---|
[f10c2880] | 133 | </para>
|
---|
[d6da5da] | 134 |
|
---|
| 135 | </sect2>
|
---|
[f10c2880] | 136 |
|
---|
[d6da5da] | 137 | <sect2 role="content">
|
---|
| 138 | <title>Contents</title>
|
---|
| 139 |
|
---|
| 140 | <segmentedlist>
|
---|
| 141 | <segtitle>Installed Programs</segtitle>
|
---|
| 142 | <segtitle>Installed Library</segtitle>
|
---|
| 143 | <segtitle>Installed Directories</segtitle>
|
---|
| 144 |
|
---|
| 145 | <seglistitem>
|
---|
| 146 | <seg>
|
---|
[e58667e] | 147 | gusbcmd
|
---|
[d6da5da] | 148 | </seg>
|
---|
| 149 | <seg>
|
---|
| 150 | libgusb.so
|
---|
| 151 | </seg>
|
---|
| 152 | <seg>
|
---|
| 153 | /usr/include/gusb-1 and
|
---|
[f10c2880] | 154 | /usr/share/gtk-doc/html/gusb (if gtk-doc is used)
|
---|
[d6da5da] | 155 | </seg>
|
---|
| 156 | </seglistitem>
|
---|
| 157 | </segmentedlist>
|
---|
| 158 |
|
---|
| 159 | <variablelist>
|
---|
| 160 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 161 | <?dbfo list-presentation="list"?>
|
---|
| 162 | <?dbhtml list-presentation="table"?>
|
---|
| 163 |
|
---|
[e58667e] | 164 | <varlistentry id="gusbcmd">
|
---|
| 165 | <term><command>gusbcmd</command></term>
|
---|
| 166 | <listitem>
|
---|
| 167 | <para>
|
---|
[4c24eb0a] | 168 | is a debugging tool for the libgusb library
|
---|
[e58667e] | 169 | </para>
|
---|
| 170 | <indexterm zone="libgusb gusbcmd">
|
---|
| 171 | <primary sortas="b-gusbcmd">gusbcmd</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
| 175 |
|
---|
[d6da5da] | 176 | <varlistentry id="libgusb-lib">
|
---|
| 177 | <term><filename class="libraryfile">libgusb.so</filename></term>
|
---|
| 178 | <listitem>
|
---|
| 179 | <para>
|
---|
[4c24eb0a] | 180 | contains the <application>libgusb</application> API functions
|
---|
[d6da5da] | 181 | </para>
|
---|
| 182 | <indexterm zone="libgusb libgusb-lib">
|
---|
| 183 | <primary sortas="c-libgusb">libgusb.so</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | </variablelist>
|
---|
| 189 |
|
---|
| 190 | </sect2>
|
---|
| 191 |
|
---|
| 192 | </sect1>
|
---|