home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / COMPRESS / PKINS402.ZIP / PKINSERT.DOC < prev    next >
Encoding:
Text File  |  1990-04-16  |  14.4 KB  |  362 lines
  1.  
  2.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  3.                                  April 17, 1990
  4.  
  5.      In  the beginning...   PKinsert  was designed  to  delete !HISTORY.DIS
  6.      files from other BBS's and  insert an archive comment (archive opening
  7.      screen) from  my BBS.   Most SysOps  will appreciate  this program and
  8.      maybe a few individuals  who normally take the  time to inscribe their
  9.      name on a file before Uploading it.   Something to take note of is the
  10.      fact  that  it  is  designed  for  the  ZIP  format  v1.00  and higher
  11.      (hopefully).  At the  time of writing  this program I  was using PKZIP
  12.      v1.10.
  13.  
  14.      I haven't 'crippled'  this software in  any way and  I'm not expecting
  15.      you to  register it.  I  have enough  problems trying to  get users to
  16.      donate! <Grin>
  17.  
  18.                                 COPYRIGHT Notice
  19.                                 ────────────────
  20.  
  21.          The  documentation  and  software  included  in  the original
  22.          PKINS402.ZIP archive herein after referred to as PKinsert are
  23.          copyrighted with  all rights  reserved to  7th Illusion Enrg.
  24.          PKinsert  may not  be  copied in  whole  or in  part, without
  25.          written consent from  7th Illusion Enrg.   You  may not sell,
  26.          rent, nor  lease copies  of PKinsert  in any  way without the
  27.          prior  written consent of 7th  Illusion Enrg. PKinsert may be
  28.          distributed  FREE  OF  CHARGE  by  modem  or  other  telecom-
  29.          munication means.
  30.  
  31.                                    DISCLAIMER
  32.                                    ──────────
  33.  
  34.          7TH  ILLUSION ENRG.  MAKES  NO REPRESENTATIONS  OR WARRANTIES
  35.          WITH  RESPECT   TO  THE  CONTENTS   HEREOF  AND  SPECIFICALLY
  36.          DISCLAIMS  ANY  IMPLIED   WARRANTIES  OF  MERCHANTABILITY  OR
  37.          FITNESS FOR  ANY PARTICULAR  PURPOSE.  Further,  7th Illusion
  38.          Enrg. reserves the right to revise these documentation and to
  39.          make changes from time to  time in the content hereof without
  40.          obligation of 7th Illusion Enrg. to notify any person of such
  41.          revision or changes.
  42.  
  43.      Files included in this package:
  44.  
  45.          PKINSERT.DOC
  46.          PKINSERT.DAT
  47.          PKINSERT.EXE
  48.          ILLUSION.DIS
  49.  
  50.      If you are missing any of these files you can pick up an original copy
  51.      from 7th ILLUSION under the name of PKINS402.ZIP.
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                      Page 1
  61.      
  62.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  63.                                  April 17, 1990
  64.  
  65.                                   REQUIREMENTS
  66.                                   ────────────
  67.  
  68.      You should set a DOS PATH to the following files:
  69.  
  70.          PKZIP.EXE     (C)1989-1990 PKWARE Inc
  71.          PKUNZIP.EXE
  72.          SCAN.EXE      Virus Scanner (C)1989-1990 McAfee Associates
  73.  
  74.      Any DOS book  can tell you  how to do  this but as  a quick review you
  75.      should have a line like this one in your AUTOEXEC.BAT file:
  76.  
  77.          PATH=[Drive]\[Path]
  78.  
  79.      If you already have a value here you can add a second, third, etc. by
  80.      using semi-colons.  Example:
  81.  
  82.          PATH=[Drive]\[Path];[Drive]\[Path]
  83.  
  84.                               CONFIGURING PKINSERT
  85.                               ────────────────────
  86.  
  87.      This is very simple.   What you should do first  is copy all the files
  88.      of this package to a safe directory such as C:\PKINSERT.
  89.  
  90.      When using PKinsert you will most probably call it up from a path.  To
  91.      speed up things PKinsert does  not search through your directories and
  92.      drives for it's CFG file.   PKinsert looks for an environment variable
  93.      called PKINSCFG to find it's configuration file.  You should edit your
  94.      AUTOEXEC.BAT file and add this line:
  95.  
  96.          SET PKINSCFG=[Drive]\[Directory]
  97.  
  98.          Notice THERE IS NO TRAILING BACKSLASH.
  99.  
  100.      Actually setting up the configuration file is pretty easy.  Just type:
  101.  
  102.          PKINSERT /CONFIG
  103.  
  104.      The PKINSCFG environment variable  may or may not  be present for this
  105.      step.
  106.  
  107.      All  the  questions  asked  are  briefly  explained  during  PKinserts
  108.      configuration so I won't go and explain it all again.  There ARE a few
  109.      points I would like to discuss about setting up PKinsert.
  110.  
  111.      PKinserts work drive
  112.      ────────────────────
  113.      I've  added  this  feature  since I  received  a  few  complaints that
  114.      PKinsert was a little slow.  I have to admit it is.  PKinsert calls up
  115.      PKZIP and PKUNZIP quite a few  times and as everyone knows PKZIP isn't
  116.      the  fastest program  in  the world!   With  the addition  of  a Virus
  117.      scanning routine the hole thing was painfully slow.
  118.  
  119.  
  120.                                      Page 2
  121.      
  122.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  123.                                  April 17, 1990
  124.  
  125.      Rejoice if you have an AT with more than 1 Meg!  PKinsert will ask you
  126.      which drive it should  use to set up  temporary files and directories.
  127.      It will  also direct PKZIP  and SCAN to  use this same  drive.  If you
  128.      have over 1 Meg of Ram I would  suggest using it as a Ram Drive.  Most
  129.      good DOS reference books will tell  you how to install one quickly and
  130.      easily.  The  cost of a  1 Meg  Ram Drive is  about 600  bytes for the
  131.      driver.
  132.  
  133.      To  further  enhance  the  speed  of  PKinsert  you  should  also  let
  134.      PKZIP/UNZIP know that you have  a Ram-Drive.  The following command is
  135.      also covered in the original documentation which accompanies PKZIP but
  136.      as a refresher I will again point it out.
  137.  
  138.      Edit your AUTOEXEC and add this line:
  139.  
  140.          SET PKTMP=<Drive>
  141.  
  142.      As an example, the value I use is:
  143.  
  144.          SET PKTMP=E:
  145.  
  146.      PKZIP  will  create  all  temporary   files  on  your  Ram-Drive  thus
  147.      increasing the  speed of PKinsert's  processing.  Not  to mention that
  148.      it'll come in handy for your own archiving too! <Grin>.
  149.  
  150.      Default file spec to use
  151.      ────────────────────────
  152.      Usually you  will want to  leave this at  [ZIP] but in  case you don't
  153.      follow the standard of ZIP I've left it open to change.  When you call
  154.      up PKinsert you can specify command line options for files such as:
  155.  
  156.          PKINSERT *.EXE D:\FILES\*.ZIP C:\WORK\PK??-A.ZIP etc.
  157.  
  158.      On an average run though you will mostly be inserting comments in ZIP
  159.      files.  You can therefore simply type:
  160.  
  161.          PKINSERT
  162.  
  163.      And  Pkinsert will  use the  default file  spec in  it's configuration
  164.      file.  It saves a bit of typing. ;-)
  165.  
  166.      Test files before processing
  167.      ────────────────────────────
  168.      This  is  VERY  important.   To save  time  PKinsert  only  checks the
  169.      archives  integrity  once  before  doing  anything  else.   If  you're
  170.      positive PKinsert won't encounter corrupted  archives you can set this
  171.      to No.   Bad archives  will be  kept under  another extension  you can
  172.      specify.
  173.  
  174.      Check Archives for Viruses
  175.      ──────────────────────────
  176.      Finally!  It took a  bit of work but  PKinsert will now check archives
  177.      for viruses.  At  the time I  wrote PKinsert v4.02  there was only one
  178.      virus  scanner  which truly  out  did  any other.   PKinsert  will use
  179.  
  180.                                      Page 3
  181.      
  182.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  183.                                  April 17, 1990
  184.  
  185.      SCAN.EXE from McAfee Associates.   You can pick up  a copy from almost
  186.      any good board as SCANVxx.ZIP.
  187.  
  188.      Those of you without the luxury of a Ram Disk might find this a little
  189.      disk intensive not to mention long <Grin>.
  190.  
  191.      PKinserts DAT File
  192.      ──────────────────
  193.      The PKINSERT.DAT file can  be changed to your  liking.  This text file
  194.      will be inserted as the archives 'opening screen'.
  195.  
  196.      A couple of  notes on it's  construction.  Use ANSI  codes only if you
  197.      have to.  Most users don't know about PKZIPs '-q' switch.  If you make
  198.      it longer than 23 lines it'll probably flash by to fast to read it.
  199.  
  200.      Be  as creative  as  you want.   SysOps  always enjoy  a  good graphic
  201.      competition.
  202.  
  203.      Disclaimer files to be deleted
  204.      ──────────────────────────────
  205.      Before your disclaimer file is inserted PKinsert will deleted those of
  206.      other boards.  Separate every value with a space.  Wild cards are ok.
  207.  
  208.      Example:
  209.  
  210.          !HIST*.* !*.BBS !*.DIS !*.FIL
  211.  
  212.      Be careful of the values you enter here.  In one archive it might be a
  213.      BBS disclaimer but  in another it could  be an important documentation
  214.      file.
  215.  
  216.      Insert disclaimer in archive
  217.      ────────────────────────────
  218.      Of course for most  SysOps having an opening  screen in the archive is
  219.      enough but others might  actually have something to  say in which case
  220.      PKinsert will ask you  for the path to  your disclaimer and it's name.
  221.      Try to conform to the standard if you're going to insert a disclaimer.
  222.      You might just over-write another file if you don't.
  223.  
  224.      TAGLINE environment setting
  225.      ───────────────────────────
  226.      Here's a  special feature  for you PCBoard  SysOps.  If  your BBS uses
  227.      ProDoor  you  are  probably  aware   that  Prodoor  uses  the  TAGLINE
  228.      environment  variable.   To  use  this feature  you  can  use  the SET
  229.      command.  Prodoor uses this value at the end of every message.
  230.  
  231.          SET TAGLINE=Don't worry.  It's only ones and zeros!
  232.  
  233.      Programs have already  been written to alternate  taglines.  I use one
  234.      of these to set a new tagline every time my computer boots up.
  235.  
  236.      If you choose  to use this  feature your archives  will be tagged with
  237.      TAGLINEs value.  It's a nice touch I think ;-)
  238.  
  239.  
  240.                                      Page 4
  241.      
  242.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  243.                                  April 17, 1990
  244.  
  245.                                  USING PKINSERT
  246.                                  ──────────────
  247.  
  248.      You can call up PKinsert without  any command line options and it will
  249.      use the default value in it's  configuration file.  But if you want to
  250.      insert  comments in  specific  files you  can  type them  on  the same
  251.      command line.  An example of this would be:
  252.  
  253.          PKINSERT testzip1.* game???.* selfex.exe *-2.* d:\main\this1*.2??
  254.  
  255.      That's about all there is to  it.  If you configured PKinsert properly
  256.      you should have no problems.
  257.  
  258.  
  259.                       POSSIBLE PROBLEMS AND BUG REPORTING
  260.                       ───────────────────────────────────
  261.  
  262.      Well, this is DOS.  Although you can do much, you can't do EVERYTHING.
  263.      In an effort to make the hole process faster I had to pack the command
  264.      line I was passing on to  PKZIP.  This doesn't leave infinite room for
  265.      endless   sub-directory   structures.   If   your   archives   are  10
  266.      sub-directories away I would think of  moving them closer, I doubt DOS
  267.      will take a command that long.
  268.  
  269.      Like  any other  program PKinsert  wasn't written  by a  computer.  It
  270.      COULD and  probably does contain  a bug  or two.  If  you experience a
  271.      break in PKinserts activities here's what you should do.
  272.  
  273.      Make  a quick  note  about where  PKinsert  stopped (The  file number,
  274.      directory name, and it's  last message).  Look for  a directory on the
  275.      work drive  you specified  named PKWRK.  If  it exists  write down the
  276.      files you found in it as well  as the directories branching off of it.
  277.      Then get rid of those files and directories.
  278.  
  279.      Once you got all that give 7th  Illusion a call and leave me a message
  280.      care of 'Storm Widow'.
  281.  
  282.                               IN MY OPINION . . .
  283.                               ───────────────────
  284.  
  285.      I couldn't resist a little note  here on the advertisements which have
  286.      plagued  the   BBS  community  since   god  knows.    Let's  face  it,
  287.      !HISTORY.DIS files are no longer needed.  Archive opening screens take
  288.      up less space and the users are sure to see them.
  289.  
  290.      Although I have  written PKinsert to  insert a disclaimer  of any name
  291.      you wish, you should think twice  before trying to set a new standard.
  292.      I  have found  some archives  with over  5 different  disclaimers (out
  293.      numbering the programs  files!).  The hole purpose  of archiving is to
  294.      make files smaller, not bigger!
  295.  
  296.                                                  J.S. Morisset
  297.                                                  a.k.a. Storm Widow
  298.  
  299.  
  300.                                      Page 5
  301.      
  302.                     PKinsert v4.02 (C)1990 7th ILLUSION Enrg.
  303.                                  April 17, 1990
  304.  
  305.                                 PKINSERT HISTORY
  306.                                 ────────────────
  307.  
  308.      v1.01 to v2.00
  309.      All these versions where intricate batch  files.  I have left the last
  310.      version (2.00) available for downloading.
  311.  
  312.      v3.0ß
  313.      Re-wrote the  hole program in  Quick Basic!   Everything is different.
  314.      I've dropped  the support  for ARC  and don't  plan to  go back.  This
  315.      version was not distributed.
  316.  
  317.  
  318.      v3.1ß
  319.      Got rid of a few bugs.  The timer feature in v3.0 wasn't working and I
  320.      got rid of it.  Also shortened  much of PKinsert's output.  Now uses a
  321.      single line to let the user know what's happening.
  322.  
  323.      NUM:  NUMber of files PKinsert has processed so far.
  324.      FN:   File Name it is currently working on.
  325.      DIR:  DIRectory where file is situated.
  326.  
  327.      Error trapping is  also much improved!   Let's hope it  won't need it.
  328.      <Ugg>
  329.  
  330.      v3.20
  331.      Added  support  for  DOSv4.0.    Uses  prodoor's  TAGLINE  environment
  332.      variable.  Will now skip the archive test if set to [N]o. <Grin>.
  333.  
  334.      v4.00
  335.      PKinsert now works  with DOS4! ;-)  Corrupted  archives are caught and
  336.      renamed.   Virus checking  is also  possible using  McAfee Associates'
  337.      SCAN.EXE program.  Work  drive can be  selected for quicker processing
  338.      on  a RAM  Drive.   Configuration is  now  internal.  No  more messin'
  339.      around with a  word processor.  And  last but not  least PKinsert goes
  340.      COLOUR!
  341.  
  342.      v4.02
  343.      Fixed the  colours in  PKinserts logo.   Also fixed  a variable  I had
  344.      forgotten about.  PKinsert will now process numerous file specs again!
  345.      <Grin>.  PKTMP environment variable is now external.
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                      Page 6
  361.      
  362.