home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / util / cli / usage / usage.doc < prev    next >
Encoding:
Text File  |  1994-03-21  |  8.9 KB  |  254 lines
  1. -----------------------------------------------------------------------------
  2.  
  3.  
  4. Usage 1.06 User Manual                21th of March, 1994
  5.  
  6.  
  7.             Copyright © 1994 Janne Kiiskilä
  8.  
  9.             Janne Kiiskilä
  10.             Kalervontie 1 C 4
  11.             FIN-90570  OULU
  12.             FINLAND
  13.  
  14. -----------------------------------------------------------------------------
  15.  
  16. 1. INTRODUCTION
  17.  
  18.     What exactly is Usage? Usage is basicly the du (disk usage) command
  19.     from UNIX. The only difference is, that this program has more
  20.     options, mainly the availability to make comparisons and return WARN
  21.     if the given amount is exceeded. And, of course wildcards, too. Now
  22.     you can check out for example the amount of .info's on your precious
  23.     hard disk (I've got over 600 KBs on my boot partition only)...
  24.  
  25.     This program was coded because we will need a command like this
  26.     in the future when we install MuFS to the Amiga 4000 at the Oulu
  27.     University. Each user will have a home-directory of their own,
  28.     and we need to limit that size and warn the user if the preferred
  29.     disk usage is exceeded.
  30.  
  31.     Also, the previous DU command that I had wasn't hit-free, it
  32.     produced some Enforcer hits when executed. I don't like Enforcer
  33.     hits, so that gave me some more motivation to do this program.
  34.  
  35. -----------------------------------------------------------------------------
  36.  
  37. 2. COPYRIGHT & DISCLAIMER
  38.  
  39.     This program is copyrighted, but FREELY DISTRIBUTABLE. If you use
  40.     it and like it, a donation or gift would be nice; a postcard,
  41.     intros, demos, public domain software, money etc. I'm a student,
  42.     and money simply doesn't want to live with me... ;(
  43.  
  44.     Selling this program for more than reasonable media cost is strictly
  45.     forbidden. A special permit is given to Fred Fish so that he can
  46.     include this program to his CD-ROMs. Also, this program may be
  47.     copied to the AmiNet CD-ROM. Others may require this permit from
  48.     me, contact address is in the CONTACT THE AUTHOR part of this
  49.     document.
  50.  
  51.     Add all standard disclaimers here, I'm in no way responsible
  52.     of what this program might cause to you; may it be data corruption,
  53.     number of aliens visiting your house, mental or physical health
  54.     problems. This program has been thoroughly tested and it should
  55.     not cause any problems, but who am I to promise anything? Big
  56.     companies can't keep their promises either - Microsoft 100%
  57.     guarantee of bugged & bloated software.
  58.  
  59. -----------------------------------------------------------------------------
  60.  
  61. 3. INSTALLACTION & USAGE
  62.  
  63.     Quite simple, just copy the program USAGE to the directory
  64.     you wish it should be in, just make sure your PATH points to
  65.     that directory. Please refer to the manuals of your computer
  66.     on the COPY and PATH-command.
  67.  
  68.     Usage [OPTIONS] [PATH] [OPTIONS]
  69.  
  70.     Path is the path/volume of which you want to know the disk usage.
  71.     Only one parameters has to be given, it may be the path or any
  72.     of the options. If a path is not given, the current directory
  73.     will be scanned.
  74.  
  75.     ALL      - recursive, calculate the size of all sub-directories too
  76.     QUIET    - no output at all, expect errors
  77.     SHORT    - print only the first level of directories
  78.     VERBOSE  - print the directories and their sizes
  79.     LEVEL    - print only the given amount of directory levels
  80.     COMPARE  - compare the disk usage to a given amount, which MUST
  81.                follow immediately after the COMPARE keyword.
  82.     NOADD    - as of version 1.04 the default output form has been
  83.                been changed, use this option for the previous output.
  84.                By default the size of a parent directory is calculated
  85.                not only from the files within that directory but it's
  86.                subdirectories, too (just like the du in UNIX).
  87.     FILELIST - create a filelist of files used for disk usage calculation.
  88.                The option LEVEL does not affect the file creation.
  89.  
  90.  
  91.     Options may be given in upper or lower case, the checking is not
  92.     case sensitive. And, they may be given in any order as well.
  93.  
  94.     Some examples might clear things out;
  95.  
  96.     USAGE
  97.     - no parameters, short instructions displayed
  98.  
  99.     USAGE RAM:
  100.     - calculate the disk usage of RAM:
  101.  
  102.     USAGE ALL
  103.     USAGE -A
  104.     - calculate the disk usage of the current directory and all of its
  105.       subdirectories, too.
  106.  
  107.     USAGE RAM: ALL
  108.     USAGE RAM: -A
  109.     - calculate the TOTAL disk usage of RAM:
  110.  
  111.     USAGE RAM:*.info ALL
  112.     - calculate the TOTAL amount of .info-files on RAM:
  113.  
  114.     USAGE RAM: ALL QUIET
  115.     - calculate the TOTAL disk usage on RAM: do not produce any output
  116.       (except possible memory allocation errors etc!)
  117.  
  118.     USAGE RAM: ALL SHORT
  119.     USAGE RAM: ALL LEVEL 1
  120.     USAGE RAM: -A -L 1
  121.     - calculate the TOTAL disk usage on RAM: and display the amount of
  122.       disk space used in the first directory levels.
  123.  
  124.     USAGE RAM: ALL VERBOSE
  125.     USAGE RAM: -A -V
  126.     - calculate the TOTAL disk usage on RAM: and display the amounts as
  127.       the program preceeds in the directory tree. Like the DU command in
  128.       UNIX.
  129.  
  130.     USAGE RAM: ALL VERBOSE FILELIST TEMP:files
  131.     USAGE -A -V -F TEMP:files RAM:
  132.     - calculate the TOTAL disk usage of RAM: and display the amounts
  133.       as the program preceeds in the directory tree. Saves the filenames
  134.       used for disk usage calculation to TEMP:files.
  135.  
  136.     USAGE RAM: ALL COMPARE 100
  137.     USAGE RAM: ALL COMP 100
  138.     USAGE RAM: -A -C 100
  139.     - calculate the TOTAL disk usage on RAM: and compare the amount to
  140.       100 KILOBYTES and return WARN if the amount is exceeded.
  141.  
  142.     USAGE RAM: ALL COMP 100 VERBOSE
  143.     USAGE RAM: -A -C 100 -V
  144.     - same as above, but also displays the size of each directory as
  145.       the program works its way through the directory tree.
  146.  
  147.     And all of the other variations you can imagine. You can't use
  148.     the keywords QUIET, VERBOSE and SHORT on the same command line!
  149.  
  150.     If you want to have that traditional DU-command familiar from
  151.     UNIX (and Amiga-ports) define an alias like this in your S:SHELL-STARTUP
  152.  
  153.     ALIAS DU USAGE ALL VERBOSE
  154.  
  155.     or, any other way you prefer it.
  156.  
  157.     See the file HomeFull.script in this archive for an example of
  158.     how to use the COMPARE-option in a script.
  159.  
  160. -----------------------------------------------------------------------------
  161.  
  162. 4. BUGS
  163.  
  164.     There aren't any bugs I know of at this point. But, there are
  165.     a few things you should remember. This program is recursive,
  166.     the sub-directory scanning is done with recursion. Recursion
  167.     uses the stack. Each recursion level uses stack about 100 bytes.
  168.     The program currently allocates a stack of 10240 bytes IF you
  169.     use a smaller stack. That amount is enough for about 80 directory
  170.     levels, but if you have VERY complex directory structures please
  171.     use the STACK command to increase the stack size before running
  172.     this program with the ALL-switch.
  173.  
  174.     Please do notice, that using CTRL-C to abort the program while
  175.     it is scanning a directory will cause memory loss. The program
  176.     is recursive, and the temporary path names allocated by each
  177.     recursion level are lost.
  178.  
  179.     But, if you do happend to find a bug or two, please inform me
  180.     immediately and I will try to fix them. Or, if you have any
  181.     nice improvement ideas. My address is in the CONTACT THE AUTHOR-
  182.     part of this documentation.
  183.  
  184. -----------------------------------------------------------------------------
  185.  
  186. 5. NOTES
  187.  
  188.     This program was compiled using the SAS/C Development System
  189.     version 6.51 and tested with Enforcer and Mungwall; hit free
  190.     program.
  191.  
  192.     This program needs at least dos.library version 37, ie.
  193.     KICKSTART 2.0 is required! Go and get an upgrade if you're
  194.     still using 1.2 or 1.3. Or even better, go get yourself
  195.     an Amiga 1200 or 4000...
  196.  
  197. -----------------------------------------------------------------------------
  198.  
  199. 6. CONTACT THE AUTHOR
  200.  
  201.     The quickest way to reach me is email, but I read my snail
  202.     mail too.
  203.  
  204.     Janne Kiiskilä
  205.     Kalervontie 1 C 4
  206.     FIN-90570  OULU
  207.     FINLAND
  208.  
  209.     email:janne.kiiskila@oulu.fi,
  210.           jannek@stekt.oulu.fi,
  211.           jannek@paju.oulu.fi,
  212.           jannek@phoenix.oulu.fi
  213.  
  214. -----------------------------------------------------------------------------
  215.  
  216. 7. HISTORY
  217.  
  218.     VERSION 1.06 (21.3.1994)
  219.  
  220.     - new option, FILELIST. Creates a list of all the files used for
  221.       the disk usage.
  222.  
  223.     - added a new option, LEVEL. It defines the number of directory
  224.       levels to be printer when scanning the directory tree. It does
  225.       NOT define the level of directories to scan through!
  226.  
  227.     - cleaned up the source quite a bit.
  228.  
  229.     - changed the way usage prints out the size of directories, now (by
  230.       default) the size of parent directory is the size of all the files
  231.       in that directory, including subdirectories. You can avoid this
  232.       behaviour by using the new switch NOADD.
  233.       Enhancement requested by Jack Nutting.
  234.  
  235.     - modified the argument handling, it's much more flexible now.
  236.       You can give the arguments in any order now, even the path may
  237.       be anywhere in the command line - now it's much easier to "make"
  238.       a DU command of your own with aliases.
  239.  
  240.     VERSION 1.02 (14.3.1994)
  241.  
  242.     - a small enhancement, added the option SHORT.
  243.       Enhancement requested by Rob Hardy.
  244.  
  245.     VERSION 1.01 (7.3.1994)
  246.  
  247.     - a small bugfix, didn't handle assigns correctly. For example        
  248.       USAGE DATA: ALL scanned the whole device where DATA: was located.
  249.       Bug reported by Rob Hardy.
  250.  
  251.     VERSION 1.0  (19.2.1994)
  252.  
  253.     - first public release
  254.