source: postlfs/shells/zsh.xml@ e19ad480

<?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 zsh-download-http "http://prdownloads.sourceforge.net/zsh/zsh-&zsh-version;.tar.bz2">
  <!ENTITY zsh-download-ftp  " ">
  <!ENTITY zsh-md5sum        "e2060f743dcdf3b383e80e862a6548fe">
  <!ENTITY zsh-size          "2.0 MB">
  <!ENTITY zsh-buildsize     "24 MB">
  <!ENTITY zsh-time          "0.5 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">zsh-&zsh-version;.tar</keyword>
      <keyword role="ftptdir">zsh</keyword>
    </keywordset>
  </sect1info>

  <title>ZSH-&zsh-version;</title>

  <indexterm zone="zsh">
    <primary sortas="a-ZSH">ZSH</primary>
  </indexterm>

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

    <para>The <application>ZSH</application> package contains a command
    interpreter (shell) usable as an interactive login shell and as
    a shell script command processor. Of the standard shells,
    <application>ZSH</application> most closely resembles
    <application>KSH</application> but includes many enhancements.</para>

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

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

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

<screen role="root"><userinput>make install &amp;&amp;
make install.info</userinput></screen>

  </sect2>

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

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

      <para>There are a whole host of configuration files for
      <application>ZSH</application> including <filename>/etc/zshenv</filename>,
      <filename>/etc/zprofile</filename>, <filename>/etc/zshrc</filename>,
      <filename>/etc/zlogin</filename>, and <filename>/etc/zlogout</filename>.
      You can find more information on these in the <filename>zsh(1)</filename>
      and related man pages.</para>

      <indexterm zone="zsh zsh-config">
        <primary sortas="e-etc-zshenv">/etc/zshenv</primary>
      </indexterm>

      <indexterm zone="zsh zsh-config">
        <primary sortas="e-etc-zprofile">/etc/zprofile</primary>
      </indexterm>

      <indexterm zone="zsh zsh-config">
        <primary sortas="e-etc-zshrc">/etc/zshrc</primary>
      </indexterm>

      <indexterm zone="zsh zsh-config">
        <primary sortas="e-etc-zlogin">/etc/zlogin</primary>
      </indexterm>

      <indexterm zone="zsh zsh-config">
        <primary sortas="e-etc-zlogout">/etc/zlogout</primary>
      </indexterm>

    </sect3>

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

      <para>Update <filename>/etc/shells</filename> to include the
      <application>ZSH</application> shell program names (as the
      <systemitem class="username">root</systemitem> user):</para>

<screen role="root"><userinput>cat &gt;&gt; /etc/shells &lt;&lt; "EOF"
<literal>/usr/bin/zsh
/usr/bin/zsh-4.2.5</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>zsh and zsh-4.2.5</seg>
        <seg>None</seg>
        <seg>/usr/lib/zsh and /usr/share/zsh</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="zsh-prog">
        <term><command>zsh</command></term>
        <listitem>
          <para>is a shell which has command-line editing, built-in spelling
          correction, programmable command completion, shell functions (with
          autoloading), a history mechanism, and a host of other features.</para>
          <indexterm zone="zsh zsh-prog">
            <primary sortas="b-zsh">zsh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>