home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / arc_lbr / arcruner.arc / ARCRUNER.DOC < prev    next >
Text File  |  1988-05-09  |  16KB  |  439 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                              ARCRUNNER Version 1.0
  25.  
  26.                          Archive Library Files Utility
  27.  
  28.                                      from
  29.  
  30.                               MILLENNIUM Software
  31.  
  32.                                   May 9, 1988
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                              Copyright (c) 1988 by
  57.  
  58.                               MILLENNIUM Software
  59.  
  60.                               All Rights Reserved
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                                                       ARCRUNNER    Page  1
  74.  
  75.  
  76.  
  77.               PURPOSE:
  78.  
  79.               ARCRUNNER is a supplemental archive utility designed to
  80.               give you the  capability to run any file stored away in
  81.               ARC  type library files without having to first extract
  82.               them to their decompressed form. ARCRUNNER was designed
  83.               to be used in conjunction with Phil Katz's compression/
  84.               extraction system, PKARC/PKXARC.
  85.  
  86.               ARCRUNNER is the necessary result of the combination of
  87.               two different types of space saving storage techniques,
  88.               user defined and built libraries and file  compression/
  89.               decompression. On my system and on many others there is
  90.               an over abundance of useful, but small,  programs which
  91.               take up a  relatively large area of a disk,  especially
  92.               hard disks.  Since the  minimum allocation  on any hard
  93.               disk system is 2048 bytes (it can be as high as 4096 or
  94.               even 8192 on specific systems),  a program only several
  95.               hundred bytes long is extremely inefficient  when it is
  96.               stored.  Batch files  are a notorious example.  Library
  97.               files have been  around for a long time.  Microsoft has
  98.               allowed you to build user defined libraries for several
  99.               of its utilities, but you are severely limited on their
  100.               actual  usage.  Archive  compression/decompression  has
  101.               also been around awhile. It, of course, was created out
  102.               of the need to reduce electronic transmission time. Now
  103.               using file compression/decompression programs,  you can
  104.               create a  user defined  library  in compressed form and
  105.               rid yourself  of all those  small inefficient files you
  106.               have cluttering up your disks,  then,  using ARCRUNNER,
  107.               you may invoke  those files from  within the compressed
  108.               file.
  109.  
  110.  
  111.  
  112.               TECHNICAL INFORMATION & SOFTWARE REQUIREMENTS:
  113.  
  114.               ARCRUNNER  was developed in 8086/8088 assembly language
  115.               (using Microsoft's Macro Assembler MASM version 5.0 and
  116.               supporting utilities LINK, MAKE, and CODEVIEW). Initial
  117.               development and testing was on a  TANDY 1000A, equipped
  118.               with a hard card type fixed disk, and EMS-5150 expanded
  119.               memory board. ARCRUNNER is designed to operate with the
  120.               following software:
  121.  
  122.                    PKARC/PKXARC -  File compression/extraction system
  123.                                    utilities by Phil Katz
  124.                    ARCMASTER    -  An  archive file management system
  125.                                    designed to enhance the use of the
  126.                                    compression/extraction utilities
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                                                       ARCRUNNER    Page  2
  140.  
  141.  
  142.  
  143.               TECHNICAL INFORMATION & SOFTWARE REQUIREMENTS (cont'd):
  144.  
  145.               You must have the program file PKXARC on your system in
  146.               order for ARCRUNNER to function. ARCMASTER, even though
  147.               not absolutely necessary, is highly recommended for the
  148.               ease of maintenance of the archived library files them-
  149.               selves.  ARCRUNNER  does not, at this time, support the
  150.               file compression/extraction program known as ARC5xx, by
  151.               System Enhancement Associate's (SEA).
  152.  
  153.  
  154.               CREDITS
  155.  
  156.               As with ARCMASTER above, ARCRUNNER  rests upon the great
  157.               work of the extremely talented programmer:  Phil Katz of
  158.               PKWARE, author of the  PKARC/PKXARC utilities.  Users of
  159.               his utilities are urged to support him through registra-
  160.               tion.
  161.  
  162.                    PKARC & PKXARC  are copyrighted products of PKWARE.
  163.                    ARCMASTER     is a copyrighted product of New-Ware.
  164.  
  165.               Special thanks to  John Newlin of New-Ware for his hints
  166.               on programming techniques and also the  encouragement to
  167.               publish this by the Shareware method. Users of ARCMASTER
  168.               are also highly encouraged to support him through regis-
  169.               tration.
  170.  
  171.  
  172.               INSTALLATION of ARCRUNNER:
  173.  
  174.               Installing ARCRUNNER for use is rather easy and straight
  175.               forward:
  176.  
  177.               1) Place the program file, ARCRUNER.COM in any directory
  178.                  on any system drive you choose,  preferably,  but not
  179.                  necessarily, the same drive/directory as the archival
  180.                  system files PKARC/PKXARC.
  181.               2) Ensure that the archival system files,  PKARC/PKXARC,
  182.                  are located in the current default drive/directory or
  183.                  in a drive/directory defined in the  DOS  environment
  184.                  PATH string.
  185.               3) Ensure that PKXARC is named as above. You must rename
  186.                  it if necessary.
  187.               4) Ensure that  your various archived libraries are also
  188.                  either located in the current default drive/directory
  189.                  or a drive/directory defined in the  DOS  environment
  190.                  PATH string.
  191.               5) It is highly recommended but not necessary to shorten
  192.                  the name of ARCRUNER.COM to AK.COM.  This will reduce
  193.                  the number of keystrokes needed on the command line.
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.                                                       ARCRUNNER    Page  3
  206.  
  207.  
  208.  
  209.               OPERATION of ARCRUNNER:
  210.  
  211.               ARCRUNNER  may be executed from the DOS command level, a
  212.               batch file, or from menu or shell programs.  It operates
  213.               satisfactory on floppy diskettes but it's primary use is
  214.               on a hard disk system. When properly executed, a program
  215.               header very similar to PKXARC's header will scroll on to
  216.               the screen, followed immediately by the  PKXARC  header.
  217.               Depending on the particular computer system, size of the
  218.               program to be extracted,  and the physical  media of the
  219.               drive/directory it is being directed to, a variable time
  220.               delay will be incurred as the file is extracted and pro-
  221.               cessed.  This delay to execution time  is the main price
  222.               you pay for the compressed storage benefits.   Next, the
  223.               program itself with whatever parameters, if any, it has,
  224.               is executed from whatever output  d:path\  was specified
  225.               on the command line,  or the current default d:path\, if
  226.               not specified.  Note, that the  system will  stay in the
  227.               current default  d:path\,  provided the executed program
  228.               doesn't change it, even though an output  d:path\ may be
  229.               specified.  Finally, upon program completion and exit to
  230.               DOS, the program file is deleted from the d:path\ it was
  231.               extracted to.  NOTE:  Programs which do not exit back to
  232.               DOS properly or which invoke system reboots,  may not be
  233.               deleted as per above. This is beyond ARCRUNNER's control
  234.               and  you will have to  delete the program file yourself.
  235.  
  236.  
  237.  
  238.               SYNTAX of ARCRUNNER:
  239.  
  240.           ARCRUNER [option] {[d:path\]library} {[d:path\]filename} params
  241.  
  242.                options:  -l = display software license
  243.                          -h = syntax help
  244.                d:path\   User specified drive/path
  245.                          Note: No spaces allowed after d:path\
  246.                library   Archive library file name
  247.                          Default extension is .ARC
  248.                filename  Name of program file to run
  249.                          Default extension is .COM
  250.                params    Parameters and/or switches necessary for the
  251.                          program file's initial execution
  252.  
  253.               Example:
  254.               Arcruner file c:\usrfiles\runtest.com b:
  255.               -will extract the program file runtest.com from file.arc
  256.               placing it in the usrfiles directory on drive c. It will
  257.               invoke it from the current drive/directory, and pass the
  258.               parameter b:
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                                                      ARCRUNNER    Page  4
  272.  
  273.  
  274.  
  275.               ARCRUNNER MESSAGES:
  276.  
  277.               When most errors are detected,  ARCRUNNER will display a
  278.               message pertaining to which error occured and then abort
  279.               to DOS if possible.  Also, PKXARC  will display it's own
  280.               error messages as it is invoked.  The listing below is a
  281.               summary  of error messages you may encounter  as you use
  282.               use ARCRUNNER.
  283.  
  284.               Archived Library File not found
  285.                  - The given archive file could not be found in any of
  286.                    the various drive/directories that  ARCRUNNER could
  287.                    access. Check that it exist in either the specified
  288.                    d:path\, current d:path\, or in a d:path\ specified
  289.                    in the DOS environment PATH string.
  290.  
  291.               File not found
  292.                  - the given compressed file could not be found within
  293.                    the archive library file. This error is usually due
  294.                    to extension differences  or a typo was made on the
  295.                    command line. If not, check your specified archived
  296.                    file, for the file's existence within it.
  297.  
  298.               Program too big to fit in memory
  299.                  - Occasionally, since  ARCRUNNER uses some 4000 bytes
  300.                    and invokes a 2nd copy of Command.Com, which itself
  301.                    uses an additional 26000 bytes or more depending on
  302.                    your DOS version, a program file which has been de-
  303.                    compressed will not fit into  the remaining memory.
  304.                    The only solutions are either to reduce your system
  305.                    configuration if possible, or add more memory if it
  306.                    can be increased. An expanded memory board would be
  307.                    a real plus.  If none of these solutions are avail-
  308.                    able to you, then that particular  program file can
  309.                    not be used in the archived library file.  Try Phil
  310.                    Katz's  PKSFX  self-extract utility  available with
  311.                    PKXARC 3.5.
  312.  
  313.               Bad environment or path too long
  314.                  - This error can occur obviously if a designated path
  315.                    is over 64 characters in length. Another reason can
  316.                    be a syntax error in the environment PATH string.
  317.  
  318.               Bad format
  319.                  - I've never seen this one invoked,  but since I used
  320.                    function 4Bh of the DOS services,  it is a possible
  321.                    return code, so I have included it also.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                                                       ARCRUNNER    Page  5
  338.  
  339.  
  340.  
  341.               ARCRUNNER MESSAGES (cont'd):
  342.  
  343.               DOS version 2.00 or later required
  344.                  - The DOS  version is checked prior to any other pro-
  345.                    cessing.  ARCRUNNER uses DOS  services not released
  346.                    before version 2.00.
  347.  
  348.               Invalid parameter(s)
  349.                  - This error will probably be  the most prevalent and
  350.                    will be caused mostly by typographical errors or an
  351.                    attempt to use wildcard characters  which ARCRUNNER
  352.                    does not support.
  353.  
  354.               COM files only
  355.                  - present only in the Shareware version to remind you
  356.                    that the program is only capable of processing .COM
  357.                    format files. This error will not be invoked unless
  358.                    you specify an extension  on the command line other
  359.                    than .COM.
  360.  
  361.               COM, EXE, or BAT files only
  362.                  - This message replaces the Shareware  COM files only
  363.                    message to remind you  that these are currently the
  364.                    only valid runtime extensions accepted by DOS.
  365.  
  366.               Unexpected error
  367.                  - used during development  of program code,  but left
  368.                    as catch all for error  codes returned for  which I
  369.                    have not provided for.  I would be  very interested
  370.                    if you encounter this error message and if possible
  371.                    please inform me as to the possible reasons leading
  372.                    up to it.
  373.  
  374.  
  375.  
  376.               LICENSE
  377.  
  378.               You may use, copy, and/or distribute the ShareWare version
  379.               of ARCRUNNER for noncommercial use as long as NO charge of
  380.               any amount is made without the  express written permission
  381.               of MILLENNIUM Software. The following exceptions are made:
  382.               Organized computer user groups or clubs may charge a small
  383.               copying or handling fee for distribution purposes to their
  384.               members for ShareWare copies of ARCRUNNER.  Similarly, BBS
  385.               operators operating on a subscription basis, may include a
  386.               copy of ARCRUNNER on their boards for downloading by board
  387.               subscribers.
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.                                                       ARCRUNNER    Page  6
  404.  
  405.  
  406.  
  407.               WARRANTY
  408.  
  409.               ARCRUNNER is provided AS IS without any warranty, either
  410.               expressed or implied, including, but not limited to fit-
  411.               ness for a particular purpose.
  412.  
  413.  
  414.  
  415.               REGISTRATION
  416.  
  417.               This ShareWare version of  ARCRUNNER  will only run .COM
  418.               format files.  If you find  ARCRUNNER easy and useful in
  419.               helping to maximize your storage efficiency, then regis-
  420.               tration of your  ShareWare version will entitle you to a
  421.               copy of the enhanced version of ARCRUNNER. This enhanced
  422.               version includes  support for  COM, EXE, and BAT program
  423.               files. It also supports the use of a user defined envir-
  424.               onment variable ARCR.  By setting  ARCR=d:path\, you can
  425.               pre-program a specific drive  and/or path  to be used by
  426.               ARCRUNNER for the default output drive/directory values.
  427.  
  428.               All registered owners of  ARCRUNNER will be entered upon
  429.               a database and thereby entitled to future upgrades for a
  430.               minimal shipping and handling fee.  Unfortunately, as of
  431.               this time, I cannot support a BBS for upgrade purposes.
  432.  
  433.               Registration of  ARCRUNNER can be accomplished by simply
  434.               mailing a check or money order in the amount of $7 to:
  435.  
  436.               MILLENNIUM Software
  437.               P.O. Box 6966
  438.               Jefferson City, MO 65102
  439.