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

Last change on this file since e60e52d was e60e52d, checked in by Joe Ciccone <jciccone@…>, 15 years ago

Replace tabs with 8 spaces.

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