source: clfs-sysroot/BOOK/final-system/common/udev.xml@ f1f6d91

Last change on this file since f1f6d91 was c439b8a, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Updated CLFS-Sysroot book sources to use DocBook-XML DTD 4.5.

  • Property mode set to 100644
File size: 10.8 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-system-udev" role="wrap">
9 <?dbhtml filename="udev.html"?>
10
11 <title>Udev-&udev-version;</title>
12
13 <indexterm zone="ch-system-udev">
14 <primary sortas="a-Udev">Udev</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Udev package contains programs for dynamic creation of device
21 nodes.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Udev</title>
27
28 <para os="a">Compile the package:</para>
29
30<screen os="b"><userinput>make CROSS_COMPILE="${CLFS_TARGET}-" CC="${CC}" LD="${CC}" \
31 EXTRAS="extras/floppy extras/cdrom_id extras/firmware \
32 extras/scsi_id extras/volume_id extras/ata_id extras/usb_id \
33 extras/edd_id extras/dasd_id extras/path_id"</userinput></screen>
34
35 <variablelist os="c">
36 <title>The meaning of the make parameter:</title>
37
38 <varlistentry>
39 <term><parameter>EXTRAS="extras/floppy extras/cdrom_id extras/firmware
40 extras/scsi_id extras/volume_id extras/ata_id extras/usb_id extras/edd_id
41 extras/dasd_id extras/path_id"</parameter></term>
42 <listitem>
43 <para>This builds the helper applications that are used with
44 udev. The helper programs assist in correct handling of devices.</para>
45 </listitem>
46 </varlistentry>
47
48 </variablelist>
49
50 <para os="c">Install the package:</para>
51
52<screen os="d"><userinput>make DESTDIR="${CLFS}" \
53 EXTRAS="extras/floppy extras/cdrom_id extras/firmware \
54 extras/scsi_id extras/volume_id extras/ata_id extras/usb_id \
55 extras/edd_id extras/dasd_id extras/path_id" install</userinput></screen>
56
57 <para os="e">Install a necessary helper script.</para>
58
59<screen os="f"><userinput>install -v extras/eventrecorder.sh ${CLFS}/lib/udev</userinput></screen>
60
61 <para os="g">Install the documentation that explains how to create
62 Udev rules:</para>
63
64<screen os="h"><userinput>install -v -m644 -D docs/writing_udev_rules/index.html \
65 ${CLFS}/usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
66
67 <para os="i">Create a directory for storing firmware that can be
68 loaded by <command>udev</command>:</para>
69
70<screen os="j"><userinput>install -dv ${CLFS}/lib/firmware</userinput></screen>
71
72 <para os="k">Finally, remove the rules installed by Udev as we will be
73 installing custom Udev rules later:</para>
74
75<screen os="l"><userinput>rm -v ${CLFS}/etc/udev/rules.d/*</userinput></screen>
76
77 </sect2>
78
79 <sect2 id="contents-udev" role="content">
80 <title>Contents of Udev</title>
81
82 <segmentedlist>
83 <segtitle>Installed programs</segtitle>
84 <segtitle>Installed directory</segtitle>
85
86 <seglistitem>
87 <seg>udevcontrol, udevd, udevinfo, udevmonitor, udevsend,
88 udevtest, and udevtrigger</seg>
89 <seg>/etc/udev</seg>
90 </seglistitem>
91 </segmentedlist>
92
93 <variablelist>
94 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
95 <?dbfo list-presentation="list"?>
96 <?dbhtml list-presentation="table"?>
97
98 <varlistentry id="udevcontrol">
99 <term><command>udevcontrol</command></term>
100 <listitem>
101 <para>Configures a number of options for the running
102 <command>udevd</command> daemon, such as the log level.</para>
103 <indexterm zone="ch-system-udev udevcontrol">
104 <primary sortas="b-udevcontrol">udevcontrol</primary>
105 </indexterm>
106 </listitem>
107 </varlistentry>
108
109 <varlistentry id="udevd">
110 <term><command>udevd</command></term>
111 <listitem>
112 <para>A daemon that reorders hotplug events before submitting them to
113 <command>udev</command>,
114 thus avoiding various race conditions</para>
115 <indexterm zone="ch-system-udev udevd">
116 <primary sortas="b-udevd">udevd</primary>
117 </indexterm>
118 </listitem>
119 </varlistentry>
120
121 <varlistentry id="udevinfo">
122 <term><command>udevinfo</command></term>
123 <listitem>
124 <para>Allows users to query the <command>udev</command> database for
125 information on any device currently present on the system; it also
126 provides a way to query any device in the <systemitem
127 class="filesystem">sysfs</systemitem> tree to help create udev
128 rules</para>
129 <indexterm zone="ch-system-udev udevinfo">
130 <primary sortas="b-udevinfo">udevinfo</primary>
131 </indexterm>
132 </listitem>
133 </varlistentry>
134
135 <varlistentry id="udevmonitor">
136 <term><command>udevmonitor</command></term>
137 <listitem>
138 <para>Prints the event received from the kernel and the event which
139 <command>udev</command> sends out after rule processing</para>
140 <indexterm zone="ch-system-udev udevmonitor">
141 <primary sortas="b-udevmonitor">udevmonitor</primary>
142 </indexterm>
143 </listitem>
144 </varlistentry>
145
146 <varlistentry id="udevsettle">
147 <term><command>udevsettle</command></term>
148 <listitem>
149 <para>Watches the Udev event queue and exits if all current uevents
150 have been handled</para>
151 <indexterm zone="ch-system-udev udevsettle">
152 <primary sortas="b-udevsettle">udevsettle</primary>
153 </indexterm>
154 </listitem>
155 </varlistentry>
156
157 <varlistentry id="udevtest">
158 <term><command>udevtest</command></term>
159 <listitem>
160 <para>Simulates a <command>udev</command> run for the given device,
161 and prints out the name of the node the real <command>udev</command>
162 would have created or the name of the renamed network interface</para>
163 <indexterm zone="ch-system-udev udevtest">
164 <primary sortas="b-udevtest">udevtest</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry id="udevtrigger">
170 <term><command>udevtrigger</command></term>
171 <listitem>
172 <para>Walks the sysfs tree for devices that need to be added to the
173 system.</para>
174 <indexterm zone="ch-system-udev udevtrigger">
175 <primary sortas="b-udevtrigger">udevtrigger</primary>
176 </indexterm>
177 </listitem>
178 </varlistentry>
179
180 <!-- helpers start here -->
181 <varlistentry id="ata_id">
182 <term><command>ata_id</command></term>
183 <listitem>
184 <para>Provides Udev with a unique string and additional
185 information (uuid, label) for an ATA drive</para>
186 <indexterm zone="ch-system-udev ata_id">
187 <primary sortas="b-ata_id">ata_id</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
191
192 <varlistentry id="cdrom_id">
193 <term><command>cdrom_id</command></term>
194 <listitem>
195 <para>Print the capabilities of a CDROM or DVDROM drive.</para>
196 <indexterm zone="ch-system-udev cdrom_id">
197 <primary sortas="b-cdrom_id">cdrom_id</primary>
198 </indexterm>
199 </listitem>
200 </varlistentry>
201
202 <varlistentry id="create_floppy_devices">
203 <term><command>create_floppy_devices</command></term>
204 <listitem>
205 <para>Creates all possible floppy devices based on the CMOS type</para>
206 <indexterm zone="ch-system-udev create_floppy_devices">
207 <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="dasd_id">
213 <term><command>dasd_id</command></term>
214 <listitem>
215 <para>Read the label from an s390 block device.</para>
216 <indexterm zone="ch-system-udev dasd_id">
217 <primary sortas="b-dasd_id">dasd_id</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="edd_id">
223 <term><command>edd_id</command></term>
224 <listitem>
225 <para>Identify x86 disk drives from Enhanced Disk Drive calls.</para>
226 <indexterm zone="ch-system-udev edd_id">
227 <primary sortas="b-edd_id">edd_id</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="firmware.sh">
233 <term><command>firmware.sh</command></term>
234 <listitem>
235 <para>Script to load firmware for a device</para>
236 <indexterm zone="ch-system-udev firmware.sh">
237 <primary sortas="b-firmware.sh">firmware.sh</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="path_id">
243 <term><command>path_id</command></term>
244 <listitem>
245 <para>Provide the shortest possible unique hardware path to a
246 device</para>
247 <indexterm zone="ch-system-udev path_id">
248 <primary sortas="b-path_id">path_id</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="scsi_id">
254 <term><command>scsi_id</command></term>
255 <listitem>
256 <para>Retrieve or generate a unique SCSI identifier.</para>
257 <indexterm zone="ch-system-udev scsi_id">
258 <primary sortas="b-scsi_id">scsi_id</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="usb_id">
264 <term><command>usb_id</command></term>
265 <listitem>
266 <para>Identify a USB block device.</para>
267 <indexterm zone="ch-system-udev usb_id">
268 <primary sortas="b-usb_id">usb_id</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="vol_id">
274 <term><command>vol_id</command></term>
275 <listitem>
276 <para>Probe filesystem type and read label and uuid.</para>
277 <indexterm zone="ch-system-udev vol_id">
278 <primary sortas="b-vol_id">vol_id</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="etc-udev">
284 <term><filename class="directory">/etc/udev</filename></term>
285 <listitem>
286 <para>Contains <command>udev</command> configuration files,
287 device permissions, and rules for device naming</para>
288 <indexterm zone="ch-system-udev etc-udev">
289 <primary sortas="e-/etc/udev">/etc/udev</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="lib-udev">
295 <term><filename class="directory">/lib/udev</filename></term>
296 <listitem>
297 <para>Contains <command>udev</command> helper programs
298 and static devices which get copied to /dev when booted.</para>
299 <indexterm zone="ch-system-udev lib-udev">
300 <primary sortas="e-/lib/udev">/lib/udev</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304 </variablelist>
305
306 </sect2>
307
308</sect1>
Note: See TracBrowser for help on using the repository browser.