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

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

Added a sysroot wrapper.
Updated the build variables section of the book, each package uses its own.

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