source: BOOK/boot/common/eudev.xml @ 90e8c97

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-boot-eudev" role="wrap">
  <?dbhtml filename="eudev.html"?>

  <title>Eudev-&eudev-version;</title>

  <indexterm zone="ch-boot-eudev">
    <primary sortas="a-Eudev">Eudev</primary>
    <secondary>boot</secondary>
  </indexterm>

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

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

  </sect2>

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

   <para os="a">Prepare Eudev for compilation:</para>

<screen os="b"><userinput>BLKID_CFLAGS="-I/tools/include" BLKID_LIBS="-L/tools/lib -lblkid" \
KMOD_CFLAGS="-I/tools/include/" KMOD_LIBS="-L/tools/lib -lkmod" \
LDFLAGS="-Wl,-rpath,/tools/lib:/lib" ./configure --prefix=/tools \
    --build=${CLFS_HOST} --host=${CLFS_TARGET} \
    --disable-introspection --disable-gtk-doc-html \
    --disable-gudev --disable-keymap --with-firmware-path=/lib/firmware \
    --enable-libkmod</userinput></screen>

    <para os="c">Compile the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <para os="g">Install the package:</para>

<screen os="j"><userinput>make install</userinput></screen>

    <para os="i">Create a directory for storing firmware that can be
    loaded by <command>udev</command>:</para>

<screen os="k"><userinput>install -dv ${CLFS}/lib/firmware</userinput></screen>

    <para os="r1">Create a dummy rule so that Eudev will name ethernet devices properly for the system.</para>

<screen os="r2"><userinput>echo "# dummy, so that network is once again on eth*" \
> ${CLFS}/etc/udev/rules.d/80-net-name-slot.rules</userinput></screen>

 </sect2>

  <sect2 id="contents-eudev" role="content">
    <title>Contents of Eudev</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed library</segtitle>
      <segtitle>Installed directories</segtitle>

      <seglistitem>
        <seg>ata_id, cdrom_id, collect, create_floppy_devices, edd_id,
        firmware.sh, fstab_import, path_id, scsi_id, udevadm, udevd, usb_id,
        v4l_id, write_cd_rules, write_net_rules</seg>
        <seg>libudev</seg>
        <seg>/etc/udev, /lib/firmware, /lib/udev, /usr/share/doc/udev</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="udevadm">
        <term><command>udevadm</command></term>
        <listitem>
        <para>Controls the runtime behavior of Eudev, requests kernel
        events, manages the event queue, and provides simple debugging.</para>
          <indexterm zone="ch-boot-eudev udevadm">
            <primary sortas="b-udevadm">udevadm</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-boot-eudev udevd">
            <primary sortas="b-udevd">udevd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

 <!-- Start of Helpers -->
      <varlistentry id="ata_id">
        <term><command>ata_id</command></term>
        <listitem>
          <para>Provides Eudev with a unique string and additional
          information (uuid, label) for an ATA drive</para>
          <indexterm zone="ch-boot-eudev ata_id">
            <primary sortas="b-ata_id">ata_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cdrom_id">
        <term><command>cdrom_id</command></term>
        <listitem>
          <para>Prints the capabilities of a CDROM or DVDROM drive.</para>
          <indexterm zone="ch-boot-eudev cdrom_id">
            <primary sortas="b-cdrom_id">cdrom_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="collect">
        <term><command>collect</command></term>
        <listitem>
          <para>Given an ID for the current uevent and a list of IDs
(for all target uevents), registers the current ID and indicates whether
all target IDs have been registered.</para>
          <indexterm zone="ch-boot-eudev collect">
            <primary sortas="b-collect">collect</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="create_floppy_devices">
        <term><command>create_floppy_devices</command></term>
        <listitem>
          <para>Creates all possible floppy devices based on the CMOS type</para>
          <indexterm zone="ch-boot-eudev create_floppy_devices">
            <primary sortas="b-create_floppy_devices">create_floppy_devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="edd_id">
        <term><command>edd_id</command></term>
        <listitem>
          <para>Identifies x86 disk drives from Enhanced Disk Drive calls</para>
          <indexterm zone="ch-boot-eudev edd_id">
            <primary sortas="b-edd_id">edd_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="firmware.sh">
        <term><command>firmware.sh</command></term>
        <listitem>
          <para>Script to load firmware for a device</para>
          <indexterm zone="ch-boot-eudev firmware.sh">
            <primary sortas="b-firmware.sh">firmware.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fstab_import">
        <term><command>fstab_import</command></term>
        <listitem>
          <para>Finds an entry in <filename>/etc/fstab</filename> that matches
the current device, and provides its information to Udev.</para>
          <indexterm zone="ch-boot-eudev fstab_import">
            <primary sortas="b-fstab_import">fstab_import</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="path_id">
        <term><command>path_id</command></term>
        <listitem>
          <para>Provides the shortest possible unique hardware path to a
          device</para>
          <indexterm zone="ch-boot-eudev path_id">
            <primary sortas="b-path_id">path_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="scsi_id">
        <term><command>scsi_id</command></term>
        <listitem>
          <para>Retrieves or generates a unique SCSI identifier.</para>
          <indexterm zone="ch-boot-eudev scsi_id">
            <primary sortas="b-scsi_id">scsi_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="usb_id">
        <term><command>usb_id</command></term>
        <listitem>
          <para>Identifies a USB block device.</para>
          <indexterm zone="ch-boot-eudev usb_id">
            <primary sortas="b-usb_id">usb_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="v4l_id">
        <term><command>v4l_id</command></term>
        <listitem>
          <para>Determines V4L capabilities for a given device.</para>
          <indexterm zone="ch-boot-eudev v4l_id">
            <primary sortas="b-v4l_id">v4l_id</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="write_cd_rules">
        <term><command>write_cd_rules</command></term>
        <listitem>
          <para>A script which generates Eudev rules to provide stable names
for network interfaces.</para>
          <indexterm zone="ch-boot-eudev write_cd_rules">
            <primary sortas="b-write_cd_rules">write_cd_rules</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="write_net_rules">
        <term><command>write_net_rules</command></term>
        <listitem>
          <para>A script which generates Eudev rules to provide stable names
for network interfaces.</para>
          <indexterm zone="ch-boot-eudev write_net_rules">
            <primary sortas="b-write_net_rules">write_net_rules</primary>
          </indexterm>
        </listitem>
      </varlistentry>
<!-- End of Helpers -->

      <varlistentry id="libudev">
        <term><filename class="libraryfile">libudev</filename></term>
        <listitem>
          <para>A library interface to eudev device information.</para>
          <indexterm zone="ch-boot-eudev libudev">
            <primary sortas="c-libudev">libudev</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="lib-eudev">
        <term><filename class="directory">/lib/udev</filename></term>
        <listitem>
          <para>Contains <command>udev</command> helper programs
          and static devices which get copied to /dev when booted.</para>
          <indexterm zone="ch-boot-eudev lib-eudev">
            <primary sortas="e-/lib/udev">/lib/udev</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>