source: postlfs/editors/joe.xml@ 563441f

<?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="postlfs-editors-joe">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="joe.html"?>
<title>JOE-&joe-version;</title>

<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 &amp;&amp;
make install</command></userinput></screen>

</sect2>

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

<para><application><acronym>JOE</acronym></application> can make use of 
several configuration files. Information about these files may be found in the 
joe man page. These files are <filename>/etc/jmacsrc</filename>, 
<filename>/etc/joerc</filename>, <filename>/etc/jpicorc</filename>, 
<filename>/etc/jstarrc</filename>, and <filename>/etc/rjoerc</filename>. 
<application><acronym>JOE</acronym></application> can also make use of
<filename>~/.joerc</filename>, which may be copied from
<filename>/etc/joerc</filename> and customized for each user's
taste.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>JOE</acronym></application> package contains 
<command>jmacs</command>,
<command>joe</command>, <command>jpico</command>,
<command>jstar</command>, <command>rjoe</command> and
<command>termidx</command>.</para>
</sect2>

<sect2><title>Description</title>

<sect3><title>jmacs</title>
<para><command>jmacs</command> is a symbolic link to
<command>joe</command> used to launch <application>Emacs</application>
emulation mode.</para></sect3>

<sect3><title>joe</title>
<para><command>joe</command> is a small text editor capable of emulating
WordStar, <application>Pico</application>, and
<application>Emacs</application>.</para></sect3>

<sect3><title>jpico</title>
<para><command>jpico</command> is a symbolic link to
<command>joe</command> used to launch <application>Pico</application>
emulation mode.</para></sect3>

<sect3><title>jstar</title>
<para><command>jstar</command> is a symbolic link to
<command>joe</command> used to launch WordStar
emulation mode.</para></sect3>

<sect3><title>rjoe</title>
<para><command>rjoe</command> 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></sect3>

<sect3><title>termidx</title>
<para><command>termidx</command> is a program used by
<command>joe</command> to generate the termcap index
file.</para></sect3>

</sect2>

</sect1>