[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[fc3e01f] | 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)">
|
---|
[4c288b0] | 12 | <!ENTITY libusb-time "0.1 SBU">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[bdf5806e] | 15 | <sect1 id="libusb" xreflabel="libusb-&libusb-version;">
|
---|
[fc3e01f] | 16 | <?dbhtml filename="libusb.html"?>
|
---|
[4c3474fe] | 17 |
|
---|
[fc3e01f] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[4c3474fe] | 22 |
|
---|
[fc3e01f] | 23 | <title>Libusb-&libusb-version;</title>
|
---|
[4c3474fe] | 24 |
|
---|
[fc3e01f] | 25 | <indexterm zone="libusb">
|
---|
| 26 | <primary sortas="a-Libusb">Libusb</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Libusb</title>
|
---|
[4c3474fe] | 31 |
|
---|
[fc3e01f] | 32 | <para>The <application>libusb</application> package contains a library
|
---|
| 33 | used by some applications for USB device access.</para>
|
---|
[4c3474fe] | 34 |
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 56 |
|
---|
[fc3e01f] | 57 | <bridgehead renderas="sect3">Libusb Dependencies</bridgehead>
|
---|
[4c3474fe] | 58 |
|
---|
[74390482] | 59 | <bridgehead renderas="sect4">Optional (Required to Build the HTML User
|
---|
[fc3e01f] | 60 | Manual)</bridgehead>
|
---|
[74390482] | 61 | <para><xref linkend="openjade"/> and
|
---|
| 62 | <ulink url="http://www.docbook.org/sgml/4.2/index.html"> DocBOOK SGML
|
---|
[4c3474fe] | 63 | DTD-4.2</ulink></para>
|
---|
| 64 |
|
---|
[74390482] | 65 | <bridgehead renderas="sect4">Optional (Required to Build the API
|
---|
[fc3e01f] | 66 | Documentation)</bridgehead>
|
---|
[74390482] | 67 | <para><xref linkend="doxygen"/> and
|
---|
[fc3e01f] | 68 | <ulink url="http://www.graphviz.org/">GraphViz</ulink></para>
|
---|
[4c3474fe] | 69 |
|
---|
[fc3e01f] | 70 | </sect2>
|
---|
[4c3474fe] | 71 |
|
---|
[fc3e01f] | 72 | <sect2 role="installation">
|
---|
| 73 | <title>Installation of Libusb</title>
|
---|
| 74 |
|
---|
[74390482] | 75 | <para>Install <application>libusb</application> by running the following
|
---|
[fc3e01f] | 76 | commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput>./configure --prefix=/usr --disable-build-docs &&
|
---|
| 79 | make</userinput></screen>
|
---|
| 80 |
|
---|
[74390482] | 81 | <para>If you wish to build the API documentation, issue
|
---|
[fc3e01f] | 82 | the following command:</para>
|
---|
| 83 |
|
---|
| 84 | <screen><userinput>make apidox</userinput></screen>
|
---|
[4c3474fe] | 85 |
|
---|
[fc3e01f] | 86 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[4c3474fe] | 87 |
|
---|
[fc3e01f] | 88 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 89 |
|
---|
[74390482] | 90 | <para>If you built the HTML user manual, install it using the following commands
|
---|
[fc3e01f] | 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 |
|
---|
[74390482] | 96 | <para>If you built the API documentation, install it using the following commands
|
---|
[fc3e01f] | 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 &&
|
---|
[4c288b0] | 100 | install -v -m644 apidocs/html/* \
|
---|
| 101 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
[4c3474fe] | 102 |
|
---|
[fc3e01f] | 103 | </sect2>
|
---|
[4c3474fe] | 104 |
|
---|
[fc3e01f] | 105 | <sect2 role="commands">
|
---|
| 106 | <title>Command Explanations</title>
|
---|
| 107 |
|
---|
| 108 | <para><parameter>--disable-build-docs</parameter>: This switch avoids building the
|
---|
[4412b30b] | 109 | HTML user manual.</para>
|
---|
| 110 |
|
---|
| 111 | <!-- Disabling obsolete text
|
---|
| 112 |
|
---|
| 113 | If you wish to build the user manual, you
|
---|
[74390482] | 114 | may need to remove the <application>OpenSP</application> catalog definitions
|
---|
| 115 | from the system SGML catalogs. Use the following command
|
---|
[fc3e01f] | 116 | before building the package to accomplish this:</para>
|
---|
| 117 |
|
---|
| 118 | <screen role='root'><userinput>sed -i.orig \
|
---|
[04af8b24] | 119 | -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
|
---|
| 120 | /etc/sgml/catalog \
|
---|
[fc3e01f] | 121 | /etc/sgml/sgml-docbook.cat</userinput></screen>
|
---|
[4c3474fe] | 122 |
|
---|
[4412b30b] | 123 | -->
|
---|
| 124 |
|
---|
[fc3e01f] | 125 | </sect2>
|
---|
[4c3474fe] | 126 |
|
---|
[fc3e01f] | 127 | <sect2 role="configuration">
|
---|
| 128 | <title>Configuring Libusb</title>
|
---|
| 129 |
|
---|
[74390482] | 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
|
---|
[fc3e01f] | 137 | class="filesystem">usb</systemitem> group using the following command:</para>
|
---|
| 138 |
|
---|
| 139 | <screen role='root'><userinput>groupadd -g 14 usb</userinput></screen>
|
---|
| 140 |
|
---|
[74390482] | 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
|
---|
[4c3474fe] | 145 | entry similar to the line below in your <filename>/etc/fstab</filename>
|
---|
[fc3e01f] | 146 | file:</para>
|
---|
[4c3474fe] | 147 |
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 153 |
|
---|
[fc3e01f] | 154 | </sect2>
|
---|
[4c3474fe] | 155 |
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 163 |
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 170 |
|
---|
[fc3e01f] | 171 | <variablelist>
|
---|
| 172 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 173 | <?dbfo list-presentation="list"?>
|
---|
| 174 | <?dbhtml list-presentation="table"?>
|
---|
[4c3474fe] | 175 |
|
---|
[fc3e01f] | 176 | <varlistentry id="usb-config">
|
---|
| 177 | <term><command>usb-config</command></term>
|
---|
| 178 | <listitem>
|
---|
[74390482] | 179 | <para>is a script that provides the right compiler and linker
|
---|
| 180 | flags for programs using
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 187 |
|
---|
[fc3e01f] | 188 | <varlistentry id="libusb-lib">
|
---|
| 189 | <term><filename class='libraryfile'>libusb.[so,a]</filename></term>
|
---|
| 190 | <listitem>
|
---|
[74390482] | 191 | <para> libraries contain C functions for accessing
|
---|
[fc3e01f] | 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>
|
---|
[4c3474fe] | 198 |
|
---|
[fc3e01f] | 199 | </variablelist>
|
---|
| 200 |
|
---|
| 201 | </sect2>
|
---|
[bdf5806e] | 202 |
|
---|
| 203 | </sect1>
|
---|