#! /bin/sh
#
# This is a shell archive.  Save this into a file, edit it
# and delete all lines above this comment.  Then give this
# file to sh by executing the command "sh file".  The files
# will be extracted into the current directory owned by
# you with default permissions.
#
# The files contained herein are:
#
# -rw-r--r--  1 hyc         54144 Jun 13 05:26 Arc521.doc
# -rw-r--r--  1 hyc          7232 Jun 12 19:31 arc.1
#
echo 'x - Arc521.doc'
if test -f Arc521.doc; then echo 'shar: not overwriting Arc521.doc'; else
sed 's/^X//' << '________This_Is_The_END________' > Arc521.doc
X
X
X
X
X
X
X
X
X
X
X
X
X                          ARC
X
X                 File Archive Utility
X                     Version 5.20
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X                 (C)COPYRIGHT 1985,86
X                          by
X          System Enhancement Associates, Inc.
X                  ALL RIGHTS RESERVED
X
X
X
X
X
XThis document describes version 5.20 of the ARC file
Xutility, which was created by System Enhancement
XAssociates, Inc. in October of 1986.
X
X
X       TABLE OF CONTENTS
X
X
X
XSection                                           Page
X
X
XIntroduction  ....................................   1
XUsing ARC  .......................................   3
XARC commands  ....................................   5
X    Adding files  ................................   5
X    Extracting files  ............................   7
X    Deleting files  ..............................   8
X    Listing archive entries  .....................   8
X    Running files  ...............................  10
X    Printing files  ..............................  11
X    Testing an archive  ..........................  11
X    Converting an archive  .......................  12
XARC options  .....................................  13
X    Suppressing compression  .....................  13
X    Backup retention  ............................  14
X    Message suppression  .........................  15
X    Encryption/Decryption  .......................  17
XRAMdisk support  .................................  18
XMARC  ............................................  19
XARCE  ............................................  20
XVersion numbers  .................................  21
XCommon questions and answers  ....................  22
XMaintenance contracts  ...........................  24
XRevision history  ................................  25
X    Changes in version 3  ........................  25
X    Changes in version 4  ........................  25
X    Changes in version 4.1  ......................  26
X    Changes in version 4.3  ......................  26
X    Changes in version 4.4  ......................  27
X    Changes in version 4.5  ......................  27
X    Changes in version 5.0  ......................  28
X    Changes in version 5.1  ......................  29
X    Changes in version 5.2  ......................  30
XProgram history and credits  .....................  31
XBulletin boards  .................................  33
XSite licenses  ...................................  34
X
X
X
X
X
X
X
X
X
X
X
X
X
X         INTRODUCTION
X
X
X
XARC is the copyrighted property of System Enhancement
XAssociates, Inc.  You are granted a limited license to
Xuse ARC, and to copy it and distribute it, provided
Xthat the following conditions are met:
X
X1) No fee may be charged for such copying and
X   distribution.
X
X2) ARC may ONLY be distributed in its original,
X   unmodified state.
X
X3) ARC may *not* be distributed, in whole or in part, as
X   part of any commercial product or service without
X   the express written permission of System
X   Enhancement Associates.
X
X
XContributions for the use of this program will be
Xappreciated, and should be sent to:
X
X          System Enhancement Associates, Inc.
X             21 New Street, Wayne NJ 07470
X
XYou may not use this product in a commercial
Xenvironment or a governmental organization without
Xpaying a license fee of $35.  Site licenses and
Xcommercial distribution licenses are available.  A
Xprogram disk and printed documentation are available
Xfor $50.  See the order form enclosed with this manual
Xfor more details.
X
X
X
XARC is user supported software.  This means that you
Xmay copy it freely and give the copies away to anyone
Xyou wish, at no cost.  They are in turn requested to
Xsend in a contribution if they decide to use it.
X
XThe user supported software concept (often referred to
Xas "shareware") is an attempt to provide software at low
Xcost.  The cost of offering a new product by
Xconventional means is staggering, and hence dissuades
Xmany independent authors and small companies from
Xdeveloping and promoting their ideas.  User supported
Xsoftware is an attempt to develop a new marketing
Xchannel, where products can be introduced at low cost.
X
X
X
X
XARC                                              Page 1
XIf user supported software works, then everyone will
Xbenefit.  The user will benefit by receiving quality
Xproducts at low cost, and by being able to "test
Xdrive" software thoroughly before purchasing it.  The
Xauthor benefits by being able to enter the commercial
Xsoftware arena without first needing large sources of
Xventure capital.
X
XBut it can only work with your support.  We're not
Xjust talking about ARC here, but about all user
Xsupported software.  If you obtain a user supported
Xprogram from a friend or colleague, and are still
Xusing it after a couple of weeks, then it is obviously
Xworth something to you, and a contribution should be
Xsent.
X
X
X
XAnd now, back to ARC:
X
XARC is used to create and maintain file archives.  An
Xarchive is a group of files collected together into
Xone file in such a way that the individual files may
Xbe recovered intact.
X
XARC is different from other archive and library
Xutilities in that it automatically compresses the
Xfiles being archived, so that the resulting archive
Xtakes up a minimum amount of space.
X
XWhen ARC is used to add a file to an archive it
Xanalyzes the file to determine which of three storage
Xmethods will result in the greatest savings.  These
Xthree methods are:
X
X1) No compression; the file is stored as is.
X
X2) Repeated-character compression; repeated sequences
X   of the same byte value are collapsed into a three-
X   byte code sequence.
X
X3) Dynamic Lempel-Zev compression;  the file is stored
X   as a series of variable size bit codes which
X   represent character strings, and which are created
X   "on the fly".
X
XNote that since one of the three methods involves no
Xcompression at all, the resulting archive entry will
Xnever be larger than the original file.
X
X
X
X
X
XARC                                              Page 2
X           USING ARC
X
X
X
XARC is invoked with a command of the following format:
X
X    ARC <x> <arcname> [<template> . . .]
X
XWhere:
X
X    <x> is an ARC command letter (see below), in
X    either upper or lower case.
X
X    <arcname> is the name of the archive to act on,
X    with or without an extension.  If no extension is
X    supplied, then ".ARC" is assumed.  The archive
X    name may include path and drive specifiers.
X
X    <template> is one or more file name templates.
X    The "wildcard" characters "*" and "?" may be used.
X    A file name template may include a path or drive
X    specifier, though it isn't always meaningful.
X
X
XIf ARC is invoked with no arguments (by typing "ARC",
Xand pressing "enter"), then a brief command summary is
Xdisplayed.
X
X
X
XFollowing is a brief summary of the available ARC
Xcommands:
X
X    a   = add files to archive
X    m   = move files to archive
X    u   = update files in archive
X    f   = freshen files in archive
X    d   = delete files from archive
X    x,e = extract files from archive
X    r   = run files from archive
X    p   = copy files from archive to standard output
X    l   = list files in archive
X    v   = verbose listing of files in archive
X    t   = test archive integrity
X    c   = convert entry to new packing method
X
X
X
X
X
X
X
X
X
XARC                                              Page 3
XFollowing is a brief summary of the available ARC
Xoptions, which may alter how a command works:
X
X    b   = retain backup copy of archive
X    s   = suppress compression (store only)
X    w   = suppress warning messages
X    n   = suppress notes and comments
X    o   = overwrite existing files when extracting
X    g   = encode or decode archive entry
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
XARC                                              Page 4
X         ARC COMMANDS
X
X
X
XThis section describes each of the commands.  ARC will
Xaccept any one command at a time.  If no commands are
Xgiven, then a brief command list is displayed.
X
X
X
XADDING FILES
X
XFiles are added to an archive using the "A" (Add), "M"
X(Move), "U" (Update), or "F" (Freshen) commands.  Add
Xalways adds the file.  Move differs from Add in that
Xthe source file is deleted once it has been added to
Xthe archive.
X
XUpdate differs from Add in that the file is only added
Xif it is not already in the archive, or if it is newer
Xthat the corresponding entry in the archive.
X
XFreshen is similar to Update, except that new files
Xare not added to the archive; only files already in
Xthe archive are updated.
X
X
XFor example, if you wish to add a file named
X"TEST.DAT" to an archive named "MY.ARC", you would use
Xa command of the form:
X
X    ARC a my test.dat
X
XIf you wanted to add all files with a ".C" extension,
Xand all files named "STUFF" to an archive named
X"JUNK.ARC", you could type:
X
X    ARC a junk *.c stuff.*
X
XIf you wanted to move all files in your current
Xdirectory into an archive named "SUM.ARC", you could
Xuse a command of the form:
X
X    ARC m sum *.*
X
XIf you have an archive named "TEXT.ARC", and you
Xwanted to add to it all of your files with an
Xextension of ".TXT" which have been created or changed
Xsince they were last archived, then you would type:
X
X    ARC u text *.txt
X
X
X
XARC                                              Page 5
XIf you have a bunch of files in your current
Xdirectory, with backup copies being stored in an
Xarchive named "SAFE.ARC", then if you wanted to make
Xsure that every file in the archive is the latest
Xversion of that file, you would type:
X
X    ARC f safe
X
X
XA word about Update and Freshen:  These are similar in
Xthat they look at the date and time of last change on
Xthe file, and only add it if the file has been changed
Xsince it was last archived.  They differ in that
XUpdate will add new files, while Freshen will not.
X
XIn other words, Update looks for the files on disk,
Xand adds them if they are new or have changed, while
XFreshen looks in the archive, and tries to update the
Xfiles which are already there.
X
X
XArchive entries are always maintained in alphabetic
Xorder.  Archive entries may not have duplicate names.
XIf you add a file to an archive that already contains
Xa file by that name, then the existing entry in the
Xarchive is replaced.  Also, the archive itself and its
Xbackup will not be added.
X
XYou may also add a file which is in a directory other
Xthan your current directory.  For example, it is
Xperfectly legal to type:
X
X    ARC a junk c:\dustbin\stuff.txt
X
XYou cannot add two files with the same name.  In other
Xwords, if you have a file named "C:\DUSTBIN\STUFF.TXT"
Xand another file named "C:\BUCKET\STUFF.TXT", then
Xtyping:
X
X    arc a junk c:\dustbin\*.* c:\bucket\*.*
X
Xwill not work.
X
X
XARC does not save the path name.  In other words, if
Xyou specify a drive and/or path when adding a file,
Xonly the actual file name is stored in the archive.
X
X
X
X
X
X
X
XARC                                              Page 6
XARC will never add an archive to itself, nor will it
Xadd the temporary copy or a backup copy of the
Xarchive.
X
X
XAn interesting note:  It has been brought to our
Xattention that BASIC programs compress to a smaller
Xsize when they are *not* tokenized.  If you are more
Xconcerned with space than speed, you may wish to
Xconvert your BASIC programs to ASCII form before
Xadding them to an archive.  Your BASIC manual should
Xgive instructions on how to do this.
X
X
X
XEXTRACTING FILES
X
XArchive entries are extracted with the "E" (Extract)
Xand "X" (eXtract) commands.  For example, if you had
Xan archive named "JUNK.ARC", and you wanted all files
Xin it with an extension of ".TXT" or ".DOC" to be
Xrecreated on your disk, you could type:
X
X    ARC x junk *.txt *.doc
X
XIf you wanted to extract all of the files in an
Xarchive named "JUNK.ARC", you could simply type:
X
X    ARC x junk
X
XWhatever method of file compression was used in
Xstoring the files is reversed, and uncompressed copies
Xare created in the current directory.
X
XYou can also specify a path name, in which case the
Xdecompressed copy is placed in the specified
Xdirectory.  For example, if you had an archive named
X"JUNK.ARC", and you wanted all files in it with an
Xextension of ".TXT" to be placed in the directory
X"C:\WASTE\LAND", then you could type:
X
X    ARC x junk c:\waste\land\*.txt
X
XIf you wanted to put the file "TRASH.TXT" on your A:
Xdrive, and the file "LITTER.TXT" on your B: drive, you
Xcould type:
X
X    ARC x junk a:trash.txt b:litter.txt
X
X
X
X
X
X
XARC                                              Page 7
XIf you give more than one path for a file, then only
Xthe first one is used.  For example, if you typed:
X
X    ARC x junk a:trash.txt b:trash.txt
X
Xthen TRASH.TXT will be placed on your A: drive.
X
X
X
XDELETING FILES
X
XArchive entries are deleted with the "D" (Delete)
Xcommand.  For example, if you had an archive named
X"JUNK.ARC", and you wished to delete all entries in it
Xwith a filename extension of ".C", you could type:
X
X    ARC d junk *.c
X
X
X
XLISTING ARCHIVE ENTRIES
X
XYou can obtain a list of the contents of an archive by
Xusing the "L" (List) command or the "V" (Verbose list)
Xcommand.  For example, to see what is in an archive
Xnamed "JUNK.ARC", you could type:
X
X    ARC l junk
X
XIf you are only interested in files with an extension
Xof ".DOC", then you could type:
X
X    ARC l junk *.doc
X
X
XARC prints a short listing of an archive's contents
Xlike this:
X
X    Name          Length    Date
X    ============  ========  =========
X    ALPHA.TXT         6784  16 May 85
X    BRAVO.TXT         2432  16 May 85
X    COCO.TXT           256  16 May 85
X            ====  ========
X    Total      3      9472
X
X
X"Name" is simply the name of the file.
X
X
X
X
X
X
XARC                                              Page 8
X"Length" is the unpacked file length.  In other words,
Xit is the number of bytes of disk space which the file
Xwould take up if it were extracted.
X
X"Date" is the date on which the file had last been
Xmodified, as of the time when it was added to the
Xarchive.
X
X"Total" is pretty obvious, I think.
X
X
XARC prints a verbose listing of an archive's contents
Xlike this:
X
XName          Length    Stowage    SF   Size now  Date       Time    CRC
X============  ========  ========  ====  ========  =========  ======  ====
XALPHA.TXT         6784  Crunched   35%      4413  16 May 85  11:53a  8708
XBRAVO.TXT         2432  Crunched   41%      1438  16 May 85  11:53a  5BD6
XCOCO.TXT           256   Packed     5%       244  16 May 85  11:53a  3AFB
X        ====  ========            ====  ========
XTotal      3      9472             27%      6095
X
X
X"Name", "Length", and "Date" are the same as for a
Xshort listing.
X
X"Stowage" is the compression method used.  The
Xfollowing compression methods are currently known:
X
X       --          No compression.
X
X     Packed        Runs of repeated byte values are
X                   collapsed.
X
X    Crunched       Lempel-Zev compression technique
X                   employed.
X
X    Squeezed       Huffman encoding compression
X                   technique, as employed by an
X                   earlier version of ARC.
X
X"SF" is the stowage factor.  In other words, it is the
Xpercentage of the file length which was saved by
Xcompression.  The total stowage factor is the stowage
Xfactor for the archive as a whole, not counting
Xarchive overhead.
X
X"Size now" is the number of bytes the file is
Xoccupying while in the archive.
X
X
X
X
X
XARC                                              Page 9
X"Time" is the time of last modification, and is
Xassociated with the date of last modification.
X
X"CRC" is the CRC check value which has been stored
Xwith the file.  Another CRC value will be calculated
Xwhen the file is extracted or tested to ensure data
Xintegrity.  There is no especially good reason for
Xdisplaying this value.
X
X
X
XRUNNING FILES
X
XArchive entries may be run without being extracted by
Xuse of the "R" (Run) command.  For example, if you had
Xan archive named "JUNK.ARC" which contained a file
Xnamed "LEMON.COM", which you wished to run, you could
Xtype:
X
X    ARC r junk lemon
X
XYou can run any file from an archive which has an
Xextension of ".COM", ".EXE", ".BAT", or ".BAS".  You
Xdo not have to specify the extension, but all matching
Xfiles are run if you do not.  In other words, if you
Xhad an archive named "JUNK.ARC" which contained the
Xfiles "LEMON.COM", "LEMON.EXE", and "LEMON.BAS", and
Xyou typed:
X
X    ARC r junk lemon
X
XThen all three programs will be run.  You can avoid
Xthis by specifying an extension in this case.
X
XYou can give arguments to the program you are running
Xby appending them to the command line.  For example,
Xif you have an archive named "JUNK.ARC" which contains
Xa program named "LEMON.COM", and you wanted to run it
Xgiving it the argument "JUICE", you would type:
X
X    ARC 


