Changeset aa9bc4f


Ignore:
Timestamp:
08/16/2004 05:19:08 AM (17 years ago)
Author:
Randy McMurchy <randy@…>
Branches:
10.0, 10.1, 11.0, 6.0, 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, ken/refactor-virt, krejzi/svn, lazarus, nosym, perl-modules, qt5new, systemd-11177, systemd-13485, trunk, xry111/git-date, xry111/git-date-for-trunk, xry111/git-date-test
Children:
9c69d5b
Parents:
f9d2ee6
Message:

Added documentation build instructions to libusb

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

Files:
3 edited

Legend:

Unmodified
Added
Removed
  • general.ent

    rf9d2ee6 raa9bc4f  
    1 <!ENTITY day          "15">
     1<!ENTITY day          "16">
    22<!ENTITY month        "08">
    33<!ENTITY year         "2004">
  • general/genlib/libusb.xml

    rf9d2ee6 raa9bc4f  
    1010<!ENTITY libusb-buildsize "2.1 MB">
    1111<!ENTITY libusb-time "0.03 SBU">
    12 
    1312]>
    1413
     
    2322<sect2>
    2423<title>Introduction to <application>libusb</application></title>
    25                                                                                
     24
    2625<para>The <application>libusb</application> package contains a library
    2726used by some applications for <acronym>USB</acronym> device access.</para>
    28                                                                                
     27
    2928<sect3><title>Package information</title>
    3029<itemizedlist spacing='compact'>
     
    3534<listitem><para>Estimated build time: &libusb-time;</para></listitem></itemizedlist>
    3635</sect3>
    37                                                                                
     36
    3837<sect3><title><application>libusb</application> dependencies</title>
    3938<sect4><title>Optional</title>
    4039<para><xref linkend="openjade"/> and <xref linkend="sgml-dtd-3"/></para></sect4>
    4140</sect3>
    42                                                                                
     41
    4342</sect2>
    4443
    4544<sect2>
    4645<title>Installation of <application>libusb</application></title>
    47                                                                                
    48 <para>Install <application>libusb</application> by running the following commands:</para>
    49                                                                                
     46
     47<para>Install <application>libusb</application> by running the following
     48commands:</para>
     49
    5050<screen><userinput><command>./configure --prefix=/usr --disable-build-docs &amp;&amp;
    5151make &amp;&amp;
    5252make install</command></userinput></screen>
    53                                                                                
     53
    5454</sect2>
    5555
    5656<sect2>
    5757<title>Command explanations</title>
    58                                                                                
    59 <para><parameter>--disable-build-docs</parameter>: This switch turns off
    60 the default enabled building of documentation since it requires
    61 <application>OpenJade</application>.</para>
     58
     59<para><option>--disable-build-docs</option>: This switch avoids building the
     60documentation. If you wish to build the documentation , you may need to remove
     61the <application>OpenSP</application> catalog definitions from the system
     62<acronym>SGML</acronym> catalogs. Use the following commands before building
     63the package to accomplish this:</para>
     64
     65<screen><userinput><command>sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
     66    /etc/sgml/catalog &amp;&amp;
     67sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
     68    /etc/sgml/sgml-docbook.cat</command></userinput></screen>
     69
     70<para>If desired, restore the orginal <acronym>SGML</acronym> catalogs after
     71the build is complete using the following commands:</para>
     72
     73<screen><userinput><command>cp /etc/sgml/catalog.orig /etc/sgml/catalog &amp;&amp;
     74cp /etc/sgml/sgml-docbook.cat.orig /etc/sgml/sgml-docbook.cat</command></userinput></screen>
     75
    6276</sect2>
    6377
    6478<sect2>
    6579<title>Configuring <application>libusb</application></title>
    66                                                                                
     80
    6781<!-- To be reviewed when hotplug enters the LFS book -->
    68                                                                                
     82
    6983<para>libusb requires the usbfs kernel filesystem to be mounted on
    7084<filename class="directory">/proc/bus/usb</filename>. Applications
    7185require the files in this directory to be accessible to the user,
    7286sometimes for both reading and writing.</para>
    73                                                                                
     87
    7488<para>To restrict access to <acronym>USB</acronym> devices, create the
    7589usb group:</para>
    76                                                                                
     90
    7791<screen><userinput><command>groupadd -g 15 usb</command></userinput></screen>
    78                                                                                
    79 <para>To get usbfs mounted on boot, we will create a special init script,
    80 because just putting an extra line into
    81 <filename>/etc/fstab</filename> does not work for those who compiled
    82 "USB device filesystem" as a kernel module.
    83 Install <filename>/etc/rc.d/init.d/usb</filename>
    84 init script included in the
    85 <xref linkend="intro-important-bootscripts"/> package.</para>
    86                                                                                
    87                                                                                
     92
     93<para>Mount usbfs at system boot-up using a special init script, as putting an
     94extra line into <filename>/etc/fstab</filename> does not work for those who
     95compiled "USB device filesystem" as a kernel module. Install the
     96<filename>/etc/rc.d/init.d/usb</filename> init script included in the
     97<xref linkend="intro-important-bootscripts"/> package:</para>
     98
    8899<screen><userinput><command>make install-usb</command></userinput></screen>
    89                                                                                
     100
    90101</sect2>
    91102
    92103<sect2>
    93104<title>Contents</title>
    94                                                                                
     105
    95106<para>The <application>libusb</application> package contains
    96107<filename class="libraryfile">libusb</filename> libraries,
    97108the <filename>/usr/include/usb.h</filename> header,
    98109and a <command>usb-config</command> script.</para>
    99                                                                                
     110
    100111</sect2>
    101                                                                                
     112
    102113<sect2><title>Description</title>
    103                                                                                
     114
    104115<sect3><title>libusb libraries</title>
    105 <para><filename class="libraryfile">libusb</filename> libraries contain C functions for
    106 accessing <acronym>USB</acronym> hardware.</para></sect3>
    107                                                                                
     116<para><filename class="libraryfile">libusb</filename> libraries contain C
     117functions for accessing <acronym>USB</acronym> hardware.</para></sect3>
     118
    108119<sect3><title>usb-config</title>
    109120<para>The <command>usb-config</command> script provides the right
    110 compiler and linker flags for programs using
    111 this library.</para></sect3>
    112                                                                                
     121compiler and linker flags for programs using this library.</para></sect3>
     122
    113123</sect2>
    114124
  • introduction/welcome/changelog.xml

    rf9d2ee6 raa9bc4f  
    2626patch to -3 version as suggested by Kevin Fleming; added gcc34 patch to
    2727OpenQuicktime instructions; added documentation build instructions to
    28 Fontconfig as suggested by Nico R.</para></listitem>
     28Fontconfig and libusb as suggested by Nico R.</para></listitem>
    2929
    3030<listitem><para>August 15th, 2004 [randy]: Added GPM as an optional
Note: See TracChangeset for help on using the changeset viewer.