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

Last change on this file since 4d7d245 was 4d7d245, checked in by Joe Ciccone <jciccone@…>, 18 years ago

Added remaining descriptions for udev helpers, and put them in alphabetical order.

  • Property mode set to 100644
File size: 10.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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" udevdir=/dev</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" udevdir=/dev install</userinput></screen>
56
57 <para os="e">Install necessary helpers.</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 </sect2>
73
74 <sect2 id="contents-udev" role="content">
75 <title>Contents of Udev</title>
76
77 <segmentedlist>
78 <segtitle>Installed programs</segtitle>
79 <segtitle>Installed directory</segtitle>
80
81 <seglistitem>
82 <seg>udevcontrol, udevd, udevinfo, udevmonitor, udevsend,
83 udevtest, and udevtrigger</seg>
84 <seg>/etc/udev</seg>
85 </seglistitem>
86 </segmentedlist>
87
88 <variablelist>
89 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
90 <?dbfo list-presentation="list"?>
91 <?dbhtml list-presentation="table"?>
92
93 <varlistentry id="udevcontrol">
94 <term><command>udevcontrol</command></term>
95 <listitem>
96 <para>Configures a number of options for the running
97 <command>udevd</command> daemon, such as the log level.</para>
98 <indexterm zone="ch-system-udev udevcontrol">
99 <primary sortas="b-udevcontrol">udevcontrol</primary>
100 </indexterm>
101 </listitem>
102 </varlistentry>
103
104 <varlistentry id="udevd">
105 <term><command>udevd</command></term>
106 <listitem>
107 <para>A daemon that reorders hotplug events before submitting them to
108 <command>udev</command>,
109 thus avoiding various race conditions</para>
110 <indexterm zone="ch-system-udev udevd">
111 <primary sortas="b-udevd">udevd</primary>
112 </indexterm>
113 </listitem>
114 </varlistentry>
115
116 <varlistentry id="udevinfo">
117 <term><command>udevinfo</command></term>
118 <listitem>
119 <para>Allows users to query the <command>udev</command> database for
120 information on any device currently present on the system; it also
121 provides a way to query any device in the <systemitem
122 class="filesystem">sysfs</systemitem> tree to help create udev
123 rules</para>
124 <indexterm zone="ch-system-udev udevinfo">
125 <primary sortas="b-udevinfo">udevinfo</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="udevmonitor">
131 <term><command>udevmonitor</command></term>
132 <listitem>
133 <para>Prints the event received from the kernel and the event which
134 <command>udev</command> sends out after rule processing</para>
135 <indexterm zone="ch-system-udev udevmonitor">
136 <primary sortas="b-udevmonitor">udevmonitor</primary>
137 </indexterm>
138 </listitem>
139 </varlistentry>
140
141 <varlistentry id="udevsettle">
142 <term><command>udevsettle</command></term>
143 <listitem>
144 <para>Watches the Udev event queue and exits if all current uevents
145 have been handled</para>
146 <indexterm zone="ch-system-udev udevsettle">
147 <primary sortas="b-udevsettle">udevsettle</primary>
148 </indexterm>
149 </listitem>
150 </varlistentry>
151
152 <varlistentry id="udevtest">
153 <term><command>udevtest</command></term>
154 <listitem>
155 <para>Simulates a <command>udev</command> run for the given device,
156 and prints out the name of the node the real <command>udev</command>
157 would have created or (not in CLFS) the name of the renamed network
158 interface</para>
159 <indexterm zone="ch-system-udev udevtest">
160 <primary sortas="b-udevtest">udevtest</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="udevtrigger">
166 <term><command>udevtrigger</command></term>
167 <listitem>
168 <para>Walks the sysfs tree for devices that need to be added to the
169 system.</para>
170 <indexterm zone="ch-system-udev udevtrigger">
171 <primary sortas="b-udevtrigger">udevtrigger</primary>
172 </indexterm>
173 </listitem>
174 </varlistentry>
175
176 <!-- helpers start here -->
177 <varlistentry id="ata_id">
178 <term><command>ata_id</command></term>
179 <listitem>
180 <para>Provides Udev with a unique string and additional
181 information (uuid, label) for an ATA drive</para>
182 <indexterm zone="ch-system-udev ata_id">
183 <primary sortas="b-ata_id">ata_id</primary>
184 </indexterm>
185 </listitem>
186 </varlistentry>
187
188 <varlistentry id="cdrom_id">
189 <term><command>cdrom_id</command></term>
190 <listitem>
191 <para>Print the capabilities of a cdrom or dvdrom drive.</para>
192 <indexterm zone="ch-system-udev cdrom_id">
193 <primary sortas="b-cdrom_id">cdrom_id</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="create_floppy_devices">
199 <term><command>create_floppy_devices</command></term>
200 <listitem>
201 <para>Creates all possible floppy devices based on the CMOS type</para>
202 <indexterm zone="ch-system-udev create_floppy_devices">
203 <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
204 </indexterm>
205 </listitem>
206 </varlistentry>
207
208 <varlistentry id="dasd_id">
209 <term><command>dasd_id</command></term>
210 <listitem>
211 <para>Read the label from an s390 block device.</para>
212 <indexterm zone="ch-system-udev dasd_id">
213 <primary sortas="b-dasd_id">dasd_id</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="edd_id">
219 <term><command>edd_id</command></term>
220 <listitem>
221 <para>Identify x86 disk drives from Enhanced Disk Drive calls.</para>
222 <indexterm zone="ch-system-udev edd_id">
223 <primary sortas="b-edd_id">edd_id</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="firmware.sh">
229 <term><command>firmware.sh</command></term>
230 <listitem>
231 <para>Script to load firmware for a device</para>
232 <indexterm zone="ch-system-udev firmware.sh">
233 <primary sortas="b-firmware.sh">firmware.sh</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="path_id">
239 <term><command>path_id</command></term>
240 <listitem>
241 <para>Provide the shortest possible unique hardware path to a
242 device</para>
243 <indexterm zone="ch-system-udev path_id">
244 <primary sortas="b-path_id">path_id</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="scsi_id">
250 <term><command>scsi_id</command></term>
251 <listitem>
252 <para>Retrieve or generate a unique SCSI identifier.</para>
253 <indexterm zone="ch-system-udev scsi_id">
254 <primary sortas="b-scsi_id">scsi_id</primary>
255 </indexterm>
256 </listitem>
257 </varlistentry>
258
259 <varlistentry id="usb_id">
260 <term><command>usb_id</command></term>
261 <listitem>
262 <para>Identify a usb block device.</para>
263 <indexterm zone="ch-system-udev usb_id">
264 <primary sortas="b-usb_id">usb_id</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="vol_id">
270 <term><command>vol_id</command></term>
271 <listitem>
272 <para>Probe filesystem type and read label and uuid.</para>
273 <indexterm zone="ch-system-udev vol_id">
274 <primary sortas="b-vol_id">vol_id</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="etc-udev">
280 <term><filename class="directory">/etc/udev</filename></term>
281 <listitem>
282 <para>Contains <command>udev</command> configuation files,
283 device permissions, and rules for device naming</para>
284 <indexterm zone="ch-system-udev etc-udev">
285 <primary sortas="e-/etc/udev">/etc/udev</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="lib-udev">
291 <term><filename class="directory">/lib/udev</filename></term>
292 <listitem>
293 <para>Contains <command>udev</command> helper programs
294 and static devices which get copied to /dev when booted.</para>
295 <indexterm zone="ch-system-udev lib-udev">
296 <primary sortas="e-/lib/udev">/lib/udev</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300 </variablelist>
301
302 </sect2>
303
304</sect1>
Note: See TracBrowser for help on using the repository browser.