home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / comm / bbs / O_ED_10.lha / oed.doc < prev   
Text File  |  1995-11-24  |  4KB  |  106 lines
  1. Short: OnlineEditor (TextEditor via StdIO) for all BBS
  2. Author: marc_albrecht@act.ohz.north.de
  3. Uploader: root@act.ohz.north.de
  4. Type: comm/bbs
  5. Version: 1.0
  6. Long:
  7.  
  8. O-Ed is a comfortable Editor for use via StdIO, therefor usable in nearly
  9. every modern BBS. 
  10. It is easy to use - simply set your BBS Editor command to OED <filename>
  11. (have a look in your BBS's documentation how to pass along the filename)
  12. and optionally add a LEVEL keyword with the user's level (directory
  13. displays, file load and file include are only possible from level 9 up)
  14. and of course a LINES keyword giving the number of lines OED may use on
  15. the screen.
  16.  
  17. Usage: Oed <filename> <level> <lines>
  18.        filename - MUST be given
  19.        level - from 0 to 255 - 9 upwards means "sysop" status
  20.        lines - from 10 to xxx - meaning number of lines on screen
  21.  
  22. Note: the screen must at least have 79 columns, so when trying it out
  23. via shell increase the shell's width accordingly!
  24.  
  25. Functions:
  26. ----------
  27. O-Ed displays an (ANSI) helpmenu at the top of the screen, showing you
  28. the main functions:
  29.  
  30. CTRL-H for a help page
  31. CTRL-Q for Quit (O-Ed will ask if you really want to quit if you
  32.                  changed the file and did not save it)
  33. CTRL-R for redraw (if the screen somehow has been corrupted)
  34.  
  35. Further functions are:
  36.  
  37. CTRL-L for reLoading the file (if you should have made mistakes - the
  38.        best and easiest undo-function)
  39. CTRL-S for Saving the file (most important function in fact)
  40. CTRL-D from level 9 upwards: lets you display directories
  41. CTRL-O from level 9 upwards: loads a new file into the editor
  42. CTRL-I from level 9 upwards: includes a file starting with the
  43.        actual line.
  44.  
  45. CTRL-K erases the line the cursor is in.
  46. CTRL-E erases from cursor position to end of line.
  47.  
  48. From the directory displayer (CTRL-D, CTRL-O or CTRL-I) you have these
  49. functions available: (also shown in top menue)
  50.  
  51. SPACE  show next page of directory (if dir should be longer than available
  52.        lines on screen)
  53. CTRL-D change current directory
  54. CTRL-Q quit directory displayer
  55. L      (when loading or including a file): give filename to open
  56.        (blank line skips function)
  57.  
  58. Delete/Backspace: Since Backspace does not work correctly on _some_
  59. terminals - or BBSs for that - I decided to not support it. You can use
  60. DELete normally, typing BackSpace gives you the help screen (since it's
  61. CTRL-H :-) ). If you can convince me to support "normal" backspace as well
  62. give me a call...
  63.  
  64. Bugs
  65. ----
  66. My betatesters and I have tested this program and (yet) found no bugs
  67. therefor it is being released to the public. Bugreports (if so) are
  68. always welcome and will surely result in bugfixes.
  69.  
  70. When receiving a CTRL-C (BBSs should handle loss of carrier this way!) O-ED
  71. waits for _one_ more character from StdIO. Since usually the line will
  72. report "CARRIER LOST" or something like that the carrier detection of your
  73. BBS will be handled correctly and O-ED will instantly quit. The wait for
  74. one character is due to FGetC.
  75.  
  76. Registrations
  77. -------------
  78. You can use this editor for testing purpose but if you install it in
  79. your BBS or find it useful otherwise please _do_ send me the shareware
  80. fee. Since I don't like crippled or annoying requestering tools I did
  81. not install such "features" - but writing many tools for BBSs and other
  82. all-day-software I have never received much thank for my work. So my
  83. wife is getting angry for my sitting at the keys and not getting paid
  84. for it :-)
  85.  
  86. I am asking a fee of 10,-DM to 15,-DM depending whether you want further
  87. updates sent to you via E-Mail (supply me with an address!) or not.
  88.  
  89. If you consider transferring money for O-Ed to me:
  90.        Kto. 4005575200 at Volksbank Stade BLZ 24191015 Germany
  91. If you want to send me money (cheques payable in DM):
  92.        Marc Albrecht, Seth 2, 21769 Lamstedt, Germany
  93. If you want to give bugreports on electronic ways:
  94.        marc_albrecht@act.ohz.north.de
  95.        Marc Albrecht@2:241/205 (FidoNet)
  96.  
  97. Further versions
  98. ----------------
  99. ...depend on the people asking for such. And also depend on shareware
  100. paiments :-)
  101. Still such versions are planned. Give me hints what to implement!
  102.  
  103. Thanks
  104. ------
  105. Noone yet.
  106.