home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Guide / c-cplusplus-interactive-guide.iso / c_ref / csource3 / 178_01 / tvx_refa.doc < prev    next >
Text File  |  1986-01-28  |  50KB  |  1,124 lines
  1.  
  2.  
  3.                                                                  
  4.  
  5.  
  6.                          TVX Reference Manual
  7.  
  8.  
  9.  
  10.      This is  the  Reference  Manual  for  TVX, a public domain screen
  11. editor written in C by Dr. Bruce E. Wampler.   (Current  address:  Dr.
  12. Bruce  E.  Wampler,  University  of New Mexico, Department of Computer
  13. Science, Farris  Engineering  Center,  Albuquerque,  NM  87131).   Any
  14. comments,  bug reports, or suggestions should be sent to that address.
  15. This manual contains the formal descriptions for each editor  command.
  16. An  appendix  gives  some notes for installing TVX on various systems.
  17. The name TVX is derived from "TV" editor for any terminal ("X"). 
  18.  
  19.  
  20.  
  21. *** GETTING STARTED ***
  22.  
  23.      To edit a file using TVX, enter the following command line:
  24.  
  25.           tvx filename -switch1 -switch2 ...
  26.  
  27.      The file name specified is the file to be edited, and  must  obey
  28. the conventions used by the local operating system (the MS-DOS version
  29. requires  DOS  version 2.0, and supports pathnames).  If the file is a
  30. new file (does not exist), TVX will ask if you really want  to  create
  31. it.   Answer  y  or n. If you gave an incorrect name, you may give the
  32. correct name, but the switches entered on the original start line will
  33. remain in effect.  Control-C can be used at this point to abort. 
  34.  
  35.      TVX has  several  switches  which   control   certain   operating
  36. characteristics.   Each  switch  begins  with  a  minus  (-),  and  is
  37. separated from the file name and other switches  by  a  blank  in  the
  38. standard  UNIX/C  convention.  Some switches may be negated by using a
  39. 'nox' form.  Thus, '-b' will cause a .bak file to be generated,  while
  40. a  '-nob'  causes the .bak file to be deleted on exit from the editor.
  41. This capability is indicated by []'s.  As many switches  as  necessary
  42. or  desired  can  be used at one time in any order.  A ':' may be used
  43. instead of a '=' for '-c' and '-o'.  The  various  switches  supported
  44. include:
  45.  
  46.      -c=filename --   read  a  configuration  file.   If  only  -c  is
  47.           specified, TVX will look for A:CONFIG.TVX on  CP/M  and  for
  48.           /bin/CONFIG.TVX  on  MS-DOS.  The -c switch is not supported
  49.           on all implementations. 
  50.      -[no]b -- generate a .BAK version  of  the  original  (the  usual
  51.           default).   The -nob option means no .BAK file is generated.
  52.           This mode of operation follows the normal Unix convention of
  53.           not keeping past generations of a file. 
  54.      -[no]i -- auto indent mode enabled. 
  55.      -[no]l -- generate BACKUP.LOG file
  56.      -o=filename -- send edited output to filename.  The  output  file
  57.           can  also  be changed at any time during the editing session
  58.           with the ':o' command. 
  59.      -r -- read only - file can be read in only
  60.      -s -- big save buffer - leaves more buffer for save file
  61.      -t -- tty mode - puts TVX into tty mode, not  using  the  screen.
  62.  
  63.  
  64.                                  -1-                                  
  65.  
  66.  
  67.  
  68.  
  69. TVX Reference Manual                                          11/27/85
  70.  
  71.  
  72.           See the special appendix on tty mode. 
  73.      -w -- word processing mode - sets autowrap on, margin to 65. 
  74.      -z --  -z  means  use  Control-Z  to mark end of file, -noz means
  75.           don't  use.   This   switch   is   used   only   on   MS-DOS
  76.           implementations. 
  77.      -# --  entering  a number from 3 up to the number of lines on the
  78.           screen will create a smaller TVX editing  window.   This  is
  79.           most useful for slower baud rates.  A -7 makes a nice, small
  80.           window showing 7 lines. 
  81.  
  82.      TVX is  mostly  a  programmer's  editor,  and  can  can  edit any
  83. standard text line file.  On Unix systems, it  is  an  alternative  to
  84. standard editors such as ed or vi.  On MS-DOS, TVX can also be used to
  85. edit  standard BASIC programs.  BASIC programs must be saved using the
  86. ",A" switch from Microsoft BASIC.  When editing BASIC files, care must
  87. be taken to preserve the BASIC statement line numbers.  On  CP/M,  TVX
  88. can  be  used  as  a totally compatible alternative to ED.  Because of
  89. memory limitations, the CP/M version contains a subset of the commands
  90. available on the regular version. 
  91.  
  92.  
  93. *** General Comments ***
  94.  
  95.      TVX functions almost identically for all versions.  All  commands
  96. are  normally  the  same,  although  it  is  possible to create custom
  97. versions with a different command set.  Control codes on are  normally
  98. entered  by pressing the CTRL key and the letter key at the same time.
  99. On most  versions,  the  character  delete  key  is  BACKSPACE.   This
  100. character  delete  keys  is  the  one  normally used by the respective
  101. operating systems.  It is up to the local implementation to notify the
  102. user of any variance from these conventions. 
  103.  
  104.      Once the file has been read in, the screen will be  cleared,  and
  105. the  first  screenful of the file printed on the screen and the cursor
  106. positioned over the first character of the file.  If  a  new  file  is
  107. being  created,  the message "buffer empty" will be displayed, and the
  108. cursor positioned in the upper left corner.   TVX  is  then  ready  to
  109. accept  commands  from  the keyboard.  TVX works on the principle that
  110. what you see is what you get.  Most commands  also  take  an  optional
  111. numeric  count.  The default count is always one.  Commands that allow
  112. a count value  are  preceded  by  the  letter  'n'  in  the  following
  113. descriptions.  Whenever a command produces output or an error message,
  114. it appears on the bottom line of the screen. 
  115.  
  116.      The BACKSPACE  key  (Control-H on some terminals) is used to edit
  117. input text.  When TVX is accepting commands, BACKSPACE will cause  the
  118. character immediately before the cursor to be deleted. 
  119.  
  120.      The text  from the file which is being edited is held in a buffer
  121. in main memory.  If a file is particularly large, it may not  entirely
  122. fit  into  main  memory.  The CP/M version of TVX allows slightly over
  123. 20,000 characters in the buffer (950 lines).  The MS-DOS versions will
  124. allow up to almost 64K characters depending on the  memory  available.
  125. Unix  versions will usually allow 120,000 characters and 5000 lines in
  126. one buffer.  If the entire file will not fit into the buffer at  once,
  127. then  only  part of it is read in at a time.  The buffer size limit in
  128.  
  129.  
  130.                                  -2-                                  
  131.  
  132.  
  133.  
  134.  
  135. TVX Reference Manual                                          11/27/85
  136.  
  137.  
  138. no way restricts the total size of a file that can be edited  by  TVX.
  139. To  make editing large files easier, some commands apply to the entire
  140. file and cause automatic cross buffer manipulation. 
  141.  
  142.      Because of the internal  organization  of  the  text  within  the
  143. buffer,  TVX  may  occasionally "compact" the tiny fragments of unused
  144. buffer space generated  as  a  part  of  normal  editing.   When  this
  145. happens,  a  message is displayed, and input keystrokes are remembered
  146. but not echoed until the compaction process is complete.  The  process
  147. may take several seconds. 
  148.  
  149.      While the  normal  screen  is  only 80 columns wide, TVX has been
  150. written to support a "virtual" screen width of 240  columns.   As  you
  151. move  the  cursor  right on a line that is longer than 80 columns, the
  152. screen will automatically scroll to  the  left  in  increments  of  16
  153. columns.   Note that on terminals that cannot disable auto wrap around
  154. for column 80, when you are making changes to a line  that  is  longer
  155. that 80 columns, the line will wrap around to the next display line so
  156. that the entire line is visible.  The wrap will disappear when you use
  157. the  'd'  or 'u' commands, or rewrite the screen with the 'v' command.
  158. Most versions will not wrap long lines. 
  159.  
  160.      A key to success when using TVX is to remember that there are two
  161. modes of operation.  The normal mode is command mode.  In  this  mode,
  162. all  keystrokes  are  interpreted as commands.  When you want to enter
  163. text, you must enter insert mode  with  the  'I'  command.   While