home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PROG_C / ED_ER.ZIP / ED.DOC next >
Text File  |  1994-01-22  |  16KB  |  429 lines
  1.             STOP!
  2.       If you are using a
  3.       program other than
  4.       ED.EXE to read this
  5.       file, exit it and
  6.       type:
  7.          ED ED <ENTER>
  8.  
  9.  
  10.  
  11.                             ED: A C source code editor
  12.                                     Version 4.0
  13.  
  14.                                    January 1994
  15.                          Written by Herb and Eric Ridge
  16.  
  17.  
  18.                                   NEW ADDITIONS
  19.  
  20.  
  21.       - minor bugs have been fixed
  22.       - Function Lister/Finder (^K) has been improved (see Line #351; press F10)
  23.       - additions to the EDCONFIG.     file (see Line #84; press F10)
  24.       - improvements to loading files from the command-line
  25.       - additions to the Manual (ED.DOC)
  26.       - ED works well from within Microsoft Windows (as a DOS APP)
  27.  
  28.  
  29.       ************************ NEW COOL ADDITIONS ***********************
  30.  
  31.          ED now supports source-code coloring, just like the big IDE
  32.       programs that cost a lot of money.  It colors KEYWORDS, COMMENTS,
  33.       NUMBERS, SYMBOLS, STRINGS, and DIRECTIVES.  And it does it fast too!
  34.  
  35.       *******************************************************************
  36.  
  37.       ************************ NEWS FLASH *******************************
  38.  
  39.          ED is now able to load a file of any size (upto the ammount of memory
  40.       on the system).  However, if the file is unstandard (i.e. EXE or COM
  41.       files) it will NOT load it.
  42.  
  43.       *******************************************************************
  44.  
  45.  
  46.  
  47.                                    WELCOME
  48.  
  49.       Welcome to ED.  This file contains information on all of the many options
  50. that ED has to offer.
  51.  
  52.  
  53.                                 INTRODUCTION
  54.  
  55.       First of all, ED is a C source code editor/compiler, which means that
  56. you can create, compile, and run your C programs from within ED!
  57.  
  58. NOTE:
  59.    ED is NOT a compiler!  It just allows you to compile your program via your
  60.    compiler's COMMAND-LINE COMPILER!
  61.  
  62.       Secondly, ED is a general purpose editor for all ASCII files.
  63.  
  64.       Third, ED is easy to use.  Possible selections are always shown in a
  65. menu at the bottom of the screen.  There is no confusing configuration
  66. you need to wade through to get ED to work. (Well, it's not TOO confusing!)
  67.  
  68.  
  69.  
  70.                               GETTING STARTED
  71.  
  72.       If you are using a hard disk I recommend that you put ED.EXE in your
  73. UTILITIES directory or any directory that is in your PATH statement.  ED will
  74. work in CGA's 25 line mode, EGA's 43 line mode, or VGA's 50 line mode.  ED will
  75. automatically start with the maxium lines per screen that you system supports.
  76. It will also work on COLOR or MONOCHROME monitors!
  77.  
  78.       ED can be started in three ways...
  79.  
  80.       1. just type ED <ENTER>
  81.             this starts UP ED and display's a window with all the files in
  82.           the current directory.  You can change the directory by pressing
  83.           F1.  You can load a file by selecting the desired file and pressing
  84.           <ENTER>.
  85.  
  86.       2. type ED myprog
  87.             this starts UP ED with "myprog" already loaded.  ED will
  88.           automatically add the .C to the end of your filename.  If the
  89.           .C extension is not found it looks for .CPP, .ASM, .DAT, .DOC, .TXT,
  90.           .BAT.  If none of these are found it starts a file in ED with no
  91.           extension.
  92.  
  93.       3. type ED nonexist.no
  94.             this will start ED with a NEW file.
  95.  
  96.  
  97.  
  98.                               CONFIG FILE
  99.                         (called EDCONFIG.   )
  100.  
  101.       ED supports a CONFIG file.  This file specifies the colors and default
  102.    mask for ED.  The file should look something like this :
  103.  
  104. Tab 3                        -- range = 0 to 8
  105.  
  106. TextBackground 1             -- range = 0 to 15
  107. TextForeground 15            -- range = 0 to 15
  108.  
  109. KeywordBackground 1          -- range = 0 to 15
  110. KeywordForeground 7          -- range = 0 to 15
  111.  
  112. SymbolBackground 1           -- range = 0 to 15
  113. SymbolForeground 11          -- range = 0 to 15
  114.  
  115. CommentBackground 1          -- range = 0 to 15
  116. CommentForeground 14         -- range = 0 to 15
  117.  
  118. NumberBackground 1           -- range = 0 to 15
  119. NumberForeground 12          -- range = 0 to 15
  120.  
  121. DirectiveBackground 1        -- range = 0 to 15
  122. DirectiveForeground 3        -- range = 0 to 15
  123.  
  124. StringBackground 1           -- range = 0 to 15
  125. StringForeground 10          -- range = 0 to 15
  126.  
  127. BottomLineBackground 15      -- range = 0 to 15
  128. BottomLineForeground 0       -- range = 0 to 15
  129. BottomLineHighlight  4       -- range = 0 to 15
  130.  
  131. FileMask *.*                 -- default mask that ED will use to load files.
  132.       (settings shown are can be changed.)
  133.  
  134.       Except for TextBackground/Foreground and the BottomLine stuff the colors
  135.    are used for the SOURCE CODE COLORING feature of ED.
  136.  
  137.       This file must be in the ROOT directory of your current working disk.
  138. If you delete this file or any part of it, ED will use it's defaults
  139.  
  140.  
  141.                                BASIC MOVEMENT
  142.  
  143.      KEY           | WHAT IT DOES
  144.     ------------------------------
  145.     ESC            | Quits ED (prompts for save)
  146.     UP ARROW       | Moves cursor UP one line
  147.     DOWN ARROW     | Moves cursor DOWN one line
  148.     LEFT ARROW     | Moves cursor LEFT one space
  149.     RIGHT ARROW    | Moves cursor RIGHT one space
  150.     HOME           | Moves cursor to beginning of line
  151.     END            | Moves cursor to end of line
  152.     TAB            | Moves cursor 3 spaces to the RIGHT
  153.     DELETE         | Deletes one character to the RIGHT of the cursor
  154.     BACKSPACE      | Deletes one character to the LEFT of the cursor
  155.     PAGE UP        | Moves cursor UP one page
  156.     PAGE DOWN      | Moves cursor DOWN one page
  157.     INS            | Toggles the INSERT and OVERTYPE mode
  158.                      █ cursor = overtype    ▄ cursor = insert
  159.     ENTER          | ADDS CR/LF to line (if in middle of line it moves
  160.                                          everything from the RIGHT of the
  161.                                          cursor DOWN.  It also puts the text
  162.                                          over the same columns as the line
  163.                                          above it)
  164.  
  165.  
  166.                                FUNCTION KEYS
  167.  
  168.       KEY    | WHAT IT DOES
  169.      -----------------------
  170.      F1      | HELP
  171.      F2      | Finds the word at the cursor
  172.      F3      | Finds the occurrence
  173.      F4      | Goes to the Cut & Paste Mode
  174.      F5      | Runs compile
  175.      F6      | Issues a DOS shell
  176.      F7      | Displays all 256 ASCII characters in a table
  177.      F8      | Shows the DOS screen
  178.      F9      | A programmers calculator
  179.      F10     | Brings the cursor to a specified line number
  180.  
  181.  
  182.                              CONTROL + KEYS
  183.  
  184.       KEY         | WHAT IT DOES
  185.      ----------------------------
  186.      ^F           | Find
  187.      ^K           | Goto function
  188.      ^N           | Inserts a blank line
  189.      ^P           | Inserts the Clip Board at the cursor
  190.      ^Q           | Finds matching {} ()
  191.      ^R           | Deletes from the cursor to the end of the line
  192.      ^Y           | Deletes the entire line
  193.      ^PAGE DOWN   | Moves the cursor to the end of file
  194.      ^PAGE UP     | Moves the cursor to the top of file
  195.      ^END         | Moves the cursor to the bottom of screen
  196.      ^HOME        | Moves the cursor to the top of screen
  197.      ^LEFT ARROW  | Moves the cursor one word to the LEFT
  198.      ^RIGHT ARROW | Moves the cursor one word to the RIGHT
  199.  
  200.  
  201.                              SHIFT + KEYS
  202.  
  203.  
  204.       KEY                    | WHAT IT DOES
  205.      ---------------------------------------
  206.      SHIFT + LEFT ARROW      | Takes you to the Cut & Paste menu and starts
  207.                                selecting to the LEFT
  208.      SHIFT + RIGHT ARROW     | Takes you to the Cut & Paste menu and starts
  209.                                selecting to the RIGHT
  210.      SHIFT + UP ARROW        | Takes you to the Cut & Paste menu and starts
  211.                                selecting UP a line
  212.      SHIFT + DOWN ARROW      | Takes you to the Cut & Paste menu and starts
  213.                                selecting DOWN a line
  214.      SHIFT + HOME            | Takes you to the Cut & Paste menu and selects
  215.                                from the cursor to the front of the line
  216.      SHIFT + END             | Takes you to the Cut & Paste menu and selects
  217.                                from the cursor to the end of the line
  218.  
  219.  
  220.                               ALTERNATE + KEYS
  221.       KEY         | WHAT IT DOES
  222.      ----------------------------
  223.      ALT + F      | File menu
  224.      ALT + S      | Search & Replace menu
  225.      ALT + X      | Quits ED (prompts for save)
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.                        DETAILED DESCRIPTION OF FUNCTIONS
  234.  
  235.  
  236.  
  237.                                 HELP - F1
  238.  
  239.       The HELP function simply display's some basic help.  Press the HILIGHTED
  240. letter to view help on the topic you want.
  241.  
  242.  
  243.                            FIND WORD AT CURSOR - F2
  244.  
  245.       This searches the file for the word that the cursor is on.  The options
  246. in the SEARCH menu affects the way it searches(options are explained later).
  247.  
  248.  
  249.                          FIND THE NEXT OCCURRENCE - F3
  250.  
  251.       This finds the next occurrence of the word specified by pressing F2 or by
  252. what was specified in the SEARCH menu.  The options in the SEARCH menu do
  253. affect the way this option works.
  254.  
  255.  
  256.                             CUT & PASTE MENU - F4
  257.  
  258.       This is a Cut & Paste menu.  You select text with the
  259. UP, DOWN, LEFT, RIGHT, PAGE UP, PAGE DOWN, HOME, and END keys.  There are nine
  260. options.  They are:
  261.  
  262.               KEY         | WHAT IT DOES
  263.              ----------------------------
  264.              F1           | Copies selected text into the Clip Board
  265.              F2           | Copies selected text into the Clip Board
  266.                             and removes it from the file
  267.              F3           | Finds the selected text
  268.              F4           | Prints the selected text
  269.              F5           | Saves the selected text to a file
  270.              F6           | OUT-DENTS the selected lines
  271.              F7           | IN-DENTS the selected lines
  272.              DEL          | Deletes selected text
  273.              ESC          | Leaves the Cut & Paste menu
  274.  
  275.  
  276.          CAUTION:  The DEL key does NOT put what you have selected into the
  277.                    Clip Board, so once you push DEL-it's gone!
  278.  
  279.          NOTE:  Once you start to select UP or DOWN you are not able to
  280.                 select LEFT or RIGHT.  And the same applies for the LEFT and
  281.                 RIGHT.
  282.  
  283.  
  284.                              COMPILE PROGRAM - F5
  285.  
  286.  
  287.       The COMPILE PROGRAM function is very useful.  To use it all you have to
  288. do is put in remarks /* */ at the top line of your file what you would use to
  289. normally compile your program from DOS using your compiler's COMMAND-LINE
  290. COMPILER.  For example, if you are using Turbo C you would put the following
  291. at the top line (line #1) of your file:
  292.  
  293.             /* tcc myprog.c mylib.lib */
  294.  
  295.       This will only compile your program.  To compile it and run it you can
  296. create a .BAT file with ED to compile and run your program.  Then you would
  297. simply put the .BAT file in remarks instead of the compiler command.  For
  298. example:
  299.  
  300.           Create COMPILE.BAT using ED:
  301.                  tcc myprog.c mylib.lib
  302.                  PAUSE                    -- just so you can look at any errors
  303.                  myprog.exe
  304.  
  305.           then add COMPILE.BAT to the top of your program(line 001:0001):
  306.                  /* COMPILE.BAT */
  307.           (you can substitute COMPILE.BAT to any name you wish.  It's used
  308.            here merely as an example)
  309.  
  310.           and press F5 to compile AND run your program.
  311.  
  312.  
  313.       I would suggest putting a PAUSE statement before the filename to run
  314. in the .BAT file before you run it.  This way you can look at any ERRORS
  315. or WARNINGS you may have.
  316.  
  317.  
  318.  
  319.                            SHELL TO DOS - F6
  320.  
  321.       This is your basic run-of-the-mill DOS SHELL.  Just type 'EXIT' to go
  322. back to ED.  If for some reason you forget that you are SHELLed out of ED and
  323. happen to run ED again, ED will warn you of this, but it will give you the
  324. option of running another copy.
  325.  
  326.  
  327.                              ASCII TABLE - F7
  328.  
  329.       This function display's all 256 ASCII characters.  Press PAGE UP or
  330. PAGE DOWN to scroll through them.  It shows you the character, its decimal
  331. value, and its hex value.
  332.  
  333.  
  334.                            SHOW DOS SCREEN - F8
  335.  
  336.       This function shows the DOS screen.  This comes in handy when you have
  337. COMPILED your program and need to look at the errors that need fixing.
  338.  
  339.  
  340.                           PROGRAMMERS CALCULATOR - F9
  341.  
  342.       The CALCULATOR can do all the basic things that a programmer might need.
  343. It will show the answer to the problem in it's DECIMAL, HEX, and BINARY forms.
  344. To exit the CALCULATOR press <ENTER>.
  345.  
  346.  
  347.  
  348.                          GOTO LINE NUMBER - F10
  349.  
  350.       This function brings you to the line number that you specify.
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.                            THE FILE MENU - ALT+F
  358.  
  359.  
  360.       KEY         | WHAT IT DOES
  361.      ----------------------------
  362.      Alt-F + N    | Prompts for save on the current file, and then creates
  363.                     a blank screen ready for editing
  364.      Alt-F + S    | Saves the current file
  365.      Alt-F + A    | Saves the current file AS another name
  366.      Alt-F + L    | Loads a file from disk.  Select the file by using the
  367.                     UP, DOWN, PAGE UP, PAGE DOWN, and ENTER keys.  You can
  368.                     change the current path by pressing F1
  369.      Alt-F + M    | This Merges or inserts a file at the cursor
  370.      Alt-F + P    | This prints the file to your IBM compatible printer.  It
  371.                     prints a .C file with line numbers, and it prints all other
  372.                     file normally
  373.      Alt-F + ESC  | Exits you from the file menu
  374.  
  375.  
  376.  
  377.                         THE SEARCH & REPLACE MENU - ALT+S
  378.  
  379.       KEY         | WHAT IT DOES
  380.      ----------------------------
  381.      Alt-S + F    | Finds a word (same as F2)
  382.      Alt-S + N    | Finds the next one (same as F3)
  383.      Alt-S + R    | Replaces a word.  Asks for prompt on replace and how many
  384.                     you wish to do.
  385.      Alt-S + C    | Toggles CASE SENSITIVE MATCH search
  386.      Alt-S + W    | Toggles WHOLE WORD MATCH search
  387.      Alt-S + ESC  | Exits the SEARCH & REPLACE menu
  388.  
  389.  
  390.                           GOTO A FUNCTION - CTRL+K
  391.  
  392.       This allows you to jump to a function in your C program.  This comes in
  393. handy if you have errors in one function and you are in another.  Just select
  394. the function either by using the ARROW keys or by the first letter of the
  395. function's name.  This function will ONLY work with a file with a .C or .CPP
  396. extension.
  397.  
  398.  
  399.  
  400.                            ADDITIONAL COMMENTS
  401.  
  402.       Please feel free to pass this to your other friends.  Just be sure to
  403. include these files:
  404.                ED.EXE
  405.                ED.DOC
  406.                EDCONFIG.
  407.  
  408.  
  409.       We would love your support, comments, suggestions, ect...
  410. And if you find any 'BUGS' in ED (which is highly un-likley, but possible)
  411. please write us a letter explaining how and where it happened.
  412.  
  413.  
  414.  
  415.                            ORDERING INFORMATION
  416.                            --------------------
  417.  
  418.       New versions of ED are always being made.  If you enjoy ED and wish to
  419. be advised of updates please send a check for the amount of $15.00 to:
  420.  
  421.                           O.K. Software
  422.                         Route 9, Box 1368
  423.                    Lexington, North Carolina 27292
  424.  
  425.  
  426.                       Thanks for your support,
  427.                            O.K. Software
  428.  
  429.