source: final-system/common/udev.xml@ 761ad5b

Last change on this file since 761ad5b was 761ad5b, checked in by Jim Gifford <clfs@…>, 19 years ago

r2847@server (orig r1365): chris | 2006-04-12 22:37:52 -0700
Cleaned up the udev installation text so the lines aren't so long, and added more -v switches and other minor text fixes.

  • Property mode set to 100644
File size: 10.0 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 <segmentedlist>
24 <segtitle>&dependencies;</segtitle>
25
26 <seglistitem>
27 <seg>Coreutils, GCC, Make, Perl, and Tree</seg>
28 </seglistitem>
29 </segmentedlist>
30
31 </sect2>
32
33 <sect2 role="installation">
34 <title>Installation of Udev</title>
35
36 <para os="a">Compile the package:</para>
37
38<screen os="b"><userinput>make EXTRAS="extras/floppy extras/cdrom_id extras/firmware \
39 extras/scsi_id extras/volume_id extras/ata_id extras/usb_id extras/edd_id extras/dasd_id \
40 extras/path_id" udevdir=/dev</userinput></screen>
41
42 <variablelist os="c">
43 <title>The meaning of the make parameter:</title>
44
45 <varlistentry>
46 <term><parameter>EXTRAS="extras/floppy extras/cdrom_id extras/firmware
47 extras/scsi_id extras/volume_id extras/ata_id extras/usb_id extras/edd_id
48 extras/dasd_id extras/path_id"</parameter></term>
49 <listitem>
50 <para>This builds the helper applications that are used with
51 udev. The helper programs assist in correct handling of devices.</para>
52 </listitem>
53 </varlistentry>
54
55 </variablelist>
56
57 <para os="d">If you want to run the testsuite, you need to change
58 a hardcoded reference to the <command>test</command>
59 program:</para>
60
61 <screen os="e"><userinput>sed -i 's@/usr/bin/test@/bin/test@' test/udev-test.pl</userinput></screen>
62
63 <para os="f">To test the results, issue:
64 <userinput>make test</userinput>.</para>
65
66 <para os="g">Install the package:</para>
67
68<screen os="h"><userinput>make DESTDIR=/ \
69 EXTRAS="extras/floppy extras/cdrom_id extras/firmware extras/scsi_id \
70 extras/volume_id extras/ata_id extras/usb_id extras/edd_id extras/dasd_id \
71 extras/path_id" udevdir=/dev install</userinput></screen>
72
73 <variablelist os="i">
74 <title>The meaning of the make parameter:</title>
75
76 <varlistentry>
77 <term><parameter>DESTDIR=/</parameter></term>
78 <listitem>
79 <para>This prevents the Udev build process from killing any
80 <command>udevd</command> processes that may be running on the
81 system.</para>
82 </listitem>
83 </varlistentry>
84
85 </variablelist>
86
87 <para os="i">Install necessary helpers.</para>
88
89<screen os="j"><userinput>install -Dv extras/eventrecorder.sh /lib/udev</userinput></screen>
90
91 <para os="l">Install the documentation that explains how to create
92 Udev rules:</para>
93
94<screen os="m"><userinput>install -v -m644 -D docs/writing_udev_rules/index.html \
95 /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
96
97 <para os="n">Create a directory for storing firmware that can be
98 loaded by <command>udev</command>:</para>
99
100<screen os="o"><userinput>install -dv /lib/firmware</userinput></screen>
101
102 </sect2>
103
104 <sect2 id="contents-udev" role="content">
105 <title>Contents of Udev</title>
106
107 <segmentedlist>
108 <segtitle>Installed programs</segtitle>
109 <segtitle>Installed directory</segtitle>
110
111 <seglistitem>
112 <seg>udevcontrol, udevd, udevinfo, udevmonitor, udevsend,
113 udevtest, and udevtrigger</seg>
114 <seg>/etc/udev</seg>
115 </seglistitem>
116 </segmentedlist>
117
118 <variablelist>
119 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
120 <?dbfo list-presentation="list"?>
121 <?dbhtml list-presentation="table"?>
122
123 <varlistentry id="udevcontrol">
124 <term><command>udevcontrol</command></term>
125 <listitem>
126 <para>Configures a number of options for the running
127 <command>udevd</command> daemon, such as the log level.</para>
128 <indexterm zone="ch-system-udev udevcontrol">
129 <primary sortas="b-udevcontrol">udevcontrol</primary>
130 </indexterm>
131 </listitem>
132 </varlistentry>
133
134 <varlistentry id="udevd">
135 <term><command>udevd</command></term>
136 <listitem>
137 <para>A daemon that reorders hotplug events before submitting them to
138 <command>udev</command>,
139 thus avoiding various race conditions</para>
140 <indexterm zone="ch-system-udev udevd">
141 <primary sortas="b-udevd">udevd</primary>
142 </indexterm>
143 </listitem>
144 </varlistentry>
145
146 <varlistentry id="udevinfo">
147 <term><command>udevinfo</command></term>
148 <listitem>
149 <para>Allows users to query the <command>udev</command> database for
150 information on any device currently present on the system; it also
151 provides a way to query any device in the <systemitem
152 class="filesystem">sysfs</systemitem> tree to help create udev
153 rules</para>
154 <indexterm zone="ch-system-udev udevinfo">
155 <primary sortas="b-udevinfo">udevinfo</primary>
156 </indexterm>
157 </listitem>
158 </varlistentry>
159
160 <varlistentry id="udevmonitor">
161 <term><command>udevmonitor</command></term>
162 <listitem>
163 <para>Prints the event received from the kernel and the event which
164 <command>udev</command> sends out after rule processing</para>
165 <indexterm zone="ch-system-udev udevmonitor">
166 <primary sortas="b-udevmonitor">udevmonitor</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry id="udevtest">
172 <term><command>udevtest</command></term>
173 <listitem>
174 <para>Simulates a <command>udev</command> run for the given device,
175 and prints out the name of the node the real <command>udev</command>
176 would have created or (not in LFS) the name of the renamed network
177 interface</para>
178 <indexterm zone="ch-system-udev udevtest">
179 <primary sortas="b-udevtest">udevtest</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="udevtrigger">
185 <term><command>udevtrigger</command></term>
186 <listitem>
187 <para>Walks the sysfs tree for devices that need to be added to the
188 system.</para>
189 <indexterm zone="ch-system-udev udevtrigger">
190 <primary sortas="b-udevtrigger">udevtrigger</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="cdrom_id">
196 <term><command>cdrom_id</command></term>
197 <listitem>
198 <para>To be written</para>
199 <indexterm zone="ch-system-udev cdrom_id">
200 <primary sortas="b-cdrom_id">cdrom_id</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="firmware_helper">
206 <term><command>firmware_helper</command></term>
207 <listitem>
208 <para>To be written</para>
209 <indexterm zone="ch-system-udev firmware_helper">
210 <primary sortas="b-firmware_helper">firmware_helper</primary>
211 </indexterm>
212 </listitem>
213 </varlistentry>
214
215 <varlistentry id="scsi_id">
216 <term><command>scsi_id</command></term>
217 <listitem>
218 <para>To be written</para>
219 <indexterm zone="ch-system-udev scsi_id">
220 <primary sortas="b-scsi_id">scsi_id</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="volume_id">
226 <term><command>volume_id</command></term>
227 <listitem>
228 <para>To be written</para>
229 <indexterm zone="ch-system-udev volume_id">
230 <primary sortas="b-volume_id">volume_id</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="ata_id">
236 <term><command>ata_id</command></term>
237 <listitem>
238 <para>To be written</para>
239 <indexterm zone="ch-system-udev ata_id">
240 <primary sortas="b-volume_id">ata_id</primary>
241 </indexterm>
242 </listitem>
243 </varlistentry>
244
245 <varlistentry id="usb_id">
246 <term><command>usb_id</command></term>
247 <listitem>
248 <para>To be written</para>
249 <indexterm zone="ch-system-udev usb_id">
250 <primary sortas="b-usb_id">usb_id</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="edd_id">
256 <term><command>edd_id</command></term>
257 <listitem>
258 <para>To be written</para>
259 <indexterm zone="ch-system-udev edd_id">
260 <primary sortas="b-edd_id">edd_id</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="dasd_id">
266 <term><command>dasd_id</command></term>
267 <listitem>
268 <para>To be written</para>
269 <indexterm zone="ch-system-udev dasd_id">
270 <primary sortas="b-dasd_id">dasd_id</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="etc-udev">
276 <term><filename class="directory">/etc/udev</filename></term>
277 <listitem>
278 <para>Contains <command>udev</command> configuation files,
279 device permissions, and rules for device naming</para>
280 <indexterm zone="ch-system-udev etc-udev">
281 <primary sortas="e-/etc/udev">/etc/udev</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="lib-udev">
287 <term><filename class="directory">/lib/udev</filename></term>
288 <listitem>
289 <para>Contains <command>udev</command> helper programs
290 and static devices which get copied to /dev when booted.</para>
291 <indexterm zone="ch-system-udev lib-udev">
292 <primary sortas="e-/lib/udev">/lib/udev</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296 </variablelist>
297
298 </sect2>
299
300</sect1>
Note: See TracBrowser for help on using the repository browser.