source: networking/netprogs/wget.xml@ 828b199

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

  <!ENTITY wget-download-http
           "&gnu-http;/wget/wget-&wget-version;.tar.gz">
  <!ENTITY wget-download-ftp
           "&gnu-ftp;/wget/wget-&wget-version;.tar.gz">
  <!ENTITY wget-md5sum        "caabf9727fa429626316619a6369fffa">
  <!ENTITY wget-size          "4.2 MB">
  <!ENTITY wget-buildsize     "33 MB (add 4 MB for tests)">
  <!ENTITY wget-time          "0.3 SBU (add 0.2 SBU for tests)">
]>

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

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

  <title>Wget-&wget-version;</title>

  <indexterm zone="wget">
    <primary sortas="a-Wget">Wget</primary>
  </indexterm>

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

    <para>
      The <application>Wget</application> package contains a utility useful for
      non-interactive downloading of files from the Web.
    </para>

    &lfs81_checked;

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

    <bridgehead renderas="sect3">Wget Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref role="runtime" linkend="cacerts"/> (runtime),
      <xref linkend="openssl"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gnutls"/>,
      <xref linkend="gpgme"/>,
      <xref linkend="libidn"/>,
      <xref linkend="pcre"/>,
      <xref linkend="valgrind"/> (optional for the test suite),
      <ulink url="http://search.cpan.org/~behroozi/IO-Socket-SSL/">IO::Socket::SSL</ulink>,
      <ulink url="http://search.cpan.org/~gaas/HTTP-Daemon/">HTTP::Daemon</ulink>
      (both required for the test suite), and
      <ulink url="https://github.com/rockdaboot/libpsl/">libpsl</ulink>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr      \
            --sysconfdir=/etc  \
            --with-ssl=openssl &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>. Almost all the
      check-TESTS tests fail if <application>valgrind</application> is enabled
      (the unit tests all pass).
    </para>

    <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>--sysconfdir=/etc</parameter>: This relocates the configuration
      file from <filename class="directory">/usr/etc</filename> to
      <filename class="directory">/etc</filename>.
    </para>

    <para>
      <parameter>--with-ssl=openssl</parameter>: This allows the program to use
      <xref linkend="openssl"/> instead of <xref linkend="gnutls"/>.
    </para>

    <para>
      <option>--enable-valgrind-tests</option>: This allows the tests to be
      run under valgrind.
    </para>

  </sect2>

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

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

      <para>
        <filename>/etc/wgetrc</filename> and
        <filename>~/.wgetrc</filename>
      </para>

      <indexterm zone="wget wget-config">
        <primary sortas="e-AA.wgetrc">~/.wgetrc</primary>
      </indexterm>

      <indexterm zone="wget wget-config">
        <primary sortas="e-etc-wgetrc">/etc/wgetrc</primary>
      </indexterm>

<!--
      <para>
        If you have installed the <xref linkend="cacerts"/> and you want
        <application>Wget</application> to use them, as the
        <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>echo ca-directory=/etc/ssl/certs >> /etc/wgetrc</userinput></screen>
-->

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>
          wget
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="wget-prog">
        <term><command>wget</command></term>
        <listitem>
          <para>
            retrieves files from the Web using the HTTP, HTTPS and FTP
            protocols.  It is designed to be non-interactive, for background or
            unattended operations.
          </para>
          <indexterm zone="wget wget-prog">
            <primary sortas="b-wget">wget</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>