home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / editors / ae92 / ea.man next >
Text File  |  1993-08-08  |  4KB  |  131 lines
  1.  
  2. NAME
  3.     ae    Ant's Editor  May '92
  4.  
  5.  
  6. USAGE
  7.     ae <filename>    
  8.     ea <filename>
  9.  
  10. where <filename> is the text file to edit or create.
  11.  
  12.  
  13. DESCRIPTION
  14. << ae >> is a full screen, VI style text editor.  The source should be
  15. portable to any environment that provides a K&R C compiler and a
  16. CURSES library.  << ea >> is a full screen, EMACS style text editor.
  17.  
  18. Text files consists of lines of printable text or tab characters.  
  19. A line can be of arbitary length and is delimited by either a 
  20. newline or the end of file.  Carriage return is mapped to newline 
  21. on input and ignored on output.  Tab stops are every eight columns.
  22. Non-printable characters may have unpredictable results depending
  23. on the implementation of CURSES.
  24.  
  25.  
  26. COMMANDS
  27.  
  28. VI STYLE
  29. h j k l        left, down, up, right cursor movement
  30. H J K L        word left, page down, page up, word right
  31. [ ]        beginning and end of line
  32. t b        top and bottom of file
  33. i        enter insert mode, formfeed to quit
  34. x        delete character under the cursor
  35. X        delete character left of the cursor
  36. F        write buffer to file
  37. R        refresh the screen
  38. Q        quit
  39. Z        switch to EMACS style
  40. ?        toggle help on/off
  41.  
  42. EMACS STYLE
  43. cursor keys    left, down, up, right cursor movement
  44. ^W ^E        word left,  word right
  45. ^N ^P        page down, page up
  46. ^A ^D        beginning and end of line
  47. ^T ^B        top and bottom of file
  48. backspace    delete character left of the cursor
  49. delete        delete character under the cursor
  50. ^F        write buffer to file
  51. ^R        refresh the screen
  52. ^C        quit
  53. ^Z        switch to VI style
  54. F1        toggle help on/off
  55.  
  56.  
  57. EXIT STATUS
  58. 0    success
  59. 1    general error
  60. 2    usage error
  61. 3    CURSES screen initialization failed
  62.  
  63.  
  64. INSTALLATION 
  65. Requires K&R C and a CURSES library for the given target machine.
  66.  
  67. The file creation MODE should be set at compile time to 0600 for 
  68. Unix systems, or 0 for the Atari ST and PC. 
  69.  
  70. The BUF size should be set at compile time to 32767.  This value
  71. was used because the Sozobon C compiler for the Atari ST has 16 
  72. bit ints and a limit on the size of arrays & structures of 32k.  
  73. Also the WatCom C compiler for the PC also has 16 bits ints.  On 
  74. machines that have 32 bit ints (most unix boxes), a larger value 
  75. for BUF could be used.
  76.  
  77. It is recommend that compact memory model be used on PC class
  78. machines.  Small memory model may work too provided BUF is not
  79. too large.
  80.  
  81. The character constants '\b', '\f', '\n', '\r', '\t' are used 
  82. in order to provide more portable code, since the compiler should
  83. handle the translation of them into the native character set.
  84. Note that '\f' (formfeed) was used to exit insert mode because
  85. K&R C had no escape constant for the escape-key.
  86.  
  87. HUP should define the name of the fall-back write file.  TERMCAP 
  88. should define for sites that use TERMCAP instead of TERMINFO.
  89. POSIX should be defined for systems that have POSIX.1 termios
  90. support (which is based on System V termios).
  91.  
  92. Most EBCDIC machines use block mode terminals.  This is a problem
  93. that has not been addressed and/or tested for.
  94.  
  95.  
  96. BUGS
  97. This editor will display a file with long lines, but has trouble
  98. scrolling the screen with long lines.  Paging up and down should
  99. work correctly, however.
  100.  
  101. The cursor is not positioned correctly on the screen when the
  102. file contains multi-glyph characters are displayed, like control
  103. codes (^X).
  104.  
  105.  
  106. REFERENCES
  107. [Fin80]    Craig A. Finseth, "Theory and Practice of Text Editors or 
  108.     A Cookbook For An EMACS", TM-165, MIT Lab. for Computer 
  109.     Science
  110.  
  111. [KeP81]    Kernighan & Plauger, "Software Tools in Pascal", 
  112.     Addison-Wesley, 81, chapter 6
  113.  
  114. [Mil86]    Eugene W. Myers & Webb Miller, "Row-replacement Algorithums
  115.     for Screen Editors", TR 86-19, Dept. of Compter Science, 
  116.     U. of Arizona
  117.  
  118. [MyM86]    Eugene W. Myers & Webb Miller, "A simple row-replacement 
  119.     method", TR 86-28, Dept. of Compter Science, U. of Arizona
  120.  
  121. [Mil87]    Webb Miller, "A Software Tools Sampler", Prentice Hall, 87
  122.     ISBN 0-13-822305-X, chapter 5
  123.  
  124. [net90]    "Editor 101/102" articles from comp.editors
  125.  
  126.  
  127. FILES
  128. ea.man        AE May '92 manual Page
  129. eaea.c        AE May '92 source for dual style editor
  130.  
  131.