source: postlfs/editors/joe.xml@ fad9b8d

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

  <!ENTITY joe-download-http "&sourceforge-dl;/joe-editor/joe-&joe-version;.tar.gz">
  <!ENTITY joe-download-ftp  " ">
  <!ENTITY joe-md5sum        "9017484e6116830d846678b625ea5c43">
  <!ENTITY joe-size          "1.8 MB">
  <!ENTITY joe-buildsize     "22 MB">
  <!ENTITY joe-time          "0.2 SBU">
]>

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


  <title>JOE-&joe-version;</title>

  <indexterm zone="joe">
    <primary sortas="a-JOE">JOE</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to JOE</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>

    &lfs112_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr     \
            --sysconfdir=/etc \
            --docdir=/usr/share/doc/joe-&joe-version; &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 -vm 755 joe/util/{stringify,termidx,uniproc} /usr/bin</userinput></screen>

<!--  These do not appear to be useful.  There are txt files in
       joe/util/unicode*/ bit I cannot we where they are used.
install -vdm755 /usr/share/doc/joe-&joe-version;/util &amp;&amp;
install -vm 644 joe/util/{*.txt,README} /usr/share/doc/joe-&joe-version;/util</userinput></screen>
-->
  </sect2>

  <sect2 role="configuration">
    <title>Configuring JOE</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>,
        and <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 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          jmacs,
          joe,
          jpico,
          jstar,
          rjoe,
          stringify,
          termidx, and
          uniproc
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /etc/joe,
          /usr/share/joe, and
          /usr/share/doc/joe-&joe-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="jmacs">
        <term><command>jmacs</command></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><command>joe</command></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><command>jpico</command></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><command>jstar</command></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><command>rjoe</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>joe</command> that restricts
            <application>JOE</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="stringify">
        <term><command>stringify</command></term>
        <listitem>
          <para>
            is a program used by <command>joe</command> to convert rc and
            .jsf files into a C file (see
            /usr/share/doc/joe-&joe-version;/util/README)
          </para>
          <indexterm zone="joe stringify">
            <primary sortas="b-stringify">stringify</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="termidx">
        <term><command>termidx</command></term>
        <listitem>
          <para>
            is a program used by <command>joe</command> to generate the
            termcap index file (see
            /usr/share/doc/joe-&joe-version;/util/README)
          </para>
          <indexterm zone="joe termidx">
            <primary sortas="b-termidx">termidx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uniproc">
        <term><command>uniproc</command></term>
        <listitem>
          <para>
            is a program used by <command>joe</command> to generate joe's
            unicode database file unicat.c from Blocks.txt CaseFolding.txt
            EastAsianWidth.txt and UnicodeData.txt (find them at
            /usr/share/doc/joe-&joe-version;/util; see
            usr/share/doc/joe-&joe-version;/util/README)
          </para>
          <indexterm zone="joe uniproc">
            <primary sortas="b-uniproc">uniproc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>