home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / fileutil / xfile.arj / XFILE.DOC next >
Encoding:
Text File  |  1991-12-26  |  13.8 KB  |  303 lines

  1.  
  2.  
  3.         XFILE.DOC       (C) Copyright 1991 by Eddy Van de Winckel, BELGIUM.
  4.         =========
  5.         Version 1.xx.
  6.  
  7.         DOCUMENTATION  FOR THE 'XFILE' DOS COMMAND.           (2612-15)
  8.         -------------------------------------------
  9.  
  10. 10      1. INTRODUCTION.
  11.  
  12.            'XFILE' is one from a set of DOS add-on and replacement commands
  13.            which have been  developed  after considering it hopeless to ex-
  14.            pect MicroSoft fixing the bugs in the DOS command interface!
  15.            Our Extended DOS commands behave in such a way that
  16.              - They won't do anything else then what you expect them to  do
  17.                (not like the 'COPY' command);
  18.              - They  will  nicely  report what they are doing (not like the
  19.                'DELete' command);
  20. 20           - They will fill in the basic needs of any (simple) PC-user.
  21.              - They will report error conditions in an  understandable  way
  22.                (not anything like "bad command or file name").
  23.              - They include on-line help.
  24.              - They comply to the normal  DOS syntax so that it is easy for
  25.                you to remember how to specify the command line.
  26.              - When possible, they will check the command  line  syntax for
  27.                incorrectness and ambiguities and report this to you.
  28.              - They can  be  interrupted  with  <CONTROL>C  as  soon as you
  29.                notice that you gave a bloody wrong command!
  30. 30
  31.            In our Extended DOS commands the syntax compatibility  with  DOS
  32.            has been maintained, i.e.
  33.  
  34.                   Command  Source  Destination  /Option  /Option ...
  35.  
  36.                                                  using the same separators.
  37.  
  38.            Compatibility with  DOS  Version 5.xx is maintained by accepting
  39.            the /? option for on-line help.
  40. 40
  41.       2. USAGE OF 'XFILE'.
  42.  
  43.          'XFILE' is a DOS-Command which covers most of the functionality of
  44.          DOS'  COPY and XCOPY commands.
  45.  
  46.          Depending on which options are given in the command-line:
  47.  
  48.          - It will ADD (copy) those files to the destination which were not
  49.            in there yet.
  50. 50
  51.          - It will UPDATE (copy) only those files which are already present
  52.            in the destination  but  which  are older than the same files in
  53.            the source.
  54.  
  55.          - It will do  both  ADD  +  UPDATE if you do not specify anything.
  56.            Here it does the same as  the  DOS  COPY  command except that it
  57.            will not copy files which are identical  and  already  on  there
  58.            (based on the filename and timestamp), saving you a lot of time!
  59.  
  60. 60       - All legal DOS-Masks and wild-cards are accepted from the command
  61.            line.
  62.  
  63.  
  64.       3. SYNTAX for the 'XFILE' command.
  65.  
  66.          The command line syntax for XFILE is:
  67.  
  68.          XFILE  [Source-Path-&-Mask]  DEST-PATH  [/Option1]  [/Option2]
  69.  
  70. 70         The syntax for Paths and file Masks is the normal DOS syntax.
  71.  
  72.          OPTIONS:
  73.            /A   to ADD only those files not present on the destination.
  74.  
  75.            /U   to UPDATE only those files which are already on the  desti-
  76.                 nation and of which  the  source  contains  a  more  recent
  77.                 version. (Great  for  updating your hard disk after working
  78.                 from a floppy or vice versa).
  79.  
  80. 80         NO OPTION will make XFILE do UPDATE + ADD, this is the  same  as
  81.                 the DOS 'COPY' command, except that it  behaves  nicely, it
  82.                 is faster and it is safer.
  83.  
  84.            XFILE /? will show an online help screen for the XFILE-command.
  85.                This is consistent with the /? parameter in DOS version 5.xx
  86.  
  87.            XFILE /R will show a registration information summary.
  88.  
  89.  
  90. 90         REMARKS:
  91.              - XFILE Source Dest /A /U is legal but not handy!
  92.              - DESTINATION-PATH MUST ALWAYS BE SPECIFIED.
  93.              - Paths can include a DRIVE identifier.
  94.              - File-Masks allow any legal DOS-mask syntax.
  95.  
  96.              XFILE  does not provide the possibility to copy  a  file  into
  97.                another name! (Which it shouldn't do!).
  98.                Use DOS' RENAME command instead. The inconsistency  of DOS's
  99.                COPY command which also allows to rename a file is the cause
  100. 100            that it cannot differentiate whether you give a directory or
  101.                a new file name to the destination (see example 1 below).
  102.  
  103.              XFILE does not provide the possibility to append files as with
  104.                     "COPY InFile1 + InFile2  OutFile"
  105.                                                     which is not consistent
  106.                with a "copy" command.
  107.                Sorry,  a "copy" command  should  not be expected to produce
  108.                something any different from the original!
  109.  
  110. 110
  111.          DEFAULTS:
  112.            - Source-Path will default to CURRENT PATH when not given.
  113.            - Source-Mask will default to *.* when not given.
  114.  
  115.          EXAMPLES:
  116.  
  117.            XFILE  *.*  C:\MYDIR  will  copy  all  files  from  the  current
  118.              directory, for example A:\, to the directory C:\MYDIR.
  119.              If the destination directory is not available, XFILE will  not
  120. 120          pack all the files into one file called "MYDIR.[No Extension]"
  121.              as does "COPY" after having reported to you "n files copied" !
  122.              (If you had never seen a real BIG BUG, here is one!).
  123.  
  124.            XFILE  *.TXT  C:\MYDIR  will copy all files with extension  .TXT
  125.              from the current directory to ddirectory C:\MYDIR.
  126.  
  127.            XFILE C:\TURBO\*.* C:\BAK /U   will copy  only  the  more recent
  128.              versions of files in C:\TURBO into directory C:\BAK.
  129.  
  130. 130
  131.        4. SPECIFICATIONS AND LIMITATIONS OF 'XFILE'.
  132.  
  133.           - CAUTION:
  134.  
  135.             XFILE uses the File Time Stamps contained in all your  files
  136.             and set automatically by DOS each time you write into a file.
  137.             IT will work incorrectly if your system does not contain the
  138.             correct time and date. It is bad practice to operate your
  139.             computer without the correct time and date set.
  140. 140
  141.           - ERROR REPORTING.
  142.  
  143.             XFILE will check the command-line for correct syntax.  It  will
  144.             report incorrect syntax and exit without executing.
  145.  
  146.             Error conditions which can  appear  during  execution  will  be
  147.             neatly  reported  to  you,  stating  the  type  of  error, i.e.
  148.             'invalid  destination path',  'source  cannot  be opened', etc.
  149.             After reporting an error, XFILE will stop executing and  return
  150. 150         to DOS.
  151.  
  152.           - BREAK WITH <CONTROL>C.
  153.  
  154.             XFILE will break and exit to DOS after <Control>C.  This is  to
  155.             give you the opportunity to stop it the earlier if you find out
  156.             that you gave a bloody wrong command! Using the  BREAK on XFILE
  157.             can cause lost clusters to be present on the  DESTINATION.  (to
  158.             be fixed with DOS' "CHKDSK /F").
  159.  
  160. 160       - ACTIVITY REPORTING.
  161.  
  162.             XFILE will report neatly what it is doing, including which file
  163.             it found and where it is copying  it  to. This  will  stop  you
  164.             praying  the  Lord all the time, hoping this long list of files
  165.             is getting at the right place as with DOS' COPY command!
  166.  
  167.           - READ/WRITE ERRORS.
  168.  
  169.             XFILE has a built in Read after Write process to make sure that
  170. 170         what is on your destination is exactly the same as the original.
  171.             This takes some more time (especially on Floppy)  but  that  is
  172.             the price to pay for a little bit of security.  The  read after
  173.             write check of XFILE is  independant  from  your  global system
  174.             setting with VERIFY ON or VERIFY OFF in the start-up batch file.
  175.  
  176.           - SYSTEM LIMITATIONS.
  177.  
  178.             XFILE is very fast. It will scan the directories at a  rate  of
  179.             25 files per second on a typical hard disk.
  180. 180         So if you have 100 files to scan and no file  on  the  destina-
  181.             tion needs an update, XFILE will take only  4  seconds after it
  182.             loaded! When files need to be updated, the time needed is deter-
  183.             mined by the speed of the disks in your system.
  184.  
  185.             There is however a price for speed: Memory. XFILE needs 237K of
  186.             RAM memory in your PC to work! So it will not run on very small
  187.             machines nor on machines clogged with  TSR'S, windows, drivers,
  188.             etc., unless 237K of  memory  are  still  available.  There  is
  189.             however no particular caution: If there is not enough available
  190. 190         memory in your system when you call XFILE,  it will report this
  191.             to you and return to  DOS without executing. Then you can still
  192.             choose to use DOS' "COPY" and start praying the Lord!
  193.  
  194.  
  195.        5. DISTRIBUTION and SHAREWARE AGREEMENT.
  196.  
  197.           XFILE Version 1.xx is distributed as SHAREWARE. There is  no  fee
  198.           for using this software because we believe it  should  have  been
  199.           there already for a long time, coming free with your DOS operating
  200. 200       system (unless you are using a  non legal copy of DOS, Bahhh!!!).
  201.           However, this software is not  in the public domain and is  copy-
  202.           righted material. It is illegal to sell or include this  software
  203.           into a commercial package, or to charge for  distribution of this
  204.           software other than for including it in a  SHAREWARE library on a
  205.           disk with no more than 30%  of  its  maximum  capacity  free.  By
  206.           using, owning or copying  this software you agree to comply  with
  207.           this DISTRIBUTION and  SHAREWARE agreement. XFILE can  be  dupli-
  208.           cated and distributed  only in full, i.e. XFILE.EXE together with
  209.           its documentation file XFILE.DOC.
  210. 210
  211.           XFILE Version 1.xx can be used for Corporate or Company use under
  212.           the same terms of agreement as stated above.
  213.  
  214.           It is expressly forbidden to ditribute XFILE under  another  name
  215.           than the original.
  216.  
  217.  
  218.        6. REGISTRATION.
  219.  
  220. 220       A registered version of XFILE, version 2.xx is available from the
  221.           author. XFILE Version 2.xx has enhanced functionality such as sup-
  222.           port  of  Subdirectories.  To recieve your own registered copy of
  223.           XFILE Version 2.xx, please send a 20 US$ note in an envelope with
  224.           your full name and addres, stating  that  you  want  to  register
  225.           XFILE. We will send you a 5.25" floppy with the latest release of
  226.           XFILE, together with another nice  utility FREE. Sorry, no credit
  227.           cards or cheques to keep our costs low.
  228.  
  229.           FOR REGISTRATION SEND A 20 US$ (TWENTY US DOLLAR) NOTE IN AN
  230. 230       ENVELOPE
  231.  
  232.             TO:    EDDY VAN DE WINCKEL
  233.                    21, RUE MARCQ
  234.                    B 1000 - BRUSSELS
  235.                    BELGIUM.
  236.  
  237.  
  238.           XFILE Version 2.xx and the other DOS utility which comes with it
  239.           are not available through SHAREWARE nor from any commercial out-
  240. 240       let.
  241.  
  242.  
  243.        7. PRODUCT LIABILITY.
  244.  
  245.           This product is made available on  an  'as is'  basis  without
  246.           warranty of fitness for any particular use. The author  cannot
  247.           be liable for any damages incurred by the use of this software.
  248.           This software is guaranteed to have been used extensively  and
  249.           tested for compliance to the specifications before release.
  250. 250
  251.           >>>>>>>>>>>  END OF "XFILE" DOCUMENTATION  <<<<<<<<<<<<<<<<<
  252.  
  253.  
  254.  
  255.  
  256.  
  257.          ----------------end-of-author's-documentation---------------
  258.  
  259.                          Software Library Information:
  260.  
  261.                     This disk copy provided as a service of
  262.  
  263.                            Public (software) Library
  264.  
  265.          We are not the authors of this program, nor are we associated
  266.          with the author in any way other than as a distributor of the
  267.          program in accordance with the author's terms of distribution.
  268.  
  269.          Please direct shareware payments and specific questions about
  270.          this program to the author of the program, whose name appears
  271.          elsewhere in  this documentation. If you have trouble getting
  272.          in touch with the author,  we will do whatever we can to help
  273.          you with your questions. All programs have been tested and do
  274.          run.  To report problems,  please use the form that is in the
  275.          file PROBLEM.DOC on many of our disks or in other written for-
  276.          mat with screen printouts, if possible.  PsL cannot debug pro-
  277.          programs over the telephone, though we can answer questions.
  278.  
  279.          Disks in the PsL are updated  monthly,  so if you did not get
  280.          this disk directly from the PsL, you should be aware that the
  281.          files in this set may no longer be the current versions. Also,
  282.          if you got this disk from another vendor and are having prob-
  283.          lems,  be aware that  some files may have become corrupted or
  284.          lost by that vendor. Get a current, working disk from PsL.
  285.  
  286.          For a copy of the latest monthly software library newsletter
  287.          and a list of the 4,000+ disks in the library, call or write
  288.  
  289.                            Public (software) Library
  290.                                P.O.Box 35705 - F
  291.                             Houston, TX 77235-5705
  292.  
  293.                                 1-800-2424-PSL
  294.                              MC/Visa/AmEx/Discover
  295.  
  296.                           Outside of U.S. or in Texas
  297.                           or for general information,
  298.                               Call 1-713-524-6394
  299.  
  300.                           PsL also has an outstanding
  301.                           catalog for the Macintosh.
  302.  
  303.