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

Last change on this file was 1bbbe07, checked in by Joe Ciccone <jciccone@…>, 10 years ago

Updated Udev to 143.

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