Category : Word Processors
Archive   : EEV530.ZIP
Filename : EEMANUAL.DOC

 
Output of file : EEMANUAL.DOC contained in archive : EEV530.ZIP
EE Manual - (C) 1988 Edgar J. Young Wilmington, Delaware


Disclaimer:

ADVANTAGE SOFTWARE and the author of the EE Editor,
herein referred to collectively as ADVANTAGE SOFTWARE,
hereby disclaim all warranties relating to this software,
whether express or implied, including without limitation any
implied warranties of merchantability or fitness for a
particular purpose. ADVANTAGE SOFTWARE will not be liable
for any special, incidental, consequential, indirect or
similar damages due to loss of data or any other reason,
even if ADVANTAGE SOFTWARE or an agent of ADVANTAGE SOFTWARE
has been advised of the possibility of such damages. In no
event shall ADVANTAGE SOFTWARE's liability for any damages
ever exceed the price paid for the license to use software,
regardless of the form of the claim. The person using the
software bears all risk as to the quality and performance of
the software.


1. Introduction

This document is the reference manual for the EE
Editor. EE is a shareware product. A registration
fee of $25 is requested if you find EE a useful
product. This will put you on the mailing list
offering update discounts on new releases of EE.
Please send check or money order to:


ADVANTAGE SOFTWARE
P.O.BOX 15042
NEWARK, DE 19711


Thank you for supporting this EE. If you have
any technical questions or suggestions for improving
EE, they may also be sent to the above address.


2. How to Use this Manual to learn the EE Editor

This manual is designed to be reference
documentation for the EE Editor. It does not contain
a tutorial. Read the manual through to get acquainted
with the EE Editor's facilities. Pay particular
attention to the INTERFACE section (section 5). Then
experiment with the editor using files of no
consequence until you gain confidence in using it.


3. System Requirements

The EE Editor is designed to work on IBM PC, XT,
AT and compatible computers with MSDOS and PCDOS
operating systems. The editor will handle CGA, EGA
(43 line mode), Monochrome, and Hercules graphics
boards. See section 4 for how to install the
interface. The editor itself requires 192K bytes of
free Random Access Memory (RAM) to function. A
minimum of 256K bytes of RAM should be installed in
the computer to accommodate operating system overhead
when using MSDOS.

The editor can be used effectively from both
floppy and hard disks. A hard disk is recommended for
faster Input/Output (I/O) and for editing multiple
files concurrently.


4. Installation

Before you install the EE Editor you are
encouraged to make backup copies of it. Refer to your
MSDOS manual if you have questions about how to do
this.

Copy the editor to where you want it to reside on
the hard or floppy disk. If the editor resides in a
subdirectory use the MSDOS PATH command to set a path
to it.

Change your CONFIG.SYS file to include the
following statement:

FILES = 20

If CONFIG.SYS already contains a FILES statement
then only change the quantity specified if it is less
than 20.

The editor uses the MSDOS environment variable EE
to determine the name of the configuration file it is
to use (see the section on Configuration). If you
consistently use the same configuration file you may
want to include the following line in your
AUTOEXEC.BAT file:

SET EE=filespec

Where 'filespec' is the path and filename of the
configuration file you want to use.

The editor (EE.EXE) is accompanied by another
file named KEYPAD.MAC. KEYPAD.MAC sets up the EE
editor to use the PC industry standard keypad keys for
normal cursor moves. It also sets up the following
keys (see section 5 for an explanation of key usage):

DO KEY.........: F1
LEARN KEY......: F2
LITERALNEXT KEY: F3
CANCEL KEY.....: F4

If for example, if you put KEYPAD.MAC in a C:\DOS
subdirectory, then to use it as the default
configuration file type the following command at the
MSDOS prompt:

SET EE=C:\DOS\KEYPAD.MAC

The editor uses the environment variable TERM to
set the type of terminal being used. You may want to
include the one of the following lines in your
AUTOEXEC.BAT file:

SET TERM=ibm-pc default setting if TERM is not set
as an environment variable, it can
be used for all IBM-PC compatible
computers.

SET TERM=ega-pc used in conjunction with an EGA
video card to produce 43 line
screen output.

SET TERM=bios-pc for all PC's with IBM screen and
keyboard BIOS compatibility (MSDOS
only). This mode is very slow,
use ibm-pc or ega-pc when
possible.

SET TERM=ansi-pc for PC's not compatible with IBM
but which can run under the
ANSI.SYS driver. If the ANSI.SYS
driver is to be used then the
following line must be included in
the CONFIG.SYS file:

