udev.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  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. <sect1 id="ch-system-udev" role="wrap">
  8. <?dbhtml filename="udev.html"?>
  9. <sect1info condition="script">
  10. <productname>udev</productname>
  11. <productnumber>&udev-version;</productnumber>
  12. <address>&udev-url;</address>
  13. </sect1info>
  14. <title>Udev-&udev-version;</title>
  15. <indexterm zone="ch-system-udev">
  16. <primary sortas="a-Udev">Udev</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The Udev package contains programs for dynamic creation of device
  21. nodes.</para>
  22. <segmentedlist>
  23. <segtitle>&buildtime;</segtitle>
  24. <segtitle>&diskspace;</segtitle>
  25. <seglistitem>
  26. <seg>&udev-ch6-sbu;</seg>
  27. <seg>&udev-ch6-du;</seg>
  28. </seglistitem>
  29. </segmentedlist>
  30. </sect2>
  31. <sect2 role="installation">
  32. <title>Installation of Udev</title>
  33. <para>The udev-config tarball contains LFS-specific files used to configure
  34. Udev. Unpack it into the Udev source directory:</para>
  35. <screen><userinput remap="pre">tar -xvf ../&udev-config;.tar.bz2</userinput></screen>
  36. <para>Create some devices and directories that Udev cannot handle due to
  37. them being required very early in the boot process, or by Udev itself:</para>
  38. <screen><userinput remap="install">install -dv /lib/{firmware,udev/devices/{pts,shm}}
  39. mknod -m0666 /lib/udev/devices/null c 1 3
  40. ln -sv /proc/self/fd /lib/udev/devices/fd
  41. ln -sv /proc/self/fd/0 /lib/udev/devices/stdin
  42. ln -sv /proc/self/fd/1 /lib/udev/devices/stdout
  43. ln -sv /proc/self/fd/2 /lib/udev/devices/stderr
  44. ln -sv /proc/kcore /lib/udev/devices/core</userinput></screen>
  45. <para>Prepare the package for compilation:</para>
  46. <!-- Note that "libdir=/usr/lib64" would be required for multilib. -->
  47. <screen><userinput remap="configure">./configure --prefix=/usr \
  48. --sysconfdir=/etc --sbindir=/sbin \
  49. --with-rootlibdir=/lib --libexecdir=/lib/udev \
  50. --docdir=/usr/share/doc/udev-&udev-version; \
  51. --disable-extras --disable-introspection</userinput></screen>
  52. <variablelist>
  53. <title>The meaning of the new configure options</title>
  54. <varlistentry>
  55. <term><parameter>--with-rootlibdir=/lib</parameter></term>
  56. <listitem>
  57. <para>This controls where the <filename
  58. class="libraryfile">libudev</filename> library is installed. The
  59. library needs to be in <filename class="directory">/lib</filename>
  60. because it's used by Udev at boot time, before <filename
  61. class="directory">/usr</filename> might be available, and the default
  62. --rootlibdir is <filename class="directory">/usr/lib</filename>.</para>
  63. </listitem>
  64. </varlistentry>
  65. <!-- Note that libexecdir *MUST* stay /lib/udev, even on a 64-bit
  66. / multilib system where udev is compiled for 64-bit. Other
  67. packages require this exact path; the udev maintainers have
  68. said this is part of the udev API. -->
  69. <varlistentry>
  70. <term><parameter>--libexecdir=/lib/udev</parameter></term>
  71. <listitem>
  72. <para>This controls where Udev-internal rules and helper programs
  73. are installed.</para>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry>
  77. <term><parameter>--docdir=/usr/share/doc/udev-&udev-version;</parameter></term>
  78. <listitem>
  79. <para>This option installs the Udev documentation in the
  80. proper location with the naming convention consistent with
  81. other packages.</para>
  82. </listitem>
  83. </varlistentry>
  84. <varlistentry>
  85. <term><parameter>--disable-extras</parameter></term>
  86. <listitem>
  87. <para>This option prevents Udev from installing helper programs and
  88. other extras which require more external libraries. These libraries
  89. are not part of the base LFS system. See the Udev
  90. <filename>README</filename> file for more information.</para>
  91. </listitem>
  92. </varlistentry>
  93. <varlistentry>
  94. <term><parameter>--disable-introspection</parameter></term>
  95. <listitem>
  96. <para>This option prevents Udev's instrospection feature, which
  97. requires packages not installed as part of the base LFS system. See
  98. the Udev <filename>README</filename> file for more information.</para>
  99. </listitem>
  100. </varlistentry>
  101. </variablelist>
  102. <para>Compile the package:</para>
  103. <screen><userinput remap="make">make</userinput></screen>
  104. <para>This package does not come with a test suite.</para>
  105. <para>Install the package:</para>
  106. <screen><userinput remap="install">make install</userinput></screen>
  107. <para>Udev has to be configured in order to work properly, as its default
  108. configuration does not cover all devices. First install two extra rules
  109. files from Udev to help support device-mapper and RAID setups:</para>
  110. <screen><userinput remap="install">install -m644 -v rules/packages/64-*.rules \
  111. /lib/udev/rules.d/</userinput></screen>
  112. <para>Now install a file to create symlinks for certain hand-held devices:</para>
  113. <screen><userinput remap="install">install -m644 -v rules/packages/40-pilot-links.rules \
  114. /lib/udev/rules.d/</userinput></screen>
  115. <para>Now install a file to handle ISDN devices:</para>
  116. <screen><userinput remap="install">install -m644 -v rules/packages/40-isdn.rules \
  117. /lib/udev/rules.d/</userinput></screen>
  118. <!-- There are more files available in the packages/ directory, if we want
  119. to consider using them. Most are probably irrelevant to LFS though.
  120. "alsa" isn't, but we already have those rules, using a better set of
  121. matches. Most of the files in packages/ are for other architectures. -->
  122. <para>Now install the LFS-specific custom rules files:</para>
  123. <screen><userinput remap="install">cd &udev-config;
  124. make install</userinput></screen>
  125. <para>Install the documentation that explains the LFS-specific rules
  126. files:</para>
  127. <screen><userinput remap="install">make install-doc</userinput></screen>
  128. </sect2>
  129. <sect2 id="contents-udev" role="content">
  130. <title>Contents of Udev</title>
  131. <segmentedlist>
  132. <segtitle>Installed programs</segtitle>
  133. <segtitle>Installed libraries</segtitle>
  134. <segtitle>Installed directory</segtitle>
  135. <seglistitem>
  136. <seg>ata_id, cdrom_id, collect, create_floppy_devices, edd_id,
  137. firmware.sh, fstab_import, path_id, scsi_id, udevadm, udevd,
  138. usb_id, write_cd_rules, and write_net_rules</seg>
  139. <seg>libudev.{a,so}</seg>
  140. <seg>/etc/udev</seg>
  141. </seglistitem>
  142. </segmentedlist>
  143. <variablelist>
  144. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  145. <?dbfo list-presentation="list"?>
  146. <?dbhtml list-presentation="table"?>
  147. <varlistentry id="ata_id">
  148. <term><command>ata_id</command></term>
  149. <listitem>
  150. <para>Provides Udev with a unique string and
  151. additional information (uuid, label) for an ATA drive</para>
  152. <indexterm zone="ch-system-udev ata_id">
  153. <primary sortas="b-ata_id">ata_id</primary>
  154. </indexterm>
  155. </listitem>
  156. </varlistentry>
  157. <varlistentry id="cdrom_id">
  158. <term><command>cdrom_id</command></term>
  159. <listitem>
  160. <para>Provides Udev with the capabilities of a
  161. CD-ROM or DVD-ROM drive</para>
  162. <indexterm zone="ch-system-udev cdrom_id">
  163. <primary sortas="b-cdrom_id">cdrom_id</primary>
  164. </indexterm>
  165. </listitem>
  166. </varlistentry>
  167. <varlistentry id="collect">
  168. <term><command>collect</command></term>
  169. <listitem>
  170. <para>Given an ID for the current uevent and a list of
  171. IDs (for all target uevents), registers the current ID
  172. and indicates whether all target IDs have been registered</para>
  173. <indexterm zone="ch-system-udev collect">
  174. <primary sortas="b-collect">collect</primary>
  175. </indexterm>
  176. </listitem>
  177. </varlistentry>
  178. <varlistentry id="create_floppy_devices">
  179. <term><command>create_floppy_devices</command></term>
  180. <listitem>
  181. <para>Creates all possible floppy devices based on the CMOS type</para>
  182. <indexterm zone="ch-system-udev create_floppy_devices">
  183. <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
  184. </indexterm>
  185. </listitem>
  186. </varlistentry>
  187. <varlistentry id="edd_id">
  188. <term><command>edd_id</command></term>
  189. <listitem>
  190. <para>Provides Udev with the EDD ID for a BIOS disk drive</para>
  191. <indexterm zone="ch-system-udev edd_id">
  192. <primary sortas="b-edd_id">edd_id</primary>
  193. </indexterm>
  194. </listitem>
  195. </varlistentry>
  196. <varlistentry id="firmware.sh">
  197. <term><command>firmware.sh</command></term>
  198. <listitem>
  199. <para>Uploads firmware to devices</para>
  200. <indexterm zone="ch-system-udev firmware.sh">
  201. <primary sortas="b-firmware.sh">firmware.sh</primary>
  202. </indexterm>
  203. </listitem>
  204. </varlistentry>
  205. <varlistentry id="fstab_import">
  206. <term><command>fstab_import</command></term>
  207. <listitem>
  208. <para>Finds an entry in <filename>/etc/fstab</filename> that
  209. matches the current device, and provides its information to
  210. Udev</para>
  211. <indexterm zone="ch-system-udev fstab_import">
  212. <primary sortas="b-fstab_import">fstab_import</primary>
  213. </indexterm>
  214. </listitem>
  215. </varlistentry>
  216. <varlistentry id="path_id">
  217. <term><command>path_id</command></term>
  218. <listitem>
  219. <para>Provides the shortest possible unique hardware path to a
  220. device</para>
  221. <indexterm zone="ch-system-udev path_id">
  222. <primary sortas="b-path_id">path_id</primary>
  223. </indexterm>
  224. </listitem>
  225. </varlistentry>
  226. <varlistentry id="scsi_id">
  227. <term><command>scsi_id</command></term>
  228. <listitem>
  229. <para>Provides Udev with a unique SCSI identifier
  230. based on the data returned from sending a SCSI INQUIRY command to
  231. the specified device</para>
  232. <indexterm zone="ch-system-udev scsi_id">
  233. <primary sortas="b-scsi_id">scsi_id</primary>
  234. </indexterm>
  235. </listitem>
  236. </varlistentry>
  237. <varlistentry id="udevadm">
  238. <term><command>udevadm</command></term>
  239. <listitem>
  240. <para>Generic udev administration tool: controls the udevd daemon,
  241. provides info from the Udev database, monitors uevents, waits for
  242. uevents to finish, tests Udev configuration, and triggers uevents
  243. for a given device</para>
  244. <indexterm zone="ch-system-udev udevadm">
  245. <primary sortas="b-udevadm">udevadm</primary>
  246. </indexterm>
  247. </listitem>
  248. </varlistentry>
  249. <varlistentry id="udevd">
  250. <term><command>udevd</command></term>
  251. <listitem>
  252. <para>A daemon that listens for uevents on the netlink socket,
  253. creates devices and runs the configured external programs in
  254. response to these uevents</para>
  255. <indexterm zone="ch-system-udev udevd">
  256. <primary sortas="b-udevd">udevd</primary>
  257. </indexterm>
  258. </listitem>
  259. </varlistentry>
  260. <varlistentry id="usb_id">
  261. <term><command>usb_id</command></term>
  262. <listitem>
  263. <para>Provides Udev with information about USB
  264. devices</para>
  265. <indexterm zone="ch-system-udev usb_id">
  266. <primary sortas="b-usb_id">usb_id</primary>
  267. </indexterm>
  268. </listitem>
  269. </varlistentry>
  270. <varlistentry id="write_cd_rules">
  271. <term><command>write_cd_rules</command></term>
  272. <listitem>
  273. <para>A script which generates Udev rules to provide stable names for
  274. optical drives (see also <xref linkend="ch-scripts-symlinks"/>)</para>
  275. <indexterm zone="ch-system-udev write_cd_rules">
  276. <primary sortas="b-write_cd_rules">write_cd_rules</primary>
  277. </indexterm>
  278. </listitem>
  279. </varlistentry>
  280. <varlistentry id="write_net_rules">
  281. <term><command>write_net_rules</command></term>
  282. <listitem>
  283. <para>A script which generates rules to provide stable names for
  284. network interfaces (see also <xref linkend="ch-scripts-network"/>)
  285. </para>
  286. <indexterm zone="ch-system-udev write_net_rules">
  287. <primary sortas="b-write_net_rules">write_net_rules</primary>
  288. </indexterm>
  289. </listitem>
  290. </varlistentry>
  291. <varlistentry id="libudev">
  292. <term><filename class="libraryfile">libudev</filename></term>
  293. <listitem>
  294. <para>A library interface to udev device information</para>
  295. <indexterm zone="ch-system-udev libudev">
  296. <primary sortas="c-libudev">libudev</primary>
  297. </indexterm>
  298. </listitem>
  299. </varlistentry>
  300. <varlistentry id="etc-udev">
  301. <term><filename class="directory">/etc/udev</filename></term>
  302. <listitem>
  303. <para>Contains Udev configuration files,
  304. device permissions, and rules for device naming</para>
  305. <indexterm zone="ch-system-udev etc-udev">
  306. <primary sortas="e-/etc/udev">/etc/udev</primary>
  307. </indexterm>
  308. </listitem>
  309. </varlistentry>
  310. </variablelist>
  311. </sect2>
  312. </sect1>