home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / util / dos / 007 / wced.doc < prev    next >
Text File  |  1993-04-25  |  8KB  |  278 lines
  1. Wced 1.7f Command Line Editor
  2.  
  3. Copyright (C) 1990, 1991, 1992, 1993 Stuart Russell (WormSoft)
  4.  
  5. Wced is a command line editor. Features include a history of
  6. commands typed, aliasing of commands (with parameters), filename
  7. completion and command line editing. The main aim of Wced is to
  8. improve the command line editing of DOS but use as little memory as 
  9. possible. When installed, wced uses approximately 14k of 
  10. conventional memory.
  11.  
  12. Usage
  13.           wced [-acdlpqst] [filespec]
  14.  
  15. Options
  16.      a -  Filenames are listed in alphabetical order.
  17.  
  18.      c -  Makes the history list circular. Normally command completion
  19.           stops at either end of the history list. 
  20.  
  21.      d -  Directories in lists have a trailing '\'.
  22.  
  23.      l -  All filenames are listed in lowercase.
  24.  
  25.      p -  List files on PATH matching given filespec. Wced will
  26.           NOT become resident.
  27.  
  28.      q -  The bell is not sounded when the start or end of the 
  29.           history list is reached.
  30.  
  31.      s -  Filenames matching the following filespec are listed. 
  32.           The default filespec is *.*. Wced will NOT become 
  33.           resident.
  34.  
  35.      t -  Translate the wced command buffer to make it DOS compatible.
  36.           ie. '.\string.\string.\' -> 'string\string'
  37.               '\string\string\' -> '\string\string'
  38.               '\' -> '\'
  39.  
  40. 1. Reading Initial Commands and Aliases
  41.  
  42. If not invoked with the 's' or 'p' flag and a filename exists on
  43. the command line Wced will attempt to read initial commands and/or
  44. aliases from the file. The alias definition has the following 
  45. format:
  46.  
  47.         wced alias fullstring 
  48.  
  49. For example, 'wced d dir' aliases 'd' to 'dir'. Subsequently, if 
  50. 'd' is the first word on the command line then it is substituted 
  51. with 'dir'.
  52.  
  53. Any line not beginning with 'wced' is treated as a command and is 
  54. placed into the history list.
  55.  
  56. 2. Alias Parameters
  57.  
  58. The aliases can have parameters in their definitions. For 
  59. example,
  60.  
  61.         wced ld hotdir %1 /d/2
  62.  
  63. aliases 'ld' to 'hotdir %1 /d/2'. The %1 will be replaced with the 
  64. first argument given on the command line, ie.
  65.  
  66.         C:>ld list.*
  67. will result in DOS executing
  68.         hotdir list.* /d/2
  69.  
  70. Another example shows how all arguments can be used.
  71.  
  72.         wced del del %* /p
  73.  
  74. This aliases 'del' to 'del %* /p'. The %* will be replaced by all 
  75. arguments on the command line, ie.
  76.  
  77.         del tom dick harry
  78. will result in DOS executing
  79.         del tom dick harry /p
  80.  
  81. In DOS >= 4.0 this will prompt before deleting the file(s).
  82. The parameters can also be used in definitions entered from the 
  83. command line (as described below).
  84.  
  85. 3. The Editing and History functions
  86.  
  87. The default editing and history keys are :
  88.  
  89. Left Arrow     Move cursor left one place along command line
  90. Right Arrow    Move cursor right one place along command line
  91. Ctrl-Left      Move cursor left to end of word
  92. Ctrl-Right     Move cursor right to end of word
  93. Home           Move to beginning of command line
  94. End            Move to end of command line
  95. Up Arrow       Move backwards (older) through history
  96. Down Arrow     Move forwards (newer) through history
  97. Alt-d          Delete entire command line
  98. Del            Delete character under cursor on command line
  99. BS             Delete character before cursor on command line
  100. Alt-x          Quit and uninstall Wced
  101. Alt-r          Remove entry on command line from history
  102. Alt-v          Print version
  103. Alt-b          Delete to beginning of command line
  104. Alt-e          Delete to end of command line
  105. Ctrl-c         Store but do not execute command on command line
  106.  
  107. Wced only operates in insert mode - there is no overtype mode.
  108.  
  109. The history commands will attempt to complete the command on the 
  110. command line. An example is shown below.
  111. Assume the history contains
  112.      ls
  113.      cd backup
  114.      less nogood
  115.      larn
  116.      worm <--- Most recent
  117.  
  118. If the user now does
  119. C:>l_<UPARROW>
  120. then the command line will be completed as
  121. C:>larn_
  122. with the cursor on the end of the line.
  123. If the <UPARROW> is pressed again the command line becomes
  124. C:>less nogood_
  125. and again ...
  126. C:>ls_
  127. The cursor is always placed at the end of the line. The feedback 
  128. I have received suggests that people prefer this. If Wced can not 
  129. complete the command it will sound the bell unless the 'q' flag 
  130. has been specified.
  131.  
  132. 4. The Alias functions
  133.  
  134. The alias functions of wced are accessed using Alt-a. The action 
  135. taken depends on the contents of the command line. If the command 
  136. line is empty then a list of current aliases is printed. If the 
  137. command line contains only one word then this is assumed to be an 
  138. alias that is to be removed from the alias table. If the alias 
  139. can not be matched then an error message is printed. If the 
  140. command line contains more than one word then the alias is added 
  141. to the alias table replacing a previous alias if necessary. Some 
  142. examples follow.
  143.  
  144. Adding:
  145.      C:>l ls<ALT-a>
  146.      C:>pkv pkunzip -vb<ALT-a>
  147. This adds the aliases l and pkv to the alias table.
  148.  
  149. Listing:
  150.      C:><ALT-a>
  151.      l = ls
  152.      pkv = pkunzip -vb
  153. This prints the current aliases.
  154.  
  155. Deleting:
  156.      C:>l<ALT-a>
  157. This deletes an entry from the alias table.
  158.      C:><ALT-a>
  159.      pkv = pkunzip -vb
  160.  
  161. 5. Filename Completion/Show
  162.  
  163. The filename completion/show functions are assigned to :
  164.  
  165. Alt-c          Complete filename
  166. Alt-s          Show possible filename completions
  167. Tab            Attempt to complete filename/show possible 
  168.                completions
  169. Ctrl-Tab       Complete/Show matching files on PATH
  170.  
  171. Filenames will be completed as far as possible. When the 
  172. completion becomes ambiguous the possible matching files 
  173. will be displayed.
  174. For example consider the following files.
  175.      backup\   buffer.c  buffer.h  buffer.obj
  176.      list.c    list.h    list.obj
  177.      wced.exe  wced.doc  wced17.zip
  178.  
  179. Pressing <Tab> on an empty line will produce a listing of the 
  180. entire directory contents.
  181.      C:><Tab>
  182.      backup\   list.c    wced.doc
  183.      buffer.c  list.h    wced.exe
  184.      buffer.h  list.obj  wced17.zip
  185.      buffer.obj
  186.  
  187. The filename completion only completes the filename that the 
  188. cursor is at the end of. In the next example files beginning with 
  189. 'b' are searched for and the 'less ' is ignored.
  190. The filename can not be completed further so the possiblities are 
  191. listed.
  192.      C:>less b<Tab>
  193.      backup\   buffer.c  buffer.h  buffer.obj
  194.  
  195. The command line is unaltered and ready for more of the filename 
  196. to be given.
  197.      C:>less b_
  198.      C:>less bu<Tab>
  199. Now the 'u' has been given the filename can be completed further.
  200.      C:>less buffer._
  201. The filename again can not be completed further so the 
  202. possibilities are listed.
  203.      C:>less buffer.<Tab>
  204.      buffer.c  buffer.h  buffer.obj
  205.      C:>less buffer._
  206. The user adds the required extension in this case.
  207.      C:>less buffer.h
  208.  
  209. Acknowledgements
  210.  
  211. Any comments, problems or suggestions for additions should be 
  212. sent to
  213.         sjr@uk.ac.warwick.dcs
  214.  
  215. Many, many thanks to all those people who took the trouble to 
  216. comment and suggest improvements for Wced. Special thanks to Matthijs.
  217.  
  218.  
  219.  
  220.  
  221.  
  222. Wkeys (v2.0) key programmer for Wced.
  223.  
  224. The Wced program is accompanied by a program called Wkeys. This 
  225. allows the editor and history keys to be reprogrammed to suite 
  226. the user. Wkeys allows the use of the extended keys, ie F11, on 
  227. an extended keyboard. The keys are defined in a data file. An 
  228. example containing the default bindings is supplied.
  229.  
  230. Usage:
  231.         wkeys [ datafile [ exefile ] ]
  232.  
  233. If an error occurs the exe file will not be updated. Hopefully a 
  234. helpfull error message will be printed to highlight the problem 
  235. in the input.
  236. If no input files are supplied then 'wkeys.dat' and 'wced.exe'
  237. are assumed.
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277. 
  278.