1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY libusb-download-http "http://prdownloads.sourceforge.net/libusb/libusb-&libusb-version;.tar.gz">
|
---|
8 | <!ENTITY libusb-download-ftp " ">
|
---|
9 | <!ENTITY libusb-md5sum "c6062b29acd2cef414bcc34e0decbdd1">
|
---|
10 | <!ENTITY libusb-size "375 KB">
|
---|
11 | <!ENTITY libusb-buildsize "7.4 MB (additional 1.3 MB to install documentation)">
|
---|
12 | <!ENTITY libusb-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libusb" xreflabel="libusb-&libusb-version;">
|
---|
16 | <?dbhtml filename="libusb.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Libusb-&libusb-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="libusb">
|
---|
26 | <primary sortas="a-Libusb">Libusb</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Libusb</title>
|
---|
31 |
|
---|
32 | <para>The <application>libusb</application> package contains a library
|
---|
33 | used by some applications for USB device access.</para>
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>Download (HTTP): <ulink url="&libusb-download-http;"/></para>
|
---|
39 | </listitem>
|
---|
40 | <listitem>
|
---|
41 | <para>Download (FTP): <ulink url="&libusb-download-ftp;"/></para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>Download MD5 sum: &libusb-md5sum;</para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>Download size: &libusb-size;</para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>Estimated disk space required: &libusb-buildsize;</para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>Estimated build time: &libusb-time;</para>
|
---|
54 | </listitem>
|
---|
55 | </itemizedlist>
|
---|
56 |
|
---|
57 | <bridgehead renderas="sect3">Libusb Dependencies</bridgehead>
|
---|
58 |
|
---|
59 | <bridgehead renderas="sect4">Optional (Required to Build the HTML User
|
---|
60 | Manual)</bridgehead>
|
---|
61 | <para><xref linkend="openjade"/> and
|
---|
62 | <ulink url="http://www.docbook.org/sgml/4.2/index.html"> DocBOOK SGML
|
---|
63 | DTD-4.2</ulink></para>
|
---|
64 |
|
---|
65 | <bridgehead renderas="sect4">Optional (Required to Build the API
|
---|
66 | Documentation)</bridgehead>
|
---|
67 | <para><xref linkend="doxygen"/> and
|
---|
68 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
69 |
|
---|
70 | </sect2>
|
---|
71 |
|
---|
72 | <sect2 role="installation">
|
---|
73 | <title>Installation of Libusb</title>
|
---|
74 |
|
---|
75 | <para>Install <application>libusb</application> by running the following
|
---|
76 | commands:</para>
|
---|
77 |
|
---|
78 | <screen><userinput>./configure --prefix=/usr --disable-build-docs &&
|
---|
79 | make</userinput></screen>
|
---|
80 |
|
---|
81 | <para>If you wish to build the API documentation, issue
|
---|
82 | the following command:</para>
|
---|
83 |
|
---|
84 | <screen><userinput>make apidox</userinput></screen>
|
---|
85 |
|
---|
86 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
87 |
|
---|
88 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
89 |
|
---|
90 | <para>If you built the HTML user manual, install it using the following commands
|
---|
91 | as the <systemitem class="username">root</systemitem> user:</para>
|
---|
92 |
|
---|
93 | <screen role="root"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/html &&
|
---|
94 | install -v -m644 doc/html/* /usr/share/doc/libusb-&libusb-version;/html</userinput></screen>
|
---|
95 |
|
---|
96 | <para>If you built the API documentation, install it using the following commands
|
---|
97 | as the <systemitem class="username">root</systemitem> user:</para>
|
---|
98 |
|
---|
99 | <screen role="root"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &&
|
---|
100 | install -v -m644 apidocs/html/* \
|
---|
101 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
102 |
|
---|
103 | </sect2>
|
---|
104 |
|
---|
105 | <sect2 role="commands">
|
---|
106 | <title>Command Explanations</title>
|
---|
107 |
|
---|
108 | <para><parameter>--disable-build-docs</parameter>: This switch avoids building the
|
---|
109 | HTML user manual.</para>
|
---|
110 |
|
---|
111 | <!-- Disabling obsolete text
|
---|
112 |
|
---|
113 | If you wish to build the user manual, you
|
---|
114 | may need to remove the <application>OpenSP</application> catalog definitions
|
---|
115 | from the system SGML catalogs. Use the following command
|
---|
116 | before building the package to accomplish this:</para>
|
---|
117 |
|
---|
118 | <screen role='root'><userinput>sed -i.orig \
|
---|
119 | -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
120 | /etc/sgml/catalog \
|
---|
121 | /etc/sgml/sgml-docbook.cat</userinput></screen>
|
---|
122 |
|
---|
123 | -->
|
---|
124 |
|
---|
125 | </sect2>
|
---|
126 |
|
---|
127 | <sect2 role="configuration">
|
---|
128 | <title>Configuring Libusb</title>
|
---|
129 |
|
---|
130 | <para><application>libusb</application> requires the
|
---|
131 | <systemitem class="filesystem">usbfs</systemitem> kernel filesystem
|
---|
132 | to be mounted on <filename class="directory">/proc/bus/usb</filename>.
|
---|
133 | Applications require the files in this directory to be accessible to the user,
|
---|
134 | sometimes for both reading and writing. To restrict access to USB devices,
|
---|
135 | ensure the <systemitem class="filesystem">usb</systemitem> group exits
|
---|
136 | on your system. If necessary, create the <systemitem
|
---|
137 | class="filesystem">usb</systemitem> group using the following command:</para>
|
---|
138 |
|
---|
139 | <screen role='root'><userinput>groupadd -g 14 usb</userinput></screen>
|
---|
140 |
|
---|
141 | <para id="libusb-kernel">Ensure that you have compiled the <quote>USB device
|
---|
142 | filesystem</quote> directly into the kernel or compiled it as a module
|
---|
143 | (listing the resulting <quote>usbcore</quote> module in the
|
---|
144 | <filename>/etc/sysconfig/modules</filename> file). You should also have an
|
---|
145 | entry similar to the line below in your <filename>/etc/fstab</filename>
|
---|
146 | file:</para>
|
---|
147 |
|
---|
148 | <indexterm zone="libusb libusb-kernel">
|
---|
149 | <primary sortas="d-USB-device-filesystem">USB device filesystem</primary>
|
---|
150 | </indexterm>
|
---|
151 |
|
---|
152 | <screen><literal>usbfs /proc/bus/usb usbfs devgid=14,devmode=0660 0 0</literal></screen>
|
---|
153 |
|
---|
154 | </sect2>
|
---|
155 |
|
---|
156 | <sect2 role="content">
|
---|
157 | <title>Contents</title>
|
---|
158 |
|
---|
159 | <segmentedlist>
|
---|
160 | <segtitle>Installed Program</segtitle>
|
---|
161 | <segtitle>Installed Libraries</segtitle>
|
---|
162 | <segtitle>Installed Directory</segtitle>
|
---|
163 |
|
---|
164 | <seglistitem>
|
---|
165 | <seg>usb-config</seg>
|
---|
166 | <seg>libusb.[so,a] and libusbpp.[so,a]</seg>
|
---|
167 | <seg>/usr/share/doc/libusb-&libusb-version;</seg>
|
---|
168 | </seglistitem>
|
---|
169 | </segmentedlist>
|
---|
170 |
|
---|
171 | <variablelist>
|
---|
172 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
173 | <?dbfo list-presentation="list"?>
|
---|
174 | <?dbhtml list-presentation="table"?>
|
---|
175 |
|
---|
176 | <varlistentry id="usb-config">
|
---|
177 | <term><command>usb-config</command></term>
|
---|
178 | <listitem>
|
---|
179 | <para>is a script that provides the right compiler and linker
|
---|
180 | flags for programs using
|
---|
181 | <filename class='libraryfile'>libusb</filename>.</para>
|
---|
182 | <indexterm zone="libusb usb-config">
|
---|
183 | <primary sortas="b-usb-config">usb-config</primary>
|
---|
184 | </indexterm>
|
---|
185 | </listitem>
|
---|
186 | </varlistentry>
|
---|
187 |
|
---|
188 | <varlistentry id="libusb-lib">
|
---|
189 | <term><filename class='libraryfile'>libusb.[so,a]</filename></term>
|
---|
190 | <listitem>
|
---|
191 | <para> libraries contain C functions for accessing
|
---|
192 | USB hardware.</para>
|
---|
193 | <indexterm zone="libusb libusb-lib">
|
---|
194 | <primary sortas="c-libusb">libusb.[so,a]</primary>
|
---|
195 | </indexterm>
|
---|
196 | </listitem>
|
---|
197 | </varlistentry>
|
---|
198 |
|
---|
199 | </variablelist>
|
---|
200 |
|
---|
201 | </sect2>
|
---|
202 |
|
---|
203 | </sect1>
|
---|