1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 |
|
---|
7 | <!ENTITY libgusb-download-http "https://github.com/hughsie/libgusb/releases/download/&libgusb-version;/libgusb-&libgusb-version;.tar.xz">
|
---|
8 | <!ENTITY libgusb-download-ftp " ">
|
---|
9 | <!ENTITY libgusb-md5sum "354a3227334991ea4e924843c144bd82">
|
---|
10 | <!ENTITY libgusb-size "52 KB">
|
---|
11 | <!ENTITY libgusb-buildsize "5.0 MB (with tests and docs)">
|
---|
12 | <!ENTITY libgusb-time "0.1 SBU (with tests and docs)">
|
---|
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 |
|
---|
35 | &lfs122_checked;
|
---|
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">
|
---|
75 | <xref linkend="json-glib"/> and
|
---|
76 | <xref linkend="libusb"/>
|
---|
77 | </para>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
80 | <para role="recommended">
|
---|
81 | &gobject-introspection;,
|
---|
82 | <xref linkend="hwdata"/> (for <filename>usb.ids</filename> data file,
|
---|
83 | which is also required for the tests), and
|
---|
84 | <xref linkend="vala"/>
|
---|
85 | </para>
|
---|
86 |
|
---|
87 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
88 | <para role="optional">
|
---|
89 | <xref linkend="gi-docgen"/> and
|
---|
90 | <xref linkend="umockdev"/> (for full test coverage)
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | </sect2>
|
---|
94 |
|
---|
95 | <sect2 role="installation">
|
---|
96 | <title>Installation of libgusb</title>
|
---|
97 |
|
---|
98 | <para>
|
---|
99 | Install <application>libgusb</application> by running the following
|
---|
100 | commands:
|
---|
101 | </para>
|
---|
102 |
|
---|
103 | <screen><userinput>mkdir build &&
|
---|
104 | cd build &&
|
---|
105 |
|
---|
106 | meson setup .. \
|
---|
107 | --prefix=/usr \
|
---|
108 | --buildtype=release \
|
---|
109 | -D docs=false &&
|
---|
110 | ninja</userinput></screen>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
114 | the API documentation for this package, issue:
|
---|
115 | </para>
|
---|
116 |
|
---|
117 | <screen role='nodump'><userinput>sed -E "/output|install_dir/s/('libgusb)'/\1-&libgusb-version;'/" \
|
---|
118 | -i ../docs/meson.build &&
|
---|
119 | meson configure -D docs=true &&
|
---|
120 | ninja</userinput></screen>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | To test the results, issue: <command>ninja test</command>.
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <para>
|
---|
127 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
131 | </sect2>
|
---|
132 |
|
---|
133 | <sect2 role="commands">
|
---|
134 | <title>Command Explanations</title>
|
---|
135 |
|
---|
136 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
137 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | <parameter>-D docs=false</parameter>: &gi-doc-disable;
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="content">
|
---|
146 | <title>Contents</title>
|
---|
147 |
|
---|
148 | <segmentedlist>
|
---|
149 | <segtitle>Installed Programs</segtitle>
|
---|
150 | <segtitle>Installed Library</segtitle>
|
---|
151 | <segtitle>Installed Directories</segtitle>
|
---|
152 |
|
---|
153 | <seglistitem>
|
---|
154 | <seg>
|
---|
155 | gusbcmd
|
---|
156 | </seg>
|
---|
157 | <seg>
|
---|
158 | libgusb.so
|
---|
159 | </seg>
|
---|
160 | <seg>
|
---|
161 | /usr/include/gusb-1 and
|
---|
162 | /usr/share/doc/libgusb-&libgusb-version; (if gi-docgen is used)
|
---|
163 | </seg>
|
---|
164 | </seglistitem>
|
---|
165 | </segmentedlist>
|
---|
166 |
|
---|
167 | <variablelist>
|
---|
168 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
169 | <?dbfo list-presentation="list"?>
|
---|
170 | <?dbhtml list-presentation="table"?>
|
---|
171 |
|
---|
172 | <varlistentry id="gusbcmd">
|
---|
173 | <term><command>gusbcmd</command></term>
|
---|
174 | <listitem>
|
---|
175 | <para>
|
---|
176 | is a debugging tool for the libgusb library
|
---|
177 | </para>
|
---|
178 | <indexterm zone="libgusb gusbcmd">
|
---|
179 | <primary sortas="b-gusbcmd">gusbcmd</primary>
|
---|
180 | </indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="libgusb-lib">
|
---|
185 | <term><filename class="libraryfile">libgusb.so</filename></term>
|
---|
186 | <listitem>
|
---|
187 | <para>
|
---|
188 | contains the <application>libgusb</application> API functions
|
---|
189 | </para>
|
---|
190 | <indexterm zone="libgusb libgusb-lib">
|
---|
191 | <primary sortas="c-libgusb">libgusb.so</primary>
|
---|
192 | </indexterm>
|
---|
193 | </listitem>
|
---|
194 | </varlistentry>
|
---|
195 |
|
---|
196 | </variablelist>
|
---|
197 |
|
---|
198 | </sect2>
|
---|
199 |
|
---|
200 | </sect1>
|
---|