source: basicnet/textweb/lynx.xml@ 95799899

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

  <!ENTITY lynx-download-http "http://lynx.isc.org/release/lynx&lynx-version;.tar.bz2">
  <!ENTITY lynx-download-ftp  "ftp://lynx.isc.org/lynx&lynx-version;/lynx&lynx-version;.tar.bz2">
  <!ENTITY lynx-md5sum        "d1e5134e5d175f913c16cb6768bc30eb">
  <!ENTITY lynx-size          "2.2 MB">
  <!ENTITY lynx-buildsize     "25 MB">
  <!ENTITY lynx-time          "0.5 SBU">
]>

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

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

  <title>Lynx-&lynx-version;</title>

  <indexterm zone="lynx">
    <primary sortas="a-Lynx">Lynx</primary>
  </indexterm>

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

    <para><application>Lynx</application> is a text based web browser.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/> or
    <ulink url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink> (which
    needs <ulink
    url="ftp://ftp.gnupg.org/gcrypt/alpha/libgpg-error/">libgpg-error</ulink>
    then <ulink url="ftp://ftp.gnupg.org/gcrypt/libgcrypt/">libgcrypt</ulink>),
    an <xref linkend="server-mail"/>,
    <xref linkend="zip"/>, <xref linkend="unzip"/>,
    <xref linkend="slang"/> and
    <!-- <ulink
    url="http://ftp.ibiblio.org/pub/linux/utils/compress/ncompress-4.2.4.tar.Z">
    ncompress</ulink> and -->
    <ulink url="http://www.gnu.org/software/sharutils/">sharutils</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --libdir=/etc \
    --with-zlib --with-bzlib &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

<screen role='root'><userinput>make docdir=/usr/share/doc/lynx-&lynx-version;/doc \
    helpdir=/usr/share/doc/lynx-&lynx-version;/help install-full &amp;&amp;
chgrp -v -R root /usr/share/doc/lynx-&lynx-version;/doc</userinput></screen>

  </sect2>

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

    <para><parameter>--libdir=/etc</parameter>: For some reason, the
    <command>configure</command> and <command>make</command> routine for
    <application>Lynx</application> uses <option>libdir</option> as the prefix
    for the configuration file. This is set to
    <filename class="directory">/etc</filename> so that the system wide
    configuration file is <filename>/etc/lynx.cfg</filename>.</para>

    <para><parameter>--with-zlib</parameter>: This enables support for
    linking <filename class="libraryfile">libz</filename> into
    <application>Lynx</application>.</para>

    <para><parameter>--with-bzlib</parameter>: This enables support for
    linking <filename class="libraryfile">libbz2</filename> into
    <application>Lynx</application>.</para>

    <para><parameter>docdir=... helpdir=...</parameter>: These
    variables are set to avoid getting the help and documentation files
    installed under <filename class="directory">/etc</filename>.</para>

    <para><parameter>install-full</parameter>: In addition to the standard
    installation, this target installs the documentation and the help
    files.</para>

    <para><option>--with-ssl</option>: This enables support for
    linking SSL into <application>Lynx</application>.</para>

    <para><option>--with-gnutls</option>: This enables support for
    linking <application>GnuTLS</application> into
    <application>Lynx</application>.</para>

    <para><command>chgrp -v -R root
    /usr/share/doc/lynx-&lynx-version;/doc</command>:
    This command corrects the improper group ownership of installed
    documentation files caused if <application>Lynx</application> is built
    by any user other than
    <systemitem class="username">root</systemitem>.</para>

    <note>
      <para>There has been a security vulnerability identified if you enable
      support for CGI links by passing the <option>--enable-cgi-links</option>
      parameter to <command>configure</command>. See <ulink
      url="http://seclists.org/lists/vulnwatch/2005/Oct-Dec/0041.html"/> for
      details.</para>
    </note>

  </sect2>

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

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

      <para><filename>/etc/lynx.cfg</filename></para>

      <indexterm zone="lynx lynx-config">
        <primary sortas="e-etc-lynx.cfg">/etc/lynx.cfg</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>Various settings such as proxies can be set in the system-wide
      <filename>lynx.cfg</filename> file found in
      <filename class="directory">/etc</filename>.</para>

    </sect3>

  </sect2>

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

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

    <seglistitem>
      <seg>lynx</seg>
      <seg>None</seg>
      <seg>/usr/share/doc/lynx-&lynx-version;</seg>
    </seglistitem>
    </segmentedlist>

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

      <varlistentry id="lynx-prog">
        <term><command>lynx</command></term>
        <listitem>
          <para>is a general purpose, text-based, distributed information
          browser for the World Wide Web.</para>
          <indexterm zone="lynx lynx-prog">
            <primary sortas="b-lynx">lynx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>