source: final-system/common/udev.xml@ 7230294

Last change on this file since 7230294 was 18bba3d, checked in by Chris Staub <chris@…>, 18 years ago

Updated udev command descriptions and text, and removed more instances of the obsolete udevdir parameter

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