| 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 and Make</seg>
 | 
|---|
| 28 |       </seglistitem>
 | 
|---|
| 29 |     </segmentedlist>
 | 
|---|
| 30 | 
 | 
|---|
| 31 |   </sect2>
 | 
|---|
| 32 | 
 | 
|---|
| 33 |   <sect2 role="installation">
 | 
|---|
| 34 |     <title>Installation of Udev</title>
 | 
|---|
| 35 | 
 | 
|---|
| 36 |     <para os="c">Compile the package:</para>
 | 
|---|
| 37 | 
 | 
|---|
| 38 | <screen><userinput>make EXTRAS="extras/firmware extras/run_directory"</userinput></screen>
 | 
|---|
| 39 | 
 | 
|---|
| 40 |     <variablelist os="d">
 | 
|---|
| 41 |       <title>The meaning of the make parameter:</title>
 | 
|---|
| 42 | 
 | 
|---|
| 43 |       <varlistentry>
 | 
|---|
| 44 |       <term><parameter>EXTRAS="extras/firmware extras/run_directory"</parameter></term>
 | 
|---|
| 45 |         <listitem>
 | 
|---|
| 46 |           <para>This builds the <command>udev_run_devd</command> and
 | 
|---|
| 47 |           <command>udev_run_hotplugd</command> binaries, which are required for
 | 
|---|
| 48 |           correct handling of hotpluggable devices.</para>
 | 
|---|
| 49 |         </listitem>
 | 
|---|
| 50 |       </varlistentry>
 | 
|---|
| 51 | 
 | 
|---|
| 52 |     </variablelist>
 | 
|---|
| 53 | 
 | 
|---|
| 54 |     <para os="e">To test the results, issue:
 | 
|---|
| 55 |     <userinput>make test</userinput>.</para>
 | 
|---|
| 56 | 
 | 
|---|
| 57 |     <para os="f">Install the package:</para>
 | 
|---|
| 58 | 
 | 
|---|
| 59 | <screen os="g"><userinput>make DESTDIR=/ EXTRAS="extras/firmware extras/run_directory" install</userinput></screen>
 | 
|---|
| 60 | 
 | 
|---|
| 61 |     <variablelist os="g1">
 | 
|---|
| 62 |       <title>The meaning of the make parameter:</title>
 | 
|---|
| 63 | 
 | 
|---|
| 64 |       <varlistentry>
 | 
|---|
| 65 |       <term><parameter>DESTDIR=/</parameter></term>
 | 
|---|
| 66 |         <listitem>
 | 
|---|
| 67 |           <para>This prevents the Udev build process from killing any
 | 
|---|
| 68 |           <command>udevd</command> processes that may be running on the
 | 
|---|
| 69 |           system.</para>
 | 
|---|
| 70 |         </listitem>
 | 
|---|
| 71 |       </varlistentry>
 | 
|---|
| 72 | 
 | 
|---|
| 73 |     </variablelist>
 | 
|---|
| 74 |     <para os="h">Udev's configuration is far from ideal by default, so install
 | 
|---|
| 75 |     the configuration files here:</para>
 | 
|---|
| 76 | 
 | 
|---|
| 77 | <screen os="i"><userinput>cp ../&udev-config-file; /etc/udev/rules.d/25-lfs.rules</userinput></screen>
 | 
|---|
| 78 | 
 | 
|---|
| 79 |     <para os="a">Install the documentation that explains how to create
 | 
|---|
| 80 |     Udev rules:</para>
 | 
|---|
| 81 | 
 | 
|---|
| 82 | <screen os="b"><userinput>install -m644 -D docs/writing_udev_rules/index.html /usr/share/doc/udev-&udev-version;/index.html</userinput></screen>
 | 
|---|
| 83 | 
 | 
|---|
| 84 |     <para os="j">Run the <command>udevstart</command> program to create our full
 | 
|---|
| 85 |     complement of device nodes.</para>
 | 
|---|
| 86 | 
 | 
|---|
| 87 | <screen os="k"><userinput>/sbin/udevstart</userinput></screen>
 | 
|---|
| 88 | 
 | 
|---|
| 89 |   </sect2>
 | 
|---|
| 90 | 
 | 
|---|
| 91 |   <sect2 id="contents-udev" role="content">
 | 
|---|
| 92 |     <title>Contents of Udev</title>
 | 
|---|
| 93 | 
 | 
