Author: manuel Date: 2005-05-28 04:46:09 -0600 (Sat, 28 May 2005) New Revision: 5480
Modified: branches/cross-lfs/BOOK/final-system/common/hotplug.xml Log: Indented hotplug.xml Modified: branches/cross-lfs/BOOK/final-system/common/hotplug.xml =================================================================== --- branches/cross-lfs/BOOK/final-system/common/hotplug.xml 2005-05-28 10:29:29 UTC (rev 5479) +++ branches/cross-lfs/BOOK/final-system/common/hotplug.xml 2005-05-28 10:46:09 UTC (rev 5480) @@ -1,5 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [ +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; [ <!ENTITY % general-entities SYSTEM "../../general.ent"> <!ENTITY % patches-entities SYSTEM "../../patches.ent"> %general-entities; @@ -7,179 +8,218 @@ ]> <sect1 id="ch-system-hotplug" xreflabel="Hotplug" role="wrap"> -<title>Hotplug-&hotplug-version;</title> -<?dbhtml filename="hotplug.html"?> + <?dbhtml filename="hotplug.html"?> -<indexterm zone="ch-system-hotplug"><primary sortas="a-Hotplug">Hotplug</primary></indexterm> + <title>Hotplug-&hotplug-version;</title> -<sect2 role="package"><title/> -<!-- Edit me - The entire text of this section needs to be proofread, as it -is taken verbatim from Unstable --> -<para>The Hotplug package contains scripts that react upon hotplug events -generated by the kernel. Such events correspond to every change in the -in the kernel state visible in the <systemitem class="filesystem">sysfs</systemitem> -filesystem, e.g., the addition and removal of hardware. This package also detects -existing hardware during boot and inserts the relevant modules into the running kernel.</para> + <indexterm zone="ch-system-hotplug"> + <primary sortas="a-Hotplug">Hotplug</primary> + </indexterm> -<segmentedlist> -<segtitle>&buildtime;</segtitle> -<segtitle>&diskspace;</segtitle> -<seglistitem><seg>0.01 SBU</seg><seg>0.1 MB</seg></seglistitem> -</segmentedlist> + <sect2 role="package"> + <title/> -<segmentedlist> -<segtitle>&dependencies;</segtitle> -<seglistitem><seg>Unchecked</seg></seglistitem> -</segmentedlist> -</sect2> + <para>The Hotplug package contains scripts that react upon hotplug events + generated by the kernel. Such events correspond to every change in the in the + kernel state visible in the <systemitem class="filesystem">sysfs</systemitem> + filesystem, e.g., the addition and removal of hardware. This package also + detects existing hardware during boot and inserts the relevant modules into + the running kernel.</para> -<sect2 role="installation"> -<title>Installation of Hotplug</title> + <segmentedlist> + <segtitle>&buildtime;</segtitle> + <segtitle>&diskspace;</segtitle> -<para>Install the Hotplug package:</para> + <seglistitem> + <seg>Not checked yet</seg> + <seg>Not checked yet</seg> + </seglistitem> + </segmentedlist> + <segmentedlist> + <segtitle>&dependencies;</segtitle> + + <seglistitem> + <seg>Unchecked</seg> + </seglistitem> + </segmentedlist> + + </sect2> + + <sect2 role="installation"> + <title>Installation of Hotplug</title> + + <para>Install the Hotplug package:</para> + <screen><userinput>make install</userinput></screen> -<para>Remove Hotplug's not-so-clean init script, since we're going to be using -the script including with LFS-Bootscripts:</para> + <para>Remove Hotplug's not-so-clean init script, since we're going to be + using the script including with LFS-Bootscripts:</para> <screen><userinput>rm -rf /etc/init.d</userinput></screen> -<para>Network device hotplugging is not supported by LFS bootscripts yet. For -that reason, remove the network hotplug agent:</para> + <para>Network device hotplugging is not supported by LFS bootscripts yet. + For that reason, remove the network hotplug agent:</para> <screen><userinput>rm -f /etc/hotplug/net.agent</userinput></screen> -<para>Create a directory for storing firmware that can be loaded by -<command>hotplug</command>:</para> + <para>Create a directory for storing firmware that can be loaded by + <command>hotplug</command>:</para> <screen><userinput>mkdir /lib/firmware</userinput></screen> -</sect2> + </sect2> + <sect2 id="contents-hotplug" role="content"> + <title>Contents of Hotplug</title> -<sect2 id="contents-hotplug" role="content"><title>Contents of Hotplug</title> + <segmentedlist> + <segtitle>Installed program</segtitle> + <segtitle>Installed scripts</segtitle> + <segtitle>Installed files</segtitle> -<segmentedlist> -<segtitle>Installed program</segtitle> -<segtitle>Installed scripts</segtitle> -<segtitle>Installed files</segtitle> -<seglistitem><seg>hotplug</seg> -<seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> -<seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, /etc/hotplug/{pci,usb}, -/etc/hotplug/usb.usermap, /etc/hotplug.d, /var/log/hotplug/events</seg></seglistitem> -</segmentedlist> + <seglistitem> + <seg>hotplug</seg> + <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg> + <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, + /etc/hotplug/{pci,usb}, /etc/hotplug/usb.usermap, /etc/hotplug.d, + and /var/log/hotplug/events</seg> + </seglistitem> + </segmentedlist> -<variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> -<?dbfo list-presentation="list"?> -<?dbhtml list-presentation="table"?> + <variablelist> + <bridgehead renderas="sect3">Short Descriptions</bridgehead> + <?dbfo list-presentation="list"?> + <?dbhtml list-presentation="table"?> -<varlistentry id="hotplug"> -<term><command>hotplug</command></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug"><primary -sortas="b-hotplug">hotplug</primary></indexterm> -<para>This script is called by default by the Linux kernel when something -changes in its internal state (e.g., a new device is added or removed)</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug"> + <term><command>hotplug</command></term> + <listitem> + <para>This script is called by default by the Linux kernel when + something changes in its internal state (e.g., a new device is + added or removed)</para> + <indexterm zone="ch-system-hotplug hotplug"> + <primary sortas="b-hotplug">hotplug</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-rc"> -<term><command>/etc/hotplug/*.rc</command></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-rc"><primary -sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary></indexterm> -<para>These scripts are used for cold plugging, i.e., detecting and acting upon -hardware already present during system startup. They are called by the -<filename>hotplug</filename> initscript that comes from the LFS-Bootscripts -package. The <command>*.rc</command> scripts try to recover hotplug events that -were lost during system boot because, for example, the root filesystem was not -mounted by the kernel</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-rc"> + <term><command>/etc/hotplug/*.rc</command></term> + <listitem> + <para>These scripts are used for cold plugging, i.e., detecting and + acting upon hardware already present during system startup. They are + called by the <filename>hotplug</filename> initscript that comes + from the LFS-Bootscripts package. The <command>*.rc</command> + scripts try to recover hotplug events that were lost during system + boot because, for example, the root filesystem was not mounted by + the kernel</para> + <indexterm zone="ch-system-hotplug hotplug-rc"> + <primary sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-agent"> -<term><command>/etc/hotplug/*.agent</command></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-agent"><primary -sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary></indexterm> -<para>These scripts are called by <command>hotplug</command> -in response to different types of hotplug events generated by the kernel. -Their action is to insert corresponding kernel modules and call any -user-provided scripts</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-agent"> + <term><command>/etc/hotplug/*.agent</command></term> + <listitem> + <para>These scripts are called by <command>hotplug</command> in + response to different types of hotplug events generated by the + kernel. Their action is to insert corresponding kernel modules + and call any user-provided scripts</para> + <indexterm zone="ch-system-hotplug hotplug-agent"> + <primary sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-blacklist"> -<term><filename>/etc/hotplug/blacklist</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-blacklist"><primary -sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary></indexterm> -<para>This file contains the list of modules that should never be inserted into -the kernel by the Hotplug scripts</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-blacklist"> + <term><filename>/etc/hotplug/blacklist</filename></term> + <listitem> + <para>This file contains the list of modules that should never be + inserted into the kernel by the Hotplug scripts</para> + <indexterm zone="ch-system-hotplug hotplug-blacklist"> + <primary + sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-functions"> -<term><filename>/etc/hotplug/hotplug.functions</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-functions"><primary -sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary></indexterm> -<para>This file contains common functions used by other scripts in the Hotplug -package</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-functions"> + <term><filename>/etc/hotplug/hotplug.functions</filename></term> + <listitem> + <para>This file contains common functions used by other scripts in + the Hotplug package</para> + <indexterm zone="ch-system-hotplug hotplug-functions"> + <primary + sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-subdirs"> -<term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-subdirs"><primary -sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary></indexterm> -<para>These directories contain user-written handlers for hotplug events</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-subdirs"> + <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term> + <listitem> + <para>These directories contain user-written handlers for hotplug + events</para> + <indexterm zone="ch-system-hotplug hotplug-subdirs"> + <primary + sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-usb.usermap"> -<term><filename>/etc/hotplug/usb.usermap</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-usb.usermap"><primary -sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary></indexterm> -<para>This file contains rules that determine which user-defined handlers to -call for each USB device, based on its vendor ID and other attributes</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-usb.usermap"> + <term><filename>/etc/hotplug/usb.usermap</filename></term> + <listitem> + <para>This file contains rules that determine which user-defined + handlers to call for each USB device, based on its vendor ID and + other attributes</para> + <indexterm zone="ch-system-hotplug hotplug-usb.usermap"> + <primary + sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-hotplug.d"> -<term><filename class="directory">/etc/hotplug.d</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-hotplug.d"><primary -sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary></indexterm> -<para>This directory contains programs (or symlinks to them) that are interested -in receiving hotplug events. For example, <application>Udev</application> puts -its symlink here during installation</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-hotplug.d"> + <term><filename class="directory">/etc/hotplug.d</filename></term> + <listitem> + <para>This directory contains programs (or symlinks to them) that + are interested in receiving hotplug events. For example, + <application>Udev</application> puts its symlink here during + installation</para> + <indexterm zone="ch-system-hotplug hotplug-hotplug.d"> + <primary sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-firmware"> -<term><filename class="directory">/lib/firmware</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-firmware"><primary -sortas="e-/lib/firmware">/lib/firmware</primary></indexterm> -<para>This directory contains the firmware for devices that need to have their -firmware loaded before use</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-firmware"> + <term><filename class="directory">/lib/firmware</filename></term> + <listitem> + <para>This directory contains the firmware for devices that need + to have their firmware loaded before use</para> + <indexterm zone="ch-system-hotplug hotplug-firmware"> + <primary sortas="e-/lib/firmware">/lib/firmware</primary> + </indexterm> + </listitem> + </varlistentry> -<varlistentry id="hotplug-events"> -<term><filename>/var/log/hotplug/events</filename></term> -<listitem> -<indexterm zone="ch-system-hotplug hotplug-events"><primary -sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary></indexterm> -<para>This file contains all the events that <command>hotplug</command> has -called since bootup</para> -</listitem> -</varlistentry> + <varlistentry id="hotplug-events"> + <term><filename>/var/log/hotplug/events</filename></term> + <listitem> + <para>This file contains all the events that <command>hotplug</command> + has called since bootup</para> + <indexterm zone="ch-system-hotplug hotplug-events"> + <primary + sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary> + </indexterm> + </listitem> + </varlistentry> -</variablelist> -</sect2> + </variablelist> + + </sect2> + </sect1> -- http://linuxfromscratch.org/mailman/listinfo/lfs-book FAQ: http://www.linuxfromscratch.org/lfs/faq.html Unsubscribe: See the above information page
