source: postlfs/editors/joe.xml@ dcbbcc4a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY joe-download-http "http://prdownloads.sourceforge.net/joe-editor/joe-&joe-version;.tar.gz">
  <!ENTITY joe-download-ftp  " ">
  <!ENTITY joe-md5sum        "2a6ef018870fca9b7df85401994fb0e0">
  <!ENTITY joe-size          "380 KB">
  <!ENTITY joe-buildsize     "5.7 MB">
  <!ENTITY joe-time          "0.11 SBU">
]>

<sect1 id="joe">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="joe.html"?>
<title>JOE-&joe-version;</title>
<indexterm zone="joe"><primary
sortas="a-JOE">JOE</primary></indexterm>

<sect2>
<title>Introduction to <application><acronym>JOE</acronym></application></title>

<para><application>JOE</application> (Joe's own editor) is a small text editor 
capable of emulating WordStar, <application>Pico</application>,
and <application>Emacs</application>.</para>

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

</sect2>

<sect2>
<title>Installation of <application><acronym>JOE</acronym></application></title>

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

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

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Configuration files</title>

<sect3 id="joe-config"><title>Config files</title>
<para><filename>/etc/joe/jmacsrc</filename>,
<filename>/etc/joe/joerc</filename>, <filename>/etc/joe/jpicorc</filename>,
<filename>/etc/joe/jstarrc</filename>, <filename>/etc/joe/rjoerc</filename>,
<filename>~/.joerc</filename></para>
<indexterm zone="joe joe-config">
<primary sortas="e-etc-joe-jmacsrc">/etc/joe/jmacsrc</primary>
</indexterm>
<indexterm zone="joe joe-config">
<primary sortas="e-etc-joe-joerc">/etc/joe/joerc</primary>
</indexterm>
<indexterm zone="joe joe-config">
<primary sortas="e-etc-joe-jpicorc">/etc/joe/jpicorc</primary>
</indexterm>
<indexterm zone="joe joe-config">
<primary sortas="e-etc-joe-jstarrc">/etc/joe/jstarrc</primary>
</indexterm>
<indexterm zone="joe joe-config">
<primary sortas="e-etc-joe-rjoerc">/etc/joe/rjoerc</primary>
</indexterm>
<indexterm zone="joe joe-config">
<primary sortas="e-AA.joerc">~/.joerc</primary>
</indexterm>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>jmacs, joe, jpico, jstar, rjoe and termidx</seg>
<seg>/etc/joe</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="jmacs">
<term><filename>jmacs</filename></term>
<listitem><para>is a symbolic link to
<command>joe</command> used to launch <application>Emacs</application>
emulation mode.</para>
<indexterm zone="joe jmacs">
<primary sortas="b-jmacs">jmacs</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="joe-prog">
<term><filename>joe</filename></term>
<listitem><para>is a small text editor capable of emulating
WordStar, <application>Pico</application>, and
<application>Emacs</application>.</para>
<indexterm zone="joe joe-prog">
<primary sortas="b-joe">joe</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="jpico">
<term><filename>jpico</filename></term>
<listitem><para>is a symbolic link to
<command>joe</command> used to launch <application>Pico</application>
emulation mode.</para>
<indexterm zone="joe jpico">
<primary sortas="b-jpico">jpico</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="jstar">
<term><filename>jstar</filename></term>
<listitem><para>is a symbolic link to
<command>joe</command> used to launch WordStar
emulation mode.</para>
<indexterm zone="joe jstar">
<primary sortas="b-jstar">jstar</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="rjoe">
<term><filename>rjoe</filename></term>
<listitem><para>is a symbolic link to
<command>joe</command> that restricts
<application><acronym>JOE</acronym></application> to editing
only files which are specified on the command-line.</para>
<indexterm zone="joe rjoe">
<primary sortas="b-rjoe">rjoe</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="termidx">
<term><filename>termidx</filename></term>
<listitem><para>is a program used by
<command>joe</command> to generate the termcap index file.</para>
<indexterm zone="joe termidx">
<primary sortas="b-termidx">termidx</primary></indexterm>
</listitem>
</varlistentry>

</variablelist>

</sect2>

</sect1>