|---|
| 94 |     <segmentedlist>
 | 
|---|
| 95 |       <segtitle>Installed programs</segtitle>
 | 
|---|
| 96 |       <segtitle>Installed directory</segtitle>
 | 
|---|
| 97 | 
 | 
|---|
| 98 |       <seglistitem>
 | 
|---|
| 99 |         <seg>udev, udevcontrol, udevd, udevinfo, udevmonitor, udevsend,
 | 
|---|
| 100 |         udevstart and udevtest</seg>
 | 
|---|
| 101 |         <seg>/etc/udev</seg>
 | 
|---|
| 102 |       </seglistitem>
 | 
|---|
| 103 |     </segmentedlist>
 | 
|---|
| 104 | 
 | 
|---|
| 105 |     <variablelist>
 | 
|---|
| 106 |       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 | 
|---|
| 107 |       <?dbfo list-presentation="list"?>
 | 
|---|
| 108 |       <?dbhtml list-presentation="table"?>
 | 
|---|
| 109 | 
 | 
|---|
| 110 |       <varlistentry id="udev">
 | 
|---|
| 111 |         <term><command>udev</command></term>
 | 
|---|
| 112 |         <listitem>
 | 
|---|
| 113 |           <para>Creates device nodes in <filename
 | 
|---|
| 114 |           class="directory">/dev</filename> or renames network interfaces (not
 | 
|---|
| 115 |           in LFS) in response to hotplug events</para>
 | 
|---|
| 116 |           <indexterm zone="ch-system-udev udev">
 | 
|---|
| 117 |             <primary sortas="b-udev">udev</primary>
 | 
|---|
| 118 |           </indexterm>
 | 
|---|
| 119 |         </listitem>
 | 
|---|
| 120 |       </varlistentry>
 | 
|---|
| 121 | 
 | 
|---|
| 122 |       <varlistentry id="udevcontrol">
 | 
|---|
| 123 |         <term><command>udevcontrol</command></term>
 | 
|---|
| 124 |         <listitem>
 | 
|---|
| 125 |           <para>Configures a number of options for the running
 | 
|---|
| 126 |           <command>udevd</command> daemon, such as the log level.</para>
 | 
|---|
| 127 |           <indexterm zone="ch-system-udev udevcontrol">
 | 
|---|
| 128 |             <primary sortas="b-udevcontrol">udevcontrol</primary>
 | 
|---|
| 129 |           </indexterm>
 | 
|---|
| 130 |         </listitem>
 | 
|---|
| 131 |       </varlistentry>
 | 
|---|
| 132 | 
 | 
|---|
| 133 |       <varlistentry id="udevd">
 | 
|---|
| 134 |         <term><command>udevd</command></term>
 | 
|---|
| 135 |         <listitem>
 | 
|---|
| 136 |           <para>A daemon that reorders hotplug events before submitting them to
 | 
|---|
| 137 |           <command>udev</command>,
 | 
|---|
| 138 |           thus avoiding various race conditions</para>
 | 
|---|
| 139 |           <indexterm zone="ch-system-udev udevd">
 | 
|---|
| 140 |             <primary sortas="b-udevd">udevd</primary>
 | 
|---|
| 141 |           </indexterm>
 | 
|---|
| 142 |         </listitem>
 | 
|---|
| 143 |       </varlistentry>
 | 
|---|
| 144 | 
 | 
|---|
| 145 |       <varlistentry id="udevinfo">
 | 
|---|
| 146 |         <term><command>udevinfo</command></term>
 | 
|---|
| 147 |         <listitem>
 | 
|---|
| 148 |           <para>Allows users to query the <command>udev</command> database for
 | 
|---|
| 149 |           information on any device currently present on the system; it also
 | 
|---|
| 150 |           provides a way to query any device in the <systemitem
 | 
|---|
| 151 |           class="filesystem">sysfs</systemitem> tree to help create udev
 | 
|---|
| 152 |           rules</para>
 | 
|---|
| 153 |           <indexterm zone="ch-system-udev udevinfo">
 | 
|---|
| 154 |             <primary sortas="b-udevinfo">udevinfo</primary>
 | 
|---|
| 155 |           </indexterm>
 | 
|---|
| 156 |         </listitem>
 | 
|---|
| 157 |       </varlistentry>
 | 
|---|
| 158 | 
 | 
|---|
| 159 |       <varlistentry id="udevmonitor">
 | 
