source: final-system/common/udev.xml @ 1c5569f

Last change on this file since 1c5569f was 1c5569f, checked in by Jim Gifford <clfs@…>, 18 years ago

r2796@server: jim | 2006-04-06 15:42:17 -0700
Updated to udev 089

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