home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / comm / envoy100.zip / HELP.ENV < prev    next >
Text File  |  1990-03-15  |  28KB  |  484 lines

  1. *                        COPYRIGHT NOTICE
  2.  
  3.  
  4.  
  5.  
  6.                                Copyright 1989, 1990
  7.                                by E. J. Schulz
  8.  
  9.  
  10.                                North Granby Software
  11.                                60 Mountain Road
  12.                                North Granby, CT
  13.                                   06060
  14.  
  15. *                        KEY COMMAND SUMMARY
  16.    Key         MACRO       Scan Code             Description
  17. --------------------------------------------------------------------------------
  18.  
  19.    Backspace   Backspace       8 Move the cursor to the left and delete the
  20.                                  character at that position.  Press the
  21.                                  Backspace key to correct typing mistakes.
  22.  
  23.    Tab Right   Go TabRight     9 Go right to the next Tab position.
  24.  
  25.    Enter       Enter          13 Move the cursor to the start of the next line
  26.                                  or to a position which you defined with the
  27.                                  alt-t key.  In Insert mode a new line is
  28.                                  inserted before moving down.
  29.  
  30.    Escape      DoLine         27 After you press the Escape Key ENVOY will
  31.                                  prompt you for a line command.  The line
  32.                                  command is executed just as it would be from
  33.                                  a command file.
  34.  
  35.    Tab Left    Go TabLeft    271 Go left to the next Tab position.
  36.  
  37.    Alt-q       Quit          272 Quit the program.
  38.  
  39.    Alt-r       Replace * * * 275 Find and replace a character string.  ENVOY
  40.                                  will prompt you for the character string
  41.                                  you wish to find, for the new charcter
  42.                                  string, and for search options.
  43.  
  44.                                  When the program prompts you, enter the
  45.                                  options you want in any order.  Press the
  46.                                  Enter key if you don't want special search
  47.                                  options.
  48.  
  49.                                  Unless you specify the Y option, ENVOY will
  50.                                  ask you before replacing a string.
  51.  
  52.                                  Find and Replace Options  :
  53.                                       B  Search In Block
  54.                                       G  Global Search
  55.                                       U  Ignore Upper/Lower Case
  56.                                       n  Replace n Occurrences
  57.                                       Y  Replace Without Asking
  58.  
  59.                                  For example, B10Y tells ENVOY to search
  60.                                  in the blocked region for ten occurrances
  61.                                  of the Search string and replace it with
  62.                                  the new string without asking.
  63.  
  64.    Alt-t       Retpos        276 Set the Return Position to the current cursor
  65.                                  position.  When you press the Enter key the
  66.                                  cursor will go to the Return Position instead
  67.                                  of to column 1.
  68.  
  69.    Alt-d       Clear Line    288 Delete the current line.
  70.  
  71.    Alt-f       Find * *      289 ENVOY will prompt you for the character
  72.                                  string you wish to find and for search
  73.                                  options.
  74.  
  75.                                  When the program prompts you, enter any
  76.                                  options you want in any order.
  77.  
  78.                                  Find Options  :
  79.                                       B  Search In Block
  80.                                       G  Global Search
  81.                                       U  Ignore Upper/Lower Case
  82.                                       n  Find the n'th Occurrence
  83.  
  84.                                  For example, B10 tells ENVOY to search
  85.                                  in the blocked region for the tenth
  86.                                  occurrence of the character string.
  87.  
  88.    alt-j       Joinline      292 Join the current line to the previous line.
  89.  
  90.    alt-b       Breakline     304 Break the current edit line at the cursor
  91.                                  position.
  92.  
  93.    Alt-n       Repeat        305 Repeat the last Find or Find and Replace
  94.                                  operation.
  95.  
  96.    alt-m       Menu          306 Show the ENVOY menu.
  97.  
  98.    Func  1     Block Top     315 Mark the beginning of a Block region.  The
  99.                                  current cursor position becomes the start
  100.                                  of a block.
  101.  
  102.    Func  2     Block End     316 Mark the end of a Block region.  The current
  103.                                  cursor position becomes the end of a block.
  104.  
  105.    Func  3     ReadFile *    317 Read a new edit file.  ENVOY will prompt you
  106.                                  for the file name and then read the file into
  107.                                  memory so that you can edit it.  If you are
  108.                                  working on a file in memory, save it before
  109.                                  you read a new file or else you will lose all
  110.                                  of the changes which you have made.
  111.  
  112.    Func  4     WriteFile *   318 Write the edit file to disk.  ENVOY will prompt
  113.                                  you for the name of the file you wish to write.
  114.                                  You may enter a full directory path name,
  115.                                  such as C:\MINE\FILE.TXT.  If you just press
  116.                                  the Enter key to enter a blank file name,
  117.                                  ENVOY will overwrite the current edit file.
  118.                                  The name of the current edit file is shown on
  119.                                  the ENVOY information line.
  120.  
  121.    Func  5     Block Copy    319 Copy the blocked region to the current
  122.                                  position.  If lines are blocked, the lines are
  123.                                  inserted below the current line.  The existing
  124.                                  lines are moved down.  If a region is blocked,
  125.                                  the block is copied to the current cursor
  126.                                  position.  Existing text is moved to the right
  127.                                  to make room.
  128.  
  129.    Func  6     Block Move    320 Move the blocked region to the current
  130.                                  position.  If lines are blocked,
  131.                                  the lines are inserted below the current
  132.                                  line.  The existing lines are moved down.
  133.                                  If a region is blocked, the block is
  134.                                  moved to the current cursor position.
  135.                                  Existing text is moved to the right to
  136.                                  make room.
  137.  
  138.    Func  7     Block Clear   321 The blocked region is deleted.
  139.  
  140.    Func  8     Block Read *  322 ENVOY will prompt you for a file name.
  141.                                  The file will be read into the current
  142.                                  file at the current position.  The new
  143.                                  text will be marked as a blocked region.
  144.  
  145.    Func  9     Block Write * 323 ENVOY will prompt you for a file name.
  146.                                  The blocked region will be written to
  147.                                  the file you name.
  148.  
  149.    Func 10     Block Lines   324 ENVOY can be set to mark either lines
  150.                                  or regions.  Block regions,(default) if
  151.                                  you want to move words, insert or delete
  152.                                  columns, etc.  Block lines to move paragraphs
  153.                                  around in the file.
  154.  
  155.    Home        Go TopFile    327 The cursor will move to the start of the first
  156.                                  line in the edit file.
  157.  
  158.    Up Arrow    Go Up         328 The cursor will move up one line in the edit
  159.                                  file.
  160.  
  161.    Page Up     Go UpPage     329 The cursor will move up to display a full
  162.                                  screen of new text.
  163.  
  164.    Left Arrow  Go Left       331 The cursor will move left one column.
  165.  
  166.    Right Arrow Go Right      333 The cursor will move right one column.
  167.  
  168.    End         Go EndFile    335 The cursor will move to the end of the
  169.                                  last line of the edit file
  170.  
  171.    Down Arrow  Go Down       336 The cursor will move down one line.
  172.  
  173.    Page Down   Go DownPage   337 The cursor will move down to display a
  174.                                  full screen of new text.
  175.  
  176.    Insert Key  InsertMode    338 In insert mode characters are inserted into
  177.                                  the line at the cursor position and the rest
  178.                                  of the line is shifted to the right.  In
  179.                                  overwrite mode any character already at the
  180.                                  cursor position is over-written.  Press the
  181.                                  Insert key to change from Insert mode to
  182.                                  Overwrite mode and back.  The current setting
  183.                                  is shown on the ENVOY display line.
  184.  
  185.    Delete Key  Clear Char    339 Delete the character at the cursor position.
  186.  
  187.    Shift F1    On            340 Go on-line.  This opens the communications
  188.                                  port so that you can communicate with a remote
  189.                                  computer.
  190.  
  191.    Shift F2    Off           341 ENVOY goes off line and returns to edit mode.
  192.  
  193.    Shift F3    Dial          342 Dial a phone number.
  194.  
  195.    Shift F4    Xget *        343 Receive a binary file.         
  196.  
  197.    Shift F5    XSend *       344 Send a binary file.            
  198.  
  199.    ^Right arr  Go TopLine    371 Go to the start of the current edit line.
  200.  
  201.    ^Left arr   Go EndLine    372 Go to the last character of the current edit
  202.                                  line.
  203.  
  204.    ^End        Clear EndLine 373 Delete all the characters from the cursor
  205.                                  position to the end of the current edit line.
  206.  
  207.    ^PgDn       Go EndBlock   374 Go to the end of the blocked region.
  208.  
  209.    ^PgUp       Go TopBlock   388 Go to the start of the blocked region.
  210.  
  211.  
  212. *                        COMMAND FILES
  213.  
  214. You can set up a command file to reconfigure the ENVOY editor or to manage your
  215. call to a remote computer.  The ENVOY commands IF, ELSE and JUMP enable you to
  216. set up a command file which will prompt you for information and  act on that
  217. information.  You can set up a command file which will try to call another
  218. computer several times before giving up or one which will try several bulletin
  219. boards and give you control when it finds one that isn't busy.  You can even set
  220. up a menu driven auto-dialer for voice communications.
  221.  
  222. Execute a command file by entering the command DO filespec, where filespec is
  223. the DOS filename and can include a complete directory path.  If you don't enter
  224. a directory path, ENVOY will look for the file in the current directory.  If the
  225. file isn't in the current directory, ENVOY will look in the ENVOY directory.
  226. You can define the ENVOY directory before you start the ENVOY program by
  227. entering the DOS command SET ENVOY=pathname, where pathname is the complete path
  228. to the ENVOY directory.  You can put the SET command in your Autoexec.Bat file
  229. so that the ENVOY directory is defined every time you start your PC.
  230.  
  231. A command file consists of a series of ENVOY line commands.  The commands are
  232. executed in just the same way as if you had entered them from the ENVOY command
  233. line or had assigned the commands to keyboard keys with the MACRO command and
  234. then pressed the MACRO keys.
  235.  
  236. A command file can use the DO command to call another command file.  When the
  237. the other command file finishes execution ENVOY continues to execute the
  238. original file.  Command files can be nested this way up to four deep.
  239.  
  240. If you want, you can put several ENVOY commands on a single line.  Separate
  241. the commands with the # character.
  242.  
  243. ENVOY doesn't check your control logic.  It is possible to set up an infinite
  244. loop in command file with the JUMP command which wants to execute forever.
  245. You can escape from a loop like this by pressing the alt-x key.
  246.  
  247. When you are writing a command file, or if you are have a problem with a
  248. command file, use the JOURNAL command to trace the execution of each line.
  249. The JOURNAL command echos all of the commands you enter to a file named
  250. Journal.Env on the current directory.  JOURNAL ON should be the first command in
  251. the file and JOURNAL OFF should be the last command.  You can also use the
  252. REMARK command to write comments to the CRT screen as the file is executed.
  253.  
  254. Put comments into a command file by using the ; character.  Anything following a
  255. ; is ignored unless it was part of a string parameter.  For example, the command
  256. FIND ';' ; ...comment...  will find the next ; character.  The comment will be
  257. ignored.
  258.  
  259.  
  260. *                        INITIALIZATION
  261.  
  262. To run Envoy you type 'ENVOY' or 'ENVOY {name of a command file}' at the DOS
  263. prompt.
  264.  
  265. When Envoy starts up it first tries to execute the file Initial.Env on the
  266. default directory.  As with any command file, If the file is not in the current
  267. directory Envoy will look for it in the ENVOY directory.  You can define the
  268. Envoy directory with the DOS command SET ENVOY=pathname.
  269.  
  270. You can use the file Initial.Env to redefine the edit keys, set a default phone
  271. number and communications parameters, or perform other set up tasks which you
  272. want to do every time you use envoy.
  273.  
  274. If you entered the name a command file as a parameter when you started Envoy,
  275. that command file will be executed after ENVOY is finished executing file
  276. Initial.Env.
  277.  
  278. These initialization files are very powerful.  You can set up command files for
  279. each of the many different jobs which Envoy can do.  For instance, you could
  280. create a command file called Work which contained the commands to log you on to
  281. your company computer.  Entering the DOS command ENVOY WORK would then log you
  282. on and return control.  you could set up other commands to log you onto other
  283. systems or to redefine the Envoy editor for special purposes.
  284.  
  285. *                        CHANGING THE DISPLAY COLORS
  286.  
  287. There are six colors used by the program for different purposes.  The COLOR
  288. command lets you redefine these colors.  The first parameter of the COLOR
  289. command chooses which color you want to redefine.  The choices are:
  290.  
  291.                    EDIT   => Edit characters
  292.                    BLOCK  => Blocked region
  293.                    INFO   => Information line
  294.                    QUES   => Envoy questions and error messages
  295.                    FOUND  => Mark search string
  296.                    HELP   => Help Screens and Menus
  297.  
  298. The second parameter of the COLOR command defines the new foreground color. The
  299. choices for foreground colors are:
  300.  
  301.                0 => Black               8  => Dark Gray
  302.                1 => Blue                9  => Light Blue
  303.                2 => Green               10 => Light Green
  304.                3 => Cyan                11 => Light Cyan
  305.                4 => Red                 12 => Light Red
  306.                5 => Magenta             13 => Light Magenta
  307.                6 => Brown               14 => Yellow
  308.                7 => Light Gray          15 => White
  309.  
  310. The third parameter of the COLOR command defines the new background color.
  311. The choices for background colors are:
  312.  
  313.  
  314.                0 => Black               8  => Black with Blink
  315.                1 => Blue                9  => Blue with Blink
  316.                2 => Green               10 => Green with Blink
  317.                3 => Cyan                11 => Cyan with Blink
  318.                4 => Red                 12 => Red with Blink
  319.                5 => Magenta             13 => Magenta with Blink
  320.                6 => Brown               14 => Brown with Blink
  321.                7 => Light Gray          15 => Light Gray with Blink
  322.  
  323. Use the Envoy Color Menu to change the Envoy default color scheme.  When you are
  324. happy with your choices, put COLOR commands in the command file INITIAL.ENV.
  325. This will redefine the defaults every time you run Envoy.
  326.  
  327.      Syntax
  328.        COlor {keyword} {foreground} {background}
  329.          Where keyword chooses which color you wish to redefine and the
  330.          foreground and background colors are given above.
  331.  
  332.      Example
  333.        COLOR Edit    0  1; Edit Screens - Black characters on blue background
  334.        COLOR Info   13  7; Info Line    - Lt Magenta on lt grey background
  335.        COLOR Found  14 14; Found String - Blinking yellow on brown background
  336.  
  337.  
  338. *                        CHARACTER CODES AND SCAN CODE
  339.  
  340.  A character code relates a character set (e.g. 'a','b'...) to the binary
  341. representation used by the computer.  This subject can be confusing because
  342. there are several incompatible character codes.
  343.  
  344. The ASCII character set is shown in another Help screen.  The ASCII set is a
  345. standard way of representing alphanumeric and computer control characters.
  346.  
  347. IBM compatible computers use 256 display codes based on the ASCII character set.
  348. The IBM display codes define what you see on the CRT screen when you write a
  349. character.  The first 128 characters of the IBM set are loosely based on the
  350. ASCII set.  The second 128 characters were chosen by IBM and be interpreted
  351. differently by non-IBM hardware, such as your printer.  This is why you
  352. sometimes see garbage when you print your screen display.
  353.  
  354. IBM compatible computers also use a keyboard character set which defines what
  355. number is generated when you press a keyboard key.  The first 128 codes are
  356. based on the ASCII character set.
  357.  
  358. The IBM extended keyboard character set includes the Function keys, the
  359. Alt- keys, etc.  ENVOY uses a character set based on the IBM character set.  The
  360. ENVOY extended codes are formed by adding 256 to the scan codes for the IBM
  361. extended character set.
  362.  
  363. You should use keys from the extended character set when you define ENVOY
  364. MACROs.  If you use a key which generates one of the ASCII codes in the range 0
  365. to 127 you will not be able to send that code to a remote computer.
  366.  
  367.  
  368. *                        ASCII Character Codes
  369.   Value Character  |  Value Character  |  Value Character  |  Value Character  |
  370.      0     NUL     |    32   (space)   |    64      @      |    96      `      |
  371.      1     SOH     |    33      !      |    65      A      |    97      a      |
  372.      2     STX     |    34      "      |    66      B      |    98      c      |
  373.      3     ETX     |    35      #      |    67      C      |    99      c      |
  374.      4     EOT     |    36      $      |    68      D      |   100      d      |
  375.      5     ENQ     |    37      %      |    69      E      |   101      e      |
  376.      6     ACK     |    38      %      |    70      F      |   102      f      |
  377.      7     BEL     |    39      '      |    71      G      |   103      g      |
  378.      8     BS      |    40      (      |    72      H      |   104      h      |
  379.      9     HT      |    41      )      |    73      I      |   105      i      |
  380.     10     LF      |    42      *      |    74      J      |   106      j      |
  381.     11     VT      |    43      +      |    75      K      |   107      k      |
  382.     12     FF      |    44      ,      |    76      L      |   108      l      |
  383.     13     CR      |    45      -      |    77      M      |   109      m      |
  384.     14     SO      |    46      .      |    78      N      |   110      n      |
  385.     15     SI      |    47      /      |    79      O      |   111      o      |
  386.     16     DLE     |    48      0      |    80      P      |   112      p      |
  387.     17     DC1     |    49      1      |    81      Q      |   113      q      |
  388.     18     DC2     |    50      2      |    82      R      |   114      r      |
  389.     19     DC3     |    51      3      |    83      S      |   115      s      |
  390.     20     DC4     |    52      4      |    84      T      |   116      t      |
  391.     21     NAK     |    53      5      |    85      U      |   117      u      |
  392.     22     SYN     |    54      6      |    86      V      |   118      v      |
  393.     23     ETB     |    55      7      |    87      W      |   119      w      |
  394.     24     CAN     |    56      8      |    88      X      |   120      x      |
  395.     25     EM      |    57      9      |    89      Y      |   121      y      |
  396.     26     SUB     |    58      :      |    90      Z      |   122      z      |
  397.     27     ESC     |    59      ;      |    91      [      |   123      {      |
  398.     28     FS      |    60      <      |    92      \      |   124      |      |
  399.     29     GS      |    61      =      |    93      ]      |   125      }      |
  400.     30     RS      |    62      >      |    94      ^      |   126      ~      |
  401.     31     US      |    63      ?      |    95      _      |   127            |
  402. *                        IBM Keyboard Scan Codes
  403.     Key      Code  |    Key      Code  |    Key      Code  |    Key      Code  |
  404.    (none)       0  |   SpaceBar    32  |     @         64  |     `         96  |
  405.     c-a         1  |     !         33  |     A         65  |     a         97  |
  406.     c-b         2  |     "         34  |     B         66  |     c         98  |
  407.     c-c         3  |     #         35  |     C         67  |     c         99  |
  408.     c-d         4  |     $         36  |     D         68  |     d        100  |
  409.     c-e         5  |     %         37  |     E         69  |     e        101  |
  410.     c-f         6  |     %         38  |     F         70  |     f        102  |
  411.     c-g         7  |     '         39  |     G         71  |     g        103  |
  412.     c-h         8  |     (         40  |     H         72  |     h        104  |
  413.     c-i         9  |     )         41  |     I         73  |     i        105  |
  414.     c-j        10  |     *         42  |     J         74  |     j        106  |
  415.     c-k        11  |     +         43  |     K         75  |     k        107  |
  416.     c-l        12  |     ,         44  |     L         76  |     l        108  |
  417.     c-m        13  |     -         45  |     M         77  |     m        109  |
  418.     c-n        14  |     .         46  |     N         78  |     n        110  |
  419.     c-o        15  |     /         47  |     O         79  |     o        111  |
  420.     c-p        16  |     0         48  |     P         80  |     p        112  |
  421.     c-q        17  |     1         49  |     Q         81  |     q        113  |
  422.     c-r        18  |     2         50  |     R         82  |     r        114  |
  423.     c-s        19  |     3         51  |     S         83  |     s        115  |
  424.     c-t        20  |     4         52  |     T         84  |     t        116  |
  425.     c-u        21  |     5         53  |     U         85  |     u        117  |
  426.     c-v        22  |     6         54  |     V         86  |     v        118  |
  427.     c-w        23  |     7         55  |     W         87  |     w        119  |
  428.     c-x        24  |     8         56  |     X         88  |     x        120  |
  429.     c-y        25  |     9         57  |     Y         89  |     y        121  |
  430.     c-z        26  |     :         58  |     Z         90  |     z        122  |
  431.   Escape       27  |     ;         59  |     [         91  |     {        123  |
  432.   (none)       28  |     <         60  |     \         92  |     |        124  |
  433.   (none)       29  |     =         61  |     ]         93  |     }        125  |
  434.   (none)       30  |     >         62  |     ^         94  |     ~        126  |
  435.   (none)       31  |     ?         63  |     _         95  |   (none)     127  |
  436. *                        IBM Extended Keyboard Scan Codes
  437.        Key         Code  |        Key         Code  |       Key           Code |
  438.                    256   |      alt-x         301   |         S-F7        346  |
  439.                    257   |      alt-c         302   |         S-F8        347  |
  440.                    258   |      alt-v         303   |         S-F9        348  |
  441.                    259   |      alt-b         304   |         S-F10       349  |
  442.                    260   |      alt-b         305   |         c-F1        350  |
  443.                    261   |      alt-n         306   |         c-F2        351  |
  444.                    262   |      alt-m         307   |         c-F3        352  |
  445.                    263   |                    308   |         c-F4        353  |
  446.                    264   |                    309   |         c-F5        354  |
  447.                    265   |                    310   |         c-F6        355  |
  448.                    266   |                    311   |         c-F7        356  |
  449.                    267   |                    312   |         c-F8        357  |
  450.                    268   |                    313   |         c-F9        358  |
  451.                    269   |                    314   |         c-F10       359  |
  452.                    270   |      F1            315   |         a-F1        360  |
  453.       TabLeft      271   |      F2            316   |         a-F2        361  |
  454.        alt-q       272   |      F3            317   |         a-F3        362  |
  455.        alt-w       273   |      F4            318   |         a-F4        363  |
  456.        alt-e       274   |      F5            319   |         a-F5        364  |
  457.        alt-r       275   |      F6            320   |         a-F6        365  |
  458.        alt-t       276   |      F7            321   |         a-F7        366  |
  459.        alt-y       277   |      F8            322   |         a-F8        367  |
  460.        alt-u       278   |      F9            323   |         a-F9        368  |
  461.        alt-i       279   |      F10           324   |         a-F10       369  |
  462.        alt-o       280   |                    325   |         PrtSc       370  |
  463.        alt-p       281   |                    326   |     c-LeftArrow     371  |
  464.                    282   |      Home          327   |     c-RightArrow    372  |
  465.                    283   |     UpArrow        328   |         c-End       373  |
  466.                    284   |      PgUp          329   |         c-PgDn      374  |
  467.                    285   |                    330   |         c-Home      375  |
  468.        alt-a       286   |    LeftArrow       331   |         alt-1       376  |
  469.        alt-s       287   |                    332   |         alt-2       377  |
  470.        alt-d       288   |   RightArrow       333   |         alt-3       378  |
  471.        alt-f       289   |                    334   |         alt-4       379  |
  472.        alt-g       290   |      End           335   |         alt-5       380  |
  473.        alt-h       291   |    DownArrow       336   |         alt-6       381  |
  474.        alt-j       292   |      PgDn          337   |         alt-7       382  |
  475.        alt-k       293   |      Ins           338   |         alt-8       383  |
  476.        alt-l       294   |      Del           339   |         alt-9       384  |
  477.                    295   |      S-F1          340   |         alt--       385  |
  478.                    296   |      S-F2          341   |         alt-=       387  |
  479.                    297   |      S-F3          342   |         c-PgUp      388  |
  480.                    298   |      S-F4          343   |          F11        389  |
  481.                    299   |      S-F5          344   |          F12        390  |
  482.      alt-z         300   |       S-F6         345   |
  483.  
  484.