|---|
| 160 |         <term><command>udevmonitor</command></term>
 | 
|---|
| 161 |         <listitem>
 | 
|---|
| 162 |           <para>Prints the event received from the kernel and the event which
 | 
|---|
| 163 |           <command>udev</command> sends out after rule processing</para>
 | 
|---|
| 164 |           <indexterm zone="ch-system-udev udevmonitor">
 | 
|---|
| 165 |             <primary sortas="b-udevmonitor">udevmonitor</primary>
 | 
|---|
| 166 |           </indexterm>
 | 
|---|
| 167 |         </listitem>
 | 
|---|
| 168 |       </varlistentry>
 | 
|---|
| 169 | 
 | 
|---|
| 170 |       <varlistentry id="udevsend">
 | 
|---|
| 171 |         <term><command>udevsend</command></term>
 | 
|---|
| 172 |         <listitem>
 | 
|---|
| 173 |           <para>Delivers hotplug events to <command>udevd</command></para>
 | 
|---|
| 174 |           <indexterm zone="ch-system-udev udevsend">
 | 
|---|
| 175 |             <primary sortas="b-udevsend">udevsend</primary>
 | 
|---|
| 176 |           </indexterm>
 | 
|---|
| 177 |         </listitem>
 | 
|---|
| 178 |       </varlistentry>
 | 
|---|
| 179 | 
 | 
|---|
| 180 |       <varlistentry id="udevstart">
 | 
|---|
| 181 |         <term><command>udevstart</command></term>
 | 
|---|
| 182 |         <listitem>
 | 
|---|
| 183 |           <para>Creates device nodes in <filename class="directory">/dev</filename>
 | 
|---|
| 184 |           that correspond to drivers compiled directly into the kernel; it
 | 
|---|
| 185 |           performs that task by simulating hotplug events presumably dropped by
 | 
|---|
| 186 |           the kernel before invocation of this program (e.g., because the root
 | 
|---|
| 187 |           filesystem has not been mounted) and submitting such synthetic hotplug
 | 
|---|
| 188 |           events to <command>udev</command></para>
 | 
|---|
| 189 |           <indexterm zone="ch-system-udev udevstart">
 | 
|---|
| 190 |             <primary sortas="b-udevstart">udevstart</primary>
 | 
|---|
| 191 |           </indexterm>
 | 
|---|
| 192 |         </listitem>
 | 
|---|
| 193 |       </varlistentry>
 | 
|---|
| 194 | 
 | 
|---|
| 195 |       <varlistentry id="udevtest">
 | 
|---|
| 196 |         <term><command>udevtest</command></term>
 | 
|---|
| 197 |         <listitem>
 | 
|---|
| 198 |           <para>Simulates a <command>udev</command> run for the given device,
 | 
|---|
| 199 |           and prints out the name of the node the real <command>udev</command>
 | 
|---|
| 200 |           would have created or (not in LFS) the name of the renamed network
 | 
|---|
| 201 |           interface</para>
 | 
|---|
| 202 |           <indexterm zone="ch-system-udev udevtest">
 | 
|---|
| 203 |             <primary sortas="b-udevtest">udevtest</primary>
 | 
|---|
| 204 |           </indexterm>
 | 
|---|
| 205 |         </listitem>
 | 
|---|
| 206 |       </varlistentry>
 | 
|---|
| 207 | 
 | 
|---|
| 208 |       <varlistentry id="etc-udev">
 | 
|---|
| 209 |         <term><filename class="directory">/etc/udev</filename></term>
 | 
|---|
| 210 |         <listitem>
 | 
|---|
| 211 |           <para>Contains <command>udev</command> configuation files,
 | 
|---|
| 212 |           device permissions, and rules for device naming</para>
 | 
|---|
| 213 |           <indexterm zone="ch-system-udev etc-udev">
 | 
|---|
| 214 |             <primary sortas="e-/etc/udev">/etc/udev</primary>
 | 
|---|
| 215 |           </indexterm>
 | 
|---|
| 216 |         </listitem>
 | 
|---|
| 217 |       </varlistentry>
 | 
|---|
| 218 | 
 | 
|---|
| 219 |     </variablelist>
 | 
|---|
| 220 | 
 | 
|---|
| 221 |   </sect2>
 | 
|---|
| 222 | 
 | 
|---|
| 223 | </sect1>
 | 
|---|