DEVICE=ANSI.SYS

SET TERM=c_ansi-pc for ANSI.SYS mode using a color
monitor.


5. Interface

The EE Editor is designed to be easy to use for
the beginner, easy to remember for the casual user,
yet flexible and fast for the constant, heavy duty,
professional user. This is accomplished by having a
menu driven system for the beginner and casual user.
And having the ability to memorize the menu commands
(learn MACROs) and assign them to a single or few
keystrokes for the continuous user.

You are encouraged to use the LEARN facility to
personalize the EE Editor. You can make it behave the
way YOU want it to. Just remember to save the MACROs
once you have LEARNed them.

The only keys you have to remember to use the EE
Editor are as follows:

5.1 Key - (default assignment is F1):

The Key brings up the main pop menu.
Almost everything the editor can do is accessed
through the main pop menu. It is composed of
commands and further menus. You can invoke the
commands or additional menus of the editor by
pressing the Key corresponding to the first
character in the pop menu line. All of the menus
can be exited by typing Q for "Quit menu".
Pressing the CANCEL Key (see below) accomplishes
the same thing. The pop menus are always exited
to the edit level of the editor or string input.
Appendix A is a map of the commands and additional
menus which are available through the key.

5.2 Key - (default assignment is F2):

The Key begins, ends, and erases
macro assignments.

To learn a new macro, start by pressing the
Key. The top window bar will display a
blinking "LEARN" message. This indicates that the
editor is learning the current keystrokes. Press
the keys you want to learn, then press the
Key again. The editor will prompt for the MACRO
key code. This is the key(s) you will press to
automatically replay the keys you just learned.
As many as 10 keys in succession can be used to
define a MACRO. The last key to press is the
ENTER key. This will enter the MACRO key code.

If there is a conflict between the new MACRO
key code and existing MACRO key codes the editor
will:

1) Ask you if you want to replace the existing
MACRO (if only one MACRO is involved).

or

2) Inform you that that key code is currently in
use (if the key code would interfere with a
fixed key (e.g. key) or with a number of
MACROs).

In either case the editor will let you have
follow-up chances to name a new MACRO if the first
attempt fails.

You can call other MACROs while learning a
new MACRO. The keystrokes of the other MACROs are
remembered, not the MACRO key code itself. This
eliminates the possibility of endless loop MACROs.
It also allows you to erase any MACRO without
interfering with any other MACRO. This feature
allows you to build complex MACROs a little at a
time using intermediate MACROs. The intermediate
MACROs can be erased once the complex MACRO is
working correctly.

MACROs can be erased by pressing the
Key twice in a row. You might think of this as
learning the zero length MACRO, and reassigning it
to an existing key sequence. The editor will
prompt you for the MACRO key code of the MACRO you
want to erase. Enter the key code followed by the
ENTER key. The editor will then erase the MACRO
and inform you it has done so.

Example of using the Key:
Desire: a single keystroke to type "printf"
Plan: type Alt-P to type printf
Learn: press the following keystrokes:
printf
Test: type and "printf" should
appear.
Save: type:

Warning: the last step (Save) is very
important, otherwise EE will forget
what it has learned between uses.
No warning is given on exit if
MACROs have been learned. In
practice, casual MACROs are made,
used, then discarded. Saving is
only an issue during the first
flurry of converting the editor to
suit your style.

5.3 Key - (default assignment is F3):

The Key informs the editor that the
next key is to be entered into text as a graphic
or control character, and not translated into an
outline command.

For example, if you want to include a
Control-A into your text you would type the
Key followed by pressing and holding the
Ctrl key then pressing the A key. When you press
the Key you will notice a strangely
blinking L on the screen. This indicates to you
that the editor is expecting to enter the next
keystroke into text literally. The editor will
accept any key after the Key has been
pressed including a normal text character, which
will be entered as normal text.

A few keys cannot be entered using the
key. These include the Ctrl-J, Enter
(Ctrl-M), and BackSpace (Ctrl-H) keys.

5.4 Key - (default assignment is F4):

The CANCEL key is used to escape from any
command. The CANCEL key will not undo what has
been done before. However, it does allow you a
graceful exit from any command you are currently
doing, except (of course) entering a LITERAL
character.

5.5 *** WARNING: The keypad cursor control keys work
only if they are defined in a configuration file
using the key. This can be alarming when
you invoke the editor without a configuration file
defined by the environment variable EE. This
usually happens when demonstrating the editor to a
friend or your boss.


