home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / dirutl / vcd10.arc / VCD.DOC next >
Encoding:
Text File  |  1988-12-26  |  10.7 KB  |  284 lines
  1.  
  2.  
  3.  
  4.                   VCD
  5.  
  6.            A Visual Change-Directory Program
  7.  
  8.                   Version 1.0
  9.  
  10.  
  11.        (C) Copyright 1988, Jeffrey S. Dean.  All Rights Reserved.
  12.  
  13.  
  14.  
  15. ------------------------------------------------------------------------
  16.                    USING VCD
  17. ------------------------------------------------------------------------
  18.  
  19. It shows one level down from the current directory, and all the way back
  20. up to the root directory.  It does not    read  in  the  entire  directory
  21. tree,  unlike  other visual directory programs, which allows it to start
  22. up much faster.
  23.  
  24. Quick start: To use VCD, just type VCD (you can rename it if you  like).
  25. Press F1 for additional help.
  26.  
  27.  
  28. ------------------------------------------------------------------------
  29.             VCD COMMAND DESCRIPTION
  30. ------------------------------------------------------------------------
  31.  
  32. VCD accepts the following commands:
  33.  
  34.      EnteráááSelect the current (highlighted) directory and exit
  35.      Esc     Quit without changing directory.
  36.  
  37.      Cursor keys (Up, Down, Left, Right) can  be  used    to  move
  38.      around  the tree.    The Right arrow is "smart" and remembers
  39.      the last path; for example, if you are  in  a  subdirectory
  40.      and  use  the  Left  arrow  to move to the top of the tree,
  41.      using the Right arrow will walk down that same path.
  42.  
  43.      Home    Move to the top of the tree
  44.      End     Move to the last item in the tree
  45.  
  46.      /         Move right in tree, to first subdirectory.
  47.      .         Move left in tree (same as Left arrow).
  48.  
  49.      +áááááááToggle  the  current  branch  open/closed.  If  the
  50.          current  directory  has any visible subdirectories,
  51.          this command will hide  those  subdirectories  from
  52.          view.  Pressing the key again will  redisplay those
  53.          subdirectories.  For convenience, use the Gray  '+'
  54.          key (lower right hand side of the numeric keypad).
  55.  
  56.      *áááááááExpand  all subdirectories under the current direc-
  57.          tory.  Reads the directory structure starting  from
  58.          the current position in the tree.    This does a com-
  59.          plete expansion, as compared to '+', which only ex-
  60.          pands  one level.    To expand the entire tree, press
  61.          Home and then '*'.  For convenience, use  the  Gray
  62.          '*'  key  (middle    right  hand  side of the numeric
  63.          keypad).
  64.  
  65.  
  66.  
  67.  
  68.      F1      Display help screen.
  69.  
  70.      F2ááááááHoist  current directory.    The current directory is
  71.          moved to the upper left corner of the screen making
  72.          it look like the root directory.
  73.  
  74.      F10áááááPush to DOS.   Runs  the  DOS  command  interpreter
  75.          (specified  by  COMSPEC)  starting in the directory
  76.          currently selected.  To return to VCD, type "EXIT".
  77.  
  78.      PgUp    Scroll up one page
  79.      PgDn    Scroll down one page
  80. Ctrl PgUp    Scroll up one line
  81. Ctrl PgDn    Scroll down one line
  82. Ctrl Left    Scroll left one character
  83. Ctrl Right   Scroll right one character
  84.  
  85.  
  86. ------------------------------------------------------------------------
  87.                    SEARCHING
  88. ------------------------------------------------------------------------
  89.  
  90. VCD has a very simple but effective method for specifying directories by
  91. name,  which can sometimes be much easier and more direct than using the
  92. cursor keys.
  93.  
  94. If you type a letter, VCD looks for a directory (in the current grouping
  95. of directories) that starts with that letter.  If it finds a  match,  it
  96. moves  to  that  directory.  If you type a second letter, it looks for a
  97. directory that starts with those two letters; and so on.  If you type  a
  98. sequence  of  letters  that  cannot be found, VCD beeps and then forgets
  99. about the letters typed so far.
  100.  
  101. For example, given the following tree:
  102.  
  103.      c:\ +---------dos
  104.      |---------data
  105.      |---------txt +---------letters
  106.      |           |---------memos +---------client
  107.      |           |           |---------customer
  108.      |           |           |---------supplier
  109.  
  110.  
  111.      Starting from:  Going to:             You can type:
  112.      --------------  ---------             -------------
  113.      c:\         c:\txt\memos         \t\m
  114.      c:\         c:\txt\memos\client     \t\m\c
  115.      c:\         c:\txt\memos\customer   \t\m\cu
  116.      c:\dos         c:\txt\letters         t\l
  117.      c:\txt         c:\dos             d [the search wraps around]
  118.      c:\txt\memos    c:\dos             Home \d
  119.  
  120. This is much easier to use than to describe.  Give it a  try  to  get  a
  121. feel  for  it.    You can intermix cursor keys and letter keys for optimal
  122. results.
  123.  
  124.  
  125.  
  126.  
  127. ------------------------------------------------------------------------
  128.                   THE VCD TREE
  129. ------------------------------------------------------------------------
  130.  
  131. When first started, VCD shows only part of the directory tree structure.
  132. VCD's  goal is to show only as much as is necessary, in order to provide
  133. optimal performance.  Other directory tree programs read the entire  di-
  134. rectory  structure, but this slows them down considerably, especially on
  135. disks containing many files and directories.  The structure shown by VCD
  136. is relative to the current directory.  All immediate  subdirectories  of
  137. the  current directory are shown, and all levels back to the root direc-
  138. tory are also shown.
  139.  
  140. This initial display provides a starting context.   With  this    informa-
  141. tion,  you  can  easily move up or down at least one level. However, any
  142. part of the tree can be expanded just by moving into it (using the  cur-
  143. sor keys), and any part of the tree can be hidden from view with the '+'
  144. key.  An entire branch can be expanded with the '*' key, and if that key
  145. is  pressed  while  at the root of the tree, then the whole tree will be
  146. expanded.
  147.  
  148.  
  149. ------------------------------------------------------------------------
  150.                    VCD VS. CD
  151. ------------------------------------------------------------------------
  152.  
  153. VCD achieves the same results as CD or CHDIR, but  (almost)  always with
  154. fewer keystrokes. Let's use one of the examples above to demonstrate:
  155.  
  156.      CD \TXT\MEMOS\CUSTOMER <Enter>  22 keystrokes
  157.      VCS <Enter> \T\M\CU <Enter>     12 keystrokes
  158.  
  159. As  the paths get longer, VCD does better.  VCD is also more tolerant of
  160. errors:  If you mistype a name, you rarely need to type more than  a few
  161. characters  to    fix the mistake.  You also never have to guess at direc-
  162. tory names, since they are displayed on the screen.
  163.  
  164. VCD does run more slowly than CD and CHDIR, since  the    latter    commands
  165. are  built  into  DOS.     However,  you can improve VCD's startup time by
  166. loading it into a RAM disk.
  167.  
  168.  
  169. ------------------------------------------------------------------------
  170.               COMMAND LINE OPTIONS
  171. ------------------------------------------------------------------------
  172.  
  173. The following command line options can be specified:
  174.  
  175.      -báPerform screen updated through the BIOS.  Screen updates
  176.     are normally done directly to video memory  for  maximum
  177.     efficiency.   If  your screen flickers when you run VCD,
  178.     if you see nothing at all, or if your machine is not  PC
  179.     compatible, use this option.
  180.  
  181. (More options may come in future versions.)
  182.  
  183.  
  184.  
  185.  
  186. ------------------------------------------------------------------------
  187.                  ERROR MESSAGES
  188. ------------------------------------------------------------------------
  189.  
  190. Out of memory
  191.  
  192.      Run CHKDSK to make sure you have around 40K of free memory.
  193.      If  you  have  enough  memory,  then  you may have too many
  194.      directories.  VCD should be able to handle  more  than  200
  195.      directories  without  difficulty,    and if you do not expand
  196.      the full directory tree, VCD can work on systems that  have
  197.      many more directories than that.
  198.  
  199. Abort, Retry, Ignore
  200.  
  201.      VCD  does not trap "critical errors", so if you run it on a
  202.      diskette drive with the door open, without the diskette, or
  203.      other similar circumstances, DOS will automatically pop  up
  204.      this  error message.  It is recommended that you remedy the
  205.      situation and then press the Retry or Ignore options.
  206.  
  207.  
  208. To report problems or bugs, send a letter to the author.  Please include
  209. enough    information about the problem so that it can be reproduced.  In-
  210. clude the VCD version number, and be sure to describe  the hardware con-
  211. figuration  (type  of PC, video adapter, monitor, disks, etc.) and soft-
  212. ware configuration (devices, memory resident programs, etc.).
  213.  
  214.  
  215. ------------------------------------------------------------------------
  216.              USING AND (RE)DISTRIBUTING VCD
  217. ------------------------------------------------------------------------
  218.  
  219. There  is  no  charge  to use VCD.  If you find it useful, please send a
  220. postcard to the author with your name and address, as well as  any  com-
  221. ments  you  may  have  (someone  coined the term "postware" for software
  222. distributed this way).    Please mention the version of VCD that you  have
  223. (the  version  number can be found on the help screen) and where you ob-
  224. tained your copy.
  225.  
  226. VCD  may  be distributed freely, as long as the following conditions are
  227. met:
  228.  
  229.      -áThe distribution must include the program and this  docu-
  230.        mentation, neither of which may be altered in any way.
  231.  
  232.      -áNo fee may be charged for  distribution    (this  means  no
  233.        fees for copying, shipping, handling, or anything else).
  234.  
  235.      -áVCD  may not be distributed together with or as part of a
  236.        product.
  237.  
  238. If you have paid (or are asked to pay for) a copy of VCD, please  report
  239. the circumstances to the author.  Distribution under any other terms re-
  240. quires written permission from the author.
  241.  
  242.  
  243.  
  244.  
  245. ------------------------------------------------------------------------
  246.                 VERSION HISTORY
  247. ------------------------------------------------------------------------
  248.  
  249. 1.0  12/88         First release
  250.  
  251.  
  252. ----------------------------------------------------------------
  253. ABOUT VCD AND THE AUTHOR
  254. ----------------------------------------------------------------
  255.  
  256. VCD was written in C using Turbo C 1.5, and uses the PC-Curses shareware
  257. library  (written  and distributed by the author) for screen management.
  258. The current version of VCD requires under 40K, and will run on    DOS  3.0
  259. and  later versions (earlier versions of DOS have not been tested).  VCD
  260. has been tested under PC-NFS and should also  work  on    other  networked
  261. file systems.
  262.  
  263. The author is a independent software consultant, usually working on var-
  264. ious  MS-DOS  and Unix programming projects.  Customized versions of VCD
  265. or versions for different operating systems can be  created  for  a  fee
  266. (general contract programming services are also available).  Contact the
  267. author for more information.
  268.  
  269. Address correspondence to:
  270.  
  271.                 Jeff Dean
  272.                710 Chimalus
  273.                Palo Alto, CA  94306
  274.                    USA
  275.               (415) 852-1225
  276.  
  277.  
  278. All correspondence should mention the version number of VCD that
  279. you are using.    The number can be found on the help screen
  280. (press the F1 key while running VCD).
  281.  
  282.                  - end -
  283.  
  284.