Changeset fc3e01f for general/genlib/libusb.xml
- Timestamp:
- 05/01/2005 01:07:45 PM (19 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- 80649d27
- Parents:
- 73db351a
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
general/genlib/libusb.xml
r73db351a rfc3e01f 5 5 %general-entities; 6 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)">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 13 ]> 14 14 15 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> 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> 25 28 26 <sect2> 27 <title>Introduction to <application>libusb</application></title> 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> 28 74 29 <para>The <application>libusb</application> package contains a library 30 used by some applications for <acronym>USB</acronym> device access.</para>75 <para>Install <application>libusb</application> by running the following 76 commands:</para> 31 77 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> 78 <screen><userinput>./configure --prefix=/usr --disable-build-docs && 79 make</userinput></screen> 47 80 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> 81 <para>If you wish to build the API documentation, issue 82 the following command:</para> 55 83 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> 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> 62 89 63 </sect2> 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> 64 92 65 <s ect2>66 <title>Installation of <application>libusb</application></title>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> 67 95 68 <para>Install <application>libusb</application> by running the following69 commands:</para>96 <para>If you built the API documentation, install it using the following commands 97 as the <systemitem class="username">root</systemitem> user:</para> 70 98 71 <screen><userinput><command>./configure --prefix=/usr --disable-build-docs && 72 make</command></userinput></screen> 99 <screen role="root"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs && 100 install -v -m644 apidocs/html/* /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen> 101 102 </sect2> 103 104 <sect2 role="commands"> 105 <title>Command Explanations</title> 73 106 74 <para>If you wish to build the <acronym>API</acronym> documentation, issue 75 the following command:</para> 107 <para><parameter>--disable-build-docs</parameter>: This switch avoids building the 108 HTML user manual. If you wish to build the user manual, you 109 may need to remove the <application>OpenSP</application> catalog definitions 110 from the system SGML catalogs. Use the following command 111 before building the package to accomplish this:</para> 76 112 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 \ 113 <screen role='root'><userinput>sed -i.orig \ 107 114 -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \ 108 115 /etc/sgml/catalog \ 109 /etc/sgml/sgml-docbook.cat</command></userinput></screen> 116 /etc/sgml/sgml-docbook.cat</userinput></screen> 117 118 </sect2> 119 120 <sect2 role="configuration"> 121 <title>Configuring Libusb</title> 110 122 111 </sect2> 123 <para><application>libusb</application> requires the 124 <systemitem class="filesystem">usbfs</systemitem> kernel filesystem 125 to be mounted on <filename class="directory">/proc/bus/usb</filename>. 126 Applications require the files in this directory to be accessible to the user, 127 sometimes for both reading and writing. To restrict access to USB devices, 128 ensure the <systemitem class="filesystem">usb</systemitem> group exits 129 on your system. If necessary, create the <systemitem 130 class="filesystem">usb</systemitem> group using the following command:</para> 112 131 113 <sect2> 114 <title>Configuring <application>libusb</application></title> 132 <screen role='root'><userinput>groupadd -g 14 usb</userinput></screen> 115 133 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> 134 <para id="libusb-kernel">Ensure that you have compiled the <quote>USB device 135 filesystem</quote> directly into the kernel or compiled it as a module 136 (listing the resulting <quote>usbcore</quote> module in the 137 <filename>/etc/sysconfig/modules</filename> file). You should also have an 138 entry similar to the line below in your <filename>/etc/fstab</filename> 139 file:</para> 140 141 <indexterm zone="libusb libusb-kernel"> 142 <primary sortas="d-USB-device-filesystem">USB device filesystem</primary> 143 </indexterm> 122 144 123 <screen><userinput role='root'><command>groupadd -g 14 usb</command></userinput></screen> 145 <screen><literal>usbfs /proc/bus/usb usbfs devgid=14,devmode=0660 0 0</literal></screen> 146 147 </sect2> 148 149 <sect2 role="content"> 150 <title>Contents</title> 124 151 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> 152 <segmentedlist> 153 <segtitle>Installed Program</segtitle> 154 <segtitle>Installed Libraries</segtitle> 155 <segtitle>Installed Directory</segtitle> 156 157 <seglistitem> 158 <seg>usb-config</seg> 159 <seg>libusb.[so,a] and libusbpp.[so,a]</seg> 160 <seg>/usr/share/doc/libusb-&libusb-version;</seg> 161 </seglistitem> 162 </segmentedlist> 163 164 <variablelist> 165 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 166 <?dbfo list-presentation="list"?> 167 <?dbhtml list-presentation="table"?> 168 169 <varlistentry id="usb-config"> 170 <term><command>usb-config</command></term> 171 <listitem> 172 <para>is a script that provides the right compiler and linker 173 flags for programs using 174 <filename class='libraryfile'>libusb</filename>.</para> 175 <indexterm zone="libusb usb-config"> 176 <primary sortas="b-usb-config">usb-config</primary> 177 </indexterm> 178 </listitem> 179 </varlistentry> 180 181 <varlistentry id="libusb-lib"> 182 <term><filename class='libraryfile'>libusb.[so,a]</filename></term> 183 <listitem> 184 <para> libraries contain C functions for accessing 185 USB hardware.</para> 186 <indexterm zone="libusb libusb-lib"> 187 <primary sortas="c-libusb">libusb.[so,a]</primary> 188 </indexterm> 189 </listitem> 190 </varlistentry> 191 192 </variablelist> 134 193 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> 194 </sect2> 179 195 180 196 </sect1>
Note:
See TracChangeset
for help on using the changeset viewer.