6. String Editing on Input

Where it makes sense, input strings can be edited
while they are being input. Examples of strings which
can be edited include: Find and Replace Strings, any
prompts for filenames. The commands for editing input
strings are obtained using the key. Cursor move
and delete commands use the same keystrokes for
editing input as editing text. This lets your MACROs
work for editing input as well as text.


7. EE Usage and Limitations

The EE Editor can be used to edit multiple files
at the same time. There is no editor imposed limit to
the number or the size of the files which can be
opened. The limit is determined by the space you have
available on your disk drive(s). The editor itself
uses a virtual memory to maintain buffers for an
unlimited number of open files of any size ( WARNING -
the virtual file is named TMPn.$$$ where 'n' is an
integer making the filename unique. Erasing this file
when the editor is in use would be disastrous). Each
file must be an ASCII file of lines separated by
Carriage Return / Line Feed sequences. The lines
themselves are limited to 999 characters long. During
an edit session the editor will automatically break
longer lines, and inform you that it has done so by
beeping.

Note: The editor will not load .EXE, .COM, .OBJ,
.O, .LIB, and .BAK files. However, it will load other
binary files if they have no initial lines over 999
characters. The editor is not designed to edit binary
files. It will ruin their utility by inserting
Carriage Return / Line Feed sequences in them at 999
character intervals, and by erasing trailing zeros and
TAB characters in each line, if they exist.


8. Loading Files into the EE Editor

The EE Editor has numerous ways of loading files.
These are listed below:

8.1 Single File Load
A single file can be loaded from the command
line.
example: EE C:\PROJ\TEST.C

If the editor is invoked without a file
specified on the command line then it will prompt
for a filename.

8.2 Multiple File Load
Multiple files can be loaded from the command
line.
example: EE C:\INC\TEST.H A:\TEST1.C

8.3 Wildcard File Load
Wildcards may be used to specify the files to
load.
example: EE *.H
example: EE TEST?.C
example: EE C:\PROJ\DATA\*.*

In the last example .EXE, .COM, .OBJ, .O,
.LIB and .BAK files would be omitted if present.

8.4 Load a File of Files
If you have a number of files which are a
part of a programming project, you may want to
list them in a file of filenames. You can then
load all of the files listed in a file by using
the @ operator.
example: FLIST is a file which contains:
D:\ARCHIVE\TEST.H
TEST1.C
TEST2.C
to edit all of these files type:
EE @FLIST

8.5 Specify Line and Column to go to after Load
If you are using a command line assembler or
compiler you may get an error message which
locates an error in a file. You can go to the
line and column of the file you are loading by
specifying "+line,column" after the filename.
example: EE TEST.C +201,25
will place the cursor in
line 201, column 25

8.6 Loading Files while Editing
The files can be loaded into the editor using
or
during an edit
session. All of the above loading methods are
applicable to both the operating system command
line and the editor filename prompt for loading
files.

8.7 Mixing it up
All of the above file loading syntaxes can be
applied whenever required to load the right mix of
files.
example:
EE A:\QQ.C TT.C +25,8 H?.* @FLIST

8.8 Loading non ASCII Files
If the editor encounters a line longer than
999 characters during loading files the editor
will beep once, then unload that particular file.

If a non ASCII file is loaded successfully
then the editor will operate on it. However,
because the editor is very conscientious about
minimizing line length by removing unused TABS and
spaces, the file is almost sure to be changed,
thereby possibly ruining the utility of the file.


9. Configuration File

The EE Editor uses a configuration file to
maintain the configuration of the editor from use to
use. The editor will only access one file at a time,
but multiple configuration files can be maintained for
different jobs (e.g. 'C', Pascal, and Assembly
Language configurations might be maintained for
different TAB settings, language sensitive MACROs,
etc.).

You must remember to save the configuration file
by using the key
sequence when you have learned MACROs, or made
environment changes which you wish to keep.

The following characteristics are maintained by
the configuration file:

9.1 MACRO Table
All of the MACROs which are learned are
maintained in the configuration file.

9.2 Display Characteristics

9.2.1 Color Scheme
The color scheme for the editor can be
changed to whatever you like (see Commands
section below). It is maintained in the
configuration file.

9.2.2 Window and Window Bar Settings
The editor can be used to edit multiple
files at the same time. You can set how many
files (1 to 5) can be viewed at the same time,
and the relative size of each file's window.
The configuration file will remember how many
windows are allowed at most, and where the
window separator bars go for each multiple
window (2 to 5) display.

