TABLE OF CONTENTS - TreeCmp v. 2.08

Operating system
Minimum requirements
Description
Installation
Syntax
Quick help
Quick info
Arguments
  source directory
  target directory
  options
    options to specify which files are compared and how they are compared
    options to control logging of results
Errorlevel
Example
Stop process
Source code
Responsability
History                                                                                 

*******************************************************************

Operating system

   TreeCmp has been tested in MS-DOS version 3.3 to 6.22
   TreeCmp is intended to be used in pure MS-DOS where files
   follow the 8.3 convention i.e. 8 spaces for the filename and
   3 for the extension.  It is not designed to be use in Windows
   MS-DOS mode where long filenames are present.

Minimum requirements

   This program is a protected mode DOS extended executable.
   It will only run on a 80286 processor or above with a
   minimum of 1-2 Mb of available extended memory.

Description

   Performs a comparison of a directory tree against another directory.

   It does recursion inside sub-directories up to any number of levels.

   TreeCmp may exclude any pattern of files from comparison.

   It may take into account or not date and time stamps.

   It is year 2000 ready !

Installation

   Copy the executable ( TREECMP.EXE ) in one of the directories that
   your DOS PATH points to.  This is to make sure that TREECMP will
   execute from any directories.  You may already have a directory,
   C:\UTIL for instance, containing some other DOS utilities; this 
   is a good place to copy TREECMP.EXE .

Syntax         TREECMP [ /INFO ]
               TREECMP   source_dir           target_dir         [ options ]
               TREECMP { d:\source | *.* }  { d:\target | *.* }  [ options ]

Quick help

   TREECMP without argument displays a quick help screen.

Quick info

   TREECMP /INFO displays information on registration.

Arguments

  source_dir

   Source directory.
   The input is transformed into its canonical form.

   Let's say, for instance, that the current directory is c:\dos.
   If you specify c: as source directory, you really get c:\dos and
   not the root directory.  In this situation, .. would mean the
   root directory.  Of course, c:\ always means the root whatever
   the current directory is.

   "*.*" is treated here as a special case and it is replaced by the
   canonical form of the current directory.
                  
   Note : The program will not compare itself (TREECMP.EXE) properly
          while it is running.

   If it really is a problem, run TREECMP from the directory pointed to
   by your TEMP environmental variable.  This directory is avoided by
   TREECMP and is never compared.
   See the note following the explanation for the /L switch.

  target_dir

   Target directory.

   Just take care that the source and the target directory trees
   do not overlap.  For instance, TREECMP k:\ k:\tryit might lead to
   unpredictable results.

  options

   Options may begin with / or -.
   The order in which the option switches appears and the case of the
   option switches are not relevant.

   By default, all files are compared and the date and time stamps
   of files are compared too.

  options to specify which files are compared and how they are compared

   **********     /Xf1,f2,...            ***************

   'eXclude' files matching file specifications f1 or f2 or ...
   To shorten the command, /Xa[b[ is the same as /Xa*.*,b*.*
   Exclude files with these specifications from process.

   **********     /S                     ***************

   'Stamps'.  Do not compare date and time stamps.
   By default, the date and time stamps of the files must be equal
   for the files to be declared equal.

  options to control logging of results


   **********     /Q                    ***************

   'Quiet' mode.
   In the default mode, all files encountered are shown on screen.
   In the quiet mode, only files which do not compare exactly are
   shown on screen during the process.

   **********     /L                    ***************

   'Log' screen messages in a file on disk.
   The content of the file is affected by the /Q option switch.

   For long process, the user may leave and come back to browse
   this file to see what happened.

   This information is appended to file TREEBAC.LOG located in
   the directory specified by the environmental variable TEMP.  

   Note : The directory that is pointed to by TEMP is never compared.
          It is avoided by TREECMP.  There is usually nothing that
          needs to be compared inside this directory and it allows the
          program to use it safely to log results in it.

Errorlevel

   Errorlevel is set on completion of the program and can be
   checked the usual way in a batch file.

   4 : Incorrect syntax or registration information requested - no work done.
   3 : Source or target directory absent - no work done.
   1 : Something is wrong.
   0 : Everything is O.K.

Example

    TreeCmp c:\ g:\ /l /s /q /xchklist.ms

    Compare partition c: and partition g:.
    Log results, date and time stamps are not taken into account,
    only show files with compare errors, and files chklist.ms are ignored.

Stop process

   As an emergency measure, if you need to stop the process, press
   Alt-C i.e first press down the [Alt] key and press [C] at the same time.

Source code

   This utility is written in Clipper 5.2
   The NANFORUM library has been used.
   This excellent PUBLIC DOMAIN (free) library gives you the ability
   to call dos interrupts.
   The file nflib305.zip can be downloaded from :
   http://www.iag.net/~philb/ftplib.htm

   The functions Ft_Int86() and Ft_Peek() are needed
   for linking TREECMP.

Responsability (the usual stuff)

   The author can not be help responsible for any loss of data or
   any other mishaps.

History

   There are no known bugs.

   Changes in version number only account improvements made
   to the documentation.

