home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / zipbo111.zip / ZIPBRAND.DOC < prev    next >
Text File  |  1994-04-02  |  22KB  |  514 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.         ┌──┬┐┌┐┌┬──┐  ┌┬─┐ ┌┬──┐┌┬──┐┌┬─┐ ┐┬┬──┐  ┌┬──┐┌┬──┐┌┬──┐┌─┬┬─┐┌┬┐
  8.         ┌┬─┴┘├┤├┼──┘  ├┼─┴┐├┼─┬┘├┼──┤├┤ │ │├┤  │  ├┼─  ├┼──┤└┴─┬┐  ├┤  └┴┘
  9.         └┴──┘└┘└┘     └┴──┘└┘ └ └┘  ┘└┘ └─┘┴┴──┘  └┘   └┘  ┘└──┴┘  └┘   o
  10.  
  11.                Version 1.11 (DOS and OS/2). Released on April 2. 1994
  12.  
  13.                Copyright 1993,1994 Ketil Kintel. All Rights Reserved.
  14.  
  15.                        ───────────────────────────────────────
  16.  
  17.      This is the  user documentation for  ZIP Brand FAST!  v1.11. It has  been
  18.      formatted for the  "Letter" paper size  (57 lines per  page), but  should
  19.      print correctly with the A4 paper  too. To print it, simply type  the DOS
  20.      command  COPY ZIPBRAND.DOC PRN.
  21.  
  22.  
  23.  
  24.                                        INDEX.
  25.                        ───────────────────────────────────────
  26.  
  27.           Index. ................................................. 1
  28.           Introduction. .......................................... 2
  29.           Software License. ...................................... 2
  30.           Benefits of registering this program. .................. 3
  31.           Protecting against tampering, viruses etc. ............. 3
  32.           Installation. .......................................... 4
  33.           Using program arguments. ............................... 4
  34.                Command line syntax: .............................. 5
  35.           Detailed description of all program arguments. ......... 5
  36.                StartPath ......................................... 5
  37.                CommentFile ....................................... 5
  38.                /V (Verbose) ...................................... 5
  39.                /I (Ignore file attributes) ....................... 6
  40.                /R (Reprocess) .................................... 6
  41.                /O (Old Time Stamp) ............................... 6
  42.                >>{LogFileName} (LogFile) ......................... 6
  43.                /B (Block Read Size) .............................. 6
  44.                /D (No Direct Video Writes) ....................... 7
  45.                /E (rEgister) ..................................... 7
  46.                /? or /H (Help) ................................... 7
  47.           Error Messages ......................................... 7
  48.                Not a .ZIP File:<FileName> ........................ 8
  49.                Comment header not found:<FileName> ............... 8
  50.                Access Denied:<FileName> .......................... 8
  51.                Could not read:<FileName> ......................... 8
  52.           The Future. ............................................ 9
  53.           Contacting the Author. ................................. 9
  54.  
  55.  
  56.      ──────────────────────────────────────────────────────────────────────
  57.      ZIP Brand FAST! v1.1 User Documentation.                        Page 1
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                     INTRODUCTION.
  65.                        ───────────────────────────────────────
  66.  
  67.      If you run a BBS or  ever used the -z switch  with your ZIP utility,  you
  68.      will know what to use this utility for.
  69.  
  70.      This is a small program to safely and quickly brand your ZIP files with a
  71.      comment of your choice.  The typical speed is  10-30 files a second.  (50
  72.      files a second with the 32bit OS/2 version on HPFS volumes.) This is more
  73.      than 10 times faster  than PKZIP v2, and  about 50-100 times faster  than
  74.      Info Zip, depending on the file  size. The file comment is taken  from an
  75.      arbitrary file. It can  be text ANSI or  even "binary". The program  will
  76.      search for uncommented zip files in a whole directory tree.
  77.  
  78.      As a file is branded, and if the  OS permits it, the seconds part  of the
  79.      file time is set to  64. This is to  avoid processing an already  branded
  80.      file when the program is run again  at a later moment. If you  donÆt like
  81.      this "feature", it can be easily disabled.
  82.  
  83.      This program is  safe to  use. If it  encounters any  problems with  your
  84.      file, nothing will be  done. It will not  write to any  file if it  isn't
  85.      100% sure of what it is doing.  The engine in this program has  been used
  86.      in local BBB's for more than a year now. Thousands and thousands of files
  87.      have been commented with it, and  it has NEVER damaged any file.  HOWEVER
  88.      THIS PROGRAM IS PROVIDED "AS IS", AND NO WARRANTIES AT ALL ARE GRANTED!
  89.  
  90.  
  91.  
  92.  
  93.                                   SOFTWARE LICENSE.
  94.                        ───────────────────────────────────────
  95.  
  96.      This program is shareware. Shareware means that you can freely distribute
  97.      the COMPLETE program package to others, and that you have the opportunity
  98.      to test it for a period of 30 days  before you decide if you want  to buy
  99.      it. If you are going to use the program after this evaluation period, you
  100.      have to register and pay for it!  The registration fee is 10 US$  and can
  101.      be paid in  almost any currency  you like. (I  don't accept  Ulzugistanic
  102.      Squinnies!) The  registration is  valid for  all future  releases of  ZIP
  103.      Brand FAST!. Cooperate  users can contact  me to negotiate  about a  site
  104.      licence. See the file ORDER.FRM for more information.
  105.  
  106.      THIS PROGRAM IS PROVIDED "AS IS",  AND NO WARRANTIES AT ALL ARE  GRANTED!
  107.      NONE AT  ALL.  I DO  NOT  WARRANT THAT  THE  SOFTWARE IS  ERROR  FREE.  I
  108.      DISCLAIMS ALL WARRANTIES WITH RESPECT TO THE SOFTWARE, EITHER  EXPRESS OR
  109.      IMPLIED,  INCLUDING   BUT   NOT   LIMITED  TO   IMPLIED   WARRANTIES   OF
  110.      MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND  NONINFRINGEMENT OF
  111.      THIRD PARTY RIGHTS.
  112.  
  113.      ──────────────────────────────────────────────────────────────────────
  114.      ZIP Brand FAST! v1.1 User Documentation.                        Page 2
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.      NO LIABILITY FOR CONSEQUENTIAL  DAMAGES.  IN NO  EVENT SHALL I BE  LIABLE
  122.      FOR CONSEQUENTIAL, INCIDENTAL OR INDIRECT DAMAGES OF ANY KIND ARISING OUT
  123.      OF THE DELIVERY, PERFORMANCE OR USE  OF THE SOFTWARE, EVEN IF I  HAS BEEN
  124.      ADVISED OF  THE  POSSIBILITY  OF SUCH  DAMAGES.    IN NO  EVENT  WILL  MY
  125.      LIABILITY FOR ANY CLAIM, WHETHER IN CONTRACT, TORT OR ANY OTHER THEORY OF
  126.      LIABILITY, EXCEED THE LICENSE FEE PAID FOR THE SOFTWARE. (Phew!)
  127.  
  128.  
  129.  
  130.                         BENEFITS OF REGISTERING THIS PROGRAM.
  131.                        ───────────────────────────────────────
  132.  
  133.      If you register this program, you  will help keeping a starving  computer
  134.      science student off the streets :-)
  135.  
  136.      Besides that, if you register this program as a single user, you  will be
  137.      granted the right to install and use it on any computer you wish, as long
  138.      as you are the only one who uses it. You will be notified  of upgrades if
  139.      you are reachable by electronic mail. You will also be prioritised if you
  140.      have any need for technical assistance, or have any questions.
  141.  
  142.      The registered version of the program does not print the (huge) shareware
  143.      message after each run, and it does not add the  invisible "unregistered"
  144.      notice at the very end of the zip file.
  145.  
  146.      This notice does not damage the file in any way. It does NOT show up when
  147.      you unzip or in any other way processes the file. It can only bee seen if
  148.      you view the file with a hex viewer. It disappears completely at the very
  149.      moment you update the file  with a tool other  than ZIP Brand FAST!  It's
  150.      only purpose is to make it more worthwhile to register this program.
  151.  
  152.      However, there is no way of telling the difference between a file branded
  153.      with PKZIP or  a file branded  with the REGISTERED  version of ZIP  Brand
  154.      FAST!.
  155.  
  156.  
  157.  
  158.                       ROTECTING AGAINST TAMPERING, VIRUSES ETC.
  159.                        ───────────────────────────────────────
  160.  
  161.      If you want to  make sure that the  program is not  tampered with in  any
  162.      way, the PGP (Pretty Good Privacy) 2.3a Signature is enclosed in the file
  163.      ZIPBRAND.SIG. If you don't have my Public Key, drop me a line, and I will
  164.      send it to you.
  165.  
  166.      Note that this signature  is only valid for  the shareware version.  When
  167.      you install your name and serial number in it, the program is changed.
  168.  
  169.  
  170.      ──────────────────────────────────────────────────────────────────────
  171.      ZIP Brand FAST! v1.1 User Documentation.                        Page 3
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.      If you use PGP, you will know  how to verify this program. For  those who
  179.      don't: There are  no other secure  way of detecting  tampering with  this
  180.      file than by using PGP. All  other methods can be  forged. PGP is one  of
  181.      the most secure and easiest way  to communicate with encrypted or  signed
  182.      messages. It is free and can be obtained from almost anywhere. Definitely
  183.      worth a look!
  184.  
  185.      The program also  does a  pretty secure self  check at  start-up. If  the
  186.      program is tampered with, by a  virus or by some amateur hacker,  it will
  187.      simply not run.
  188.  
  189.  
  190.  
  191.                                     INSTALLATION.
  192.                        ───────────────────────────────────────
  193.  
  194.      This program does not  really require a installation,  but I'll tell  you
  195.      how to use it anyway.
  196.  
  197.      Copy the file ZIPBRAND.EXE to a directory of your choice. If  you haven't
  198.      got a comment file, create one now. Use the file ZIPBRAND.CMT included in
  199.      this archive as an example. The preferred location of this file is in the
  200.      same directory as ZIPBRAND.EXE, but anywhere will do, but if this comment
  201.      isn't in the same directory as ZIPBRAND.EXE, or in the  current directory
  202.      when the program is run, you will have to specify the path to it with the
  203.      parameter [CommentFile].
  204.  
  205.      If you use a parameter frequently, it is an good idea to place  it in the
  206.      environment variable ZIPBRAND. Add a line containing the DOS  SET command
  207.      to your AUTOEXEC.BAT. (e.g. SET ZIPBRAND=/D c:\BANNERS\BBS.TXT)  See your
  208.      DOS  documentation  for  more  information  about  the  SET  command  and
  209.      AUTOEXEC.BAT.
  210.  
  211.      If you have registered  the program you  may want to  run ZIPBRAND /E  to
  212.      install your name and serial number  in your copy of ZIPBRAND.EXE and  to
  213.      transform it into the  registered version. If you  have the OS/2  version
  214.      you must run the file ZIPBRREG.CMD instead.
  215.  
  216.  
  217.  
  218.                               USING PROGRAM ARGUMENTS.
  219.                        ───────────────────────────────────────
  220.  
  221.      Note that all arguments are optional and the order is arbitrary. They
  222.      MUST, however, be separated with a space. All arguments, except for the
  223.      >>{LogFileName} can be put in a environment variable called ZIPBRAND. Use
  224.      the SET ZIPBRAND= command  to do this. See your DOS documentation for
  225.      more information about environment variables.
  226.  
  227.      ──────────────────────────────────────────────────────────────────────
  228.      ZIP Brand FAST! v1.1 User Documentation.                        Page 4
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.      Command line syntax:
  237.      ────────────────────
  238.      ZIPBRAND  [{StartPath}] [{CommentFile}] [/V] [[/R] | [[/O] | [/T]]]
  239.                [/B{bytes}] [/D] [>>{LogFileName}]
  240.  
  241.      or ZIPBRAND /E [/D]
  242.      or ZIPBRAND /? [/D]
  243.  
  244.      Note that the /D and the /E  switch is not supported in the  OS/2 version
  245.      of the program.
  246.  
  247.  
  248.  
  249.                    DETAILED DESCRIPTION OF ALL PROGRAM ARGUMENTS.
  250.                        ───────────────────────────────────────
  251.  
  252.      StartPath
  253.      ─────────
  254.      Any directory specified on the command line will indicate the  path where
  255.      the program  will start branding files. All files with the extension .ZIP
  256.      in all sub directories will be processed.
  257.  
  258.      The default is the current directory.
  259.  
  260.      CommentFile
  261.      ───────────
  262.      Any filename specified on  the command line will  indicate what file  the
  263.      comment is to be  taken from. This file  can be of any  type, but a  text
  264.      file is naturally preferred. This file must be of the same format  as for
  265.      the PKZIP utility. This means that  you must have an empty line  first in
  266.      the file to make it display properly. The limit of the comment is 8kb. If
  267.      it is bigger, it will be truncated without any warning. Please send  me a
  268.      note if this limit is too small.
  269.  
  270.      The default  is ZIPBRAND.CMT  in the  current  directory. If  it  doesn't
  271.      exist, the file in the program directory is used.
  272.  
  273.      /V (Verbose)
  274.      ────────────
  275.      Makes the program show some more  output. Both the comment and the  files
  276.      processed will be listed. Can be used with the >>{LogFileName}  option to
  277.      create a complete log  of files processed. The  use of this switch  slows
  278.      down program execution a bit.
  279.  
  280.      The default  is that  only error  messages  and the  file count  will  be
  281.      displayed.
  282.  
  283.  
  284.      ──────────────────────────────────────────────────────────────────────
  285.      ZIP Brand FAST! v1.1 User Documentation.                        Page 5
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.      /I (Ignore file attributes)
  293.      ───────────────────────────
  294.      This switch tells the program to  reset the file attribute before  trying
  295.      to brand the file.  The attribute is reset  to it's original value  after
  296.      the file has been branded.
  297.  
  298.      Use this  switch first  if you  get  the Access  Denied:<FileName>  error
  299.      message.
  300.  
  301.      /R (Reprocess)
  302.      ──────────────
  303.      This switch tells the program that all ZIP files, already branded or not,
  304.      will be reprocessed. This is useful if you want to brand the  ZIPs with a
  305.      different comment.
  306.  
  307.      /O (Old Time Stamp)
  308.      ──────────────────
  309.      This switch is for those who prefer the old way (prior to version 1.1) of
  310.      marking the files as branded. This  was done by setting the file  time to
  311.      00:00:00. This has  the advantage that  it shows in  a directory  listing
  312.      which files which are branded, and which are not.
  313.  
  314.      This is the default if your operating or file system does not  permit the
  315.      setting of "invalid" file times. (OS/2 as an example.)
  316.  
  317.      /T (No Time Stamp)
  318.      ──────────────────
  319.      This switch stops the program from messing with the file time at  all. If
  320.      you use this switch, the  program has no way  of telling which files  are
  321.      already branded, so all files will  be reprocessed each time the  program
  322.      is run.
  323.  
  324.      >>{LogFileName} (LogFile)
  325.      ─────────────────────────
  326.      Appends the action log  to the file {LogFileName}.  Included in this  log
  327.      are the  time  and date  when  run,  command line  arguments,  the  error
  328.      messages and statistics. Use in conjunction with the /V switch to include
  329.      all files processed in this log.
  330.  
  331.      Note that this  option is a  DOS pipe operator,  and therefore cannot  be
  332.      included in the environment variable ZIPBRAND.
  333.  
  334.      /B (Block Read Size)
  335.      ────────────────────
  336.      This switch tells the program what block size (in bytes) to use  for read
  337.      operations. This is to fine tune the performance on individual systems.
  338.  
  339.  
  340.  
  341.      ──────────────────────────────────────────────────────────────────────
  342.      ZIP Brand FAST! v1.1 User Documentation.                        Page 6
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.      The optimal  value depends  on your  HD and  cache  configuration, but  a
  350.      suggestion will be a value right above the size of the original comment.
  351.  
  352.      The default is 2048 bytes. Valid values are in the range 256-12288 bytes.
  353.  
  354.      /D (No Direct Video Writes)
  355.      ───────────────────────────
  356.      Use "slow"  BIOS  write  for  screen  updates. Use  this  switch  if  you
  357.      encounter any problems with  your display. It might  be necessary to  use
  358.      this switch  to make  certain screen  scroll back  utilities capture  the
  359.      output from this program.
  360.      The use of  this switch slows  down program execution  a bit,  especially
  361.      when the /V option is used too.
  362.  
  363.      The default is to write directly to video ram.
  364.  
  365.      This switch has  no effect in  the OS/2 version,  since there is  nothing
  366.      called  "writing directly" to anywhere in a real operating system.
  367.  
  368.      /E (rEgister)
  369.      ─────────────
  370.      Use this switch to transform your  copy of the program into a  registered
  371.      version, and to  install your name  and serial number  in it. Follow  the
  372.      instructions given.  Note that the name must be typed in exactly as it is
  373.      printed on the registration certificate. The case IS significant.
  374.  
  375.      If the  program already  is registered,  the name  and  serial number  is
  376.      removed, and the program is changed back to the shareware version.
  377.  
  378.      Note that this switch causes the  ZIPBRAND.EXE executable to be  changed,
  379.      so you may have to reinstall certain anti virus utilities.
  380.  
  381.      This switch is not supported in  the OS/2 version. You will instead  have
  382.      to use the script ZIPBRREG.CMD to register your copy of ZIP Brand FAST!
  383.  
  384.      /? or /H (Help)
  385.      ───────────────
  386.      Displays a brief help  on how to use  the program, including all  command
  387.      line arguments.
  388.  
  389.  
  390.  
  391.                                    ERROR MESSAGES
  392.                        ───────────────────────────────────────
  393.  
  394.      Only the  error  messages concerning  the  processing of  zip  files  are
  395.      mentioned here. All the other messages are fairly self explaining.
  396.  
  397.  
  398.      ──────────────────────────────────────────────────────────────────────
  399.      ZIP Brand FAST! v1.1 User Documentation.                        Page 7
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.      Not a .ZIP File:<FileName>
  408.      ──────────────────────────
  409.      The file has  a .ZIP extension,  but was  not recognised as  a valid  zip
  410.      file. ZIP  Brand FAST!  uses a  very quick  method for  checking for  ZIP
  411.      files, so you get  this error message  if the file  is a self  extraction
  412.      archive renamed from  .EXE to .ZIP,  even though PKZIP  and Info ZIP  can
  413.      handle these files.
  414.  
  415.      Solution: Try to run PKZIPFIX (or Info ZIP with the switch  -F or -FF) on
  416.      the file first.  If the error  still occurs, rename,  move or delete  the
  417.      file.
  418.  
  419.      Comment header not found:<FileName>
  420.      ───────────────────────────────────
  421.      The file was recognised as a zip file, but the program could not find the
  422.      end of central dir record. This  is probably because the file has  an old
  423.      comment which is bigger than 24kb, or it has been damaged or  modified by
  424.      some other zip file utility.
  425.  
  426.      Solution: Run your zip  utility with  the parameter -z  on the  file   to
  427.      reconstruct the end of central dir  record. [PK]ZIP -z FileName <NUL.  If
  428.      the error still occurs, run PKZIPFIX (or Info Zip with the switch -F or -
  429.      FF) on the file.
  430.  
  431.      Access Denied:<FileName>
  432.      ────────────────────────
  433.      The file could not  be opened for reading  and writing. This is  probably
  434.      because the  file is  flagged as  read only,  or some  other process  has
  435.      opened and locked the file.
  436.  
  437.      Solution: Make sure that the file does  not have the Read-only  or System
  438.      attribute set, or run the program with the /I switch.
  439.      If the file still gets this error message, try running the  program again
  440.      at a later time or close the process which has locked the file.
  441.  
  442.      Could not read:<FileName>
  443.      ─────────────────────────
  444.      The file was successfully  opened and recognised as  a zip file, but  the
  445.      program was not able to continue  to read from it.  This is a very,  very
  446.      rare situation and will probably only happen if your operating  system is
  447.      at an  unstable  state.  (Or  if  you discover  an  unknown  bug  in  the
  448.      program...)
  449.  
  450.      Solution: Reboot the operating  system. Please notify  the author if  you
  451.      get this error message.
  452.  
  453.  
  454.  
  455.      ──────────────────────────────────────────────────────────────────────
  456.      ZIP Brand FAST! v1.1 User Documentation.                        Page 8
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.                                      THE FUTURE.
  464.                        ───────────────────────────────────────
  465.  
  466.      Support for  self extracting  archives (ZIP2EXE)  might  be included.  If
  467.      anyone could provide me  with a fast and  reliable way of detecting  such
  468.      archives (I do  not want  to search  the entire  file), this  is easy  to
  469.      implement.
  470.  
  471.      The support for other archive types (e.g. ARJ) might also be  included in
  472.      future releases if I find a quick way to process them and if the interest
  473.      is big enough.
  474.  
  475.      But if you have any comments or suggestions of improvements of  your own,
  476.      please drop me a  line, and I will  see what I can  do about it. This  is
  477.      especially true  for bug  reports. Don't  just  think that  someone  else
  478.      already have  notified me  about it,  because  the odd  thing is  -  they
  479.      didn't!
  480.  
  481.  
  482.  
  483.                                CONTACTING THE AUTHOR
  484.                        ───────────────────────────────────────
  485.  
  486.      Any questions, suggestions or comments can  be directed to the author  in
  487.      any of the following ways:
  488.  
  489.      By ordinary mail:
  490.           Ketil Kintel
  491.           ZIP Brand FAST!
  492.           Dr. Frostadsg. 34
  493.           N-8650 Mosjoen
  494.           Norway
  495.  
  496.      Or by electronic mail: (preferred)
  497.           Internet   : kintel@hsr.no
  498.           X.400      : S=kintel;OU=ifi;O=hsr;P=uninett;A=uninett;C=no;
  499.           Various Norwegian BBS Networks:  Ketil Kintel@alp
  500.  
  501.           For those who care about privacy, my PGP 2.3 Public Key is available
  502.           on request, from me or from any Public Keys Server.
  503.  
  504.      Remember to include your name and  serial number if you are a  registered
  505.      user.
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.      ──────────────────────────────────────────────────────────────────────
  513.      ZIP Brand FAST! v1.1 User Documentation.                        Page 9
  514.