source: general/genlib/libgusb.xml@ 50ab38f

trunk
Last change on this file since 50ab38f was 50ab38f, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Update packages
Update to xfsprogs-5.12.0.
Update to libgusb-0.3.7.
Update to inkscape-1.1.

  • Property mode set to 100644
File size: 5.1 KB
Line 
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
7 <!ENTITY libgusb-download-http "https://github.com/hughsie/libgusb/archive/&libgusb-version;/libgusb-&libgusb-version;.tar.gz">
8 <!ENTITY libgusb-download-ftp " ">
9 <!ENTITY libgusb-md5sum "b980fe26244b108db6692b00865af1b4">
10 <!ENTITY libgusb-size "52 KB">
11 <!ENTITY libgusb-buildsize "1.9 MB (with tests)">
12 <!ENTITY libgusb-time "less than 0.1 SBU (with tests)">
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
38 &lfs101_checked;
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">
78 <xref linkend="libusb"/>
79 </para>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="gtk-doc"/>,
84 <xref linkend="gobject-introspection"/>,
85 <xref linkend="usbutils"/> (for <filename>usb.ids</filename> data file,
86 which is also required for the tests), and
87 <xref linkend="vala"/>
88 </para>
89
90 <para condition="html" role="usernotes">
91 User Notes: <ulink url="&blfs-wiki;/libgusb"/>
92 </para>
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 &amp;&amp;
104cd build &amp;&amp;
105
106meson --prefix=/usr -Ddocs=false .. &amp;&amp;
107ninja</userinput></screen>
108
109 <para>
110 To test the results, issue: <command>ninja test</command>.
111 </para>
112
113 <para>
114 Now, as the <systemitem class="username">root</systemitem> user:
115 </para>
116
117<screen role="root"><userinput>ninja install</userinput></screen>
118 </sect2>
119
120 <sect2 role="commands">
121 <title>Command Explanations</title>
122
123 <para>
124 <option>-Ddocs=true</option>: Use this option if
125 <application>GTK-Doc</application> is installed and you wish to install
126 the documentation.
127 </para>
128
129 </sect2>
130
131 <sect2 role="content">
132 <title>Contents</title>
133
134 <segmentedlist>
135 <segtitle>Installed Programs</segtitle>
136 <segtitle>Installed Library</segtitle>
137 <segtitle>Installed Directories</segtitle>
138
139 <seglistitem>
140 <seg>
141 gusbcmd
142 </seg>
143 <seg>
144 libgusb.so
145 </seg>
146 <seg>
147 /usr/include/gusb-1 and
148 /usr/share/gtk-doc/html/gusb (if gtk-doc is used)
149 </seg>
150 </seglistitem>
151 </segmentedlist>
152
153 <variablelist>
154 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
155 <?dbfo list-presentation="list"?>
156 <?dbhtml list-presentation="table"?>
157
158 <varlistentry id="gusbcmd">
159 <term><command>gusbcmd</command></term>
160 <listitem>
161 <para>
162 is a debugging tool for the libgusb library
163 </para>
164 <indexterm zone="libgusb gusbcmd">
165 <primary sortas="b-gusbcmd">gusbcmd</primary>
166 </indexterm>
167 </listitem>
168 </varlistentry>
169
170 <varlistentry id="libgusb-lib">
171 <term><filename class="libraryfile">libgusb.so</filename></term>
172 <listitem>
173 <para>
174 contains the <application>libgusb</application> API functions
175 </para>
176 <indexterm zone="libgusb libgusb-lib">
177 <primary sortas="c-libgusb">libgusb.so</primary>
178 </indexterm>
179 </listitem>
180 </varlistentry>
181
182 </variablelist>
183
184 </sect2>
185
186</sect1>
Note: See TracBrowser for help on using the repository browser.