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

Last change on this file since 3322dab was 59fb197, checked in by Jim Gifford <clfs@…>, 13 years ago

r3817@server (orig r1719): jciccone | 2006-06-05 13:56:36 -0700
Brought the clfs-2.0 branch up to trunk.

  • Property mode set to 100644
File size: 10.4 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="${LFS_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="${LFS}" \
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 ${LFS}/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    ${LFS}/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 ${LFS}/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 LFS) 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      <varlistentry id="ata_id">
177        <term><command>ata_id</command></term>
178        <listitem>
179          <para>Provides Udev with a unique string and additional
180          information (uuid, label) for an ATA drive</para>
181          <indexterm zone="ch-system-udev ata_id">
182            <primary sortas="b-ata_id">ata_id</primary>
183          </indexterm>
184        </listitem>
185      </varlistentry>
186
187      <varlistentry id="cdrom_id">
188        <term><command>cdrom_id</command></term>
189        <listitem>
190          <para>To be written</para> 
191          <indexterm zone="ch-system-udev cdrom_id">
192            <primary sortas="b-cdrom_id">cdrom_id</primary>
193          </indexterm>
194        </listitem>
195      </varlistentry>
196
197      <varlistentry id="create_floppy_devices">
198        <term><command>create_floppy_devices</command></term>
199        <listitem>
200          <para>Creates all possible floppy devices based on the CMOS type</para>
201          <indexterm zone="ch-system-udev create_floppy_devices">
202            <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
203          </indexterm>
204        </listitem>
205      </varlistentry>
206
207      <varlistentry id="firmware.sh">
208        <term><command>firmware.sh</command></term>
209        <listitem>
210          <para>To be written</para> 
211          <indexterm zone="ch-system-udev firmware.sh">
212            <primary sortas="b-firmware.sh">firmware.sh</primary>
213          </indexterm>
214        </listitem>
215      </varlistentry>
216
217      <varlistentry id="path_id">
218        <term><command>path_id</command></term>
219        <listitem>
220          <para>Provide the shortest possible unique hardware path to a
221          device</para>
222          <indexterm zone="ch-system-udev path_id">
223            <primary sortas="b-path_id">path_id</primary>
224          </indexterm>
225        </listitem>
226      </varlistentry>
227
228      <varlistentry id="scsi_id">
229        <term><command>scsi_id</command></term>
230        <listitem>
231          <para>To be written</para> 
232          <indexterm zone="ch-system-udev scsi_id">
233            <primary sortas="b-scsi_id">scsi_id</primary>
234          </indexterm>
235        </listitem>
236      </varlistentry>
237
238      <varlistentry id="vol_id">
239        <term><command>vol_id</command></term>
240        <listitem>
241          <para>To be written</para> 
242          <indexterm zone="ch-system-udev vol_id">
243            <primary sortas="b-vol_id">vol_id</primary>
244          </indexterm>
245        </listitem>
246      </varlistentry>
247
248      <varlistentry id="usb_id">
249        <term><command>usb_id</command></term>
250        <listitem>
251          <para>To be written</para> 
252          <indexterm zone="ch-system-udev usb_id">
253            <primary sortas="b-usb_id">usb_id</primary>
254          </indexterm>
255        </listitem>
256      </varlistentry>
257
258      <varlistentry id="edd_id">
259        <term><command>edd_id</command></term>
260        <listitem>
261          <para>To be written</para> 
262          <indexterm zone="ch-system-udev edd_id">
263            <primary sortas="b-edd_id">edd_id</primary>
264          </indexterm>
265        </listitem>
266      </varlistentry>
267
268      <varlistentry id="dasd_id">
269        <term><command>dasd_id</command></term>
270        <listitem>
271          <para>To be written</para> 
272          <indexterm zone="ch-system-udev dasd_id">
273            <primary sortas="b-dasd_id">dasd_id</primary>
274          </indexterm>
275        </listitem>
276      </varlistentry>
277
278      <varlistentry id="etc-udev">
279        <term><filename class="directory">/etc/udev</filename></term>
280        <listitem>
281          <para>Contains <command>udev</command> configuation files,
282          device permissions, and rules for device naming</para>
283          <indexterm zone="ch-system-udev etc-udev">
284            <primary sortas="e-/etc/udev">/etc/udev</primary>
285          </indexterm>
286        </listitem>
287      </varlistentry>
288
289      <varlistentry id="lib-udev">
290        <term><filename class="directory">/lib/udev</filename></term>
291        <listitem>
292          <para>Contains <command>udev</command> helper programs
293          and static devices which get copied to /dev when booted.</para>
294          <indexterm zone="ch-system-udev lib-udev">
295            <primary sortas="e-/lib/udev">/lib/udev</primary>
296          </indexterm>
297        </listitem>
298      </varlistentry>
299    </variablelist>
300
301  </sect2>
302
303</sect1>
Note: See TracBrowser for help on using the repository browser.