Changeset aa9bc4f for general/genlib

Timestamp:

08/16/2004 05:19:08 AM (20 years ago)

Author:

Randy McMurchy <randy@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 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, 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:

9c69d5bc

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

File:

• general/genlib/libusb.xml (modified) (3 diffs)

general/genlib/libusb.xml

@@ -10 +10 @@
 <!ENTITY libusb-buildsize "2.1 MB">
 <!ENTITY libusb-time "0.03 SBU">
-
 ]>
 
@@ -23 +22 @@
 <sect2>
 <title>Introduction to <application>libusb</application></title>
-                                                                               
+
 <para>The <application>libusb</application> package contains a library
 used by some applications for <acronym>USB</acronym> device access.</para>
-                                                                               
+
 <sect3><title>Package information</title>
 <itemizedlist spacing='compact'>
@@ -35 +34 @@
 <listitem><para>Estimated build time: &libusb-time;</para></listitem></itemizedlist>
 </sect3>
-                                                                               
+
 <sect3><title><application>libusb</application> dependencies</title>
 <sect4><title>Optional</title>
 <para><xref linkend="openjade"/> and <xref linkend="sgml-dtd-3"/></para></sect4>
 </sect3>
-                                                                               
+
 </sect2>
 
 <sect2>
 <title>Installation of <application>libusb</application></title>
-                                                                               
-<para>Install <application>libusb</application> by running the following commands:</para>
-                                                                               
+
+<para>Install <application>libusb</application> by running the following 
+commands:</para>
+
 <screen><userinput><command>./configure --prefix=/usr --disable-build-docs &amp;&amp;
 make &amp;&amp;
 make install</command></userinput></screen>
-                                                                               
+
 </sect2>
 
 <sect2>
 <title>Command explanations</title>
-                                                                               
-<para><parameter>--disable-build-docs</parameter>: This switch turns off
-the default enabled building of documentation since it requires
-<application>OpenJade</application>.</para>
+
+<para><option>--disable-build-docs</option>: This switch avoids building the
+documentation. If you wish to build the documentation , you may need to remove 
+the <application>OpenSP</application> catalog definitions from the system 
+<acronym>SGML</acronym> catalogs. Use the following commands before building 
+the package to accomplish this:</para>
+
+<screen><userinput><command>sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
+    /etc/sgml/catalog &amp;&amp;
+sed -i.orig -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
+    /etc/sgml/sgml-docbook.cat</command></userinput></screen>
+
+<para>If desired, restore the orginal <acronym>SGML</acronym> catalogs after 
+the build is complete using the following commands:</para>
+
+<screen><userinput><command>cp /etc/sgml/catalog.orig /etc/sgml/catalog &amp;&amp;
+cp /etc/sgml/sgml-docbook.cat.orig /etc/sgml/sgml-docbook.cat</command></userinput></screen>
+
 </sect2>
 
 <sect2>
 <title>Configuring <application>libusb</application></title>
-                                                                               
+
 <!-- To be reviewed when hotplug enters the LFS book -->
-                                                                               
+
 <para>libusb requires the usbfs kernel filesystem to be mounted on
 <filename class="directory">/proc/bus/usb</filename>. Applications
 require the files in this directory to be accessible to the user,
 sometimes for both reading and writing.</para>
-                                                                               
+
 <para>To restrict access to <acronym>USB</acronym> devices, create the
 usb group:</para>
-                                                                               
+
 <screen><userinput><command>groupadd -g 15 usb</command></userinput></screen>
-                                                                               
-<para>To get usbfs mounted on boot, we will create a special init script,
-because just putting an extra line into
-<filename>/etc/fstab</filename> does not work for those who compiled
-"USB device filesystem" as a kernel module.
-Install <filename>/etc/rc.d/init.d/usb</filename>
-init script included in the
-<xref linkend="intro-important-bootscripts"/> package.</para>
-                                                                               
-                                                                               
+
+<para>Mount usbfs at system boot-up using a special init script, as putting an 
+extra line into <filename>/etc/fstab</filename> does not work for those who 
+compiled "USB device filesystem" as a kernel module. Install the 
+<filename>/etc/rc.d/init.d/usb</filename> init script included in the
+<xref linkend="intro-important-bootscripts"/> package:</para>
+
 <screen><userinput><command>make install-usb</command></userinput></screen>
-                                                                               
+
 </sect2>
 
 <sect2>
 <title>Contents</title>
-                                                                               
+
 <para>The <application>libusb</application> package contains
 <filename class="libraryfile">libusb</filename> libraries,
 the <filename>/usr/include/usb.h</filename> header,
 and a <command>usb-config</command> script.</para>
-                                                                               
+
 </sect2>
-                                                                               
+
 <sect2><title>Description</title>
-                                                                               
+
 <sect3><title>libusb libraries</title>
-<para><filename class="libraryfile">libusb</filename> libraries contain C functions for
-accessing <acronym>USB</acronym> hardware.</para></sect3>
-                                                                               
+<para><filename class="libraryfile">libusb</filename> libraries contain C 
+functions for accessing <acronym>USB</acronym> hardware.</para></sect3>
+
 <sect3><title>usb-config</title>
 <para>The <command>usb-config</command> script provides the right
-compiler and linker flags for programs using
-this library.</para></sect3>
-                                                                               
+compiler and linker flags for programs using this library.</para></sect3>
+
 </sect2>