home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / USCX / PGMRHELP.ZIP / PE.DOC < prev    next >
Text File  |  1990-05-01  |  22KB  |  564 lines

  1.  
  2.  
  3.  
  4.                                 +-------------------+
  5.                                 |                   |+
  6.                                 |  PPPPPP   EEEEEE  ||
  7.                                 |  P     P  E       ||
  8.                                 |  PPPPPP   EEE     ||
  9.                                 |  P        E       ||
  10.                                 |  P        EEEEEE  ||
  11.                                 |                   ||
  12.                                 +-------------------+|
  13.                                  +-------------------+
  14.  
  15.  
  16.                      PROGRAMMERS EDITOR VERSION 1.0 USERS GUIDE
  17.  
  18.  
  19.  
  20.                             Copyright Henry Weidman 1990
  21.                                  All Rights Reserved
  22.  
  23.  
  24.  
  25.                           This document was created with PE
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.           WARRANTY
  33.  
  34.           The warranty is  limited  to the replacement of defective disk-
  35.           ettes.  Defective  diskettes will be replaced if the  defective
  36.           diskette  is returned  to Weidman  Enterprises.  Weidman Enter-
  37.           prises is not liable for any other loss of time or money due to
  38.           the use of this software.
  39.  
  40.           How to contact Weidman Enterprises:
  41.  
  42.           COMPUSERVE: Compuserve ID: 73240,1653
  43.  
  44.           US MAIL:
  45.           Weidman Enterprises, 24 Bickel Court, Sterling VA 22170
  46.  
  47.  
  48.  
  49.                      - PE Version 1.0 Software License -
  50.  
  51.  
  52.       Programmers  Editor  is  copyrighted by the author.  If you obtained
  53.       this  program  from  a shareware distributor or a bulletin board you
  54.       may use it to determine if it meets your text editing needs.  If you
  55.       continue to use it, you must become a registered user.  This version
  56.       of  PE  may  be  copied  and  shared with other users as long as the
  57.       entire  diskette  is  copied.   You  are  encouraged  to  share this
  58.       software  with  other users.  The registered version of PE, which is
  59.       available  only to registered users may not be distributed or copied
  60.       except for making a backup copy.
  61.  
  62.                         WHY YOU SHOULD REGISTER PE
  63.  
  64.       The  excitement of trying a new software package is the anticipation
  65.       that  maybe  this  one  will perform magic for you.  PE will perform
  66.       magic  for  you!  You  will not find an editor that has the features
  67.       contained  in PE for any price.  There is no other editor that is as
  68.       easy  to  use  as  PE and has the features that PE has.  PE is worth
  69.       much  more  than  the  registration  cost and the registered version
  70.       comes  with  more features and utilities than the shareware version.
  71.       If  you  like  PE  and want me to continue to update and support it,
  72.       then register.  You can ensurethat I will continue to support PE by
  73.       registering now and the magic will continue.
  74.  
  75.  
  76.       Registered users will receive:
  77.  
  78.       1) Question and answer support via U.S. mail or CompuServe.
  79.       2) Complete Documentation (25 page users guide on diskette
  80.          or optional printed manual)
  81.       3) The registered version of PE which has the following additional
  82.          features:
  83.  
  84.          - 2 Views of the same file in 2 separate windows
  85.          - Additional Mouse Support
  86.          - Interface to Turbo C and Turbo Pascal MAKE utility
  87.          - Macro Editor
  88.          - Column Addition
  89.          - 144 user definable special character keys
  90.          - User programmable file filters with 4 file filters
  91.            included. The file filters perform conversion of
  92.            documents from non ascii formats to ascii.
  93.          - Separate Tab Filter utility
  94.          - Document Statistics utility (line count, word count,
  95.            lines per page, character count and lines of code count)
  96.          - Selective page print utility (print a selected range
  97.            of pages)
  98.          - Yearly update subscription available
  99.  
  100.       4) Notice of future updates to PE
  101.  
  102.       Purchase Options
  103.  
  104.       Latest Version of PE on diskette: $25.00
  105.                    Printed Users Guide: $10.00
  106.           One year update subscription: $15.00
  107.  
  108.       To become a registered user, use the order form on the next page
  109.       and submit payment for each system that PE will be installed on.
  110.       Site licenses are available on request.
  111.  
  112.  
  113.  
  114.                                    PE Order Form
  115.  
  116.  
  117.    Date: ________________
  118.  
  119.    Specify one diskette type:
  120.  
  121.          3 1/2 inch 720K ______
  122.          5 1/4 inch 360K ______
  123.  
  124.     Include Printed Manual ______
  125.     One Yearly Update      ______
  126.     --------------------------------------------
  127.    |                                            |
  128.    |  Ship To: _____________________________    |
  129.    |           _____________________________    |
  130.    |           _____________________________    |
  131.    |           _____________________________    |
  132.    |                                            |
  133.    |                                            |
  134.     --------------------------------------------
  135.  
  136.  
  137.  
  138.    Please enclose a check, money order or U.S. dollars,
  139.    and mail this order form to:
  140.  
  141.  
  142.                      Weidman Enterprises
  143.                      24 Bickel Court
  144.                      Sterling VA
  145.                      22170
  146.                      USA
  147.  
  148.  
  149.  
  150.            PE                       - CONTENTS -                       PE
  151.  
  152.  
  153.            Using Soft keys, Online Help, Installation...................1
  154.            Options, Version, Files......................................2
  155.            Description, Usage...........................................3
  156.            Key pad Functions............................................4
  157.            Status Line..................................................4
  158.            Cautions, Running DOS programs...............................5
  159.            Soft keys, Top Level Soft keys...............................6
  160.  
  161.  
  162.        MONOCHROME DISPLAY PROBLEMS
  163.  
  164.        If you are using a color display adapter with a monochrome monitor,
  165.        run  PEINSTAL  and  select  the Mono Display option or select color
  166.        options that work with your display.
  167.  
  168.  
  169.  
  170.                                    USING SOFTKEYS
  171.  
  172.  
  173.         Soft  keys  are  the  F1  to F10 or shift-F1 to shift-F10 function
  174.         keys.   When  a  small  up  arrow  is displayed on the screen in a
  175.         softkey  label,  press  the  SHIFT  key  and  the  FUNCTION  key
  176.         simultaneously to activate the function.  For example:
  177.  
  178.             Softkey   (The up arrow is shown as a caret ^ symbol in this
  179.              Label     document because the up arrow cannot be printed.)
  180.            +=======+
  181.           1|^ Menu |  Press shift and F10 simultaneously to exit to the top
  182.           0| Next  |  level softkey menu. Press F10 to go to the next lower
  183.            +=======+  level softkey menu.
  184.  
  185.         Where possible, softkeys are displayed from left to right according
  186.         to frequency of use. The most frequently used keys are assigned to
  187.         F1 and the least frequently used keys are assigned to F9.
  188.  
  189.  
  190.  
  191.                                        - i -
  192.  
  193.  
  194.  
  195.  
  196.                                  INSTALLATION
  197.  
  198.  
  199.         Copy the diskette files into any directory, then execute the
  200.         PEINSTAL  program to set the  PE installation directory path
  201.         and select user options.  PEINSTAL allows the user to select
  202.         display,  prompt,  memory size,  and  installation directory
  203.         options. If the installation directory option is left blank,
  204.         then  PE  will look  in the current directory  for the  HELP
  205.         files and macro files (*.MAC).
  206.  
  207.  
  208.                                      CAUTIONS
  209.  
  210.       +=======+  +===========+
  211.       | QUIT  |  | Save      |  'Q' exits from PE without saving work.
  212.       |       |  | Continue  |  'S' prompts the user to save work for
  213.       +=======+  | Quit      |      each window containing a file that
  214.                  | >         |      has been changed.
  215.                  +===========+
  216.       +-------+
  217.       |Abandon|  Clears the screen and text memory without saving work.
  218.       | File  |
  219.       +-------+
  220.       +-------+
  221.       |Run DOS|  Non recoverable errors while running the DOS program
  222.       |Program|  will result in loss of the editing session. Save work
  223.       +-------+  before using Run DOS.
  224.  
  225.       +-------+  The current file is abandoned then the user is
  226.       | Read  |  is prompted for a valid file name and the new
  227.       | File  |  file is read into the editor.
  228.       +-------+
  229.                  Out of Memory error message: When this error occurs,
  230.                  most editor functions are disabled except File functions.
  231.                  Abandon or Save files and then continue or Quit and
  232.                  execute PEINSTAL to select a larger memory usage option.
  233.  
  234.       BUGS
  235.       -  Search, Replace will not replace only one character with an empty
  236.          replace string (at least one character must be specified in the
  237.          replace string or a space is automatically substituted).
  238.       -  Search, Replace backwards does not search on the current line (it
  239.          begins the search on the previous line).
  240.       -  A line cannot be broken at the last character on a line.
  241.  
  242.       TRADEMARKS
  243.           IBM, and PC-DOS are trademarks of International Business
  244.           Machines Corp.
  245.           MS-DOS is a trademark of Microsoft Corp.
  246.           Turbo C and Turbo Pascal are trademarks of Borland International
  247.           Wordstar is a trademark of MicroPro International
  248.  
  249.  
  250.                                       - ii -
  251.  
  252.  
  253.  
  254.      PE                                - 1 -                               PE
  255.  
  256.  
  257.  
  258.                            - SOFTKEYS ARE FUNCTION KEYS -
  259.  
  260.                                  - Using Softkeys -
  261.  
  262.                   Soft keys are simply function key labels which are
  263.                   displayed at the  bottom of the screen. There are
  264.                   a  hierarchy of softkey  menus.  Pressing any top
  265.                   (or main) level softkey causes the selected lower
  266.                   level of softkeys to appear.  Pressing the "Menu"
  267.                   softkey  returns  the  user to the top  (or Main)
  268.                   level.  When the up arrow symbol  is displayed in
  269.                   a softkey label,  press  the  shift  key  and the
  270.                   function key simultaneously.
  271.  
  272.  
  273.  
  274.  
  275.                                     ON LINE HELP
  276.  
  277.         Press the HELP key from the top level softkey menu and then press
  278.         the desired help softkey. To get familiar with the keyboard, the
  279.         key pad, softkeys and control keys, try the "KEYS" help first.
  280.  
  281.  
  282.  
  283.  
  284.                          INSERTING AND DELETING TEXT
  285.  
  286.  
  287.         The key pad "Ins" key toggles the INSert and OVeRtype modes and
  288.         displays the current mode on the status line. In insert mode,
  289.         characters may be inserted wherever the cursor is. In overtype
  290.         mode, a character typed at the keyboard replaces the current
  291.         character. The key pad "Del" key deletes the current character.
  292.         The backspace (<-) key deletes the previous character.
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.       PE                                - 2 -                              PE
  300.  
  301.  
  302.         NAME         PE, Programmers editor
  303.  
  304.  
  305.         TO RUN       PE [ filename [line_number] ]
  306.         [] denotes optional parameters
  307.  
  308.  
  309.         VERSION      PE.................VERSION 1.0.....................1990
  310.  
  311.  
  312.        ENVIRONMENT   IBM PC or PC compatible, MS/PC-DOS 2.1 or greater,
  313.                      Monochrome or Color, 256K memory. Supports EGA and VGA.
  314.                            To run concurrent DOS programs, more memory is
  315.                      needed (minimum total ram 512K) depending on the memory
  316.                      requirements of the DOS programs being executed. To use
  317.                      MAKE, 640K is recommended.
  318.  
  319.  
  320.         MEMORY       Depends on memory option selected in PEINSTAL. The
  321.         USAGE        amount of memory used determines maximum edit file
  322.                      size. Refer to the chart below.  Number of lines and
  323.                      pages may vary depending on the content of the
  324.                      document. PE  will occupy the maximum amount of memory
  325.                      available up to the maximum limits shown below.
  326.  
  327.                         MEMORY USAGE            MAXIMUM EDIT FILE SIZE
  328.                        1K = 1024 BYTES             1K = 1000 BYTES
  329.  
  330.                     *250K max  128K min.   2000 LINES,  40 PAGES, 110K
  331.                     *512K max  128K min.   6500 LINES, 115 PAGES, 322K
  332.                     *640K max  128K min.   7500+LINES, 135+PAGES, 450K
  333.  
  334.                     *Depends on amount of memory allocated to DOS and
  335.                      other memory resident programs.
  336.  
  337.  
  338.            FILES
  339.  
  340.          PE.EXE        Main executable
  341.          PEINSTAL.EXE  Installation and set up program
  342.          *.MAC         Stored keystroke macro files.
  343.          HELP*.TXT     Help files
  344.          PE.DOC        This document
  345.          INSTALL.EXE   Shows installation instructions
  346.          INSTALL.PE    Installation instructions
  347.  
  348.  
  349.         AUTHOR         Henry Weidman
  350.  
  351.  
  352.  
  353.  
  354.       PE                                - 3 -                               PE
  355.  
  356.  
  357.         DESCRIPTION
  358.  
  359.         Programmer's  Editor creates pure ascii text files and may be used
  360.         for  programming,  creating  batch  files,  creating forms and for
  361.         creating text files.
  362.  
  363.         PE  is  a  very  user  friendly  text  editor  with  many advanced
  364.         features.   PE  was  designed  for both new computer users and for
  365.         more  experienced  users.   New  users  can begin using PE without
  366.         referring  to  the  users guide.  It is only necessary to refer to
  367.         the  users  guide  for  information  about  the  editor's  unique
  368.         features.   All editor features are displayed on the softkey menus
  369.         or  are  explained in the on-line help files.  Experienced and new
  370.         users will appreciate the advanced features of PE which are listed
  371.         below:
  372.  
  373.            ANSI Control Sequences            Extended Ascii Characters
  374.            ASCII Table                       File Filters
  375.            Auto Indent                       Hex, Decimal Calculator
  376.            Block Copy, Delete, Move, Write   Insert Control Characters
  377.            Calendar                          Multiple Files, 9 File Windows
  378.            DOS File Management               Search, Replace
  379.            DOS Print                         Macros
  380.            EGA 43 line support               VGA 50 line support
  381.            Execute DOS programs              254 Columns
  382.            Ram Based, Fast                   7500+  lines
  383.  
  384.  
  385.         USAGE
  386.  
  387.         Most  of  the  editor commands are displayed on the softkey menus.
  388.         There  are  several  levels  of  softkeys.   The  second  level of
  389.         softkeys  may  be  accessed  by  pressing  any  of  the  top level
  390.         softkeys.
  391.  
  392.         In  some  of  the  low  level  menus, the next level is reached by
  393.         pressing  the  "Prev or Next" softkey.  To return to the main menu
  394.         when  the "Prev or Next" softkey is displayed, press the Shift key
  395.         and  the "Prev or Next" softkey simultaneously until the main menu
  396.         appears.   In menus where only the "Menu" softkey is displayed, it
  397.         is  not  necessary  to  press the shift key.  To return to the top
  398.         level menu immediately, press CtrlX.
  399.  
  400.         The  key  pad buttons are available for moving the cursor by using
  401.         the arrow keys, the Pg Up, Pg Dn keys, or the Home, End keys.  The
  402.         Ins  key  toggles  the  INSERT  or  OVERWRITE mode and the Del key
  403.         deletes  characters.   In  addition,  the  Esc  key will undo line
  404.         deletions.   As  many as the last 20 deleted lines may be restored
  405.         at the current cursor position.
  406.  
  407.         Some  softkey  menu  commands  and  key  pad functions may also be
  408.         executed by pressing specific Ctrl or Alt keys.
  409.  
  410.         The  calculator  uses  reverse polish notation and has decimal and
  411.         hex modes.  In addition to the normal arithmetic functions, it has
  412.         a  shift  left  and  shift right capability.  To shift the current
  413.         result  left  or  right  use  the '<' and '>' keys.  The result is
  414.         shifted  left  or  right  one  bit each time the '<' or '>' key is
  415.         pressed.
  416.  
  417.  
  418.  
  419.       PE                                - 4 -                               PE
  420.  
  421.  
  422.  
  423.                               THE KEY PAD FUNCTIONS
  424.  
  425.  
  426.                              +======+ +======+
  427.        Cancel commands   --> | Esc  | | Num  | <-- Automatically turned on
  428.        or un delete lines    |      | | Lock |     when using the calculator
  429.                              +======+ +======+
  430.  
  431.                                       Cursor     Page            Top of Screen
  432.                                         Up        Up             [Ctrl Pg Up]
  433.                              +======+ +======+ +======+ +======+
  434.        Beginning of line --> | 7    | | 8    | | 9    | |      | <-- Multiply
  435.        Top of file [Ctrl-    | Home | |      | | Pg Up| | *    |
  436.        Home]                 +======+ +======+ +======+ +======+
  437.  
  438.                               Cursor            Cursor
  439.                               Left              Right
  440.        Move Left  [Ctrl <- ] +======+ +======+ +======+ +======+
  441.        Move Right [Ctrl -> ] | 4    | | 5    | | 6    | | -    | <-- Subtract
  442.        (Move one word)       | <-   | |      | | ->   | |      |
  443.                              +======+ +======+ +======+ +======+
  444.  
  445.                                        Cursor    Page            End of Screen
  446.                                         Down     Down            [Ctrl Pg Dn]
  447.                              +======+ +======+ +======+
  448.        End of line       --> | 1    | | 2    | | 3    | +======+     Calc
  449.        End of file [Ctrl End]| End  | |      | | Pg Dn| |      | <-- Enter,
  450.                              +======+ +======+ +======+ | +    |     Add
  451.                                                         |      |
  452.                               +=============+  +======+ |      |
  453.        Toggle insert,    -->  | 0           |  |      | |      |
  454.        over type mode         | Ins         |  | Del  | +======+
  455.        (insert characters     +=============+  +======+
  456.         or over type characters)               Delete character
  457.                                                or insert decimal point
  458.                                                in calculator mode
  459.  
  460.  
  461.                                    the STATUS LINE
  462.  
  463.        +------------------------------------------------------------------+
  464.        |W:1 Ln:130  Col:16  File:myfile.txt                   SK AI WW INS|
  465.        +------------------------------------------------------------------+
  466.         File: The current file name is placed on the status line after a
  467.               Read or Save operation.
  468.         W:    Window number                              AI   Auto indent
  469.         Ln:   Line number                                WW   Word wrap
  470.         Col:  Column number                              INS  INSert mode
  471.         File: Current file name                          OVR  OVeRtype mode
  472.                                                          SK   Storing keys
  473.  
  474.  
  475.  
  476.       PE                                - 5 -                               PE
  477.  
  478.  
  479.  
  480.  
  481.                                      CAUTIONS
  482.  
  483.       +=======+  +===========+
  484.       | QUIT  |  | Save      |  'Q' exits from PE without saving work.
  485.       |       |  | Continue  |  'S' prompts the user to save work for
  486.       +=======+  | Quit      |      each window containing a file that
  487.                  | >         |      has been changed.
  488.                  +===========+
  489.       +-------+
  490.       |Abandon|  Clears the screen and text memory without saving work.
  491.       | File  |
  492.       +-------+
  493.       +-------+
  494.       |Run DOS|  Non recoverable errors while running the DOS program
  495.       |Program|  will result in loss of the editing session. Save work
  496.       +-------+  before using Run DOS.
  497.  
  498.       +-------+  The current file is abandoned then the user is
  499.       | Read  |  prompted for a valid file name and the new file
  500.       | File  |  is read into the editor.
  501.       +-------+
  502.  
  503.  
  504.  
  505.  
  506.  
  507.       PE                                - 6 -                              PE
  508.  
  509.  
  510.                                        SOFTKEYS
  511.  
  512.  
  513.         When  the up arrow symbol is displayed in a softkey label, use the
  514.         shift key in combination with the function key.
  515.  
  516.  
  517.         Use the Esc key to cancel a command.
  518.  
  519.  
  520.  
  521.                                   TOP LEVEL SOFTKEYS
  522.  
  523.         +=======+
  524.        F| File, | File and directory management functions
  525.        1|  Dir  | Including change directory and list directory
  526.         +=======+
  527.         +=======+
  528.        F|Search,| Search/Replace, set markers, or move within file
  529.        2| Goto  | Search/Replace allows Control or alt characters
  530.         +=======+
  531.         +=======+
  532.        F| Block | Move blocks horizontally or vertically
  533.        3| Cmds  | Copy or write blocks
  534.         +=======+
  535.         +=======+
  536.        F| Text  | Line centering, set margins, format text, auto indent,
  537.        4| Cmds  | word wrap, set tab width
  538.         +=======+
  539.         +=======+
  540.        F|Window | Create, delete windows, move between windows
  541.        5| Cmds  |
  542.         +=======+
  543.         +=======+
  544.        F| User  | Force color or monochrome modes, select EGA 43 line
  545.        6|Options| or VGA 50 line mode. User defined macros.
  546.         +=======+
  547.         +=======+
  548.        F| Help  | Access help files
  549.        7|       |
  550.         +=======+
  551.         +=======+
  552.        F|Special| RPN calculator, date, time, run dos programs,
  553.        8| Tools | display key codes, ascii table, file filters,
  554.         +=======+ dos print, calendar
  555.         +=======+
  556.        F|Special| Extended ascii characters, draw boxes, create forms,
  557.        9| Chars | math symbols, Greek letters
  558.         +=======+
  559.         +=======+
  560.        1| Quit  | Exit with or without saving work
  561.        0|       |
  562.         +=======+
  563.  
  564.