home *** CD-ROM | disk | FTP | other *** search
/ CD Shareware Magazine 1997 January / CD_shareware_1-97.iso / DOS / UTL-DSK / FILUP610.ZIP / FILUPDAT.DOC < prev    next >
Encoding:
Text File  |  1996-10-28  |  6.8 KB  |  176 lines
  1. FILUPDAT.DOC                         1                         Revised: 10-28-96
  2.  
  3. Introduction:
  4.  
  5. This program is designed to make updating of files and source code  both  easier
  6. and quicker.  It compares a list of files in a source directory  to  a  list  of
  7. files in a destination directory and copies any files that are  newer  than  the
  8. ones found in the destination directory.  This is quicker than  copying  all  of
  9. the files with DOS wildcard commands and cleaner than  copying  everything  when
  10. you only want some of the files in the destination area.
  11.  
  12.  
  13. The control card file:
  14.  
  15. FILUPDAT requires an ASCII control card file to be created.   The  control  card
  16. file can consist of five types of records:
  17.  
  18. (1)  comments:  These records start with semi-colons or  colons  or  are  blank.
  19.      They are available primarily for documenting what you're doing.
  20.  
  21. (2)  source directory:  These records start  with  "-S"  (or  "-F"  for  "from")
  22.      followed by the path to copy the files from.   Something  like  "-SC:\QB45"
  23.      works fine.
  24.  
  25. (3)  destination directory:  These records start with "-D" (or  "-T"  for  "to")
  26.      followed  by   the   path   to   copy   the   files   to.    For   example,
  27.      "-DJ:\EBBNEW\DOCS".
  28.  
  29. (4)  exclusion specification:  These records start with "-X" followed by a space
  30.      and one or more filespecs (typically with wildcards).   For  example,  your
  31.      main file specification may be "*.*" but you  can  exclude  any  QuickBASIC
  32.      source code files or  object  modules  by  including  a  "-X  *.BAS  *.OBJ"
  33.      statement.
  34.  
  35. (5)  files:  These records have a single file name (e.g.  "EBBFFILE.WP") that is
  36.      to be copied from the source directory to the destination directory.   File
  37.      specifications can include standard DOS wildcards ("*" and "?").  A comment
  38.      can follow the file name provided the comment starts  with  a  colon  or  a
  39.      semi-colon.
  40.  
  41.  
  42. FILUPDAT.DOC                         2                         Revised: 10-28-96
  43.  
  44. Source and destination cards can be changed throughout the  control  card  file.
  45. Files are copied based on the most recent  source/destination  card  before  the
  46. file card.  Changing either the source or destination will reset  the  exclusion
  47. specification so you have to respecify the -X card if desired.
  48.  
  49. Also note that cards are processed sequentially.   The  exclusion  specification
  50. card only affects file name card(s) which occur after it.
  51.  
  52.  
  53. A sample control card file might look like this:
  54.  
  55.         ; Sample file
  56.         -SC:\PDOX
  57.         -DJ:\EBBNEW\PRGS
  58.         CUSTOM.SC
  59.         ADDRESS.SC
  60.         ZIPCODE.SC
  61.         ; Specifying another source file path; destination still the same
  62.         -SC:\MINE
  63.         NEWUSER.SC
  64.  
  65.  
  66. Specifying parameters:
  67.  
  68. Parameters for this program can be set in the following ways.  The last  setting
  69. encountered always wins:
  70.   - Read from an *.INI file (see BRUCEINI.DOC file),
  71.   - Through the use of an environmental variable (SET FILUPDAT=whatever), or
  72.   - From the command line (see "Syntax" below)
  73.  
  74.  
  75.  
  76. FILUPDAT.DOC                         3                         Revised: 10-28-96
  77.  
  78. Syntax:
  79.  
  80.     FILUPDAT { ctlfile | /Cctlfile } [ /-A ] [ /-R ] [ /CLONE ]
  81.       [ /Flist_file [ /OVERWRITE | /APPEND | /-OVERWRITE | /OVERASK ] ]
  82.       [ /FULL ] [ /ABORT | /SKIP | /CREATE ]
  83.       [ /MONO ] [ /Q ] [ /Iinitfile | /-I ] [ /? ]
  84.  
  85. where:
  86.  
  87. "ctlfile" or "/Cctlfile" is the name of the  control  statement  file.   It  can
  88. include path information if necessary.
  89.  
  90. "/Flist_file" says you want a text file created which tells you what files  were
  91. considered and what happened to each of them.  The "list_file" is  the  name  of
  92. the file.  This is primarily used for checking the operation of the utility. The
  93. file name can include path information if necessary; it must  contain  a  period
  94. (use something like "/FTEST." if no extension is used).
  95.  
  96. "/OVERWRITE" says that if the list_file  already  exists,  don't  prompt  before
  97. overwriting it.
  98.  
  99. "/APPEND" says to append to the list_file if it already exists.
  100.  
  101. "/-OVERWRITE" says to abort if the output file exists already.
  102.  
  103. "/OVERASK" says to prompt if the  output  file  exists  already.   This  is  the
  104. default.
  105.  
  106. "/FULL" says to write out full comparison information in the list_file.  This is
  107. primarily for debugging purposes but it includes the numeric  representation  of
  108. the date and time for both the source and destination files.
  109.  
  110. "/ALL" says to copy all files in your ctlfile regardless of relative ages.
  111.  
  112. "/ABORT" says that if any source or destination subdirectory is missing, give an
  113. error message and abort the program.  This is initially the default.
  114.  
  115. "/SKIP" says that if any source or destination subdirectory is missing, give  an
  116. error message, skip all files for that  specification,  but  otherwise  continue
  117. running the program.
  118.  
  119. "/CREATE" says that if a destination subdirectory  is  missing,  give  an  error
  120. message and try to create the subdirectory.  If  successful,  copy  the  desired
  121. files to it.  If not successful, skip  all  files  for  that  specification  but
  122. otherwise continue running the program.   If  the  source  subdirectory  is  not
  123. found, the program will operate as if /SKIP was specified.
  124.  
  125. "/MONO" (or "/-COLOR") does  not  try  to  override  screen  colors.   Initially
  126. defaults to "/COLOR".
  127.  
  128. "/COLOR" (or "/-MONO") allows screen colors to be overridden.  This is initially
  129. the default.
  130.  
  131. "/Q" turns off the file-by-file status reporting.
  132.  
  133.  
  134. FILUPDAT.DOC                         4                         Revised: 10-28-96
  135.  
  136. "/Iinitfile" says to read an initialization file with the file name  "initfile".
  137. The file specification *must* contain a period.  Initfiles are described in  the
  138. BRUCEINI.DOC file.  Initially defaults to "/IFILUPDAT.INI".
  139.  
  140. "/-I" (or "/INULL") says to skip loading the initialization file.
  141.  
  142. "/?" or "/HELP" or "HELP" shows you the syntax for the command.
  143.  
  144.  
  145. Return codes:
  146.  
  147. FILUPDAT returns the following ERRORLEVEL codes:
  148.  
  149.         0 = no problems
  150.       250 = operation aborted by pressing Escape
  151.       251 = invalid control file or bad drive/subdirectory specification
  152.       252 = copy failed
  153.       253 = no files found to copy
  154.       255 = syntax problems, or /? requested
  155.  
  156.  
  157. Author:
  158.  
  159.                         Bruce Guthrie
  160.                         Room H-4885
  161.                         U.S. Dept of Commerce/ESA/STAT-USA
  162.                         Washington, DC 20230
  163.  
  164.                         voice: (202) 482-3234
  165.                         e-mail: bguthrie@doc.gov
  166.  
  167. You may freely copy and re-distribute this program; however, the U.S. Department
  168. of Commerce neither guarantees nor assures compatibility of the program with all
  169. computer software or hardware.
  170.  
  171. See BRUCEymm.DOC file for revision history.
  172.  
  173. Please provide an Internet e-mail address on all correspondence.
  174.  
  175. 
  176.