home *** CD-ROM | disk | FTP | other *** search
/ Complete Linux / Complete Linux.iso / docs / apps / editors / fpted.rea < prev    next >
Encoding:
Text File  |  1993-10-31  |  8.4 KB  |  214 lines
  1.  
  2.  
  3.                 FPTED R4.0
  4.  
  5.             By Fernando J. G. Pereira
  6.  
  7.  
  8.     FPTED is a, easy to use, text editor, that allows the user to do
  9.     almost all of the most used features in other text editors.
  10.  
  11.     It isn't as powerful as "vi", or "emacs", but I think, it's easy
  12.     to use, its runtime version is very small (in disk space), it
  13.     lets you do almost everything you usually do in other editors, and lots
  14.     of other things like using a mouse or performing word completion.
  15.  
  16.     Its main characteristics are:
  17.  
  18.     1 - Its user friendly (at least that's what I think...).
  19.     2 - It lets you edit several (up to 20) text files at the same time.
  20.     3 - You can cut & paste between files, and you can recover deleted text,
  21.         even after you exit and return to the editor.
  22.     4 - You can redefine keys (define macros).
  23.     5 - You can repeat sequences of key commands.
  24.     6 - It has "search and replace", with individual confirmations.
  25.     7 - It has abbreviation substitutions (performed with TAB).
  26.     8 - You can create definition files that could be read each time
  27.         the editor is called (using one environment variable).
  28.     9 - It has online help.
  29.     10- It has MOUSE SUPPORT, word wrap and word completion.
  30.     11- It has autoindent and parenthesis match (useful when writing
  31.         programs).
  32.     12 -It doesn't create tmp files, like other editors do, so if the
  33.         system goes down, you may loose all changes you've made since
  34.         the last time you save. To minimize this problem, the editor
  35.         catches a lot of signals (SIGDANGER,SIGPWR,SIGHUP,SIGTERM etc)
  36.         and saves a copy of each changed file.
  37.  
  38.  
  39.     Also, this editor was designed to be portable between different
  40.     architectures, so it's very easy to port a wide range of machines.
  41.  
  42.     To make it portable, the default key bindings use almost only alphabetic
  43.     keys, but, as you can redefine keys, this shouldn't be a big problem...
  44.  
  45.     This program was written in traditional C, using the curses library
  46.     and some portable UNIX features (like signals, etc.).
  47.  
  48.     To create a runtime version of this editor you must start by extracting
  49.     this articles from the newsgroup and execute the shell archives.
  50.  
  51.     sh <arch1>
  52.     sh <arch2>
  53.  
  54.     When this is finished, you can make a runtime version using make and
  55.     selecting the desired makefile (or changing one of the existing ones).
  56.  
  57.     Attention: This makefile will attempt to send a mail message to me,
  58.            so that I can make a list of users.
  59.            From times to times I intend to send to those people a
  60.            file containing all the patches needed to remove bugs
  61.            found meanwhile.
  62.  
  63.            The makefile will automatically erase the "mail" code
  64.            from itself in the first time you compile FPTED
  65.            successfully, after the message is sent.
  66.  
  67.     make
  68.  
  69.     or
  70.  
  71.     make -f Makefile
  72.  
  73.     If your system does not have the SIGNAL UNIX system call, then you
  74.     should remove the flag -DUNIX from the compiler line in the respective
  75.     makefile.
  76.     Also, if you are not using terminals with VT like key code sequences
  77.     (starting with "<ESC>["), then you should remove the flag -DVT_TERM.
  78.     If you are running a system V machine and your curses lib parses a lot
  79.     of function and other keys, then you wouldn't need the flag VT_TERM.
  80.  
  81.     There are several important compilation flags:
  82.  
  83.     1 - QUICK_SCROLL enables a multi-line scroll mode. This mode can be
  84.     useful when your terminal normal scroll is very slow.
  85.  
  86.     This option is the default in BSD systems. If you don't like jump scrolls
  87.     you should disable it, removing the compilation flag in BSD.make.
  88.  
  89.     2 - STATUS_LINE enables a status line with the name of the file
  90.     currently edited and the key used to access the menu. If you
  91.     disable it, the editor will perform faster when displaying
  92.     error messages.
  93.  
  94.     3 - MOUSE_SUPPORT lets you use the mouse keys to locate text in the editor
  95.     when using a xterm. You can still use the standard X clipboard using
  96.     the shift key.
  97.     This option works only if the option -DVT_TERM is enabled.
  98.  
  99.     4 - SMART_INDENT automatically erases all the spaces and tabs in the lines
  100.     left blanc when auto-indenting with <RETURN>.
  101.  
  102.     5 - POSIX_IO - Supports POSIX multilanguage input (only available if you
  103.     system has a include file called /usr/include/locale.h ).
  104.     This is not a default flag: If you want to use it, you should insert the
  105.     flag -DPOSIX_IO into the compilation line of the makefile.
  106.     To use this feature you should define all the necessary locale environment
  107.     variables.
  108.  
  109.     Although the editor supports 8 bit characters.
  110.  
  111.     6 - DISABLE_SHELL_ESCAPES - Will disable the user to access the shell.
  112.  
  113.     7 - AVOID_FRAGMENTATION - Avoid dynamic memory fragmentation. In this mode
  114.     fpted will only alloc memory blocks with sizes that are a multiple of a
  115.     certain value ( in fact: n * BLOCK_SIZE -1 ).
  116.     The default BLOCK_SIZE is 4 bytes, but you can set it to 8 or 16, changing
  117.     fpted.h before compiling.
  118.     With this option enabled memory allocation will perform faster, and memory
  119.     fragmentation can be avoided, beacuse freed blocks will soon be reused.
  120.     On the other side, there will be a statistically constant rate of unused
  121.     memory, since fpted will only alloc memory blocks with sizes multiple of
  122.     BLOCK_SIZE. In order to minimize this problem, BLOCK_SIZE was set to a
  123.     small value (4 bytes), but if your system's memory allocation is slow
  124.     you can set a bigger value.
  125.  
  126.     8 - USE_LAST_COLUMN: Some curses implementations get confused when a
  127.     program draws text in the last column of the screen/window. If your
  128.     curses doesn't have this particular bug, you can enable the flag
  129.     -DUSE_LAST_COLUMN to enable the use of the last column.
  130.  
  131.  
  132.  
  133.     If your system has more than one version of curses (as it is the case in
  134.     ULTRIX), you can change the name of the include files in fpted.c and change
  135.     the respective names in the makefile...
  136.  
  137.     If your curses library doesn't have some functions like keypad(),
  138.     scrollok() and idlok(), you should edit fpted.c and remove, or comment,
  139.     the lines where these functions appear [these lines are documented].
  140.  
  141.     After installing the runtime version, before you start using this
  142.     editor you should define the following environment variables:
  143.  
  144.     FPTED_HELP is the path to the help file:
  145.  
  146.     FPTED will search for a file named fpted_help in the directory where
  147.     it was compiled. If you want to use a different file or directory, you
  148.     should define the environment variable FPTED_HELP.
  149.  
  150.     If you are using a csh, do as follows:
  151.  
  152.         setenv FPTED_HELP `pwd`/fpted_help
  153.  
  154.     ( if you are in a different directory, instead of `pwd`, you should
  155.     specify a complete path )
  156.  
  157.  
  158.     FPTED_CLIPFILE is the file where the clipboard is saved when you exit the
  159.          editor. If you want to use a file named fpted_clip inside a
  160.          directory named tmp in your home directory do as follows:
  161.  
  162.     mkdir ~/tmp
  163.     setenv FPTED_CLIPFILE ~/tmp/fpted_clip
  164.  
  165.     FPTED_DEFS is the definitions file that is automatically readded each time
  166.          you run this editor:
  167.  
  168.     setenv FPTED_DEFS ~/.fpted_defs
  169.  
  170.     This file can be created with this editor (saving the definitions 
  171.     created interactively), or you can copy one of the sample files in
  172.     this directory:
  173.  
  174.     c_fpted_defs - Key and abbreviations useful for C programmers.
  175.     vt_fpted_defs - Key definitions for VT200 like terminals.
  176.             (Defines DO, HELP, INSERT, DELETE, PREV-SCREEN, ...).
  177.  
  178.     As one example, if you want to use a VT200, you should do as follows:
  179.  
  180.     cp vt_fpted_defs ~/.fpted_defs
  181.  
  182.     If you like this program you should also put all of the environment
  183.     definition in your .chsrc or .profile.
  184.  
  185.     If you don't like the use of ESCaped keys (timeout, etc.) you can
  186.     redefine other key (using ^K^V) to access the menu. Then you just
  187.     have to save the definition in a file using the "s" command in
  188.     command line mode.
  189.  
  190.         **********    IMPORTANT NOTE      **********
  191.  
  192.     I intend this program to be FREE software, that is: you can distribute it,
  193.     but you shouldn't use it for selling...  So, you are free to use this
  194.     application, and you can distribute any number of copies, as long as this
  195.     notice will appear in every copy.  Also, I DENY any responsibility for any
  196.     kind of possible problems caused by this application (That means, if
  197.     something unexpected goes wrong, you are at your own...).
  198.  
  199.                 *************
  200.  
  201.  
  202.     I hope you enjoy.
  203.  
  204.  
  205.  
  206.                     Fernando Pereira
  207.  
  208.                         18/Feb/92
  209.  
  210.                         Lisboa - Portugal
  211.  
  212.                       fjp@minerva.inesc.pt
  213.  
  214.