source: postlfs/editors/nano.xml@ 86eaa277

<?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 nano-download-http "http://www.nano-editor.org/dist/v1.2/nano-&nano-version;.tar.gz">
  <!ENTITY nano-download-ftp  "ftp://ftp.uni-koeln.de/editor/nano-&nano-version;.tar.gz">
  <!ENTITY nano-md5sum        "f2b3efbf1cf356d736740d531b6b22c4">
  <!ENTITY nano-size          "891 KB">
  <!ENTITY nano-buildsize     "5.1 MB">
  <!ENTITY nano-time          "0.1 SBU">

  <!-- The nano development version fixes a lot of issues w.r.t.
       locale issues. This entity can be removed when nano-2.0 stable
       is released and added to BLFS -->
  <!ENTITY nano-devel-version "1.9.99pre2">
]>

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

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

  <title>Nano-&nano-version;</title>

  <indexterm zone="nano">
    <primary sortas="a-Nano">Nano</primary>
  </indexterm>

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

    <para>The <application>nano</application> package contains a small,
    simple text editor which aims to replace <application>Pico</application>,
    the default editor in the <application>Pine</application> package.</para>

    <caution>
      <para>The <application>Nano</application> package has major issues
      when used in a UTF-8 based locale. A development version is available
      which addresses these issues at <ulink
      url="http://www.nano-editor.org/dist/v1.3/nano-&nano-devel-version;.tar.gz"/>.
      This version can be installed with the same instructions shown below.
      See the <xref linkend="locale-issues"/> page for a more general
      discussion of these problems.</para>
    </caution>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="slang"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc/nano \
    --enable-color --enable-multibuffer --enable-nanorc &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 install &amp;&amp;
install -v -m644 -D nanorc.sample /etc/nano/nanorc.sample &amp;&amp;
install -v -m755 -d /usr/share/doc/nano-&nano-version; &amp;&amp;
install -v -m644 *.html /usr/share/doc/nano-&nano-version;</userinput></screen>

  </sect2>

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

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

      <para><filename>/etc/nano/nanorc</filename> and
      <filename>~/.nanorc</filename></para>

      <indexterm zone="nano nano-config">
        <primary sortas="e-etc-nano-nanorc">/etc/nano/nanorc</primary>
      </indexterm>

      <indexterm zone="nano nano-config">
        <primary sortas="e-AA.nanorc">~/.nanorc</primary>
      </indexterm>

    </sect3>

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

      <para>Example configuration (create as a system-wide
      <filename>/etc/nano/nanorc</filename> or a personal
      <filename>~/.nanorc</filename> file)</para>

<screen><literal>set autoindent
set const
set fill 72
set historylog
set multibuffer
set nohelp
set regexp
set smooth
set suspend</literal></screen>

      <para>Another example is the <filename>nanorc.sample</filename> file
      in the <filename class="directory">/etc/nano</filename> directory.
      It includes color configurations and has some documentation included
      in the comments.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>nano</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/nano</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="nano-prog">
        <term><command>nano</command></term>
        <listitem>
          <para>is a small, simple text editor which aims to replace
          <application>Pico</application>, the default editor in the
          <application>Pine</application> package.</para>
          <indexterm zone="nano nano-prog">
            <primary sortas="b-nano">nano</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>