aboutsummaryrefslogtreecommitdiffstats
path: root/chapter06/udev.xml
blob: c53977ed2867f3ca615b9bef53bc99c1b9bf3992 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-udev" role="wrap">
  <?dbhtml filename="udev.html"?>

  <title>Udev-&udev-version;</title>

  <indexterm zone="ch-system-udev">
    <primary sortas="a-Udev">Udev</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Udev package contains programs for dynamic creation of device
    nodes.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>0.1 SBU</seg>
        <seg>3.8 MB</seg>
      </seglistitem>
    </segmentedlist>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Coreutils and Make</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Udev</title>

    <para>Compile the package:</para>

<screen><userinput>make EXTRAS=extras/run_directory</userinput></screen>

    <variablelist>
      <title>The meaning of the make option:</title>

      <varlistentry>
        <term><parameter>EXTRAS=extras/run_directory</parameter></term>
        <listitem>
          <para>This builds the <command>udev_run_devd</command> and
          <command>udev_run_hotplugd</command> binaries, which are required
          for correct handling of hotpluggable devices.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>To test the results, issue:
    <userinput>make test</userinput>.</para>

    <para>Install the package:</para>

<screen><userinput>make DESTDIR=/ EXTRAS=extras/run_directory install</userinput></screen>

    <variablelist>
      <title>The meaning of the make parameter:</title>

      <varlistentry>
        <term><parameter>DESTDIR=/</parameter></term>
        <listitem>
          <para>This prevents the Udev build process from killing any
          <command>udevd</command> processes that may be running on the
          host system.</para>
        </listitem>
      </varlistentry>

    </variablelist>

    <para>Udev's configuration is far from ideal by default, so install
    the configuration files here:</para>

<screen><userinput>cp -v ../&udev-config-file; /etc/udev/rules.d/25-lfs.rules</userinput></screen>

    <para>Install the documentation that explains how to create Udev rules:</para>

<screen><userinput>install -m644 -D -v docs/writing_udev_rules/index.html /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>

    <!-- Not for the LiveCD -->
    <!-- Edit Me -->
    <para>Run the <command>udevstart</command> program to create our full
    complement of device nodes.</para>

<screen><userinput>/sbin/udevstart</userinput></screen>

  </sect2>

  <sect2 id="contents-udev" role="content">
    <title>Contents of Udev</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed directory</segtitle>

      <seglistitem>
        <seg>udev, udev_run_devd, udev_run_hotplugd, udevcontrol, udevd,
        udevinfo, udevmonitor, udevsend, udevstart, and udevtest</seg>
        <seg>/etc/udev</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="udev">
        <term><command>udev</command></term>
        <listitem>
          <para>Creates device nodes in <filename class="directory">/dev</filename>
          or renames network interfaces (not in LFS) in response to hotplug
          events</para>
          <indexterm zone="ch-system-udev udev">
            <primary sortas="b-udev">udev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udev_run_devd">
        <term><command>udev_run_devd</command></term>
        <listitem>
          <para>Executes programs and scripts in the <filename
          class="directory">/etc/dev.d/</filename> directory in response to
          hotplug events</para>
          <indexterm zone="ch-system-udev udev_run_devd">
            <primary sortas="b-udev_run_devd">udev_run_devd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udev_run_hotplugd">
        <term><command>udev_run_hotplugd</command></term>
        <listitem>
          <para>Executes programs and scripts in the <filename
          class="directory">/etc/hotplug.d/</filename> directory in response
          to hotplug events</para>
          <indexterm zone="ch-system-udev udev_run_hotplugd">
            <primary sortas="b-udev_run_hotplugd">udev_run_hotplugd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevcontrol">
        <term><command>udevcontrol</command></term>
        <listitem>
          <para>Configures a number of options for the running
          <command>udevd</command> daemon, such as the log level.</para>
          <indexterm zone="ch-system-udev udevcontrol">
            <primary sortas="b-udevcontrol">udevcontrol</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevd">
        <term><command>udevd</command></term>
        <listitem>
          <para>A daemon that reorders hotplug events before submitting them to
          <command>udev</command>, thus avoiding various race conditions</para>
          <indexterm zone="ch-system-udev udevd">
            <primary sortas="b-udevd">udevd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevinfo">
        <term><command>udevinfo</command></term>
        <listitem>
          <para>Allows users to query the <command>udev</command> database for
          information on any device currently present on the system; it also
          provides a way to query any device in the <systemitem
          class="filesystem">sysfs</systemitem> tree to help create udev
          rules</para>
          <indexterm zone="ch-system-udev udevinfo">
            <primary sortas="b-udevinfo">udevinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevmonitor">
        <term><command>udevmonitor</command></term>
        <listitem>
          <para>Prints the event received from the kernel and the event which
          <command>udev</command> sends out after rule processing</para>
          <indexterm zone="ch-system-udev udevmonitor">
            <primary sortas="b-udevmonitor">udevmonitor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevsend">
        <term><command>udevsend</command></term>
        <listitem>
          <para>Delivers hotplug events to <command>udevd</command></para>
          <indexterm zone="ch-system-udev udevsend">
            <primary sortas="b-udevsend">udevsend</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevstart">
        <term><command>udevstart</command></term>
        <listitem>
          <para>Creates device nodes in <filename class="directory">/dev</filename>
          that correspond to drivers compiled directly into the kernel; it
          performs that task by simulating hotplug events presumably dropped by
          the kernel before invocation of this program (e.g., because the root
          filesystem has not been mounted) and submitting such synthetic hotplug
          events to <command>udev</command></para>
          <indexterm zone="ch-system-udev udevstart">
            <primary sortas="b-udevstart">udevstart</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="udevtest">
        <term><command>udevtest</command></term>
        <listitem>
          <para>Simulates a <command>udev</command> run for the given device,
          and prints out the name of the node the real <command>udev</command>
          would have created or (not in LFS) the name of the renamed network
          interface</para>
          <indexterm zone="ch-system-udev udevtest">
            <primary sortas="b-udevtest">udevtest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="etc-udev">
        <term><filename class="directory">/etc/udev</filename></term>
        <listitem>
          <para>Contains <command>udev</command> configuation files,
          device permissions, and rules for device naming</para>
          <indexterm zone="ch-system-udev etc-udev">
            <primary sortas="e-/etc/udev">/etc/udev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>