source: general/genlib/libgusb.xml@ f10c288

10.0 10.1 11.0 11.1 11.2 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since f10c288 was f10c288, checked in by Ken Moffat <ken@…>, 5 years ago

For libgusb promote gtk-doc to recommended, but explain how to avoid it. By default the *install* will fail with FileNotFoundError: [Errno 2] No such file or directory: 'gtkdoc-scan'.

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

  • Property mode set to 100644
File size: 5.0 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 "3c178f1171f808785d6af971b1fdc50c">
10 <!ENTITY libgusb-size "40 KB">
11 <!ENTITY libgusb-buildsize "2.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 <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 &lfs82_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 &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=false</option>: Add this option if
126 <application>gtk-doc</application> has not been installed.
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.