[c9214d5] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 4 | %general-entities;
|
---|
| 5 | ]>
|
---|
| 6 | <sect1 id="ch-system-hotplug" xreflabel="Hotplug" role="wrap">
|
---|
| 7 | <title>Hotplug-&hotplug-version;</title>
|
---|
| 8 | <?dbhtml filename="hotplug.html"?>
|
---|
| 9 |
|
---|
| 10 | <indexterm zone="ch-system-hotplug"><primary sortas="a-Hotplug">Hotplug</primary></indexterm>
|
---|
| 11 |
|
---|
| 12 | <sect2 role="package"><title/>
|
---|
| 13 | <!-- Edit me - The entire text of this section needs to be proofread, as it
|
---|
| 14 | is taken verbatim from Unstable -->
|
---|
| 15 | <para>The Hotplug package contains scripts that react upon hotplug events
|
---|
| 16 | generated by the kernel. Such events correspond to every change in the
|
---|
[33798c5] | 17 | in the kernel state visible in the <systemitem class="filesystem">sysfs</systemitem>
|
---|
| 18 | filesystem, e.g., the addition and removal of hardware. This package also detects
|
---|
| 19 | existing hardware during boot and inserts the relevant modules into the running kernel.</para>
|
---|
| 20 |
|
---|
[c9214d5] | 21 | <segmentedlist>
|
---|
| 22 | <segtitle>&buildtime;</segtitle>
|
---|
| 23 | <segtitle>&diskspace;</segtitle>
|
---|
| 24 | <seglistitem><seg>0.01 SBU</seg><seg>0.1 MB</seg></seglistitem>
|
---|
| 25 | </segmentedlist>
|
---|
| 26 |
|
---|
[33798c5] | 27 | <segmentedlist>
|
---|
| 28 | <segtitle>Hotplug installation depends on</segtitle>
|
---|
| 29 | <seglistitem><seg>Unchecked</seg></seglistitem>
|
---|
| 30 | </segmentedlist>
|
---|
[c9214d5] | 31 | </sect2>
|
---|
| 32 |
|
---|
| 33 | <sect2 role="installation">
|
---|
| 34 | <title>Installation of Hotplug</title>
|
---|
| 35 |
|
---|
| 36 | <para>Install the Hotplug package:</para>
|
---|
| 37 |
|
---|
| 38 | <screen><userinput>make install</userinput></screen>
|
---|
| 39 |
|
---|
| 40 | <para>Remove Hotplug's not-so-clean init script, since we're going to be using
|
---|
| 41 | the script including with LFS-Bootscripts:</para>
|
---|
| 42 |
|
---|
| 43 | <screen><userinput>rm -rf /etc/init.d</userinput></screen>
|
---|
| 44 |
|
---|
| 45 | <para>Network device hotplugging is not supported by LFS bootscripts yet. For
|
---|
| 46 | that reason, remove the network hotplug agent:</para>
|
---|
| 47 |
|
---|
| 48 | <screen><userinput>rm -f /etc/hotplug/net.agent</userinput></screen>
|
---|
| 49 | </sect2>
|
---|
| 50 |
|
---|
| 51 |
|
---|
| 52 | <sect2 id="contents-hotplug" role="content"><title>Contents of Hotplug</title>
|
---|
| 53 |
|
---|
[33798c5] | 54 | <segmentedlist>
|
---|
| 55 | <segtitle>Installed program</segtitle>
|
---|
| 56 | <segtitle>Installed scripts</segtitle>
|
---|
| 57 | <segtitle>Installed files</segtitle>
|
---|
| 58 | <seglistitem><seg>hotplug</seg>
|
---|
| 59 | <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg>
|
---|
| 60 | <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, /etc/hotplug/{pci,usb},
|
---|
[882ab22] | 61 | /etc/hotplug/usb.usermap, /etc/hotplug.d</seg></seglistitem>
|
---|
[33798c5] | 62 | </segmentedlist>
|
---|
| 63 |
|
---|
| 64 | <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 65 | <?dbfo list-presentation="list"?>
|
---|
| 66 |
|
---|
[c9214d5] | 67 | <varlistentry id="hotplug">
|
---|
[33798c5] | 68 | <term><command>hotplug</command></term>
|
---|
[c9214d5] | 69 | <listitem>
|
---|
| 70 | <indexterm zone="ch-system-hotplug hotplug"><primary
|
---|
| 71 | sortas="b-hotplug">hotplug</primary></indexterm>
|
---|
| 72 | <para>This script is called by default by Linux kernel when something
|
---|
| 73 | changes in its internal state (e.g., a new device is added or removed).</para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </varlistentry>
|
---|
| 76 |
|
---|
| 77 | <varlistentry id="hotplug-rc">
|
---|
[33798c5] | 78 | <term><command>/etc/hotplug/*.rc</command></term>
|
---|
[c9214d5] | 79 | <listitem>
|
---|
| 80 | <indexterm zone="ch-system-hotplug hotplug-rc"><primary
|
---|
[33798c5] | 81 | sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary></indexterm>
|
---|
[c9214d5] | 82 | <para>These scripts are used for cold plugging, i.e., detection and other
|
---|
| 83 | specific actions upon hardware already present during system startup.
|
---|
| 84 | They are called by the <filename>hotplug</filename> initscript that comes
|
---|
[33798c5] | 85 | from the LFS-Bootscripts package.
|
---|
[c9214d5] | 86 | The <command>*.rc</command>
|
---|
| 87 | scripts try to recover hotplug events that were lost during system boot
|
---|
| 88 | because, e.g., the root filesystem was not mounted by the kernel.
|
---|
| 89 | </para>
|
---|
| 90 | </listitem>
|
---|
| 91 | </varlistentry>
|
---|
| 92 |
|
---|
| 93 | <varlistentry id="hotplug-agent">
|
---|
[33798c5] | 94 | <term><command>/etc/hotplug/*.agent</command></term>
|
---|
[c9214d5] | 95 | <listitem>
|
---|
| 96 | <indexterm zone="ch-system-hotplug hotplug-agent"><primary
|
---|
[33798c5] | 97 | sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary></indexterm>
|
---|
| 98 | <para>These scripts are called by <command>hotplug</command>
|
---|
[c9214d5] | 99 | in response to different types of hotplug events generated by the kernel.
|
---|
| 100 | Their action is to insert corresponding kernel modules and call user-provided
|
---|
| 101 | scripts, if any.
|
---|
| 102 | </para>
|
---|
| 103 | </listitem>
|
---|
| 104 | </varlistentry>
|
---|
| 105 |
|
---|
| 106 | <varlistentry id="hotplug-functions">
|
---|
| 107 | <term><filename>/etc/hotplug/hotplug.functions</filename></term>
|
---|
| 108 | <listitem>
|
---|
| 109 | <indexterm zone="ch-system-hotplug hotplug-functions"><primary
|
---|
| 110 | sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary></indexterm>
|
---|
| 111 | <para>This file contains common functions used by other scripts in Hotplug
|
---|
| 112 | package.
|
---|
| 113 | </para>
|
---|
| 114 | </listitem>
|
---|
| 115 | </varlistentry>
|
---|
| 116 |
|
---|
| 117 | <varlistentry id="hotplug-blacklist">
|
---|
| 118 | <term><filename>/etc/hotplug/blacklist</filename></term>
|
---|
| 119 | <listitem>
|
---|
| 120 | <indexterm zone="ch-system-hotplug hotplug-blacklist"><primary
|
---|
| 121 | sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary></indexterm>
|
---|
| 122 | <para>This file contains the list of modules that should never be
|
---|
| 123 | inserted into the kernel by hotplug scripts.
|
---|
| 124 | </para>
|
---|
| 125 | </listitem>
|
---|
| 126 | </varlistentry>
|
---|
| 127 |
|
---|
| 128 | <varlistentry id="hotplug-subdirs">
|
---|
| 129 | <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term>
|
---|
| 130 | <listitem>
|
---|
| 131 | <indexterm zone="ch-system-hotplug hotplug-subdirs"><primary
|
---|
| 132 | sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary></indexterm>
|
---|
| 133 | <para>These directories are supposed to contain user-written handlers for
|
---|
| 134 | hotplug events.
|
---|
| 135 | </para>
|
---|
| 136 | </listitem>
|
---|
| 137 | </varlistentry>
|
---|
| 138 |
|
---|
| 139 | <varlistentry id="hotplug-usb.usermap">
|
---|
| 140 | <term><filename>/etc/hotplug/usb.usermap</filename></term>
|
---|
| 141 | <listitem>
|
---|
| 142 | <indexterm zone="ch-system-hotplug hotplug-usb.usermap"><primary
|
---|
| 143 | sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary></indexterm>
|
---|
| 144 | <para>This file contains rules that determine which user-defined handlers to
|
---|
| 145 | call for each USB device, based on its vendor, id and other attributes.
|
---|
| 146 | </para>
|
---|
| 147 | </listitem>
|
---|
| 148 | </varlistentry>
|
---|
| 149 |
|
---|
| 150 | <varlistentry id="hotplug-hotplug.d">
|
---|
| 151 | <term><filename class="directory">/etc/hotplug.d</filename></term>
|
---|
| 152 | <listitem>
|
---|
| 153 | <indexterm zone="ch-system-hotplug hotplug-hotplug.d"><primary
|
---|
| 154 | sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary></indexterm>
|
---|
| 155 | <para>This directory contains programs (or symlinks to them)
|
---|
| 156 | that are interested in receiving hotplug events. E.g.,
|
---|
[33798c5] | 157 | <application>Udev</application> puts its symlink here during installation.
|
---|
[c9214d5] | 158 | </para>
|
---|
| 159 | </listitem>
|
---|
| 160 | </varlistentry>
|
---|
| 161 | </variablelist>
|
---|
| 162 | </sect2>
|
---|
| 163 | </sect1>
|
---|