udev.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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; plus &udev-testfiles-du; for testfiles</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>The udev-testfiles tarball contains files needed to test udev. The
  37. file expands to an apparent size of about 37MB but the actual disk usage
  38. is less than 7MB.</para>
  39. <screen><userinput remap="pre">tar -xvf ../udev-&udev-version;-testfiles.tar.bz2 --strip-components=1</userinput></screen>
  40. <para>Create some devices and directories that Udev cannot handle due to
  41. them being required very early in the boot process, or by Udev itself:</para>
  42. <screen><userinput remap="install">install -dv /lib/{firmware,udev/devices/pts}
  43. mknod -m0666 /lib/udev/devices/null c 1 3</userinput></screen>
  44. <para>Prepare the package for compilation:</para>
  45. <!-- Note that "libdir=/usr/lib64" would be required for multilib. -->
  46. <screen><userinput remap="configure">./configure --prefix=/usr \
  47. --sysconfdir=/etc --sbindir=/sbin \
  48. --with-rootlibdir=/lib --libexecdir=/lib/udev \
  49. --disable-extras --disable-introspection</userinput></screen>
  50. <variablelist>
  51. <title>The meaning of the new configure options</title>
  52. <varlistentry>
  53. <term><parameter>--with-rootlibdir=/lib</parameter></term>
  54. <listitem>
  55. <para>This controls where the <filename
  56. class="libraryfile">libudev</filename> library is installed. The
  57. library needs to be in <filename class="directory">/lib</filename>
  58. because it's used by Udev at boot time, before <filename
  59. class="directory">/usr</filename> might be available, and the default
  60. --rootlibdir is <filename class="directory">/usr/lib</filename>.</para>
  61. </listitem>
  62. </varlistentry>
  63. <!-- Note that libexecdir *MUST* stay /lib/udev, even on a 64-bit
  64. / multilib system where udev is compiled for 64-bit. Other
  65. packages require this exact path; the udev maintainers have
  66. said this is part of the udev API. -->
  67. <varlistentry>
  68. <term><parameter>--libexecdir=/lib/udev</parameter></term>
  69. <listitem>
  70. <para>This controls where Udev-internal rules and helper programs
  71. are installed.</para>
  72. </listitem>
  73. </varlistentry>
  74. <varlistentry>
  75. <term><parameter>--disable-extras</parameter></term>
  76. <listitem>
  77. <para>This option prevents Udev from installing helper programs and
  78. other extras which require more external libraries. These libraries
  79. are not part of the base LFS system. See the Udev
  80. <filename>README</filename> file for more information.</para>
  81. </listitem>
  82. </varlistentry>
  83. <varlistentry>
  84. <term><parameter>--disable-introspection</parameter></term>
  85. <listitem>
  86. <para>This option prevents Udev's instrospection feature, which
  87. requires packages not installed as part of the base LFS system. See
  88. the Udev <filename>README</filename> file for more information.</para>
  89. </listitem>
  90. </varlistentry>
  91. </variablelist>
  92. <para>Compile the package:</para>
  93. <screen><userinput remap="make">make</userinput></screen>
  94. <para>Test the package.</para>
  95. <screen><userinput remap="test">make check</userinput></screen>
  96. <para>Install the package:</para>
  97. <screen><userinput remap="install">make install</userinput></screen>
  98. <para>Remove an empty documentation directory:</para>
  99. <screen><userinput remap="install">rmdir -v /usr/share/doc/udev</userinput></screen>
  100. <para>Now install the LFS-specific custom rules files:</para>
  101. <screen><userinput remap="install">cd &udev-config;
  102. make install</userinput></screen>
  103. <para>Install the documentation that explains the LFS-specific rules
  104. files:</para>
  105. <screen><userinput remap="install">make install-doc</userinput></screen>
  106. </sect2>
  107. <sect2 id="contents-udev" role="content">
  108. <title>Contents of Udev</title>
  109. <segmentedlist>
  110. <segtitle>Installed programs</segtitle>
  111. <segtitle>Installed libraries</segtitle>
  112. <segtitle>Installed directories</segtitle>
  113. <seglistitem>
  114. <seg>ata_id, cdrom_id, collect, create_floppy_devices, edd_id,
  115. firmware.sh, fstab_import, path_id, scsi_id, udevadm, udevd,
  116. usb_id, write_cd_rules, and write_net_rules</seg>
  117. <seg>libudev.{a,so}</seg>
  118. <seg>/etc/udev, /lib/udev, /lib/firmware</seg>
  119. </seglistitem>
  120. </segmentedlist>
  121. <variablelist>
  122. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  123. <?dbfo list-presentation="list"?>
  124. <?dbhtml list-presentation="table"?>
  125. <varlistentry id="ata_id">
  126. <term><command>ata_id</command></term>
  127. <listitem>
  128. <para>Provides Udev with a unique string and
  129. additional information (uuid, label) for an ATA drive</para>
  130. <indexterm zone="ch-system-udev ata_id">
  131. <primary sortas="b-ata_id">ata_id</primary>
  132. </indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="cdrom_id">
  136. <term><command>cdrom_id</command></term>
  137. <listitem>
  138. <para>Provides Udev with the capabilities of a
  139. CD-ROM or DVD-ROM drive</para>
  140. <indexterm zone="ch-system-udev cdrom_id">
  141. <primary sortas="b-cdrom_id">cdrom_id</primary>
  142. </indexterm>
  143. </listitem>
  144. </varlistentry>
  145. <varlistentry id="collect">
  146. <term><command>collect</command></term>
  147. <listitem>
  148. <para>Given an ID for the current uevent and a list of
  149. IDs (for all target uevents), registers the current ID
  150. and indicates whether all target IDs have been registered</para>
  151. <indexterm zone="ch-system-udev collect">
  152. <primary sortas="b-collect">collect</primary>
  153. </indexterm>
  154. </listitem>
  155. </varlistentry>
  156. <varlistentry id="create_floppy_devices">
  157. <term><command>create_floppy_devices</command></term>
  158. <listitem>
  159. <para>Creates all possible floppy devices based on the CMOS type</para>
  160. <indexterm zone="ch-system-udev create_floppy_devices">
  161. <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
  162. </indexterm>
  163. </listitem>
  164. </varlistentry>
  165. <varlistentry id="edd_id">
  166. <term><command>edd_id</command></term>
  167. <listitem>
  168. <para>Provides Udev with the EDD ID for a BIOS disk drive</para>
  169. <indexterm zone="ch-system-udev edd_id">
  170. <primary sortas="b-edd_id">edd_id</primary>
  171. </indexterm>
  172. </listitem>
  173. </varlistentry>
  174. <varlistentry id="firmware.sh">
  175. <term><command>firmware.sh</command></term>
  176. <listitem>
  177. <para>Uploads firmware to devices</para>
  178. <indexterm zone="ch-system-udev firmware.sh">
  179. <primary sortas="b-firmware.sh">firmware.sh</primary>
  180. </indexterm>
  181. </listitem>
  182. </varlistentry>
  183. <varlistentry id="fstab_import">
  184. <term><command>fstab_import</command></term>
  185. <listitem>
  186. <para>Finds an entry in <filename>/etc/fstab</filename> that
  187. matches the current device, and provides its information to
  188. Udev</para>
  189. <indexterm zone="ch-system-udev fstab_import">
  190. <primary sortas="b-fstab_import">fstab_import</primary>
  191. </indexterm>
  192. </listitem>
  193. </varlistentry>
  194. <varlistentry id="path_id">
  195. <term><command>path_id</command></term>
  196. <listitem>
  197. <para>Provides the shortest possible unique hardware path to a
  198. device</para>
  199. <indexterm zone="ch-system-udev path_id">
  200. <primary sortas="b-path_id">path_id</primary>
  201. </indexterm>
  202. </listitem>
  203. </varlistentry>
  204. <varlistentry id="scsi_id">
  205. <term><command>scsi_id</command></term>
  206. <listitem>
  207. <para>Provides Udev with a unique SCSI identifier
  208. based on the data returned from sending a SCSI INQUIRY command to
  209. the specified device</para>
  210. <indexterm zone="ch-system-udev scsi_id">
  211. <primary sortas="b-scsi_id">scsi_id</primary>
  212. </indexterm>
  213. </listitem>
  214. </varlistentry>
  215. <varlistentry id="udevadm">
  216. <term><command>udevadm</command></term>
  217. <listitem>
  218. <para>Generic udev administration tool: controls the udevd daemon,
  219. provides info from the Udev database, monitors uevents, waits for
  220. uevents to finish, tests Udev configuration, and triggers uevents
  221. for a given device</para>
  222. <indexterm zone="ch-system-udev udevadm">
  223. <primary sortas="b-udevadm">udevadm</primary>
  224. </indexterm>
  225. </listitem>
  226. </varlistentry>
  227. <varlistentry id="udevd">
  228. <term><command>udevd</command></term>
  229. <listitem>
  230. <para>A daemon that listens for uevents on the netlink socket,
  231. creates devices and runs the configured external programs in
  232. response to these uevents</para>
  233. <indexterm zone="ch-system-udev udevd">
  234. <primary sortas="b-udevd">udevd</primary>
  235. </indexterm>
  236. </listitem>
  237. </varlistentry>
  238. <varlistentry id="usb_id">
  239. <term><command>usb_id</command></term>
  240. <listitem>
  241. <para>Provides Udev with information about USB
  242. devices</para>
  243. <indexterm zone="ch-system-udev usb_id">
  244. <primary sortas="b-usb_id">usb_id</primary>
  245. </indexterm>
  246. </listitem>
  247. </varlistentry>
  248. <varlistentry id="write_cd_rules">
  249. <term><command>write_cd_rules</command></term>
  250. <listitem>
  251. <para>A script which generates Udev rules to provide stable names for
  252. optical drives (see also <xref linkend="ch-scripts-symlinks"/>)</para>
  253. <indexterm zone="ch-system-udev write_cd_rules">
  254. <primary sortas="b-write_cd_rules">write_cd_rules</primary>
  255. </indexterm>
  256. </listitem>
  257. </varlistentry>
  258. <varlistentry id="write_net_rules">
  259. <term><command>write_net_rules</command></term>
  260. <listitem>
  261. <para>A script which generates rules to provide stable names for
  262. network interfaces (see also <xref linkend="ch-scripts-network"/>)
  263. </para>
  264. <indexterm zone="ch-system-udev write_net_rules">
  265. <primary sortas="b-write_net_rules">write_net_rules</primary>
  266. </indexterm>
  267. </listitem>
  268. </varlistentry>
  269. <varlistentry id="libudev">
  270. <term><filename class="libraryfile">libudev</filename></term>
  271. <listitem>
  272. <para>A library interface to udev device information</para>
  273. <indexterm zone="ch-system-udev libudev">
  274. <primary sortas="c-libudev">libudev</primary>
  275. </indexterm>
  276. </listitem>
  277. </varlistentry>
  278. <varlistentry id="etc-udev">
  279. <term><filename class="directory">/etc/udev</filename></term>
  280. <listitem>
  281. <para>Contains Udev configuration files,
  282. device permissions, and rules for device naming</para>
  283. <indexterm zone="ch-system-udev etc-udev">
  284. <primary sortas="e-/etc/udev">/etc/udev</primary>
  285. </indexterm>
  286. </listitem>
  287. </varlistentry>
  288. </variablelist>
  289. </sect2>
  290. </sect1>