ARM Club 1/ARM_CLUB_CD.iso/contents/apps/discs/a/compress/DocCompr

Text File | 1991-04-22 | 5.8 KB | 137 lines

>&.DocCompr

Compress Utility Documentation

Package Version 1.22 19th June 1989

This file documents the machine code utility Compress (1.21,25th April 1989).

It contains two sections:

        - Compress Documentation
                How to use the compress utility.
        * Package documentation
                Information about the package in general. Please read this.

Document Version 1.01 19th June 1989

--- Compress Documentation

        The compress command is used to fully compact ADFS L and D format
floppy discs and old format hard discs. The ordinary compact command merely
moves some of the files on the discs to make a larger block of free space. The
Compress command repeatedly calls the Compact command until all the free space
on the disc is in one block at the end of the disc.

        The syntax of the command is:

*COMPRESS [<disc spec.>] [-h] [-i] [-v]

[<disc spec.>] (which is optional) works the same as for *COMPACT. If it is not
present the current drive is used.
[-h]           prints out help information on the program (help)
[-i]           prints out version information on the program (info)
[-v]           prints out status information as the program proceeds (verbose)

        You can press escape at any time during the compress, though it may
take a short while to respond.

        If only the -h and/or the -v options are present on the command line
then the program will print out the information without actually doing a
compress.

        Examples:

*COMPRESS               Compress the current drive
*COMPRESS -v            Compress the current drive, printing status info
*COMPRESS -h -i         Print version and help info on *COMPRESS
*COMPRESS :0 -h         Compress drive 0 printing help info first

        If you wish to make a program that uses compact use compress instead
then you could either change the program or set an Alias:

*SET Alias$Compact Compress %*0

- How the program works

        The code repeatedly calls ADFS_FreeSpace to get the largest free block
and the total free space. When these two are equal then the program finishes.

--- Package Documentation

*** This section has been changed. Please read it. There are significant
*** alterations to it.

*** Users of other shareware written by me please note - the text below may
*** look the same as others but it is not. Take a few moments to look through
*** it for differences, please.

This package contains:
Compress   1.21 (25th April 1989): Utility (transient mc) to do compression
SCompress  1.21 (25th April 1989): BASIC source code for the above
DocCompr   1.01 (19th June 1989): This text file
Macros          (26th April 1989): Standard BASIC assembler Macros.
   The software contained in this package is Shareware. The word 'Shareware'
means many things to many people, so I'll explain what I mean. In fact, some
people would call this 'freeware' or 'public domain software' but it hardly
matters what you call it - your obligations are set out below.
   The program is free. You may make any number of copies and give them away to
anyone (subject to the condition that you give them ALL the files in the
package). You may not sell this software, or use it otherwise for personal gain
without my permission. If you wish to post it on your Bulletin Board or include
it in your Shareware library then that, too, is fine.
   If you want to add any part of the code or data to one of your programs for
your own use, then that's fine too. If you want to add it to something you plan
to sell, or otherwise release as copyright material (whether for gain or not)
then you'll need my permission - I retain copyright on this program.
   If you like this program and find it useful then I would appreciate a small
donation (say 5 pounds) (since this took up quite a while to get working). This
donation is a voluntary contribution.
   If you send a donation and say which version of the package you have then I
will send you an update if there is one. This disc will also contain up-to-date
copies of as much of my shareware as will fit, plus any other stuff I can fit.
There may be no update, since, for the moment, I've done all I want to to this
program. Thus I don't guarantee that, if you send me money, I'll send you a
new version of the program. You will, however, get a disc with things on it. If
you'd prefer to wait until there is a disc with a new version on it then please
say so. In this case you'll get a thankyou note.
   This program has been tested with RISC OS. It should be suitable for both
Arthur 1.2 and RISC OS. Please state, when sending for updates, whether you
have RISC OS.
   This software carries no warranty, either express or implied. I've tested it
and, to the best of my knowledge, there are no bugs. If you come across a bug
then I'd be delighted if you got in touch with me. I can't guarantee to fix it
but I'll probably have a good try.
My address is:
        Martyn Lovell
        16, Fairwater Park,
        Barnwood,
        Gloucester.
        GL4 7HF
No telephone calls please.
However, I can be contacted as:
Cix:       MartynL
Janet:     [e-mail]
Interspan: Contact via Janet at above address
Eureka II: Martyn Lovell (112)
Note that, during university terms, I read all this EMail sites regularly but
in the holiday periods I may read them less regularly.
For bug reports please send the following information:
        Machine Type
        Arthur Version
        Software Version
        Screenmode in use
        Had the code been modified (if so, try to explain how)
        What *exactly* happened
        Modules Installed
        Modules Unplugged
        Podules Installed
        Drives Installed
        RAM Available
        Monitor Type
        Did you use it via an Alias$
        What format of disc were you using
        Did the disc need compacting
        Is the bug repeatable?
and everything else that seems relevant.