source: general/genlib/libgusb.xml@ 9029db2

10.1 11.0 qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 9029db2 was 9029db2, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

Tag most of General Libraries and dependencies

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24241 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • 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://people.freedesktop.org/~hughsient/releases/libgusb-&libgusb-version;.tar.xz">
8 <!ENTITY libgusb-download-ftp " ">
9 <!ENTITY libgusb-md5sum "61022fb9abf16804ed3541a67af7d695">
10 <!ENTITY libgusb-size "44 KB">
11 <!ENTITY libgusb-buildsize "2.3 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 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>libgusb-&libgusb-version;</title>
24
25 <indexterm zone="libgusb">
26 <primary sortas="a-libgusb">libgusb</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to libgusb</title>
31
32 <para>
33 The <application>libgusb</application> package contains the GObject
34 wrappers for <application>libusb-1.0</application> that makes it
35 easy to do asynchronous control, bulk and interrupt transfers with
36 proper cancellation and integration into a mainloop.
37 </para>
38
39 &lfs101_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&libgusb-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&libgusb-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &libgusb-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &libgusb-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &libgusb-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &libgusb-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">libgusb Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="libusb"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="gtk-doc"/>,
85 <xref linkend="gobject-introspection"/>,
86 <xref linkend="usbutils"/> (for <filename>usb.ids</filename> data file,
87 which is also required for the tests), and
88 <xref linkend="vala"/>
89 </para>
90
91 <para condition="html" role="usernotes">
92 User Notes: <ulink url="&blfs-wiki;/libgusb"/>
93 </para>
94 </sect2>
95
96 <sect2 role="installation">
97 <title>Installation of libgusb</title>
98
99 <para>
100 Install <application>libgusb</application> by running the following
101 commands:
102 </para>
103
104 <screen><userinput>mkdir build &amp;&amp;
105cd build &amp;&amp;
106
107meson --prefix=/usr -Ddocs=false .. &amp;&amp;
108ninja</userinput></screen>
109
110 <para>
111 To test the results, issue: <command>ninja test</command>.
112 </para>
113
114 <para>
115 Now, as the <systemitem class="username">root</systemitem> user:
116 </para>
117
118<screen role="root"><userinput>ninja install</userinput></screen>
119 </sect2>
120
121 <sect2 role="commands">
122 <title>Command Explanations</title>
123
124 <para>
125 <option>-Ddocs=true</option>: Use this option if
126 <application>GTK-Doc</application> is installed and you wish to install
127 the documentation.
128 </para>
129
130 </sect2>
131
132 <sect2 role="content">
133 <title>Contents</title>
134
135 <segmentedlist>
136 <segtitle>Installed Programs</segtitle>
137 <segtitle>Installed Library</segtitle>
138 <segtitle>Installed Directories</segtitle>
139
140 <seglistitem>
141 <seg>
142 gusbcmd
143 </seg>
144 <seg>
145 libgusb.so
146 </seg>
147 <seg>
148 /usr/include/gusb-1 and
149 /usr/share/gtk-doc/html/gusb (if gtk-doc is used)
150 </seg>
151 </seglistitem>
152 </segmentedlist>
153
154 <variablelist>
155 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
156 <?dbfo list-presentation="list"?>
157 <?dbhtml list-presentation="table"?>
158
159 <varlistentry id="gusbcmd">
160 <term><command>gusbcmd</command></term>
161 <listitem>
162 <para>
163 is a debugging tool for the libgusb library
164 </para>
165 <indexterm zone="libgusb gusbcmd">
166 <primary sortas="b-gusbcmd">gusbcmd</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry id="libgusb-lib">
172 <term><filename class="libraryfile">libgusb.so</filename></term>
173 <listitem>
174 <para>
175 contains the <application>libgusb</application> API functions
176 </para>
177 <indexterm zone="libgusb libgusb-lib">
178 <primary sortas="c-libgusb">libgusb.so</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 </variablelist>
184
185 </sect2>
186
187</sect1>
Note: See TracBrowser for help on using the repository browser.