Category : Communication (modem) tools and utilities
Archive   : ENVOY100.ZIP
Filename : HELP.ENV

* COPYRIGHT NOTICE




Copyright 1989, 1990
by E. J. Schulz


North Granby Software
60 Mountain Road
North Granby, CT
06060

* KEY COMMAND SUMMARY
Key MACRO Scan Code Description
--------------------------------------------------------------------------------

Backspace Backspace 8 Move the cursor to the left and delete the
character at that position. Press the
Backspace key to correct typing mistakes.

Tab Right Go TabRight 9 Go right to the next Tab position.

Enter Enter 13 Move the cursor to the start of the next line
or to a position which you defined with the
alt-t key. In Insert mode a new line is
inserted before moving down.

Escape DoLine 27 After you press the Escape Key ENVOY will
prompt you for a line command. The line
command is executed just as it would be from
a command file.

Tab Left Go TabLeft 271 Go left to the next Tab position.

Alt-q Quit 272 Quit the program.

Alt-r Replace * * * 275 Find and replace a character string. ENVOY
will prompt you for the character string
you wish to find, for the new charcter
string, and for search options.

When the program prompts you, enter the
options you want in any order. Press the
Enter key if you don't want special search
options.

Unless you specify the Y option, ENVOY will
ask you before replacing a string.

Find and Replace Options :
B Search In Block
G Global Search
U Ignore Upper/Lower Case
n Replace n Occurrences
Y Replace Without Asking

For example, B10Y tells ENVOY to search
in the blocked region for ten occurrances
of the Search string and replace it with
the new string without asking.

Alt-t Retpos 276 Set the Return Position to the current cursor
position. When you press the Enter key the
cursor will go to the Return Position instead
of to column 1.

Alt-d Clear Line 288 Delete the current line.

Alt-f Find * * 289 ENVOY will prompt you for the character
string you wish to find and for search
options.

When the program prompts you, enter any
options you want in any order.

Find Options :
B Search In Block
G Global Search
U Ignore Upper/Lower Case
n Find the n'th Occurrence

For example, B10 tells ENVOY to search
in the blocked region for the tenth
occurrence of the character string.

alt-j Joinline 292 Join the current line to the previous line.

alt-b Breakline 304 Break the current edit line at the cursor
position.

Alt-n Repeat 305 Repeat the last Find or Find and Replace
operation.

alt-m Menu 306 Show the ENVOY menu.

Func 1 Block Top 315 Mark the beginning of a Block region. The
current cursor position becomes the start
of a block.

Func 2 Block End 316 Mark the end of a Block region. The current
cursor position becomes the end of a block.

Func 3 ReadFile * 317 Read a new edit file. ENVOY will prompt you
for the file name and then read the file into
memory so that you can edit it. If you are
working on a file in memory, save it before
you read a new file or else you will lose all
of the changes which you have made.

Func 4 WriteFile * 318 Write the edit file to disk. ENVOY will prompt
you for the name of the file you wish to write.
You may enter a full directory path name,
such as C:\MINE\FILE.TXT. If you just press
the Enter key to enter a blank file name,
ENVOY will overwrite the current edit file.
The name of the current edit file is shown on
the ENVOY information line.

Func 5 Block Copy 319 Copy the blocked region to the current
position. If lines are blocked, the lines are
inserted below the current line. The existing
lines are moved down. If a region is blocked,
the block is copied to the current cursor
position. Existing text is moved to the right
to make room.

Func 6 Block Move 320 Move the blocked region to the current
position. If lines are blocked,
the lines are inserted below the current
line. The existing lines are moved down.
If a region is blocked, the block is
moved to the current cursor position.
Existing text is moved to the right to
make room.

Func 7 Block Clear 321 The blocked region is deleted.

Func 8 Block Read * 322 ENVOY will prompt you for a file name.
The file will be read into the current
file at the current position. The new
text will be marked as a blocked region.

Func 9 Block Write * 323 ENVOY will prompt you for a file name.
The blocked region will be written to
the file you name.

Func 10 Block Lines 324 ENVOY can be set to mark either lines
or regions. Block regions,(default) if
you want to move words, insert or delete
columns, etc. Block lines to move paragraphs
around in the file.

Home Go TopFile 327 The cursor will move to the start of the first
line in the edit file.

Up Arrow Go Up 328 The cursor will move up one line in the edit
file.

Page Up Go UpPage 329 The cursor will move up to display a full
screen of new text.

Left Arrow Go Left 331 The cursor will move left one column.

Right Arrow Go Right 333 The cursor will move right one column.

