home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 4 / CDPD_IV.bin / fish / 911-930 / ff919a / qdir / qdir.doc < prev    next >
Text File  |  1994-05-04  |  6KB  |  172 lines
  1.  
  2.                                  Qdir  v1.36
  3.  
  4.                                A "dir" program
  5.  
  6.  
  7. Written by: Gregg Scholfield
  8. Copyright 1993 ALL RIGHTS RESERVED
  9.  
  10.  
  11. INTRODUCTION
  12.  
  13.     Qdir was written for those of us who use the CLI. Have you been
  14.     frustrated with the random order of files when using the AmigaDOS
  15.     LIST command? Or the nice orderly appearance of the DIR command but
  16.     with no file statistics? I have, and that's why I wrote this program.
  17.  
  18.     Qdir is a directory file listing program that can replace both DIR and
  19.     LIST AmigaDOS commands. The program lists files alphabetically like
  20.     the AmigaDOS DIR command but displays ALL of the file and directory
  21.     statistics like the LIST command. The result is a nice orderly list
  22.     that's easy to read. It supports all of the AmigaDOS wildcards (#?.~)
  23.     and syntax like normal AmigaDOS commands do. The bottom line also
  24.     gives you statistics on how many files and directories were found; the
  25.     bytecount of the files; FREE disk space available for the device you
  26.     pointed to.
  27.  
  28.     The program was written in C to keep it compact and fast. It is PURE
  29.     so you can use the RESIDENT command to load it into memory which will
  30.     speed it up even more. It uses only 20k of RAM when made resident. Qdir
  31.     requires AmigaDOS 2.0, Kickstart version 37 or higher to run.
  32.  
  33.     When you get the registered version of Qdir you will have the ability
  34.     to configure the output listing to your own personal taste.
  35.  
  36.  
  37. COPYRIGHT
  38.  
  39.     Qdir is a shareware program and is copyrighted by the author, Gregg
  40.     Scholfield, ALL RIGHTS RESERVED. This shareware version of the program
  41.     may be freely distributed as long as this document file is distributed
  42.     with the main program.
  43.  
  44.     This program is supplied "as is" with no warranty expressed or implied
  45.     to its quality, performance or fitness for any particular purpose. The
  46.     entire risk as to the quality and performance of the software is with
  47.     the user. In no event will the author be liable for direct, indirect,
  48.     or incidental damages resulting from the use of this software.
  49.  
  50.  
  51. INSTALL
  52.  
  53.     To install Qdir you would simply copy the main program file into your
  54.     c: directory. This will insure that the program is in your path and
  55.     can be called from any sub-directory.
  56.  
  57.  
  58. USE
  59.  
  60.     Once installed you use Qdir as you would any AmigaDOS command: type
  61.     its name on the CLI command line. There are some useful command line
  62.     switches that make this program even more flexible.
  63.  
  64.  
  65.     Switch  Description
  66.     ------  -----------
  67.  
  68.     -?      Display a help screen for command switches.
  69.  
  70.     -d      Display a listing of directories only, no files.
  71.  
  72.     -f      Display a listing of files only, no directories.
  73.  
  74.     -s    * Enter the program setup mode. This allows you to configure
  75.             Qdir to display the listing in a format of your own design.
  76.  
  77.     * This function is only available in the registered version.
  78.  
  79.  
  80.     Use Qdir as if you were using the AmigaDOS DIR or LIST commands. For
  81.     example:
  82.  
  83.     qdir              lists ALL files and directories in the "current"
  84.                       directory.
  85.  
  86.     qdir -f           lists ALL files in the "current" directory.
  87.  
  88.     qdir ram:         lists ALL files and directories in the RAM: device.
  89.  
  90.     qdir df0:#?.info  lists ALL icon (.info) files in the root directory
  91.                       of df0:
  92.  
  93.     qdir dh0: -d      lists ALL directories in the root directory of dh0:.
  94.  
  95.  
  96. SETUP MODE (registered users only)
  97.  
  98.     When Qdir is in the setup mode, several parameters can be changed by
  99.     you. These changes are saved in a configuration file in your sys:s
  100.     directory. Once the configuration file is saved, Qdir will use it to
  101.     format the output listing.
  102.  
  103.     qdir -s           enters the setup mode.
  104.  
  105.     During setup mode you will be asked some questions, which are shown
  106.     below. You answer these by pressing one of the keys shown in
  107.     parenthesis (). The program automatically goes on to the next one until
  108.     you are finished or you have pressed "A" which aborts the setup
  109.     operation and makes NO changes to the existing configuration file.
  110.  
  111.  
  112.         Listing   Options
  113.         ========  ===============================================
  114.  
  115.         SIZE    > (R)emove (B)yte bloc(K)? (A)bort
  116.  
  117.         PROTECT > (R)emove (K)eep? (A)bort
  118.  
  119.         DATE    > (R)emove (K)eep? (A)bort
  120.  
  121.         TIME    > (R)emove (1)2hr (2)4hr? (A)bort
  122.  
  123.         DISPLAY > (Number of display lines, 00=NO limit)? (A)bort
  124.  
  125.         COMMENT > (R)emove (K)eep? (A)bort
  126.  
  127.  
  128.     Key to Options
  129.     ==============
  130.  
  131.     (R)emove       Remove this item from the output listing.
  132.     (K)eep         Keep this item in the output listing.
  133.     (A)bort        Quit setup mode immediately, don't save changes.
  134.  
  135.     (B)yte         Display file size in bytes.
  136.     bloc(K)        Display file size in AmigaDOS blocks.
  137.  
  138.     (1)2hr         Display time stamp in 12 hour format, ie:  2:35p
  139.     (2)4hr         Display time stamp in 24 hour format, ie: 14:35:47
  140.  
  141.     (Number of..)  Display this many lines before pausing the screen and
  142.                    asking the user to: Q = Quit or "press any other key
  143.                    to continue". The useful range is between 10 lines to
  144.                    99 lines, or 00 for NO pause.
  145.  
  146.  
  147. REGISTER
  148.  
  149.     To register Qdir, send $5 US to:
  150.  
  151.     Gregg Scholfield
  152.     PO Box 20481
  153.     Carson City, NV  89721
  154.  
  155.     I will respond by sending you a diskette containing the latest version
  156.     of Qdir, fully operational. Orders from outside United States please
  157.     send $8 US.
  158.  
  159.  
  160. FEEDBACK
  161.  
  162.     I welcome any comments and criticism you may wish to offer.
  163.     Enhancements in future releases will depend on your comments and wish
  164.     lists.
  165.  
  166.  
  167. FUTURE ENHANCEMENTS
  168.  
  169.     One user has asked me to include "recursion" as a command line option.
  170.     This would list the current directory and all files/directories within
  171.     any sub-directories of the current directory. I am working on this now.
  172.