home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / snip9707.zip / T_CLEAN.DOC < prev    next >
Text File  |  1997-07-05  |  4KB  |  78 lines
  1. +++Date last modified: 05-Jul-1997
  2.  
  3.       T_CLEAN - A utility for cleaning directories based on individual
  4.                 file time stamps.
  5.  
  6.  
  7. Legal:  T_CLEAN is a free public domain utility. It is not guaranteed to do
  8.         anything more than take up disk space. Specifically, it is provided
  9.         "as is" without warranty of any kind, either expressed or implied,
  10.         including but not limited to the implied warranties of
  11.         merchantability and fitness for any particular purpose.  
  12.  
  13.         The user of this program and documentation agrees to hold the
  14.         author(s) of this material harmless for any direct or consequential
  15.         damages resulting from its use.
  16.  
  17.  
  18. Syntax: T_CLEAN directory [...directory] [-tN] [-l[FILE] [nrgi?]
  19.  
  20.  
  21. At least one directory must be specified. Multiple directories may be
  22. specified. Directory specifications may use either relative or absolute path
  23. names.
  24.  
  25.  
  26. Switches:   All switches are optional and may be either upper or lower case.
  27.             Either "-" or "/" may be used as the switch lead-in character.
  28.  
  29.   -tN       The "-t" switch specifies the file age to begin purging,
  30.             specified in days. For example, specifying "-t30" would delete
  31.             all files older than 30 days. The default if "-t" is not
  32.             specified is 14 days.
  33.  
  34.   -l[FILE]  The "-l" switch specifies a log file to record the activity of
  35.             T_CLEAN. Note that the file name is optional, in which case the
  36.             log data are directed to the console and may therefore be
  37.             redirected or piped to another file or process.
  38.  
  39.   -n        The "-n" switch instructs T_CLEAN to process normally, but not to
  40.             really delete anything. This is useful in combination with the
  41.             "-l" switch in verifying operation before actually using T_CLEAN
  42.             to delete files from a large or critical directory.
  43.  
  44.   -r        The "-r" switch instructs T_CLEAN to process all nested
  45.             subdirectories of the specified directories.
  46.  
  47.   -g        The "-g" switch is used in combination with the "-r" switch to
  48.             instruct T_CLEAN to try to delete nested subdirectories. Note
  49.             that only empty subdirectories (either cleaned out by T_CLEAN or
  50.             previously empty) are actually deleted.
  51.  
  52.   -i        The "-i" switch instructs T_CLEAN to ignore special file
  53.             attributes, i.e. Hidden, Read only, or System files.
  54.  
  55.             *** NOTE *** Use the "-i" switch with extreme caution!!!
  56.  
  57.   -?        If you run T_CLEAN without specifying a directory or with one or
  58.             more invalid switches, it will display a help screen and abort.
  59.             You can also see the help screen by using the "-?" switch.
  60.  
  61.  
  62. ERRORLEVEL: T_CLEAN returns an ERRORLEVEL of zero if successful, or non-zero
  63.             in case of failure. In the case of a syntax error, the help
  64.             screen is displayed and a non-zero ERRORLEVEL is returned. If the
  65.             "-?" switch is invoked, the help screen is displayed and T_CLEAN
  66.             returns a zero ERRORLEVEL.
  67.  
  68.             In the case of an internal failure, an error message is displayed
  69.             and/or logged. If T_CLEAN can continue, it will do so. If the
  70.             internal error prevents T_CLEAN from continuing, it will return
  71.             with a non-zero ERRORLEVEL.
  72.  
  73.  
  74. Technical:  T_CLEAN is supplied with complete source code. It has been
  75.             compiled and tested using C compilers from Microsoft,Watcom,
  76.             Symantec/Zortech, and Borland. The supplied executable was
  77.             created using Zortech C ver. 3.0r4.
  78.