home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / gohom10a.zip / GOED.HLP < prev    next >
Text File  |  1994-04-30  |  12KB  |  331 lines
  1. Help file for GoED.
  2.  
  3. @@Contents
  4. HelpOnHelp : `1Help on Help`0
  5. GoEdOver   : `1Editor Overview`0
  6. @@SectionHdr :
  7. @@SectionHdr :    `2Command Parameters`0
  8. @@SectionHdr :
  9. CmdLine    : `1Command line parameters`0
  10. FileCmds   : `1Commands placed in first line of file`0
  11. @@SectionHdr :
  12. @@SectionHdr :    `2Edit Keys`0
  13. @@SectionHdr :
  14. CursKeys   : `1Cursor Movement`0
  15. DelKeys    : `1Delete Keys`0
  16. FnKeys     : `1Function Keys`0
  17. MarkKeys   : `1Selecting Text`0
  18. SearchKeys : `1Finding Text`0
  19. MiscKeys   : `1Miscellaneous Keys`0
  20. MacroKeys  : `1Macro Keys`0
  21. File       : `1Managing Files`0
  22. @@SectionHdr :
  23. @@SectionHdr :    `2Miscellaneous Items`0
  24. @@SectionHdr :
  25. Colors     : `1Using Colors`0
  26. MenuBar    : `1Menu Bar`0
  27. @@EndContents
  28.  
  29.  
  30.  
  31. @@Help
  32. [HelpOnHelp]
  33. To use help, select the topic you want help on from the topics
  34. list (enter 'T' to get back to the topics list). Use the
  35. cursor and page keys to scroll through the text. The `2 Next`0
  36. and `2 Previous `0 buttons move to the next and previous
  37. topic, respectively.
  38.  
  39. All of the buttons in `1GoHelp`0 can be executed by simply
  40. pressing the key that is highlighted on the button. You can
  41. also TAB to the button or press it's accelerator key (press
  42. <ALT> + key hightlighted on button label).
  43.  
  44. To get help on a particular program, run `1GoHelp`0 with the
  45. first argument on the command line set: `1GoHome`0,
  46. `1GoScript`0, `1GoSched`0, or `1GoEd`0. You can also run
  47. `1GoHelp`0 with no arguments, in which case you will be
  48. presented with a menu to select the program you want help on.
  49.  
  50. ■
  51.  
  52. [GoEdOver]
  53. GoEd is a file editor that has several unique features that
  54. make it different from other editors.  GoEd was designed to
  55. be small in size but not in features, load files as quick as
  56. possible, be able to define the number of rows and columns to
  57. display, allow text to be assigned different colors, and to
  58. be integrated in with GoHome to behave as a "pop-up" notepad.
  59.  
  60. GoEd functions like most text editors: it performs basic file
  61. editing, search-and-replace, and goto line operations.  It
  62. also provides several advanced features such as cut, copy,
  63. and paste blocks of text, set tabs, set maximum line length,
  64. set read-only mode, display control characters, and allows
  65. text to be assigned to macro keys.  In addition, GoEd also
  66. provides for characters to be displayed in different colors
  67. and the width and height of the editor to be set.
  68.  
  69. ■
  70.  
  71. [CmdLine]
  72. `1GoEd`0 provides a way to customize its behavior by using
  73. command line arguments. As with all GoHome programs, command
  74. line arguments may be placed in a config file. The default
  75. config file for `1GoEd`0 is `2GOED.CFG`0. If a different
  76. config file is used, it may be specified when starting
  77. `1GoEd`0 with the argument "@configfile" where configfile
  78. is replaced with the file name of the config file to use.
  79.  
  80. The syntax for starting `1GoEd`0 is
  81.  
  82.      GoEdit [parameters] filename                                   
  83.                                                                         
  84. Parameters                                                              
  85.   /POS=row,col,width,height - position and size of edit window
  86.   /FULL=[Y|N]     full screen edit window
  87.   /SAVSCRN=[Y|N]  Save foreground screen (default is 'Y'). Use
  88.                   `1/SAVSCRN=N`0 to increase editor capacity by
  89.                   4,212 bytes.
  90.   /IGGMDS=[Y|N]   Ignore any config commands in file
  91.   /READ=[Y|N]     readonly
  92.   /TAB=x          x is tab tab size (default 4) 
  93.   /USECOLORS=[Y|N]  Use back quote as color attribute 
  94.                   indicator
  95.   /TEXT=x         x is text color attribute (ie. x=1B for 
  96.                   cyan on blue)
  97.   /STATUS=x       x is status line color (ie. x=5C for red on 
  98.                   magenta) 
  99.   /LEN=x          x is the maximum number of characters 
  100.                   in a line      
  101.   /FIND=x         x is a string to search and goto in the 
  102.                   text file
  103.   /GOTO=x         x is the line number to go to                        
  104.   /CSET=[m|b|1,2,3,4]  Select color set 
  105.                   (m->mono,b->B&W,other color)
  106.   /PAL=x          use color palette x where is 1 or 
  107.                   2 (VGA only).
  108.   @configfile     Use command parameters in 'configfile'
  109. ■
  110.  
  111.  
  112. [FileCmds]
  113. `1GoEd`0 may be configured differently depending on the
  114. file. When `1GoEd`0 is reading in a file, it checks to see
  115. if the first line starts with "GoEdCmds:". If it does, then
  116. `1GoEd`0 will uses the parameters that follow it as the 
  117. default edit parameters. For example, assume that the 
  118. following line appeared as the first line in a file.
  119.  
  120. GoEdCmds: /POS=2,27,23,20  /READ /GOTO=2
  121.  
  122. The /POS=2,27,23,20 command would move the edit window to the
  123. 2nd row and the 27th column of the screen.  It also would set
  124. the width of the editor to 23 characters and the height to 20
  125. rows.  Screen coordinates start with one and go to the
  126. maximum allowed by the screen (usually 25 rows and 80
  127. columns).
  128.  
  129. The /READ command puts GoEd into read-only mode (i.e.  the
  130. file cannot be edited).  To turn off read-only mode, press
  131. "<Alt><O>" to pop-up the Options dialog.  Then press
  132. "<Alt><R>" to move to the "Read only" field and remove the
  133. check mark by pressing the space bar.  The file can now be
  134. edited.
  135.  
  136. Finally, the /GOTO=2 command tells GoEd to move to the second
  137. line of the file.  This will hide the commands in the first
  138. line of the file.
  139.  
  140. GoEd also has a command line parameter, "/IGCMDS", that
  141. tells it to ignore any commands in the first line of the file.
  142.  
  143. ■
  144.  
  145.  
  146. [CursKeys]
  147. The following keys are used to move the cursor around in
  148. `1GoEd`0.
  149.  
  150.        Key        Action
  151.     ----------------------------------------------
  152.        ─         Moves left one character
  153.        ─         Moves right one character
  154.                  Moves up one line
  155.                  Moves down one line
  156.       Ctrl ─     Moves to next word at right
  157.       Ctrl ─     Moves to next word at left
  158.       Home        Moves to start of line
  159.       End         Moves to end of line
  160.       Ctrl+Home   Moves to top of window
  161.       Ctrl+End    Moves to bottom of windows
  162.       PgUp        Scrolls up one screenful
  163.       PgDn        Scrolls up one screenful
  164.       Ctrl+PgUp   Moves to beginning of file
  165.       Ctrl+PgDn   Moves to end of file
  166.       Ctrl+W      Scrolls up one line
  167.       Ctrl+Z      Scrolls down one line
  168. ■
  169.  
  170. [DelKeys]
  171.        Key        Action
  172.     ---------------------------------------------------
  173.        Del        Delete character cursor is on 
  174.        BkSpace    Delete char to left of cursor
  175.        Ctl-T      Delete the word to right of cursor
  176.        Ctl-D      Delete line cursor is on
  177.        Ctl-Q      Delete to end of line                               
  178.  
  179. ■
  180.  
  181. [FnKeys]
  182.        Key       Action
  183.     ---------------------------------------------------
  184.        F1        Show Help screen
  185.        F2        Save the text to file
  186.        F3        Exit the editor
  187.        F4        Search for a piece of text (Find)
  188.        F5        Repeat last search (Find Next)
  189.        F6        Start marking a block        
  190.        F7        Cut marked block           
  191.        F8        Paste a block of text previous copied or cut
  192.        F9        Display information about the file
  193.        F10       Edit another file          
  194.  
  195. ■
  196.  
  197. [MarkKeys] 
  198. To mark a block, move the cursor to the first line to be 
  199. selected. Use the arrow keys to move the cursor to the last
  200. line you want selected.  To cancel the selection, press <Esc>.
  201.  
  202.        Key        Action
  203.     --------------------------------------------------------
  204.        Ctl+M      Start marking a block 
  205.        arrow keys Extend marked block      
  206.        Ctl+C      Copy marked block to clipboard
  207.        Ctl+V      Paste block from clipboard
  208.        Ctl+X      Cut marked block to clipboard
  209.  
  210. ■
  211.  
  212. [SearchKeys]
  213.        Key       Action
  214.     ---------------------------------------------------
  215.        Ctl+S    Search for text (Find)
  216.        Ctl+L    Repeat last search (Find Next)
  217.        Ctl+R    Find & replace text
  218.        Ctl+G    Goto a line number  
  219. ■
  220.  
  221. [MiscKeys]
  222.        Key       Action
  223.     ---------------------------------------------------
  224.        Ctl+I    Display information about the file
  225.        Ctl+O    Show Options dialog 
  226.        Alt+H    Bring up the help system
  227.        Alt+Z    Show color codes
  228.  
  229. ■
  230.  
  231. [MacroKeys]
  232. GoEd allows you to define up to 10 `1Macro`0 keys. A `1Macro`0
  233. key will insert a predefined text segment into the current 
  234. cursor location. 
  235.  
  236. `1Macro`0 keys are assigned to the <Alt> number keys (<Alt><1>,
  237. <Alt><2>, ..., <Alt><0>). They may be defined on the command 
  238. line but are generally placed in the config file for `1GoEd`0
  239. (i.e. GOED.CFG). `1GoEd`0 has 10 command line arguments for
  240. each allowable macro key: /alt1, /alt2, ..., /alt0. The macro
  241. strings must be enclosed in quotes. For example, if we want
  242. to assign the string "Added Dimension Software, Inc." to
  243. <Alt><1>, we would add the following line to GOED.CFG:
  244.  
  245.   /ALT1="Added Dimension Software, Inc."
  246.  
  247. Now, whenever the <Alt><1> keys are pressed, the above string
  248. will be inserted into the text file. 
  249.  
  250. Macros may extend multiple lines. For example, we could assign
  251. an address block to the <Alt><2> keys using the following line:
  252.  
  253.   /ALT2="John Doe
  254.    1234 Anytown Ave.
  255.    Burbsville, USA  54321
  256. "
  257.  
  258. Note that the entire string is enclosed within quotes.
  259.  
  260. ■
  261.  
  262. [File]
  263.        Key       Action
  264.     ---------------------------------------------------
  265.       Alt-S      Save text to file
  266.       Alt-A      Save the text to another file name
  267.       Alt-E      Edit another file
  268.  
  269. ■
  270.  
  271. [Colors]
  272. `1GoEd`0 has a unique feature that allows text files to
  273. display characters in different colors. These is handy to
  274. highlight certain words in a file. For example, you may want
  275. to have a file that lists the keys used by Word Perfect. You
  276. could have the key sequence displayed in blue and the
  277. description displayed in yellow.
  278.  
  279. GoEd uses the forward quote (``) to tell it to use the color
  280. that corresponds with the number following it.  Note that
  281. there are two single quotes on the keyboard, the forward
  282. quote is the one that is typically just to the left of the
  283. number 1 key and when the <Shift> key is pressed will display
  284. a tilde (~) character.
  285.  
  286. To see a list of colors that are assigned to numbers, display
  287. the "Show Colors" dialog (press <Alt><Z>). 
  288.  
  289. To have `1GoEd`0 interpret color codes, either start it with
  290. the `2/USECOLORS`0 option or turn on colors by checking the
  291. "Use color codes" check box in the `2Options`0 dialog.
  292.  
  293. For example, say we want to have a file that lists the
  294. function keys used by `1GoEd`0. We want to use the color
  295. assigned to number 5 to display the function keys and 
  296. the color assigned to number 8 to display the description.
  297. The file might look like this
  298.  
  299. GoEdCmds: /POS=2,12,48,14  /READ /GOTO=2 /USECOLORS
  300.   Key       Action
  301. ---------------------------------------------------
  302.   ``5F1``3        ``7Show Help screen``3
  303.   ``5F2``3        ``7Save the text to file``3
  304.   ``5F3``3        ``7Exit the editor``3
  305.   ``5F4``3        ``7Search for a piece of text (Find)``3
  306.   ``5F5``3        ``7Repeat last search (Find Next)``3
  307.   ``5F6``3        ``7Start marking a block``3
  308.   ``5F7``3        ``7Cut marked block``3
  309.   ``5F8``3        ``7Paste a block of text``3
  310.   ``5F9``3        ``7Display information about the file``3
  311.   ``5F10``3       ``7Edit another file``3
  312.  
  313. Note that the first line contains parameters to size the
  314. editor, put it in read-only mode, goto to the second line,
  315. and turn on the ability to use colors.
  316. ■
  317.  
  318. [MenuBar]
  319. If GoEd is in full screen mode, a menu bar will be used.
  320. If this is the case, some of the <Alt> key combinations 
  321. will pull-down a menu instead of performing an action.
  322. For example, in full screen mode the <Alt><O> keys will
  323. pull-down the "Options" menu; if not in full screen mode,
  324. then <Alt><O> will display the "Options" dialog.
  325. ■
  326.  
  327.  
  328.  
  329. @@EndHelp
  330. 
  331.