End Go EndFile 335 The cursor will move to the end of the
last line of the edit file

Down Arrow Go Down 336 The cursor will move down one line.

Page Down Go DownPage 337 The cursor will move down to display a
full screen of new text.

Insert Key InsertMode 338 In insert mode characters are inserted into
the line at the cursor position and the rest
of the line is shifted to the right. In
overwrite mode any character already at the
cursor position is over-written. Press the
Insert key to change from Insert mode to
Overwrite mode and back. The current setting
is shown on the ENVOY display line.

Delete Key Clear Char 339 Delete the character at the cursor position.

Shift F1 On 340 Go on-line. This opens the communications
port so that you can communicate with a remote
computer.

Shift F2 Off 341 ENVOY goes off line and returns to edit mode.

Shift F3 Dial 342 Dial a phone number.

Shift F4 Xget * 343 Receive a binary file.

Shift F5 XSend * 344 Send a binary file.

^Right arr Go TopLine 371 Go to the start of the current edit line.

^Left arr Go EndLine 372 Go to the last character of the current edit
line.

^End Clear EndLine 373 Delete all the characters from the cursor
position to the end of the current edit line.

^PgDn Go EndBlock 374 Go to the end of the blocked region.

^PgUp Go TopBlock 388 Go to the start of the blocked region.


* COMMAND FILES

You can set up a command file to reconfigure the ENVOY editor or to manage your
call to a remote computer. The ENVOY commands IF, ELSE and JUMP enable you to
set up a command file which will prompt you for information and act on that
information. You can set up a command file which will try to call another
computer several times before giving up or one which will try several bulletin
boards and give you control when it finds one that isn't busy. You can even set
up a menu driven auto-dialer for voice communications.

Execute a command file by entering the command DO filespec, where filespec is
the DOS filename and can include a complete directory path. If you don't enter
a directory path, ENVOY will look for the file in the current directory. If the
file isn't in the current directory, ENVOY will look in the ENVOY directory.
You can define the ENVOY directory before you start the ENVOY program by
entering the DOS command SET ENVOY=pathname, where pathname is the complete path
to the ENVOY directory. You can put the SET command in your Autoexec.Bat file
so that the ENVOY directory is defined every time you start your PC.

A command file consists of a series of ENVOY line commands. The commands are
executed in just the same way as if you had entered them from the ENVOY command
line or had assigned the commands to keyboard keys with the MACRO command and
then pressed the MACRO keys.

A command file can use the DO command to call another command file. When the
the other command file finishes execution ENVOY continues to execute the
original file. Command files can be nested this way up to four deep.

If you want, you can put several ENVOY commands on a single line. Separate
the commands with the # character.

ENVOY doesn't check your control logic. It is possible to set up an infinite
loop in command file with the JUMP command which wants to execute forever.
You can escape from a loop like this by pressing the alt-x key.

When you are writing a command file, or if you are have a problem with a
command file, use the JOURNAL command to trace the execution of each line.
The JOURNAL command echos all of the commands you enter to a file named
Journal.Env on the current directory. JOURNAL ON should be the first command in
the file and JOURNAL OFF should be the last command. You can also use the
REMARK command to write comments to the CRT screen as the file is executed.

Put comments into a command file by using the ; character. Anything following a
; is ignored unless it was part of a string parameter. For example, the command
FIND ';' ; ...comment... will find the next ; character. The comment will be
ignored.


* INITIALIZATION

To run Envoy you type 'ENVOY' or 'ENVOY {name of a command file}' at the DOS
prompt.

When Envoy starts up it first tries to execute the file Initial.Env on the
default directory. As with any command file, If the file is not in the current
directory Envoy will look for it in the ENVOY directory. You can define the
Envoy directory with the DOS command SET ENVOY=pathname.

You can use the file Initial.Env to redefine the edit keys, set a default phone
number and communications parameters, or perform other set up tasks which you
want to do every time you use envoy.

If you entered the name a command file as a parameter when you started Envoy,
that command file will be executed after ENVOY is finished executing file
Initial.Env.

These initialization files are very powerful. You can set up command files for
each of the many different jobs which Envoy can do. For instance, you could
create a command file called Work which contained the commands to log you on to
your company computer. Entering the DOS command ENVOY WORK would then log you
on and return control. you could set up other commands to log you onto other
systems or to redefine the Envoy editor for special purposes.

* CHANGING THE DISPLAY COLORS

There are six colors used by the program for different purposes. The COLOR
command lets you redefine these colors. The first parameter of the COLOR
command chooses which color you want to redefine. The choices are:

