home *** CD-ROM | disk | FTP | other *** search
/ Computer Club Elmshorn Atari PD / CCE_PD.iso / mac / 1100 / CCE_1149.ZIP / CCE_1149.PD / FED / FED.DOC < prev    next >
Text File  |  1995-02-07  |  13KB  |  264 lines
  1. Press <ctrl> F to unfold a line, or <ctrl> C to exit from help
  2.  
  3. FED 1.0
  4.       ________   ________   ____
  5.      / ______/  / ______/  / __ \
  6.     / /        / /        / /  \ \
  7.        / /_____   / /_____   / /   / /
  8.       / ______/  / ______/  / /   / /
  9.      / /        / /        / /   / /
  10.     / /        / /_____   / /___/ /
  11.    /_/        /_______/  /_______/
  12.  
  13.    A folding text editor for the Atari ST
  14.  
  15.    By Shawn Hargreaves,
  16.    1 Salisbury Road,
  17.    Market Drayton,
  18.    Shropshire,
  19.    England,
  20.    TF9 1AJ
  21.    Email slh100@tower.york.ac.uk (until 1996)
  22.  
  23.    FED is a small, fast, and powerful text editor. It features:
  24.  
  25.    - reverse video text selection
  26.    - emacs style kill/yank
  27.    - automatic indentation
  28.    - block indent/unindent
  29.    - wordwrap
  30.    - can fold blocks of text out of sight, using code indentation
  31.    - brace match function
  32.    - incremental 'as you type' searching
  33.    - 'grep' function to search/replace through multiple files
  34.    - up to 20 files can be opened at once
  35.    - handles all 256 characters
  36.    - binary mode for hacking program and data files
  37.    - macros and key repeat
  38.    - shell function  to run external commands from within FED
  39.    - supports Mark Williams C -e error handling
  40.    - can use 50 line mode in high rez, and 80 columns in low rez
  41.    - configuration utility to alter the key bindings
  42.    - built in tetris game
  43.  
  44. Copyright:
  45.    FED is copyright Shawn Hargreaves, 1994. You can use it or abuse it in
  46.    any way you like, and are welcome to redistribute copies, subject to
  47.    the following conditions:
  48.  
  49.    - You must not distribute copies of FED for profit.
  50.  
  51.    - If you wish to distribute copies, you must include all of the files
  52.      README, FED.CFG, FED.TOS, FED.DOC, FED_CFG.TOS, and FED_CFG.DOC, and
  53.      you must not alter any of these files.
  54.  
  55.    - I am not under any circumstances to be held responsible for any 
  56.      damage, real or imagined, that this program may cause.
  57.  
  58.    Since this is a first release, there are probably a few bugs that I
  59.    have missed. If you find any, or have any suggestions for improvements,
  60.    please let me know. Although I am not asking for any payment, this took
  61.    a long time to write, and if you feel like showing your appreciation by
  62.    sending me a fiver I really wouldn't mind. If you are interested in
  63.    seeing the source code I would be happy to send you a copy.
  64.  
  65. Cursor movement:
  66.    ⇦,⇨,⇧,⇩:       move the cursor
  67.    <shift> ⇦,⇨:   go to the start or end of the line
  68.    <ctrl> ⇦,⇨:    move a word to the left or right
  69.    <shift> ⇧,⇩:   move up or down a screen at a time
  70.    <HOME>:        go to the start of the file
  71.    <shift> HOME:  go to the end of the file
  72.    <ctrl> G:      go to line
  73.    <ctrl> M:      go to the brace matching the one under the cursor
  74.    <ctrl> =:      display cursor position
  75.    <ctrl> >:      go to next error (Mark Williams C)
  76.    <ctrl> <:      go to previous error (Mark Williams C)
  77.  
  78.    The show cursor position function displays a line of the form
  79.    * aw <filename> - line <l> - col <c> - byte <b> - 0x<h> (<d>)
  80.    The asterisk, if present, indicates that the file has been altered
  81.    since the last save. The 'a' and 'w' indicate respectively that the
  82.    file is in auto-indent mode or wordwrap mode. <l> and <c> are the
  83.    current cursor line and column, <b> is the offset in bytes from the
  84.    start of the file, <h> is the hex value of the character under the
  85.    cursor, and <d> is the decimal value.
  86.  
  87.    FED supports Mark Williams C compilation error handling via the -e
  88.    command line option. The error file should contain lines of the format
  89.    '<line>: <error message>' or '<line>: <file>: <error message>'.
  90.    FED will automatically position the cursor on the correct line of the
  91.    correct file, displaying the error message preceded by [a/b], where 'a'
  92.    is the current error number and 'b' is the total number of errors. Use
  93.    <ctrl> < and <ctrl> > to move through the list of errors. To abort the
  94.    compilation, exit from FED via <ctrl> Q or <ctrl> C instead of <ctrl> Z.
  95.  
  96. Folding & marking:
  97.    <ctrl> B:      mark a block of text (press ESC to finish)
  98.    <ctrl> F:      fold/unfold
  99.    <ctrl> E:      expand all folds
  100.  
  101.    To mark a block of text, press <ctrl> B. You can then move the cursor
  102.    to the other end of the block, using the normal movement keys
  103.    (including searching). When a block has been marked, many FED functions
  104.    will act on the marked text rather than the whole file. Any of the kill
  105.    functions will kill the entire block. Fold will fold the selected text,
  106.    rather than using indentation, and print will only print the marked
  107.    block. Pressing TAB will indent the block, and pressing BACKSPACE while
  108.    in the leading spaces will unindent the block. To cancel a selection,
  109.    press <ctrl> B again, or ESC.
  110.  
  111.    Folding is a feature which allows a section of text to be 'folded' away
  112.    out of sight, and replaced on the display by a single line which is
  113.    displayed in reverse video. Pressing <ctrl> F will make a fold from the
  114.    current line (or remove a fold if the line is already folded). The size
  115.    of the fold is determined by the indentation of the text, or can be
  116.    specified by marking a block (see above). FED should correctly fold
  117.    most C or Pascal code, although occasional problems may be caused by
  118.    erratic indentation. It can be configured to automatically fold a file
  119.    as it is loaded, and all of the folds in a file can be removed by
  120.    pressing <ctrl> E. All of the editing functions continue to work with a
  121.    folded file: in particular killing a fold line will kill all of the
  122.    text within the fold.
  123.  
  124. Editing:
  125.    <TAB>:         indent line (or marked block)
  126.    <ctrl> I:      insert character by ASCII code
  127.    <ctrl> T:      transpose (swap) two characters
  128.    <ctrl> L:      convert word to lower case
  129.    <ctrl> U:      convert word to upper case
  130.    <ctrl> A:      toggle automatic indentation on/off
  131.    <INSERT>:      toggle insert/overwrite mode
  132.    <ctrl> /:      set word wrap column (0 for off)
  133.    <ctrl> R:      reformat line (wordwrap must be turned on)
  134.  
  135. Deleting:
  136.    <BACKSPACE>:   backspace (or unindent marked block)
  137.    <DEL>:         delete next character
  138.    <ctrl> D:      delete next character
  139.    <ctrl> DEL>    kill next word (or marked block)
  140.    <ctrl> K:      kill to end of line (or marked block)
  141.    <ctrl> X:      kill line (or marked block)
  142.    <ctrl> Y:      yank text back from kill buffer
  143.    <UNDO>:        yank text back from kill buffer
  144.  
  145. Searching:
  146.    <ctrl> S:      search/replace
  147.    <ctrl> *:      search multiple files (grep)
  148.    <ctrl> @:      toggle search case sensitivity on/off
  149.  
  150.    FED supports incremental searching, which means that it attempts to
  151.    find a string matching the search pattern as you type it in. You can
  152.    backspace if you make a mistake, and can use the left and right (or up
  153.    and down) arrow keys to skip to the next or previous occurrences of the
  154.    string. To use the search pattern from the previous search, press ENTER
  155.    (or the right/down arrow key) before typing anything. To search for the
  156.    word beneath the cursor, press <ctrl> S a second time. To exit from a
  157.    search, press ESC or ENTER.
  158.  
  159.    To do a search/replace, after you have entered the search string press
  160.    <ctrl> R. FED will prompt for the replace string, and then work through
  161.    the file prompting before each replacement is made. Press 'y', SPACE or
  162.    ENTER to make the replacement, or <ctrl> SPACE or <ctrl> ENTER to
  163.    replace all occurrences. To skip past a match, press 'n' or use the
  164.    arrow keys.
  165.  
  166.    The search files (grep) function is exactly like a normal search/replace
  167.    except that FED will prompt you to enter a file specification, and when
  168.    the end of the first file is reached it will automatically load and
  169.    search the next file which matches the specification.
  170.  
  171. Files:
  172.    <ctrl> O:      open file
  173.    <ctrl> V:      view a list of all open files
  174.    <ctrl> N:      switch to the next open file
  175.    <ctrl> SPACE:  switch to the next open file
  176.    <ctrl> P:      print file (or marked block)
  177.    <ctrl> W:      write file to the disk
  178.    <ctrl> Z:      save everything and exit
  179.    <ctrl> C:      close file
  180.    <ctrl> Q:      quit
  181.  
  182.    The open file function prompts for a file name. It accepts wildcards,
  183.    and if the file is already loaded it will just switch to it, instead of
  184.    loading it from the disk. To force a file to load in binary mode, press
  185.    <ctrl> ENTER after typing the filename, instead of just ENTER.
  186.  
  187.    FED allows the editing of non-ASCII files via binary mode. In this
  188.    mode TAB, CR and LF are not treated specially when the file is loaded:
  189.    instead an EOL is assummed every 64 bytes. The file can be edited as
  190.    usual, but the layout of lines on the screen is purely visual, since a
  191.    CR/LF is not added to each line when it is saved or printed. The hex
  192.    value of the character under the cursor is displayed at the bottom of
  193.    the screen.
  194.  
  195.    To display graphics characters, FED uses the BIOS function 3 (Bconout)
  196.    with a parameter of 5. Unfortunately MiNT 0.95 (the only version I have
  197.    tested) appears to ignore the 5, treating this call in the same way as
  198.    a Bconout(2). This means that binary files and files which contain
  199.    graphics characters (such as the character set listing below) will not
  200.    be displayed correctly. This problem does not occur if FED is run under
  201.    TOSWIN, only when run from the desktop or a shell. Anyone know a
  202.    solution to this?
  203.  
  204. Miscellaneous:
  205.    <ctrl> (:      start recording a macro
  206.    <ctrl> ):      stop recording the macro
  207.    <ctrl> ENTER:  play the macro
  208.    <ctrl> #:      repeat the last keystroke
  209.    <ctrl> !:      pass command to shell
  210.    <ctrl> %:      change screen mode (width 40/80, height 25/50)
  211.    <ctrl> J:      play tetris
  212.    HELP:          display help
  213.    <ctrl> H:      display help
  214.    <ctrl> ?:      display help
  215.  
  216.    To pass a command to a shell, FED first attempts to use the shell_p
  217.    pointer (which is supported by several shells, including gulam) to pass
  218.    the command to the current instance of the shell. If this is not set,
  219.    it will run the shell named in the SHELL environment variable, and if
  220.    SHELL is not set it will attempt to run the command directly. It will
  221.    search PATH for program files, but running a GEM application may cause
  222.    problems.
  223.  
  224.    FED has a built in tetris game, which is accessed by pressing <ctrl> J.
  225.    Use the ⇦ and ⇨ keys to move the shape, ⇧ to rotate it, and <SPACE> to
  226.    drop it into place to complete a row. Have fun!
  227.  
  228.    Most operations can be cancelled by pressing ESC, <ctrl> C or <ctrl> G.
  229.    Numbers can be entered in decimal, hex or octal, using the C convention
  230.    of 0x for a hex number and a leading 0 for octal.
  231.  
  232. Command line options:
  233.    <filename>     - load <filename>
  234.    -e <filename>  - this file is the Mark Williams C error buffer
  235.    -b <filename>  - load this file in binary mode
  236.    -f <filename>  - fold this file on load
  237.    -w             - use wide 80 character mode (low rez only)
  238.    -h             - use high 50 line mode (high rez only)
  239.    -s             - standard mode (ignore -w, -h, and config settings)
  240.  
  241.    For details of how to install and configure FED, see FED_CFG.DOC
  242.  
  243. Character set:
  245.     0  1  2  3  4  5  6  7  8  9  A  B  C  D  E  F 
  246.      |¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|
  247.    0 |    ⓪     0  @  P  `  p  Ç  É  á  ã  ij  ס  α  ≡  |
  248.    1 |  ⇧  ①  !  1  A  Q  a  q  ü  æ  í  õ  IJ  ע  β  ±  |
  249.    2 |  ⇩  ②  "  2  B  R  b  r  é  Æ  ó  Ø  א  פ  Γ  ≥  |
  250.    3 |  ⇨  ③  #  3  C  S  c  s  â  ô  ú  ø  ב  צ  π  ≤  |
  251.    4 |  ⇦  ④  $  4  D  T  d  t  ä  ö  ñ  œ  ג  ק  Σ  ⌠  |
  252.    5 |  ❎  ⑤  %  5  E  U  e  u  à  ò  Ñ  Œ  ד  ר  σ  ⌡  |
  253.    6 |  ╱  ⑥  &  6  F  V  f  v  å  û  ª  À  ה  ש  µ  ÷  |
  254.    7 |  ◆  ⑦  '  7  G  W  g  w  ç  ù  º  Ã  ו  ת  τ  ≈  |
  255.    8 |  ✓  ⑧  (  8  H  X  h  x  ê  ÿ  ¿  Õ  ז  ן  Φ  °  |
  256.    9 |     ⑨  )  9  I  Y  i  y  ë  Ö  ⌐  ¨  ח  ך  Θ  ∙  |
  257.    A |     ə  *  :  J  Z  j  z  è  Ü  ¬  ´  ט  ם  Ω  ·  |
  258.    B |  ♪    +  ;  K  [  k  {  ï  ¢  ½  †  י  ף  δ  √  |
  259.    C |       ,  <  L  \  l  |  î  £  ¼  ¶  כ  ץ  ∮  ⁿ  |
  260.    D |       -  =  M  ]  m  }  ì  ¥  ¡  ©  ל  §  ϕ  ²  |
  261.    E |      .  >  N  ^  n  ~  Ä  ß  «  ®  מ  ∧  ∈  ³  |
  262.    F |      /  ?  O  _  o    Å  ƒ  »  ™  נ  ∞  ∩  ¯  |
  263.      |__________________________________________________|
  264.