source: postlfs/editors/joe.xml

trunk
Last change on this file was 868811b, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Many tags.
genutils
sysutils
netlibs
netprogs
netutils
editors
filesystems
shells
  • Property mode set to 100644
File size: 8.5 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY joe-download-http "&sourceforge-dl;/joe-editor/joe-&joe-version;.tar.gz">
8 <!ENTITY joe-download-ftp " ">
9 <!ENTITY joe-md5sum "9017484e6116830d846678b625ea5c43">
10 <!ENTITY joe-size "1.8 MB">
11 <!ENTITY joe-buildsize "22 MB">
12 <!ENTITY joe-time "0.2 SBU">
13]>
14
15<sect1 id="joe" xreflabel="JOE-&joe-version;">
16 <?dbhtml filename="joe.html"?>
17
18
19 <title>JOE-&joe-version;</title>
20
21 <indexterm zone="joe">
22 <primary sortas="a-JOE">JOE</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to JOE</title>
27
28 <para>
29 <application>JOE</application> (Joe's own editor) is a small text
30 editor capable of emulating WordStar, <application>Pico</application>,
31 and <application>Emacs</application>.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&joe-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&joe-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &joe-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &joe-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &joe-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &joe-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 </sect2>
71
72 <sect2 role="installation">
73 <title>Installation of JOE</title>
74
75 <para>
76 Install <application>JOE</application> by running the
77 following commands:
78 </para>
79
80<screen><userinput>./configure --prefix=/usr \
81 --sysconfdir=/etc \
82 --docdir=/usr/share/doc/joe-&joe-version; &amp;&amp;
83make</userinput></screen>
84
85 <para>
86 This package does not come with a test suite.
87 </para>
88
89 <para>
90 Now, as the <systemitem class="username">root</systemitem> user:
91 </para>
92
93<screen role="root"><userinput>make install &amp;&amp;
94
95install -vm 755 joe/util/{stringify,termidx,uniproc} /usr/bin</userinput></screen>
96
97<!-- These do not appear to be useful. There are txt files in
98 joe/util/unicode*/ bit I cannot we where they are used.
99install -vdm755 /usr/share/doc/joe-&joe-version;/util &amp;&amp;
100install -vm 644 joe/util/{*.txt,README} /usr/share/doc/joe-&joe-version;/util</userinput></screen>
101-->
102 </sect2>
103
104 <sect2 role="configuration">
105 <title>Configuring JOE</title>
106
107 <sect3 id="joe-config">
108 <title>Config Files</title>
109
110 <para>
111 <filename>/etc/joe/jmacsrc</filename>,
112 <filename>/etc/joe/joerc</filename>,
113 <filename>/etc/joe/jpicorc</filename>,
114 <filename>/etc/joe/jstarrc</filename>,
115 <filename>/etc/joe/rjoerc</filename>,
116 and <filename>~/.joerc</filename>
117 </para>
118
119 <indexterm zone="joe joe-config">
120 <primary sortas="e-etc-joe-jmacsrc">/etc/joe/jmacsrc</primary>
121 </indexterm>
122
123 <indexterm zone="joe joe-config">
124 <primary sortas="e-etc-joe-joerc">/etc/joe/joerc</primary>
125 </indexterm>
126
127 <indexterm zone="joe joe-config">
128 <primary sortas="e-etc-joe-jpicorc">/etc/joe/jpicorc</primary>
129 </indexterm>
130
131 <indexterm zone="joe joe-config">
132 <primary sortas="e-etc-joe-jstarrc">/etc/joe/jstarrc</primary>
133 </indexterm>
134
135 <indexterm zone="joe joe-config">
136 <primary sortas="e-etc-joe-rjoerc">/etc/joe/rjoerc</primary>
137 </indexterm>
138
139 <indexterm zone="joe joe-config">
140 <primary sortas="e-AA.joerc">~/.joerc</primary>
141 </indexterm>
142
143 </sect3>
144
145 </sect2>
146
147 <sect2 role="content">
148 <title>Contents</title>
149
150 <segmentedlist>
151 <segtitle>Installed Programs</segtitle>
152 <segtitle>Installed Libraries</segtitle>
153 <segtitle>Installed Directories</segtitle>
154
155 <seglistitem>
156 <seg>
157 jmacs,
158 joe,
159 jpico,
160 jstar,
161 rjoe,
162 stringify,
163 termidx, and
164 uniproc
165 </seg>
166 <seg>
167 None
168 </seg>
169 <seg>
170 /etc/joe,
171 /usr/share/joe, and
172 /usr/share/doc/joe-&joe-version;
173 </seg>
174 </seglistitem>
175 </segmentedlist>
176
177 <variablelist>
178 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
179 <?dbfo list-presentation="list"?>
180 <?dbhtml list-presentation="table"?>
181
182 <varlistentry id="jmacs">
183 <term><command>jmacs</command></term>
184 <listitem>
185 <para>
186 is a symbolic link to <command>joe</command> used to
187 launch <application>Emacs</application> emulation mode
188 </para>
189 <indexterm zone="joe jmacs">
190 <primary sortas="b-jmacs">jmacs</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="joe-prog">
196 <term><command>joe</command></term>
197 <listitem>
198 <para>
199 is a small text editor capable of emulating
200 WordStar, <application>Pico</application>, and
201 <application>Emacs</application>
202 </para>
203 <indexterm zone="joe joe-prog">
204 <primary sortas="b-joe">joe</primary>
205 </indexterm>
206 </listitem>
207 </varlistentry>
208
209 <varlistentry id="jpico">
210 <term><command>jpico</command></term>
211 <listitem>
212 <para>
213 is a symbolic link to <command>joe</command> used to
214 launch <application>Pico</application> emulation mode
215 </para>
216 <indexterm zone="joe jpico">
217 <primary sortas="b-jpico">jpico</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="jstar">
223 <term><command>jstar</command></term>
224 <listitem>
225 <para>
226 is a symbolic link to <command>joe</command> used to
227 launch WordStar emulation mode
228 </para>
229 <indexterm zone="joe jstar">
230 <primary sortas="b-jstar">jstar</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="rjoe">
236 <term><command>rjoe</command></term>
237 <listitem>
238 <para>
239 is a symbolic link to <command>joe</command> that restricts
240 <application>JOE</application> to editing only files which are
241 specified on the command-line
242 </para>
243 <indexterm zone="joe rjoe">
244 <primary sortas="b-rjoe">rjoe</primary>
245 </indexterm>
246 </listitem>
247 </varlistentry>
248
249 <varlistentry id="stringify">
250 <term><command>stringify</command></term>
251 <listitem>
252 <para>
253 is a program used by <command>joe</command> to convert rc and
254 .jsf files into a C file (see
255 /usr/share/doc/joe-&joe-version;/util/README)
256 </para>
257 <indexterm zone="joe stringify">
258 <primary sortas="b-stringify">stringify</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="termidx">
264 <term><command>termidx</command></term>
265 <listitem>
266 <para>
267 is a program used by <command>joe</command> to generate the
268 termcap index file (see
269 /usr/share/doc/joe-&joe-version;/util/README)
270 </para>
271 <indexterm zone="joe termidx">
272 <primary sortas="b-termidx">termidx</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="uniproc">
278 <term><command>uniproc</command></term>
279 <listitem>
280 <para>
281 is a program used by <command>joe</command> to generate joe's
282 unicode database file unicat.c from Blocks.txt CaseFolding.txt
283 EastAsianWidth.txt and UnicodeData.txt (find them at
284 /usr/share/doc/joe-&joe-version;/util; see
285 usr/share/doc/joe-&joe-version;/util/README)
286 </para>
287 <indexterm zone="joe uniproc">
288 <primary sortas="b-uniproc">uniproc</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 </variablelist>
294
295 </sect2>
296
297</sect1>
Note: See TracBrowser for help on using the repository browser.