EDIT => Edit characters
BLOCK => Blocked region
INFO => Information line
QUES => Envoy questions and error messages
FOUND => Mark search string
HELP => Help Screens and Menus

The second parameter of the COLOR command defines the new foreground color. The
choices for foreground colors are:

0 => Black 8 => Dark Gray
1 => Blue 9 => Light Blue
2 => Green 10 => Light Green
3 => Cyan 11 => Light Cyan
4 => Red 12 => Light Red
5 => Magenta 13 => Light Magenta
6 => Brown 14 => Yellow
7 => Light Gray 15 => White

The third parameter of the COLOR command defines the new background color.
The choices for background colors are:


0 => Black 8 => Black with Blink
1 => Blue 9 => Blue with Blink
2 => Green 10 => Green with Blink
3 => Cyan 11 => Cyan with Blink
4 => Red 12 => Red with Blink
5 => Magenta 13 => Magenta with Blink
6 => Brown 14 => Brown with Blink
7 => Light Gray 15 => Light Gray with Blink

Use the Envoy Color Menu to change the Envoy default color scheme. When you are
happy with your choices, put COLOR commands in the command file INITIAL.ENV.
This will redefine the defaults every time you run Envoy.

Syntax
COlor {keyword} {foreground} {background}
Where keyword chooses which color you wish to redefine and the
foreground and background colors are given above.

Example
COLOR Edit 0 1; Edit Screens - Black characters on blue background
COLOR Info 13 7; Info Line - Lt Magenta on lt grey background
COLOR Found 14 14; Found String - Blinking yellow on brown background


* CHARACTER CODES AND SCAN CODE

A character code relates a character set (e.g. 'a','b'...) to the binary
representation used by the computer. This subject can be confusing because
there are several incompatible character codes.

The ASCII character set is shown in another Help screen. The ASCII set is a
standard way of representing alphanumeric and computer control characters.

IBM compatible computers use 256 display codes based on the ASCII character set.
The IBM display codes define what you see on the CRT screen when you write a
character. The first 128 characters of the IBM set are loosely based on the
ASCII set. The second 128 characters were chosen by IBM and be interpreted
differently by non-IBM hardware, such as your printer. This is why you
sometimes see garbage when you print your screen display.

IBM compatible computers also use a keyboard character set which defines what
number is generated when you press a keyboard key. The first 128 codes are
based on the ASCII character set.

The IBM extended keyboard character set includes the Function keys, the
Alt- keys, etc. ENVOY uses a character set based on the IBM character set. The
ENVOY extended codes are formed by adding 256 to the scan codes for the IBM
extended character set.

You should use keys from the extended character set when you define ENVOY
MACROs. If you use a key which generates one of the ASCII codes in the range 0
to 127 you will not be able to send that code to a remote computer.


