source: connect/dhcp/dhcpcd.xml@ ebabf24

<?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;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY dhcpcd-download-http "http://ftp.osuosl.org/pub/gentoo/distfiles/dhcpcd-&dhcpcd-version;.tar.bz2">
  <!ENTITY dhcpcd-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/dhcpcd-&dhcpcd-version;.tar.bz2">
  <!ENTITY dhcpcd-md5sum        "e2e5cd9b8824c7b1d37a7c441b83515f">
  <!ENTITY dhcpcd-size          "128 KB">
  <!ENTITY dhcpcd-buildsize     "1.3 MB">
  <!ENTITY dhcpcd-time          "less than 0.1 SBU">
]>

<sect1 id="dhcpcd" xreflabel="dhcpcd-&dhcpcd-version;">
  <?dbhtml filename="dhcpcd.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Dhcpcd-&dhcpcd-version;</title>

  <indexterm zone="dhcpcd">
    <primary sortas="a-Dhcpcd">Dhcpcd</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Dhcpcd</title>

    <para>The <application>dhcpcd</application> package contains the
    <command>dhcpcd</command> client. This is useful for connecting your computer
    to a network which uses DHCP to assign network addresses.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&dhcpcd-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&dhcpcd-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &dhcpcd-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &dhcpcd-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &dhcpcd-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &dhcpcd-time;</para>
      </listitem>
    </itemizedlist>

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch:
        <ulink url="&patch-root;/dhcpcd-&dhcpcd-version;-fhs-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/dhcpcd"/></para>

  </sect2>

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

    <para>Install <application>dhcpcd</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix="" --sysconfdir=/var/lib \
    --mandir=/usr/share/man &amp;&amp;
make</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--prefix=""</parameter>: There may be a good reason for
    abandoning the normal BLFS convention of using
    <parameter>--prefix=/usr</parameter> here.  If you are installing
    DHCP, it is likely that it is
    required during the boot process and
    <filename class="directory">/usr</filename> may be network mounted, in which
    case <command>dhcpcd</command> wouldn't be available due to being on the
    network! Therefore, depending on your situation, you may want it to be
    installed in <filename class="directory">/sbin</filename> or
    <filename class="directory">/usr/sbin</filename>. This command installs to
    <filename class="directory">/sbin</filename>.</para>

    <para><parameter>--sysconfdir=/var/lib</parameter>: This command installs
    configuration and state files in the
    <filename class="directory">/var/lib</filename> directory.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Dhcpcd</title>

    <sect3 id="dhcpcd-config">
      <title>Config Files</title>

      <para><filename>/var/lib/dhcpc/*</filename></para>

      <indexterm zone="dhcpcd dhcpcd-config">
        <primary sortas="e-var-lib-dhcpc">/var/lib/dhcpc/*</primary>
      </indexterm>

    </sect3>

    <sect3 id="dhcpcd-init">
      <title>Configuration Information</title>

      <para>To configure <command>dhcpcd</command>, you need to first install
      the network service script,
      <filename>/etc/sysconfig/network-devices/services/dhcpcd</filename>
      included in the <xref linkend="bootscripts"/> package
      (as user <systemitem class="username">root</systemitem>):</para>

      <indexterm zone="dhcpcd dhcpcd-init">
        <primary sortas="f-dhcpcd">dhcpcd (service script)</primary>
      </indexterm>

<screen role='root'><userinput>make install-service-dhcpcd</userinput></screen>

      <para id="dhcpcd-config2">Finally, as the <systemitem
      class="username">root</systemitem> user create the
      <filename>/etc/sysconfig/network-devices/ifconfig.eth0/dhcpcd</filename>
      configuration file using the following commands.  Adjust appropriately
      for additional interfaces:</para>

      <indexterm zone="dhcpcd dhcpcd-config2">
        <primary sortas="e-etc-sysconfig-dhcpcd">/etc/sysconfig/.../dhcpcd</primary>
      </indexterm>

<screen role='root'><userinput>install -v -d /etc/sysconfig/network-devices/ifconfig.eth0 &amp;&amp;
cat &gt; /etc/sysconfig/network-devices/ifconfig.eth0/dhcpcd &lt;&lt; "EOF"
<literal>ONBOOT="yes"
SERVICE="dhcpcd"
DHCP_START="<replaceable>&lt;insert appropriate start options here&gt;</replaceable>"
DHCP_STOP="-k <replaceable>&lt;insert additional stop options here&gt;</replaceable>"

# Set PRINTIP="yes" to have the script print
# the DHCP assigned IP address
PRINTIP="no"

# Set PRINTALL="yes" to print the DHCP assigned values for
# IP, SM, DG, and 1st NS. This requires PRINTIP="yes".
PRINTALL="no"</literal>
EOF</userinput></screen>

      <para>For more information on the appropriate <envar>DHCP_START</envar> and
      <envar>DHCP_STOP</envar> values, examine the man page for
      <command>dhcpcd</command>.</para>

      <note>
        <para id="dhcpcd-config3">The default behavior of
        <command>dhcpcd</command> is to overwrite (after making backup copies)
        <filename>/etc/resolv.conf</filename>, <filename>/etc/yp.conf</filename> and
        <filename>/etc/ntp.conf</filename> with new files containing information from
        the DHCP server. If this is undesirable, review the
        <command>dhcpcd</command> man page for switches to add to the
        <envar>DHCP_START</envar> value.</para>
      </note>

      <indexterm zone="dhcpcd dhcpcd-config3">
        <primary sortas="e-etc-resolv.conf">/etc/resolv.conf</primary>
      </indexterm>

      <indexterm zone="dhcpcd dhcpcd-config3">
        <primary sortas="e-etc-yp.conf">/etc/yp.conf</primary>
      </indexterm>

      <indexterm zone="dhcpcd dhcpcd-config3">
        <primary sortas="e-etc-ntp.conf">/etc/ntp.conf</primary>
      </indexterm>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>dhcpcd</seg>
        <seg>None</seg>
        <seg>/var/lib/dhcpc</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="dhcpcd-prog">
        <term><command>dhcpcd</command></term>
        <listitem>
          <para>is an implementation of the DHCP client
          specified in RFC2131 and RFC1541
          (depending on which options are specified).</para>
          <indexterm zone="dhcpcd dhcpcd-prog">
            <primary sortas="b-dhcpcd">dhcpcd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>