source: BOOK/final-system/common/udev.xml@ 6cd5eb9

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 6cd5eb9 was 6cd5eb9, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Fix the location of the test suite logs again. Remove a extra comma in the udev installed programs.

  • Property mode set to 100644
File size: 12.4 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 EXTRAS="extras/ata_id extras/cdrom_id extras/collect \
31 extras/edd_id extras/firmware extras/floppy extras/path_id extras/rule_generator \
32 extras/scsi_id extras/usb_id extras/volume_id" udevdir=/dev</userinput></screen>
33
34 <variablelist os="c">
35 <title>The meaning of the make parameter:</title>
36
37 <varlistentry>
38 <term><parameter>EXTRAS="extras/ata_id extras/cdrom_id extras/collect
39 extras/edd_id extras/firmware extras/floppy extras/path_id extras/rule_generator
40 extras/scsi_id extras/usb_id extras/volume_id"</parameter></term>
41 <listitem>
42 <para>This builds the helper applications that are used with
43 udev. The helper programs assist in correct handling of devices.</para>
44 </listitem>
45 </varlistentry>
46
47 </variablelist>
48
49 <para os="d">If you want to run the testsuite, you need to change
50 a hardcoded reference to the <command>test</command> program:</para>
51
52 <screen os="e"><userinput>sed -i 's@/usr/bin/test@/bin/test@' test/udev-test.pl</userinput></screen>
53
54 <para os="f">To test the results, issue:
55 <userinput>make test</userinput>.</para>
56
57 <para os="g">Install the package:</para>
58
59<screen os="h"><userinput>make EXTRAS="extras/ata_id extras/cdrom_id extras/collect \
60 extras/edd_id extras/firmware extras/floppy extras/path_id extras/rule_generator \
61 extras/scsi_id extras/usb_id extras/volume_id" DESTDIR=/ udevdir=/dev install</userinput></screen>
62
63 <variablelist os="i">
64 <title>The meaning of the make parameter:</title>
65
66 <varlistentry>
67 <term><parameter>DESTDIR=/</parameter></term>
68 <listitem>
69 <para>This prevents the Udev build process from killing any
70 <command>udevd</command> processes that may be running on the
71 system.</para>
72 </listitem>
73 </varlistentry>
74
75 </variablelist>
76
77 <para os="j">Install documentation:</para>
78
79<screen os="k"><userinput>install -v -m644 -D docs/writing_udev_rules/index.html \
80 /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
81
82 <para os="l">Create a directory for storing firmware that can be
83 loaded by <command>udev</command>:</para>
84
85<screen os="m"><userinput>install -dv /lib/firmware</userinput></screen>
86
87 </sect2>
88
89 <sect2 id="contents-udev" role="content">
90 <title>Contents of Udev</title>
91
92 <segmentedlist>
93 <segtitle>Installed programs</segtitle>
94 <segtitle>Installed library</segtitle>
95 <segtitle>Installed directory</segtitle>
96
97 <seglistitem>
98 <seg>udevadm, udevd, udevinfo (symlink to udevadm),
99 udevsettle (symlink to udevadm)</seg>
100 <seg>libvolume_id</seg>
101 <seg>/etc/udev, /lib/udev</seg>
102 </seglistitem>
103 </segmentedlist>
104
105 <variablelist>
106 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
107 <?dbfo list-presentation="list"?>
108 <?dbhtml list-presentation="table"?>
109
110 <varlistentry id="udevadm">
111 <term><command>udevadm</command></term>
112 <listitem>
113 <para>This program combines <command>udevinfo</command>,
114 <command>udevtrigger</command>, <command>udevsettle</command>,
115 <command>udevcontrol</command>, <command>udevmonitor</command>,
116 and <command>udevtest</command> into one command.</para>
117 <indexterm zone="ch-system-udev udevadm">
118 <primary sortas="b-udevadm">udevadm</primary>
119 </indexterm>
120 </listitem>
121 </varlistentry>
122
123 <varlistentry id="udevadm-control">
124 <term><command>udevadm control</command></term>
125 <listitem>
126 <para>Configures a number of options for the running
127 <command>udevd</command> daemon, such as the log level. (Symlink to
128 udevadm)</para>
129 <indexterm zone="ch-system-udev udevadm-control">
130 <primary sortas="b-udevadm-control">udevadm control</primary>
131 </indexterm>
132 </listitem>
133 </varlistentry>
134
135 <varlistentry id="udevd">
136 <term><command>udevd</command></term>
137 <listitem>
138 <para>A daemon that reorders hotplug events before submitting them to
139 <command>udev</command>,
140 thus avoiding various race conditions</para>
141 <indexterm zone="ch-system-udev udevd">
142 <primary sortas="b-udevd">udevd</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="udevinfo">
148 <term><command>udevinfo</command></term>
149 <listitem>
150 <para>Allows users to query the <command>udev</command> database for
151 information on any device currently present on the system; it also
152 provides a way to query any device in the <systemitem
153 class="filesystem">sysfs</systemitem> tree to help create udev
154 rules. (Symlink to udevadm)</para>
155 <indexterm zone="ch-system-udev udevinfo">
156 <primary sortas="b-udevinfo">udevinfo</primary>
157 </indexterm>
158 </listitem>
159 </varlistentry>
160
161 <varlistentry id="udevadm-monitor">
162 <term><command>udevadm monitor</command></term>
163 <listitem>
164 <para>Prints the event received from the kernel and the event which
165 <command>udev</command> sends out after rule processing</para>
166 <indexterm zone="ch-system-udev udevadm-monitor">
167 <primary sortas="b-udevadm-monitor">udevadm monitor</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 <varlistentry id="udevsettle">
173 <term><command>udevsettle</command></term>
174 <listitem>
175 <para>Watches the Udev event queue and exits if all current uevents
176 have been handled. (Symlink to udevadm)</para>
177 <indexterm zone="ch-system-udev udevsettle">
178 <primary sortas="b-udevsettle">udevsettle</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="udevadm-test">
184 <term><command>udevadm test</command></term>
185 <listitem>
186 <para>Simulates a <command>udev</command> run for the given device,
187 and prints out the name of the node the real <command>udev</command>
188 would have created or the name of the renamed network interface</para>
189 <indexterm zone="ch-system-udev udevadm-test">
190 <primary sortas="b-udevadm-test">udevadm test</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="udevadm-trigger">
196 <term><command>udevadm trigger</command></term>
197 <listitem>
198 <para>Walks the sysfs tree for devices that need to be added to the
199 system.</para>
200 <indexterm zone="ch-system-udev udevadm-trigger">
201 <primary sortas="b-udeadm-vtrigger">udevadm trigger</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <!-- Start of Helpers -->
207 <varlistentry id="ata_id">
208 <term><command>ata_id</command></term>
209 <listitem>
210 <para>Provides Udev with a unique string and additional
211 information (uuid, label) for an ATA drive</para>
212 <indexterm zone="ch-system-udev ata_id">
213 <primary sortas="b-ata_id">ata_id</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="cdrom_id">
219 <term><command>cdrom_id</command></term>
220 <listitem>
221 <para>Print the capabilities of a CDROM or DVDROM drive.</para>
222 <indexterm zone="ch-system-udev cdrom_id">
223 <primary sortas="b-cdrom_id">cdrom_id</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="create_floppy_devices">
229 <term><command>create_floppy_devices</command></term>
230 <listitem>
231 <para>Creates all possible floppy devices based on the CMOS type</para>
232 <indexterm zone="ch-system-udev create_floppy_devices">
233 <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="dasd_id">
239 <term><command>dasd_id</command></term>
240 <listitem>
241 <para>Read the label from an s390 block device.</para>
242 <indexterm zone="ch-system-udev dasd_id">
243 <primary sortas="b-dasd_id">dasd_id</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="edd_id">
249 <term><command>edd_id</command></term>
250 <listitem>
251 <para>Identify x86 disk drives from Enhanced Disk Drive calls.</para>
252 <indexterm zone="ch-system-udev edd_id">
253 <primary sortas="b-edd_id">edd_id</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="firmware.sh">
259 <term><command>firmware.sh</command></term>
260 <listitem>
261 <para>Script to load firmware for a device</para>
262 <indexterm zone="ch-system-udev firmware.sh">
263 <primary sortas="b-firmware.sh">firmware.sh</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="path_id">
269 <term><command>path_id</command></term>
270 <listitem>
271 <para>Provide the shortest possible unique hardware path to a
272 device</para>
273 <indexterm zone="ch-system-udev path_id">
274 <primary sortas="b-path_id">path_id</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="scsi_id">
280 <term><command>scsi_id</command></term>
281 <listitem>
282 <para>Retrieve or generate a unique SCSI identifier.</para>
283 <indexterm zone="ch-system-udev scsi_id">
284 <primary sortas="b-scsi_id">scsi_id</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="usb_id">
290 <term><command>usb_id</command></term>
291 <listitem>
292 <para>Identify a USB block device.</para>
293 <indexterm zone="ch-system-udev usb_id">
294 <primary sortas="b-usb_id">usb_id</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="vol_id">
300 <term><command>vol_id</command></term>
301 <listitem>
302 <para>Probe filesystem type and read label and uuid.</para>
303 <indexterm zone="ch-system-udev vol_id">
304 <primary sortas="b-vol_id">vol_id</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308<!-- End of Helpers -->
309
310 <varlistentry id="libvolume_id">
311 <term><filename class="libraryfile">libvolume_id</filename></term>
312 <listitem>
313 <para>This library provides programs such as <command>vol_id</command>
314 with a filesystems type, abel, and uuid from a device node or a
315 image.</para>
316 <indexterm zone="ch-system-udev libvolume_id">
317 <primary sortas="b-libvolume_id">libvolume_id</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="etc-udev">
323 <term><filename class="directory">/etc/udev</filename></term>
324 <listitem>
325 <para>Contains <command>udev</command> configuration files,
326 device permissions, and rules for device naming</para>
327 <indexterm zone="ch-system-udev etc-udev">
328 <primary sortas="e-/etc/udev">/etc/udev</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="lib-udev">
334 <term><filename class="directory">/lib/udev</filename></term>
335 <listitem>
336 <para>Contains <command>udev</command> helper programs
337 and static devices which get copied to /dev when booted.</para>
338 <indexterm zone="ch-system-udev lib-udev">
339 <primary sortas="e-/lib/udev">/lib/udev</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343 </variablelist>
344
345 </sect2>
346
347</sect1>
Note: See TracBrowser for help on using the repository browser.