source: final-system/common/udev.xml @ c4efa05

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

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