9.3 Cursor Behavior

9.3.1 Auto Indent
The editor can be set to auto indent the
next line or not.

9.3.2 Insert / Overwrite
The editor can be toggled to insert
incoming keystrokes, or to overwrite existing
text with incoming keystrokes. The cursor
will change size for these two modes except
where TERM is set to c_ansi-pc, ansi-pc, or
bios-pc.

9.3.3 TAB Table
TABs can be set at any column.

9.3.4 TAB Behavior
TAB characters can be treated as
expandable characters, graphic characters, or
control characters.

9.3.5 ENTER Key Behavior
The ENTER key can be set to cause one of
three actions:

- Go to the beginning of the next line.
- Make a new line below and go to its
beginning.
- Break the line at the current cursor
location as if inserting a Carriage Return
/ Line Feed sequence at that point.

9.3.6 Cursor Upward and Downward Travel Limits
The cursor can be set so that it will not
travel to the limits of the screen. Cursor
movement requests when the limits are reached
will cause the screen to scroll instead of the
cursor moving.

9.3.7 Cursor Free or Locked
The cursor can be locked to the center
line of the window or free to move vertically
within limits set by the user. The
configuration file remembers how the cursor is
allowed to travel vertically.

9.4 Horizontal Scroll Jump
The number of characters that the text jumps
when the cursor hits the left or right screen
boundary can be set.

9.5 Follow-up Command
The editor can be exited in a way that issues
a follow-up command to the operating system. The
text of the follow-up command is preserved in the
configuration file.


10. Commands

Below are listed the commands used in the editor
and how each should work. Where applicable, hints on
effective usage are given. The commands are listed
below in the order in which they appear in the editor
menus. Also see Appendix A, it is a map of the menus
of commands.

Each command is listed by the keystrokes required
to invoke it. For example: is a
command which can be invoked by pressing the key,
then 'F' for the option on the DO menu, then
'S' for the option of the Find menu. MACROs
are displayed in this manner on the
command.

10.1 < cursor
Moves the cursor to backward in text by the
amount specified in the list below:


10.1.1 << cursor>
Moves the cursor to the previous
character in the current line.

10.1.2 << cursor>
Moves the cursor to the previous word in
the current line.

10.1.3 << cursor>
Moves the cursor to the previous tab stop
in the current line.

10.1.4 << cursor>
Moves the cursor to the left end of the
line.

10.1.5 << cursor>
Moves the cursor to the previous line.

10.1.6 << cursor>
Moves the cursor to the previous line by
scrolling the screen down one line.

10.1.7 << cursor>
Moves the cursor up the number of lines
in the current window minus one.

10.1.8 << cursor>
Moves the cursor to the beginning of the
file.

10.1.9 << cursor>
Moves the cursor to the beginning of a
marked block.

10.2 > cursor
Moves the cursor forward in text by the
amount specified in the list below:

10.2.1 <> cursor>
Moves the cursor to the next character in
the current line.

10.2.2 <> cursor>
Moves the cursor to the next word in the
current line.

10.2.3 <> cursor>
Moves the cursor to the next tab stop in
the current line.

10.2.4 <> cursor>
Moves the cursor to the end of the
current line.

10.2.5 <> cursor>
Moves the cursor to the next line.

10.2.6 <> cursor>
Moves the cursor to the next line by
scrolling the screen up one line.

10.2.7 <> cursor>
Moves the cursor down the number of lines
in the current window minus one.

10.2.8 <> cursor>
Moves the cursor to the end of the file.

10.2.9 <> cursor>
Moves the cursor to the end of a marked
block.

10.3
Alignment is used to check for columnar
alignment. Issuing the command causes a temporary
colored vertical line to appear in the current
window at the cursor column. The next key you
press will cause the vertical line to disappear,
as well as do whatever that key does.

10.4 Block
Block commands deal with blocks of text.
These commands are listed below:

10.4.1
Copies a block of marked text to the
current cursor location. A block of text can
be copied from one file to another.

10.4.2
Deletes the block of marked text.
BEWARE- if the marked block of text is in a
file other than the one you are editing it
will still be deleted!

10.4.3
Moves the block of marked text from its
present location to the current cursor
location. The block of marked text can be
moved from one file to another.

10.4.4
Read a specified file into the current
window at the current cursor location.

10.4.5
Writes the block of marked text to the
file specified.

