1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/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
|
---|
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 |
|
---|
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 |
|
---|
27 | <segmentedlist>
|
---|
28 | <segtitle>&dependencies;</segtitle>
|
---|
29 | <seglistitem><seg>Unchecked</seg></seglistitem>
|
---|
30 | </segmentedlist>
|
---|
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 |
|
---|
50 | <para>Create a file that is necessary for the logging of hotplug events:</para>
|
---|
51 |
|
---|
52 | <screen><userinput>touch /var/log/hotplug/events</userinput></screen>
|
---|
53 |
|
---|
54 | <para>Create a directory for storing firmware that can be loaded by
|
---|
55 | <command>hotplug</command>:</para>
|
---|
56 |
|
---|
57 | <screen><userinput>mkdir /lib/firmware</userinput></screen>
|
---|
58 |
|
---|
59 | </sect2>
|
---|
60 |
|
---|
61 |
|
---|
62 | <sect2 id="contents-hotplug" role="content"><title>Contents of Hotplug</title>
|
---|
63 |
|
---|
64 | <segmentedlist>
|
---|
65 | <segtitle>Installed program</segtitle>
|
---|
66 | <segtitle>Installed scripts</segtitle>
|
---|
67 | <segtitle>Installed files</segtitle>
|
---|
68 | <seglistitem><seg>hotplug</seg>
|
---|
69 | <seg>/etc/hotplug/*.rc, /etc/hotplug/*.agent</seg>
|
---|
70 | <seg>/etc/hotplug/hotplug.functions, /etc/hotplug/blacklist, /etc/hotplug/{pci,usb},
|
---|
71 | /etc/hotplug/usb.usermap, /etc/hotplug.d, /var/log/hotplug/events</seg></seglistitem>
|
---|
72 | </segmentedlist>
|
---|
73 |
|
---|
74 | <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
75 | <?dbfo list-presentation="list"?>
|
---|
76 | <?dbhtml list-presentation="table"?>
|
---|
77 |
|
---|
78 | <varlistentry id="hotplug">
|
---|
79 | <term><command>hotplug</command></term>
|
---|
80 | <listitem>
|
---|
81 | <indexterm zone="ch-system-hotplug hotplug"><primary
|
---|
82 | sortas="b-hotplug">hotplug</primary></indexterm>
|
---|
83 | <para>This script is called by default by the Linux kernel when something
|
---|
84 | changes in its internal state (e.g., a new device is added or removed)</para>
|
---|
85 | </listitem>
|
---|
86 | </varlistentry>
|
---|
87 |
|
---|
88 | <varlistentry id="hotplug-rc">
|
---|
89 | <term><command>/etc/hotplug/*.rc</command></term>
|
---|
90 | <listitem>
|
---|
91 | <indexterm zone="ch-system-hotplug hotplug-rc"><primary
|
---|
92 | sortas="d-/etc/hotplug/*.rc">/etc/hotplug/*.rc</primary></indexterm>
|
---|
93 | <para>These scripts are used for cold plugging, i.e., detecting and acting upon
|
---|
94 | hardware already present during system startup. They are called by the
|
---|
95 | <filename>hotplug</filename> initscript that comes from the LFS-Bootscripts
|
---|
96 | package. The <command>*.rc</command> scripts try to recover hotplug events that
|
---|
97 | were lost during system boot because, for example, the root filesystem was not
|
---|
98 | mounted by the kernel</para>
|
---|
99 | </listitem>
|
---|
100 | </varlistentry>
|
---|
101 |
|
---|
102 | <varlistentry id="hotplug-agent">
|
---|
103 | <term><command>/etc/hotplug/*.agent</command></term>
|
---|
104 | <listitem>
|
---|
105 | <indexterm zone="ch-system-hotplug hotplug-agent"><primary
|
---|
106 | sortas="d-/etc/hotplug/*.agent">/etc/hotplug/*.agent</primary></indexterm>
|
---|
107 | <para>These scripts are called by <command>hotplug</command>
|
---|
108 | in response to different types of hotplug events generated by the kernel.
|
---|
109 | Their action is to insert corresponding kernel modules and call any
|
---|
110 | user-provided scripts</para>
|
---|
111 | </listitem>
|
---|
112 | </varlistentry>
|
---|
113 |
|
---|
114 | <varlistentry id="hotplug-blacklist">
|
---|
115 | <term><filename>/etc/hotplug/blacklist</filename></term>
|
---|
116 | <listitem>
|
---|
117 | <indexterm zone="ch-system-hotplug hotplug-blacklist"><primary
|
---|
118 | sortas="e-/etc/hotplug/blacklist">/etc/hotplug/blacklist</primary></indexterm>
|
---|
119 | <para>This file contains the list of modules that should never be inserted into
|
---|
120 | the kernel by the Hotplug scripts</para>
|
---|
121 | </listitem>
|
---|
122 | </varlistentry>
|
---|
123 |
|
---|
124 | <varlistentry id="hotplug-functions">
|
---|
125 | <term><filename>/etc/hotplug/hotplug.functions</filename></term>
|
---|
126 | <listitem>
|
---|
127 | <indexterm zone="ch-system-hotplug hotplug-functions"><primary
|
---|
128 | sortas="e-/etc/hotplug/hotplug.functions">/etc/hotplug/hotplug.functions</primary></indexterm>
|
---|
129 | <para>This file contains common functions used by other scripts in the Hotplug
|
---|
130 | package</para>
|
---|
131 | </listitem>
|
---|
132 | </varlistentry>
|
---|
133 |
|
---|
134 | <varlistentry id="hotplug-subdirs">
|
---|
135 | <term><filename class="directory">/etc/hotplug/{pci,usb}</filename></term>
|
---|
136 | <listitem>
|
---|
137 | <indexterm zone="ch-system-hotplug hotplug-subdirs"><primary
|
---|
138 | sortas="e-/etc/hotplug/{pci,usb}">/etc/hotplug/{pci,usb}</primary></indexterm>
|
---|
139 | <para>These directories contain user-written handlers for hotplug events</para>
|
---|
140 | </listitem>
|
---|
141 | </varlistentry>
|
---|
142 |
|
---|
143 | <varlistentry id="hotplug-usb.usermap">
|
---|
144 | <term><filename>/etc/hotplug/usb.usermap</filename></term>
|
---|
145 | <listitem>
|
---|
146 | <indexterm zone="ch-system-hotplug hotplug-usb.usermap"><primary
|
---|
147 | sortas="e-/etc/hotplug/usb.usermap">/etc/hotplug/usb.usermap</primary></indexterm>
|
---|
148 | <para>This file contains rules that determine which user-defined handlers to
|
---|
149 | call for each USB device, based on its vendor ID and other attributes</para>
|
---|
150 | </listitem>
|
---|
151 | </varlistentry>
|
---|
152 |
|
---|
153 | <varlistentry id="hotplug-hotplug.d">
|
---|
154 | <term><filename class="directory">/etc/hotplug.d</filename></term>
|
---|
155 | <listitem>
|
---|
156 | <indexterm zone="ch-system-hotplug hotplug-hotplug.d"><primary
|
---|
157 | sortas="e-/etc/hotplug.d">/etc/hotplug.d</primary></indexterm>
|
---|
158 | <para>This directory contains programs (or symlinks to them) that are interested
|
---|
159 | in receiving hotplug events. For example, <application>Udev</application> puts
|
---|
160 | its symlink here during installation</para>
|
---|
161 | </listitem>
|
---|
162 | </varlistentry>
|
---|
163 |
|
---|
164 | <varlistentry id="hotplug-firmware">
|
---|
165 | <term><filename class="directory">/lib/firmware</filename></term>
|
---|
166 | <listitem>
|
---|
167 | <indexterm zone="ch-system-hotplug hotplug-firmware"><primary
|
---|
168 | sortas="e-/lib/firmware">/lib/firmware</primary></indexterm>
|
---|
169 | <para>This directory contains the firmware for devices that need to have their
|
---|
170 | firmware loaded before use</para>
|
---|
171 | </listitem>
|
---|
172 | </varlistentry>
|
---|
173 |
|
---|
174 | <varlistentry id="hotplug-events">
|
---|
175 | <term><filename>/var/log/hotplug/events</filename></term>
|
---|
176 | <listitem>
|
---|
177 | <indexterm zone="ch-system-hotplug hotplug-events"><primary
|
---|
178 | sortas="e-/var/log/hotplug/events">/var/log/hotplug/events</primary></indexterm>
|
---|
179 | <para>This file contains all the events that <command>hotplug</command> has
|
---|
180 | called since bootup</para>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | </variablelist>
|
---|
185 | </sect2>
|
---|
186 | </sect1>
|
---|