home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1995 November / PCWK1195.iso / inne / podstawy / dos / 4dos / 4uzytki / bkup12.exe / BKUP.DOC < prev    next >
Text File  |  1995-05-18  |  17KB  |  349 lines

  1.  A DESCRIPTION OF BKUP.BTM
  2.  (May 20, 1995)
  3.  
  4.  BKUP.BTM transports files between computers. It can also be used
  5.  for quick 'maintenance of disk' (like deleting unnecessary files).
  6.  
  7.  Since version 10, BKUP no longer supports 4DOS prior to 5.x. Use
  8.  BKUP version 8 instead.
  9.  
  10.  BKUP.BTM is written in 4DOS batch language. 4DOS is a registered
  11.  trademark and copyrighted property of JP Software, Inc. For other
  12.  copyrighted programs see below, "Copyrighted programs".
  13.  
  14.  
  15.  CREATING A COMPRESSED FILE FOR NEW (UPDATED) FILES
  16.  ==================================================
  17.  BKUP.BTM creates a list of files saved on specified disk (default is
  18.  default [boot] drive) either [a] today, or [b] since a specified number of
  19.  days back, or [c] since a specified date.
  20.  
  21.  The list of files can be edited in various ways, leaving on it only those
  22.  files you wish to transport to your other computer(s).
  23.  
  24.  When the list editing is done, BKUP.BTM runs a compressor to create an
  25.  archive on specified drive (default is B:), with the specified date as a
  26.  name (for example, 3-26-93.ZIP). If such an archive already exists, it is
  27.  updated with new versions, or new files, if detected in the list. BKUP
  28.  can run 3 compressors: PKZIP, ZIP, and UC2. However, there are a few
  29.  limitations on using ZIP and UC2 for some options (see below, "Usage
  30.  Notes and Limitations").
  31.  
  32.  The files are archived with pathnames. This means that they will be
  33.  extracted on the target computer to the same subdirectories where they
  34.  were created on the source computer. By default, files are extracted to
  35.  the default (boot) drive, unless otherwise specified. If a subdirectory
  36.  does not exist on the target computer, it is created by the extraction
  37.  program during extracting.
  38.  
  39.  The archive is marked with the description "Updated from: name", where
  40.  "name" stands for an actual "name" given to your computer (see below,
  41.  "'Names' for computers and diskettes".
  42.  
  43.  EXTRACTING THE UPDATED FILES FROM THE ARCHIVE TO THE OTHER
  44.  COMPUTER(S)
  45.  ==========================================================
  46.  To extract the archived file(s), use the -x (or /x, or x) switch.
  47.  BKUP.BTM can run 3 extractors: PKUNZIP, UNZIP, and UC2. However,
  48.  there are a few limitations on using ZIP and UC2 for some options (see
  49.  below, "Usage Notes and Limitations").
  50.  
  51.  If there is more than one archive on your diskette, BKUP lets you select
  52.  the one(s) you wish to extract. Extracted files (archives) are marked with
  53.  the description "Extracted to: name; name; ...", where "name" stands for
  54.  the actual "name" of your computer (see below, "'Names' for computers and
  55.  diskettes"). If you try to extract the archive again to the same computer,
  56.  you will be told that it was already extracted, and will be asked to
  57.  decide to either "force extract" it, delete the archive file from disk, or
  58.  quit. If you do not respond, BKUP will leave the archive intact and go on
  59.  after 3 seconds to treat the next one. If in doubt, don't hesitate to use
  60.  the "force extract" option, because all extractors will not overwrite
  61.  files on your disk unless the matching files stored in the archive are
  62.  newer.
  63.  
  64.  If the archive was extracted, but then was updated again with new versions
  65.  or files (this is normal if both updating and extraction are done the same
  66.  day, or for the same date), it will be marked with the description "Updated
  67.  from: name", to allow subsequent extractions as well as indicate the source
  68.  of the new files (i.e., the computer on which they have been created).
  69.  
  70.  The extraction utility pops up a menu of archive files, even if only
  71.  one such archive exists. If more than one archive exists, you can mark
  72.  those you wish to extract (by pressing the spacebar at the relevant
  73.  filename).
  74.  
  75.  EDITING THE LIST OF FILENAMES
  76.  (before compression)
  77.  =============================
  78.  When the list of all the relevant files is created, BKUP.BTM lets you
  79.  select one of the following options:
  80.  
  81.  (*) View (and handle) filenames on screen, one by one
  82.  (*) Use an editor to edit results (results file)
  83.  (*) View results before making any decision
  84.  (*) Go immediately to archiving (no selection)
  85.  (*) Quit (results file will remain intact)
  86.  If you choose viewing (and handling) files on screen, the following
  87.  options are then available while working:
  88.  
  89.  (*) Accept or omit a file (from the list)
  90.  (*) View a file before making a decision about it
  91.  (*) Delete a file from disk (after or before viewing)
  92.  (*) Stop selecting and begin archiving immediately
  93.  (*) View the list of selections at each step
  94.  (*) Quit (results file will remain intact)
  95.  
  96.  CONFIGURING BKUP
  97.  ================
  98.  BKUP can be configured by BKUP.INI. This file can easily be edited
  99.  with any editor. However, the primary parameters and options defined in
  100.  BKUP.INI can be overridden from the command line. Alternatively, aliases
  101.  can be used to avoid editing BKUP.INI. If BKUP.INI is missing or the user
  102.  prefers not to have it, and the user does not provide any commands on the
  103.  command line, BKUP will use its internal defaults.
  104.  
  105.  The PRIMARY defaults (for both compressing and extracting) are:
  106.  (replaceable from the command line)
  107.  
  108.  (1) Disk from which files will be compressed  - default (boot) drive
  109.  (2) Drive where archive will be created       - B:
  110.  (3) Disk to which files will be extracted     - default (boot) drive
  111.  (4) Drive where archive(s) will be looked for - B:
  112.  (5) Compression and extraction programs:      - PKZIP and PKUNZIP
  113.  (6) Date for files to be updated:             - today
  114.  (7) Exclude files:                    -  *.zip *.bak *.tmp *.log *.uc2
  115.  
  116.  The SECONDARY defaults (for both compressing and extracting) are:
  117.  (NOT replaceable from the command line, but BKUP will request you
  118.  to make decisions for options (8)-(11) if BKUP.INI is missing, or
  119.  if they are not defined in BKUP.INI.
  120.  
  121.  (8)  Checking the name of updates diskette     - yes
  122.  (9)  Name of updates diskette                  - "transmit"
  123.  (10) Name of search and extract drives         - computer's label
  124.  (11) Text editor to be used                    - t.com
  125.  
  126.  OTHER defaults (definable only in BKUP.INI):
  127.  
  128.  (12) Colors of final message     - bright white & black on white;
  129.  
  130. INTEGRITY CHECKING can be defined either in BKUP.INI or from the command
  131. line. If defined as 'yes' in BKUP.INI, it can still be overridden from
  132. the command line with the /noint switch. If not defined in BKUP.INI or
  133. on the command line, it will be ignored.
  134.  
  135.  Therefore,
  136.  
  137.  (1) if you just type "BKUP", this is equal to typing:
  138.  
  139.      BKUP c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  140.     (+ secondary defaults)
  141.     
  142.  (2) if you just type "BKUP -X", this is equal to typing:
  143.     
  144.     BKUP -x c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  145.     (+ secondary defaults)
  146.  
  147.  
  148.  "NAMES" FOR COMPUTERS AND DISKETTES
  149.  ===================================
  150.  BKUP is set to use the labels of your "search disk" and "extract disk"
  151.  (both of which would normally be your default [boot] drive) as "names" for
  152.  your computer. This makes it possible to know which of your computers
  153.  has/have been updated, and to which computers the archive has been
  154.  extracted (if there are more than one archive, BKUP will add all of
  155.  their names when the archive was extracted).
  156.  
  157.  You can change this default by entering a different name for your
  158.  computer at the 'compuname=' line in BKUP.INI.
  159.  
  160.  If your default (boot) drive has been given no label, BKUP will prompt you
  161.  to give your computer a temporary name for the current session. You
  162.  can make this "name" permanent by labeling your hard disk or typing
  163.  a name at the 'compuname=' line in BKUP.INI.
  164.  
  165.  BKUP can also be set to check the "name" (i.e., label) of the diskette
  166.  inserted into the "archive drive". If you prefer to always use the same
  167.  diskette for transporting files between your various computers, this
  168.  is the best solution for keeping all of the update archives on one
  169.  device. By default, the name of the update diskette is "TRANSMIT". You
  170.  can change the name at the 'updatedr=' line in BKUP.INI. Also, you may
  171.  cancel this option altogether by typing 'no' at the 'updatename=' line.
  172.  If this line is not defined, or BKUP.INI is missing, BKUP will prompt
  173.  you at the relevant moment to enter a name for the updates diskette.
  174.  If the diskette inserted into the drive is not the dedicated one,
  175.  BKUP will ask you if you wish to continue (i.e., put the archive on
  176.  the current diskette). You can of course switch diskettes while BKUP is
  177.  waiting for your answer.
  178.  
  179.  USAGE
  180.  =====
  181.  
  182.  HELP
  183.  ----
  184.  BKUP h (or ?) will display a set of HELP screens.
  185.  BKUP i will take you immediately to the first USAGE screen.
  186.  
  187.  Usage for ARCHIVING:
  188.  -------------------
  189.  
  190.   BKUP [<search_drive:> <archive_drive:>] [parameters] [options]
  191.     <search_drive:>  is the drive which should be searched for files
  192.     <archive_drive:> is the drive where the archive should be created
  193.  
  194.   Parameters are:  [ n|-sMM-DD-YY ]
  195.      'n' stands for 'number of days back from today'.  For example, 'BKUP 3'
  196.          will create a list since three days back from today's date.
  197.      's' (or /s or -s) stands for 'since', followed by date, in the
  198.          MM-DD-YY (month-day-year) format. For example: BKUP s01-29-90 will
  199.          create a list for files created since 29 January 1990.
  200.  
  201.   Options are:     [ /pkzip|/zip|/uc ] [ /x file(s) file(s) ...]
  202.          '/pkz'                select Katz's PKZIP and PKUNZIP (Default)
  203.          '/zip'                select free ZIP and UNZIP
  204.          '/uc'                 select UC2 (UltraCompressor II)
  205.          '/int' or 'noint'     check / do not check integrity of archive
  206.          '/x file(s) ...'      list of file(s) for exclusion
  207.  
  208. Note:
  209.  If you specify only one drive, you will be asked by the program to specify
  210.  interactively both. This is necessary because the program cannot tell, when
  211.  you specify only one drive, whether it is 'target' or 'source'.
  212.  
  213.  
  214.  Usage for EXTRACTING
  215.  --------------------
  216.   BKUP -x|/x|x [<toupdate_drive:> <archive_drive:>] [options]
  217.   where
  218.       <toupdate_drive:>  is the drive to extract TO.
  219.       <archive_drive:>   is the drive to extract FROM.
  220.       If no drives specified, defaults are default (boot) drive ("to")
  221.       and B: ("from")
  222.       
  223.   Options are: [ /pkz|/zip|/uc ] [ /x file(s) file(s) ...]
  224.  
  225.       '/pkz'            select Katz's PKZIP and PKUNZIP (Default)
  226.       '/zip'            select free ZIP and UNZIP
  227.       '/uc'             select UC2 (UltraCompressor II)
  228.       '/x file(s) ...'  list of file(s) not to be extracted
  229.  
  230.  Note:
  231.  If you specify only one drive, you will be asked by the program to specify
  232.  interactively both. This is necessary because the program cannot tell, when
  233.  you specify only one drive, whether it is 'target' or 'source'.
  234.  
  235.  USAGE NOTES AND LIMITATIONS
  236.  ===========================
  237.  Excluding files
  238. ----------------
  239.  The list of files created by BKUP can include filenames which you actually
  240.  exclude from either compression or extraction. This makes sense if you
  241.  re-edit the list (this can be done by EDLIST.BTM) and use it as a take
  242.  file for other tasks (such as copying or moving). COMFILE.BTM can be
  243.  used for such tasks. (Both EDLIST and COMFILE are included in my
  244.  collection EZ-BTMxx.ZIP on Simtel20 /msdos/4dos.) Also, if you do not
  245.  wish a certain file to be extracted, although compressed in the archive,
  246.  exclude it via the /x switch (it makes no sense of course to put the
  247.  filename into a permanent list in BKUP.INI). You may wish to avoid
  248.  extraction if you are not sure about the version. Excluding the file via
  249.  the /x switch on the command line then makes it possible to extract it
  250.  manually to a different subdirectory and check it before replacing the
  251.  older version.
  252.  
  253.  Unfortunately, full exclusion options are possible only with PKZIP/PKUNZIP
  254.  and (since version #3) UC2.
  255.  See next section for the limitations of using ZIP/UNZIP and UC2.
  256.  
  257.  You can enter exclusion files / filespecs at the 'excludes=' line in
  258.  BKUP.INI. The exclusion line will work for both compression and extraction.
  259.  You can also override this line from the command line via the /x switch
  260.  (see "Usage" above). If you exclude many files, BKUP will create an
  261.  exclusion file instead of entering the exclusions on the command line.
  262.  Since ZIP cannot take an exclusion file, make sure to use this feature
  263.  only if you use PKZIP/PKUNZIP or UC2 (for ZIP you will simply have to
  264.  exclude files from the results list). If you have a slow computer, you may
  265.  gain some speed by leaving the 'exclude=' line in BKUP.INI empty and refrain
  266.  from using this option altogether.
  267.  
  268.  Limitations of free ZIP and UNZIP
  269.  ---------------------------------
  270.  (a) ZIP/UNZIP unfortunately needs more memory than PKZIP/PKUNZIP. You may
  271.      have to quit your application to run BKUP with these programs.
  272.  (b) Due to the lack of certain exit codes, BKUP could not be configured to
  273.      put the right messages after completion or non-completion of certain
  274.      operations (like 'freshen', in case there are 'no new files for
  275.      updating').
  276.  (c) ZIP/UNZIP cannot have a take file (script file) for handling a list
  277.      of exclusion files (i.e., files not to be compressed or extracted).
  278.      This makes it impossible to have more than 53 characters in the
  279.      "exclusion line" (after the /x switch or in BKUP.INI). This can
  280.      partly be solved by rejecting undesired files from the updates
  281.      list.
  282.  
  283.  Limitations of UC2
  284.  ------------------
  285.  (a) UC2 unfortunately needs more memory than PKZIP/PKUNZIP. You may
  286.      have to quit your application to run BKUP with UC2. Theoretically,
  287.      UltraStealth can make it possible for UC to work with only 32K,
  288.      but then you must load your application beforehand with US, which
  289.      cannot be secured by BKUP. Currently BKUP exits if less then 400K
  290.      are available for UC2.
  291.  (b) Due to the lack of proper exit codes, BKUP could not be configured to
  292.      put the right messages after completion or non-completion of certain
  293.      operations (like 'freshen', in case there are 'no new files for
  294.      updating', and various errors).
  295.  
  296.  HISTORY
  297.  =======
  298.  BKUP.BTM was initiated by Ron Zweig (ron@post.tau.ac.il), then edited
  299.  and augmented by Itamar Even-Zohar (itamarez@plato.tau.ac.il).
  300.  Version 7, November 1993: Fuller filename display and computer "name"
  301.  added for better information about which computer has been updated.
  302.  Version 8, January 1994: (1) A safer procedure for defining a temporary
  303.  drive added; (2) A better file selection menu replace the one-at-a-time
  304.  selection menu (thanks due to Sam Wilson; see label ":operate" for
  305.  details [in BKUP.BTM]). Version 9-10, March-May 1994: (1) The new date range
  306.  option for DIR replaces Winer's PCTODAY for those who work with 4DOS
  307.  5.x; (2) BKUP was split into primary and auxiliary files; BKUP.INI
  308.  added to facilitate configuring; (3) Both Free ZIP/UNZIP and UC2 have been
  309.  added as alternatives to PKZIP/PKUNZIP; (4) Files can now be excluded
  310.  also from the command line (an /x switch added) for both compression and
  311.  extraction. Version 11-12, May 1994 & May 1995: (1) UC2 recent full ability
  312.  for file exclusion implemented; (2) More than one hard disk can be
  313.  registered as 'updated from' or 'extracted to'; (3) An _optional_ BKUP.BTM
  314.  file was added to allow the use of the same aliases commands for different
  315.  configurations on different computers; (4) Integrity check of archive added:
  316.  it can be requested / overridden via BKUP.INI or on the command line (with
  317.  the new /int and /noint switches respectively).
  318.  
  319.  Copyrighted programs
  320.  ====================
  321.  PKZIP/PKUNZIP (c) may be purchased from PKWARE, Inc., 9025 N. Deerwood Dr.,
  322.  Brown Deer, WI 53223-2437, USA. Phone: 414-354-8699; FAX: 414-354-8559;
  323.  BBS: 414-354-8670. It may also be downloaded from Simtel20 mirror sites in
  324.  /msdos/zip.
  325.  
  326.  PKZIP/PKUNZIP, can be replaced by (1) the free ZIP and UNZIP, downloadable
  327.  from Simtel20 mirror sites (in /msdos/zip), or by (2) UC2 (UltraCompressor
  328.  II), downloadable from Simtel20's /msdos/archiver.
  329.  
  330.  To run ZIP/UNZIP or UC2, you must either modify BKUP.INI, or always put
  331.  the /zip or /uc switch on the command line, or put this option into your
  332.  BKUP alias. However, ZIP/UNZIP and UC2 unfortunately have several
  333.  shortcomings. For details see "Usage Notes and Limitations").
  334.  
  335.  UC is produced by Ad Infinitum Programs, the Netherlands (AIP-NL).
  336.  Address: AIP-NL, P.O. Box 1432, 3430 BK Nieuwegein, The Netherlands.
  337.  Internet: desk@aip.nl; CompuServe: 100115,2303; Fido: 2:281/713.1.
  338.  Phone: +31-30-662107; FAX: +31-30-616571; BBS: +31-3402-55707.
  339.  
  340.  
  341.  Itamar Even-Zohar
  342.  Porter Chair of Semiotics
  343.  Tel Aviv University
  344.  Tel Aviv 69978 Israel
  345.    Phone: +972-3-642-7233 (office)
  346.    Fax:   +972-3-642-2141 (office)
  347.    e-mail addresses:
  348.    itamarez@post.tau.ac.il
  349.