source: BOOK/boot/common/eudev.xml@ a15706a

systemd
Last change on this file since a15706a was 615803b, checked in by Chris Staub <chris@…>, 10 years ago

Added command explanations for eudev

  • Property mode set to 100644
File size: 10.6 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-boot-eudev" role="wrap">
9 <?dbhtml filename="eudev.html"?>
10
11 <title>Eudev-&eudev-version;</title>
12
13 <indexterm zone="ch-boot-eudev">
14 <primary sortas="a-Eudev">Eudev</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Eudev package contains programs for dynamic creation of device
21 nodes.</para>
22
23 </sect2>
24
25 <sect2 role="installation">
26 <title>Installation of Eudev</title>
27
28 <para os="a">Prepare Eudev for compilation:</para>
29
30<screen os="b"><userinput>./configure --prefix=/tools --build=${CLFS_HOST} --host=${CLFS_TARGET} \
31 --disable-introspection --disable-gtk-doc-html \
32 --disable-gudev --disable-keymap --with-firmware-path=/tools/lib/firmware \
33 --enable-libkmod</userinput></screen>
34
35 <variablelist os="b1">
36 <title>The meaning of the new configure options:</title>
37
38 <varlistentry>
39 <term><parameter>--disable-introspection --disable-gtk-doc-html
40 --disable-gudev --disable-keymap</parameter></term>
41 <listitem>
42 <para>These switches disable several features which are not needed
43 for the temporary system and have additional dependencies.</para>
44 </listitem>
45 </varlistentry>
46
47 <varlistentry>
48 <term><parameter>--with-firmware-path=/tools/lib/firmware</parameter></term>
49 <listitem>
50 <para>This allows Eudev to load firmware from
51 <filename class="directory">/tools/lib/firmware</filename> instead of
52 the default location of <filename class="directory">/lib/firmware</filename>.</para>
53 </listitem>
54 </varlistentry>
55
56 <varlistentry>
57 <term><parameter>--enable-libkmod</parameter></term>
58 <listitem>
59 <para>Allows Eudev to load modules by using
60 <filename class="libraryfile">libkmod</filename> directly.</para>
61 </listitem>
62 </varlistentry>
63
64 </variablelist>
65
66 <para os="c">Compile the package:</para>
67
68<screen os="d"><userinput>make</userinput></screen>
69
70 <para os="g">Install the package:</para>
71
72<screen os="j"><userinput>make install</userinput></screen>
73
74 <para os="i">Create a directory for storing firmware that can be
75 loaded by <command>udev</command>:</para>
76
77<screen os="k"><userinput>install -dv /tools/lib/firmware</userinput></screen>
78
79 <para os="r1">Create a dummy rule so that Eudev will name ethernet devices properly for the system.</para>
80
81<screen os="r2"><userinput>echo "# dummy, so that network is once again on eth*" &gt; \
82 /tools/etc/udev/rules.d/80-net-name-slot.rules</userinput></screen>
83
84 </sect2>
85
86 <sect2 id="contents-eudev" role="content">
87 <title>Contents of Eudev</title>
88
89 <segmentedlist>
90 <segtitle>Installed programs</segtitle>
91 <segtitle>Installed library</segtitle>
92 <segtitle>Installed directories</segtitle>
93
94 <seglistitem>
95 <seg>ata_id, cdrom_id, collect, create_floppy_devices, edd_id,
96 firmware.sh, fstab_import, path_id, scsi_id, udevadm, udevd, usb_id,
97 v4l_id, write_cd_rules, write_net_rules</seg>
98 <seg>libudev</seg>
99 <seg>/tools/etc/udev, /tools/lib/firmware, /tools/lib/udev</seg>
100 </seglistitem>
101 </segmentedlist>
102
103 <variablelist>
104 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
105 <?dbfo list-presentation="list"?>
106 <?dbhtml list-presentation="table"?>
107
108 <varlistentry id="udevadm-eudev">
109 <term><command>udevadm</command></term>
110 <listitem>
111 <para>Controls the runtime behavior of Eudev, requests kernel
112 events, manages the event queue, and provides simple debugging.</para>
113 <indexterm zone="ch-boot-eudev udevadm-eudev">
114 <primary sortas="b-udevadm-eudev">udevadm</primary>
115 </indexterm>
116 </listitem>
117 </varlistentry>
118
119 <varlistentry id="udevd">
120 <term><command>udevd</command></term>
121 <listitem>
122 <para>A daemon that reorders hotplug events before submitting them to
123 <command>udev</command>,
124 thus avoiding various race conditions</para>
125 <indexterm zone="ch-boot-eudev udevd">
126 <primary sortas="b-udevd">udevd</primary>
127 </indexterm>
128 </listitem>
129 </varlistentry>
130
131 <!-- Start of Helpers -->
132 <varlistentry id="ata_id">
133 <term><command>ata_id</command></term>
134 <listitem>
135 <para>Provides Eudev with a unique string and additional
136 information (uuid, label) for an ATA drive</para>
137 <indexterm zone="ch-boot-eudev ata_id">
138 <primary sortas="b-ata_id">ata_id</primary>
139 </indexterm>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry id="cdrom_id">
144 <term><command>cdrom_id</command></term>
145 <listitem>
146 <para>Prints the capabilities of a CDROM or DVDROM drive.</para>
147 <indexterm zone="ch-boot-eudev cdrom_id">
148 <primary sortas="b-cdrom_id">cdrom_id</primary>
149 </indexterm>
150 </listitem>
151 </varlistentry>
152
153 <varlistentry id="collect">
154 <term><command>collect</command></term>
155 <listitem>
156 <para>Given an ID for the current uevent and a list of IDs
157(for all target uevents), registers the current ID and indicates whether
158all target IDs have been registered.</para>
159 <indexterm zone="ch-boot-eudev collect">
160 <primary sortas="b-collect">collect</primary>
161 </indexterm>
162 </listitem>
163 </varlistentry>
164
165 <varlistentry id="create_floppy_devices">
166 <term><command>create_floppy_devices</command></term>
167 <listitem>
168 <para>Creates all possible floppy devices based on the CMOS type</para>
169 <indexterm zone="ch-boot-eudev create_floppy_devices">
170 <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
171 </indexterm>
172 </listitem>
173 </varlistentry>
174
175 <varlistentry id="edd_id">
176 <term><command>edd_id</command></term>
177 <listitem>
178 <para>Identifies x86 disk drives from Enhanced Disk Drive calls</para>
179 <indexterm zone="ch-boot-eudev edd_id">
180 <primary sortas="b-edd_id">edd_id</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="firmware.sh">
186 <term><command>firmware.sh</command></term>
187 <listitem>
188 <para>Script to load firmware for a device</para>
189 <indexterm zone="ch-boot-eudev firmware.sh">
190 <primary sortas="b-firmware.sh">firmware.sh</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="fstab_import">
196 <term><command>fstab_import</command></term>
197 <listitem>
198 <para>Finds an entry in <filename>/etc/fstab</filename> that matches
199the current device, and provides its information to Udev.</para>
200 <indexterm zone="ch-boot-eudev fstab_import">
201 <primary sortas="b-fstab_import">fstab_import</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 <varlistentry id="path_id">
207 <term><command>path_id</command></term>
208 <listitem>
209 <para>Provides the shortest possible unique hardware path to a
210 device</para>
211 <indexterm zone="ch-boot-eudev path_id">
212 <primary sortas="b-path_id">path_id</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="scsi_id">
218 <term><command>scsi_id</command></term>
219 <listitem>
220 <para>Retrieves or generates a unique SCSI identifier.</para>
221 <indexterm zone="ch-boot-eudev scsi_id">
222 <primary sortas="b-scsi_id">scsi_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>Identifies a USB block device.</para>
231 <indexterm zone="ch-boot-eudev usb_id">
232 <primary sortas="b-usb_id">usb_id</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="v4l_id">
238 <term><command>v4l_id</command></term>
239 <listitem>
240 <para>Determines V4L capabilities for a given device.</para>
241 <indexterm zone="ch-boot-eudev v4l_id">
242 <primary sortas="b-v4l_id">v4l_id</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="write_cd_rules">
248 <term><command>write_cd_rules</command></term>
249 <listitem>
250 <para>A script which generates Eudev rules to provide stable names
251for network interfaces.</para>
252 <indexterm zone="ch-boot-eudev write_cd_rules">
253 <primary sortas="b-write_cd_rules">write_cd_rules</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="write_net_rules">
259 <term><command>write_net_rules</command></term>
260 <listitem>
261 <para>A script which generates Eudev rules to provide stable names
262for network interfaces.</para>
263 <indexterm zone="ch-boot-eudev write_net_rules">
264 <primary sortas="b-write_net_rules">write_net_rules</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268<!-- End of Helpers -->
269
270 <varlistentry id="libudev-eudev">
271 <term><filename class="libraryfile">libudev</filename></term>
272 <listitem>
273 <para>A library interface to eudev device information.</para>
274 <indexterm zone="ch-boot-eudev libudev-eudev">
275 <primary sortas="c-libudev-eudev">libudev</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="etc-eudev">
281 <term><filename class="directory">/etc/udev</filename></term>
282 <listitem>
283 <para>Contains <command>udev</command> configuration files,
284 device permissions, and rules for device naming</para>
285 <indexterm zone="ch-boot-eudev etc-eudev">
286 <primary sortas="e-/etc/udev">/etc/udev</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="lib-eudev">
292 <term><filename class="directory">/lib/udev</filename></term>
293 <listitem>
294 <para>Contains <command>udev</command> helper programs
295 and static devices which get copied to /dev when booted.</para>
296 <indexterm zone="ch-boot-eudev lib-eudev">
297 <primary sortas="e-/lib/udev">/lib/udev</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301 </variablelist>
302
303 </sect2>
304
305</sect1>
Note: See TracBrowser for help on using the repository browser.