* ASCII Character Codes
Value Character | Value Character | Value Character | Value Character |
0 NUL | 32 (space) | 64 @ | 96 ` |
1 SOH | 33 ! | 65 A | 97 a |
2 STX | 34 " | 66 B | 98 c |
3 ETX | 35 # | 67 C | 99 c |
4 EOT | 36 $ | 68 D | 100 d |
5 ENQ | 37 % | 69 E | 101 e |
6 ACK | 38 % | 70 F | 102 f |
7 BEL | 39 ' | 71 G | 103 g |
8 BS | 40 ( | 72 H | 104 h |
9 HT | 41 ) | 73 I | 105 i |
10 LF | 42 * | 74 J | 106 j |
11 VT | 43 + | 75 K | 107 k |
12 FF | 44 , | 76 L | 108 l |
13 CR | 45 - | 77 M | 109 m |
14 SO | 46 . | 78 N | 110 n |
15 SI | 47 / | 79 O | 111 o |
16 DLE | 48 0 | 80 P | 112 p |
17 DC1 | 49 1 | 81 Q | 113 q |
18 DC2 | 50 2 | 82 R | 114 r |
19 DC3 | 51 3 | 83 S | 115 s |
20 DC4 | 52 4 | 84 T | 116 t |
21 NAK | 53 5 | 85 U | 117 u |
22 SYN | 54 6 | 86 V | 118 v |
23 ETB | 55 7 | 87 W | 119 w |
24 CAN | 56 8 | 88 X | 120 x |
25 EM | 57 9 | 89 Y | 121 y |
26 SUB | 58 : | 90 Z | 122 z |
27 ESC | 59 ; | 91 [ | 123 { |
28 FS | 60 < | 92 \ | 124 | |
29 GS | 61 = | 93 ] | 125 } |
30 RS | 62 > | 94 ^ | 126 ~ |
31 US | 63 ? | 95 _ | 127  |
* IBM Keyboard Scan Codes
Key Code | Key Code | Key Code | Key Code |
(none) 0 | SpaceBar 32 | @ 64 | ` 96 |
c-a 1 | ! 33 | A 65 | a 97 |
c-b 2 | " 34 | B 66 | c 98 |
c-c 3 | # 35 | C 67 | c 99 |
c-d 4 | $ 36 | D 68 | d 100 |
c-e 5 | % 37 | E 69 | e 101 |
c-f 6 | % 38 | F 70 | f 102 |
c-g 7 | ' 39 | G 71 | g 103 |
c-h 8 | ( 40 | H 72 | h 104 |
c-i 9 | ) 41 | I 73 | i 105 |
c-j 10 | * 42 | J 74 | j 106 |
c-k 11 | + 43 | K 75 | k 107 |
c-l 12 | , 44 | L 76 | l 108 |
c-m 13 | - 45 | M 77 | m 109 |
c-n 14 | . 46 | N 78 | n 110 |
c-o 15 | / 47 | O 79 | o 111 |
c-p 16 | 0 48 | P 80 | p 112 |
c-q 17 | 1 49 | Q 81 | q 113 |
c-r 18 | 2 50 | R 82 | r 114 |
c-s 19 | 3 51 | S 83 | s 115 |
c-t 20 | 4 52 | T 84 | t 116 |
c-u 21 | 5 53 | U 85 | u 117 |
c-v 22 | 6 54 | V 86 | v 118 |
c-w 23 | 7 55 | W 87 | w 119 |
c-x 24 | 8 56 | X 88 | x 120 |
c-y 25 | 9 57 | Y 89 | y 121 |
c-z 26 | : 58 | Z 90 | z 122 |
Escape 27 | ; 59 | [ 91 | { 123 |
(none) 28 | < 60 | \ 92 | | 124 |
(none) 29 | = 61 | ] 93 | } 125 |
(none) 30 | > 62 | ^ 94 | ~ 126 |
(none) 31 | ? 63 | _ 95 | (none) 127 |
* IBM Extended Keyboard Scan Codes
Key Code | Key Code | Key Code |
256 | alt-x 301 | S-F7 346 |
257 | alt-c 302 | S-F8 347 |
258 | alt-v 303 | S-F9 348 |
259 | alt-b 304 | S-F10 349 |
260 | alt-b 305 | c-F1 350 |
261 | alt-n 306 | c-F2 351 |
262 | alt-m 307 | c-F3 352 |
263 | 308 | c-F4 353 |
264 | 309 | c-F5 354 |
265 | 310 | c-F6 355 |
266 | 311 | c-F7 356 |
267 | 312 | c-F8 357 |
268 | 313 | c-F9 358 |
269 | 314 | c-F10 359 |
270 | F1 315 | a-F1 360 |
TabLeft 271 | F2 316 | a-F2 361 |
alt-q 272 | F3 317 | a-F3 362 |
alt-w 273 | F4 318 | a-F4 363 |
alt-e 274 | F5 319 | a-F5 364 |
alt-r 275 | F6 320 | a-F6 365 |
alt-t 276 | F7 321 | a-F7 366 |
alt-y 277 | F8 322 | a-F8 367 |
alt-u 278 | F9 323 | a-F9 368 |
alt-i 279 | F10 324 | a-F10 369 |
alt-o 280 | 325 | PrtSc 370 |
alt-p 281 | 326 | c-LeftArrow 371 |
282 | Home 327 | c-RightArrow 372 |
283 | UpArrow 328 | c-End 373 |
284 | PgUp 329 | c-PgDn 374 |
285 | 330 | c-Home 375 |
alt-a 286 | LeftArrow 331 | alt-1 376 |
alt-s 287 | 332 | alt-2 377 |
alt-d 288 | RightArrow 333 | alt-3 378 |
alt-f 289 | 334 | alt-4 379 |
alt-g 290 | End 335 | alt-5 380 |
alt-h 291 | DownArrow 336 | alt-6 381 |
alt-j 292 | PgDn 337 | alt-7 382 |
alt-k 293 | Ins 338 | alt-8 383 |
alt-l 294 | Del 339 | alt-9 384 |
295 | S-F1 340 | alt-- 385 |
296 | S-F2 341 | alt-= 387 |
297 | S-F3 342 | c-PgUp 388 |
298 | S-F4 343 | F11 389 |
299 | S-F5 344 | F12 390 |
alt-z 300 | S-F6 345 |