10.4.6 << shift>
Shifts the block of marked text to the
left by the number of spaces or TAB stops
specified. This command is useful in editing
block structured language files, when
indenting enhances visibility of
subordination. In order for it to work, the
block must be marked only when the cursor is
in the first column.

10.4.7 <> shift>
Shifts the block of marked text to the
right by the number of spaces or TAB stops
specified. This command is useful in editing
block structured language files, when
indenting enhances visibility of
subordination. In order for it to work, the
block must be marked only when the cursor is
in the first column.

10.4.8
Marks the beginning of a block of text.
Any block of text marked must be totally
within a single file.

10.4.9
Marks the end of a block of text. Any
block of text marked must be totally within a
single file.

10.4.10
Unmarks the currently marked block of
text.

10.5
Changes the case of the letter under the
cursor and moves the cursor to the right one
space. If the character under the cursor is not a
letter the cursor is only moved. The cursor will
jump lines looking for the next character.

10.6 Delete
Deletes per items listed below:

10.6.1
Deletes the character under the cursor.
Characters to the right of the cursor move to
the left one column.

10.6.2 << character>
When in "Ins" (insert) input mode,
deletes the character to the left of the
cursor. The characters under the cursor and
to the right of it move one column to the
left.
When in "Ovr" (overwrite) input mode,
overwrites the character to the left of the
cursor with a space character.

10.6.3
Deletes the word or fraction of the word
that the cursor is on beginning at the letter
the cursor is on. If the cursor is on a space
then all spaces before the next word are
deleted.

10.6.4
Deletes the remainder of the line that
the cursor is on starting at the cursor
position.

10.6.5
Deletes the entire line that the cursor
is on.

10.6.6
Deletes the marked block, even if the
marked block is not in the current window.

10.7 Undelete
Provides a minor undo facility.

10.7.1
Undeletes the last character deleted.
The deleted characters are kept in a 256
character buffer, so that is the limit of
undeleting characters. The high bit is lost
if characters are undeleted, therefore
undeleting graphics characters is not
recommended.

10.7.2
Undeletes the last line deleted. Only
the last line deleted is in the last line
deleted buffer, so you cannot undelete
multiple lines. However you can use
as a simple mechanism to
replicate a line in many places, or just to
move it.


10.8 Find

10.8.1
Is used to find a string in the files
being edited. Find string is case sensitive.
Find can work in the current file or across
files in the editor. By using the
or string> commands the find string last entered
will be recalled. You also have limited line
editing to edit the find string using the
commands.

10.8.2
Is used to find a string then replace it
with another string. Find/Replace is case
sensitive. It can work in the current file or
across files in the editor. Find and Replace
string editing works the same as for Find
above. Using the
command at the Replacement prompt will move
the Find string down from the line above to be
edited. This is useful when renaming a
variable in a file or across files. Using the
command will recall the
last string replacement during the current
edit session. You also have limited line
editing to edit the replace string using the
commands.

10.8.3
Is used to find the next occurrence of
the current find string.

10.8.4
Is used to find the previous occurrence
of the current find string.

10.8.5
Is used to find the matching parenthesis,
bracket, or squiggly bracket. This find does
not work across file boundaries. If a match
is not found, a pop up information box will
indicate this. If a match is found the cursor
is moved to the match. This function is
extremely useful in matching blocks in 'C' and
in sorting out nested logical statements. I
imagine it would be invaluable for editing
LISP!

10.9 Goto

10.9.1
Moves the cursor to the column specified.

10.9.2
Moves the cursor to the beginning of the
line specified.

10.9.3 <0-9 mark>
Moves to mark 0-9 (see Mark below).

10.10
Inserts a line in text by moving the line
that the cursor is in down one line.

10.11 Mark

10.11.1
Marks the beginning of a block of text.
Any block of text marked must be totally
within a single file.

10.11.2
Marks the ending of a block of text. Any
block of text marked must be totally within a
single file.

10.11.3 <0-9 mark>
Marks a location (0 - 9) within a file.
You can then use <0 - 9 mark> to get
back to the marked locations.

10.12

  3 Responses to “Category : Word Processors
Archive   : EEV530.ZIP
Filename : EEMANUAL.DOC

  1. Very nice! Thank you for this wonderful archive. I wonder why I found it only now. Long live the BBS file archives!

  2. This is so awesome! 😀 I’d be cool if you could download an entire archive of this at once, though.

  3. But one thing that puzzles me is the “mtswslnkmcjklsdlsbdmMICROSOFT” string. There is an article about it here. It is definitely worth a read: http://www.os2museum.com/wp/mtswslnk/