home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / unix / filec.zoo / filec.doc next >
Encoding:
Text File  |  1990-12-14  |  9.3 KB  |  294 lines
  1.  
  2.  
  3.  
  4.  
  5.                   FILEC
  6.  
  7.                File Name Completion
  8.                --------------------
  9.  
  10.                   Richard Miller
  11.  
  12.  
  13.     FILEC  is Terminate and Stay Resident (TSR)  utility that reduces 
  14.     the number of keystrokes needed to enter long filenames. When the 
  15.     HOTKEY is pressed FILEC reads a partial filename as typed by  the 
  16.     user  and  attempts  to  complete the filename  by  seaching  the 
  17.     appropriate  directory.  The completed filename is then pasted by 
  18.     FILEC, as if the user had typed it. 
  19.  
  20.       e.g.   C:\ type au<HOT_KEY>
  21.          C:\ type autoexec.bat
  22.  
  23.     If  FILEC  can not find a unique completion it only pastes as 
  24.     much  as is common to the multiple completions.   The  user  then    
  25.     must  type  an  extra letter and try again.   For example if  the 
  26.     current directory contains both COMMAND.COM and  CONFIG.SYS  then 
  27.     following will occur. 
  28.     
  29.         C:\ dir c<HOT_KEY>
  30.         C:\ dir co
  31.  
  32.     The user must then add either the M or N depend on what she wants.
  33.  
  34.         C:\ dir com<HOT_KEY>
  35.         C:\ dir command.com
  36.  
  37.     If the partial filename doesn't match any existing filename  then 
  38.     FILEC will paste nothing at all and merely beep at you. 
  39.  
  40.         C:\ type phantom<HOT_KEY>
  41.         C:\ type phantom
  42.  
  43.     FILEC  also completes directory names in the same  manner.    For 
  44.     example  if  you have a disk with two levels  of  subdirectoryies 
  45.     then the following is possible. 
  46.  
  47.         C:\ dir A:\ba<HOT_KEY>
  48.         C:\ dir A:\basement
  49.  
  50.     Notice that FILEC recognizes the disk drive specified was A:  and 
  51.     searches  accordingly.    You can then add to what FILEC has just 
  52.     added. 
  53.  
  54.         C:\ dir A:\basement\ca<HOT_KEY>
  55.         C:\ dir A:\basement\carpark
  56.  
  57.     FILEC also understands parent and root directories.
  58.  
  59.         A:\CARPARK\ type ..\carpark\j<HOT_KEY>
  60.         A:\CARPARK\ type ..\carpark\jaguar.xjs
  61.  
  62.  
  63.     Installing FILEC
  64.     ----------------
  65.  
  66.     First  place  a  copy  of FILEC.EXE somewhere in  your  path  (or 
  67.     alternatively  you  can  specify a full  pathname  when  you  run 
  68.     FILEC).   Then to install FILEC run FILEC.EXE at the  DOS  prompt 
  69.     with the "install" option. 
  70.  
  71.          C:\ filec install
  72.      
  73.          FILE going resident ....
  74.  
  75.          C:\
  76.  
  77.     FILEC  will make itself resident and the DOS prompt will  return. 
  78.     If  FILEC is subsequently run again it will recognize that it  is 
  79.     already  installed  and will not go resident  again  however  the 
  80.     options are passed to the resident copy. 
  81.  
  82.          C:\ file nobeep
  83.  
  84.          FILEC: patched resident code
  85.  
  86.          C:\
  87.  
  88.     FILEC will now respond when ever the HOT_KEY is pressed.
  89.  
  90.     NOTE:  FILEC reads the partial filename directly from the  screen 
  91.     from  current cursor postion backwards until the first space, ">"
  92.     , "<" or "|".   This means that conmpletion  will not work if the
  93.     partial filename is butted against some other letters.
  94.           
  95.         C:PROMPTcomm<HOT_KEY>      {will not work} 
  96.         C:PROMPTcomm
  97.  
  98.         C:PROMPT comm<HOT_KEY>     {will work}
  99.         C:PROMPT command.com
  100.           
  101.     A  neat solution  to this  problem is to add a ">" to the end of 
  102.     your prompt string in your autoexec.bat
  103.           
  104.         "set prompt=$p$g>"
  105.                         
  106.  
  107.     Command Line Options
  108.     --------------------
  109.  
  110.     There  are  a  number of options that user can  specify  via  the 
  111.     command line.   All the options can be set at once when initially 
  112.     installing FILEC but only one option can be given when  modifying 
  113.     FILEC once it is resident. 
  114.  
  115.     If FILEC is run with no options it displays a brief usage message 
  116.     and termainates. 
  117.  
  118.     install
  119.     ------- 
  120.  
  121.     Specifies  that you want FILEC to go resident.  The option is 
  122.     implied if you specify any other option. 
  123.  
  124.     sleep (not default)
  125.     -----
  126.  
  127.     Specifies  that  you  want FILEC to  stay  resident  but  not 
  128.     active.   While FILEC is sleeping it will not respond to  the 
  129.     HOT_KEY. 
  130.  
  131.     awake (default)
  132.     -----
  133.  
  134.     This  option  jolts FILEC out of sleep mode  and  FILEC  will 
  135.     subsequently respond to the HOT_KEY. 
  136.  
  137.     beep (default)
  138.     ----
  139.  
  140.     Turns on sound effects.  FILEC uses three different beeps. The 
  141.     first  beep  indicates that multiple  completions  have  been 
  142.     found,  the second indicates no completions can be found, and 
  143.     the third indicates a unique completion has been found. 
  144.  
  145.     nobeep (not default)
  146.     ------
  147.  
  148.     Turns beeps off.
  149.  
  150.     freq f
  151.     ------
  152.  
  153.     Allows you to change the frequency (pitch) of the beeps.  The
  154.     actual sound is dependent on you machine's speed. The default
  155.     value for f is 100.
  156.  
  157.     window (not default)
  158.     ------
  159.  
  160.     Turns window mode on.   In window mode every time the HOT_KEY 
  161.     is  pressed a window pops to show what is about to be pasted.  
  162.     (See WINDOW MODE) 
  163.  
  164.     nowindow (default)
  165.     --------
  166.  
  167.     Turns window mode off.
  168.  
  169.     win y x
  170.     -------
  171.  
  172.     Specifies the x y coordinates of the top left hand corner  of 
  173.     the window. (default 15,3)  eg file win 10 10
  174.  
  175.     hotkey scan mask
  176.     ----------------
  177.  
  178.     Allows you to specify different hotkeys. Default (Ctrl-SPACE).
  179.  
  180.  
  181.  
  182.     WINDOW MODE
  183.     -----------
  184.  
  185.     When  FILEC  is  in WINDOW mode it pops a window every  time  the 
  186.     HOT_KEY  is  press.   The window shows the partial  filename  the 
  187.     completion found and the number of matches found. 
  188.  
  189.     You  then have the option aborting by pressing ESC or pasting  by 
  190.     pressing  any  other they.   The key pressed is  also  pasted  to 
  191.     minimize keystrokes.  If you press ENTER to paste the  completion 
  192.     the ENTER is not pasted. 
  193.  
  194.  
  195.     HOT_KEY
  196.     -------
  197.  
  198.     The HOT_KEY is specified by two numbers - a ScanCode and KeyMask.
  199.     The ScanCode specifies which key will cause FILEC to POP and  the
  200.     KeyMask specifies  what state the  CTRL/ALT/SHIFTS/LOCKS/INS must
  201.     in when the ScanCode key is struck.
  202.  
  203.     To determine the scan code of a particular key, look it up in the
  204.     following table.  To determine the KeyMask value add together all
  205.     the values for the things you want from the Keyboard Status Mask.
  206.  
  207.     The default HOT_KEY is Ctrl-SPACE and there for has
  208.  
  209.         Scancode = 57    (SPACE)
  210.         KeyMask  = 4     (Value For CTRL)
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.     Keyboard ScanCodes (XT Style)
  220.     -----------------------------
  221.  
  222.     .--.--.  .--.--.--.--.--.--.--.--.--.--.--.--.--.--.--.  .--.--.--.--.
  223.     |F1|F2|  | ~| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \|BS|  |ES|NL|SL|SR|
  224.     |59|60|  |41|2 |3 |4 |5 |6 |7 |8 |9 |10|11|12|13|43|14|  | 1|69|70|84|
  225.     .--.--.  .--.--.--.--.--.--.--.--.--.--.--.--.--.--.--.  .--.--.--.--.
  226.     |F3|F4|  |TAB|Q |W |E |R |T |Y |U |I |O |P |[ |] |    |  | 7| 8| 9|Ps|
  227.     |61|62|  |15 |16|17|18|19|20|21|22|23|24|25|26|27|    |  |71|72|73|55|
  228.     .--.--.  .---.--.--.--.--.--.--.--.--.--.--.--.--.    |  .--.--.--.--.
  229.     |F5|F6|  |CTRL|A |S |D |F |G |H |J |K |L |; |' |ENTER |  | 4| 5| 6| -|
  230.     |63|64|  | 29 |30|31|32|33|34|35|36|37|38|39|40| 28   |  |75|76|77|74|
  231.     .--.--.  .-----.--.--.--.--.--.--.--.--.--.--.--------.  .--.--.--.--.
  232.     |F7|F8|  |Shift|Z |X |C |V |B |N |M |, |. |/ |R/Shift |  | 1| 2| 3|  |
  233.     |65|64|  | 42  |44|45|46|47|48|49|50|51|52|53| 54     |  |79|80|81| +|
  234.     .--.--.  .---.-.--.--.--.--.--.--.--.--.--.--.----.---.  .--.--.--.78|
  235.     |F9|F0|  |ALT|  |          SPACE BAR          |   |CAP|  | INS |DL|  |
  236.     |67|68|  |56 |  |             57              |   |58 |  | 82  |83|  |
  237.     .--.--.  .---.  .-----------------------------.   .---.  .-----.--.--.
  238.  
  239.  
  240.  
  241.     Keyboard Status Mask
  242.     --------------------
  243.  
  244.       Bit           7      6      5      4      3      2      1      0
  245.       Value       128     64     32     16      8      4      2      1
  246.                 .------.------.------.------.------.------.------.------.
  247.       Function  | Ins  | CAPS | Num  | Scrl | Alt  | Ctrl | Left | Rght |
  248.                 |      | Lock | Lock | Lock |      |      | Shft | Shft |
  249.                 .------.------.------.------.------.------.------.------.
  250.  
  251.  
  252.  
  253.     From The Author
  254.     ---------------
  255.  
  256.     FileC was inspired by file name completion facilities offered
  257.     in a number of *Unix* shells, including csh and tcsh. I found
  258.     it very frustrating to return to DOS after using these shells
  259.     so I set about writting a TSR to do the job. Now I have FileC 
  260.     in all my AUTOEXEC.BATs (it turned out to be actually useful
  261.     to my supprize).
  262.  
  263.     FILEC has been released into the PUBLIC DOMAIN product.
  264.  
  265.     You are free to distribute this  program amongst your friends
  266.     and co-workers for non-commercial purposes.  If you like this
  267.     File Completion Utility and find it valuable then please let
  268.     me know. This will encourage me to continue developement and
  269.     deployment of other utilites.
  270.  
  271.                 Richard Miller
  272.         Soft Flair Systems
  273.         79 Abuklea Rd,
  274.         Eastwood, NSW. 2122
  275.         AUSTRALIA
  276.  
  277.  
  278.     If you have received FileC over the Internet, and have given
  279.     it a whirl please drop me some email.  A simple 2 line message
  280.     would be enough, just so I can keep track of where my creations 
  281.     get to.
  282.  
  283.     Internet Email Address: richard@macadam.mqcs.mq.oz.au
  284.                 richard@macadam.mpce.mq.edu.au
  285.  
  286.     Any comments/bug reports/suggestion would also be greatly 
  287.     appreciated. If there is sufficient interest or you ask me
  288.     I'm happy to distribute the source code as well - which is
  289.     almost entirely written in Turbo C.
  290.  
  291.     RJM
  292.  
  293.  
  294.