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