@database
@Author "Andreas Etzrodt"
@$VER: "SHARKsort.guide" (10.06.98)
@node Main "SHARKsort-Doc"

                           "Very funny Scotty, now beam down my clothes."

                            - Captain James T. Kirk



     SHARKsort-Documentation
     -----------------------
           @{" Intro         " link intro        } ...why this piece of code?
           @{" Author        " link author       } ...the Author's address
           @{" Copyright     " link copy         } ...the Copyrights
           @{" Registering   " link register     } ...CARDWARE!

           @{" Requirements  " link require      } ...what do you need?
           @{" Installation  " link install      } ...how to install SHARKsort
           @{" Usage         " link usage        } ...how to use SHARKsort

           @{" History       " link history      } ...how did it begin?
           @{" Future        " link future       } ...what to come?
           @{" Thanks        " link thanks       } ...many thanks to...

@endnode

@node "intro" "Intro"

This program sorts ASCII-lists with up to 10.000 items.


The features:

- sorts files with up to 10.000 items
- *very* easy to use (ASL-Requester)
- deletes blank characters
- deletes blank lines
- has a progress-bar
- displays how long it took to sort
- can print the destination-file on the printer
  (with or without line-numbers!)
- fast


@endnode


@node "install" "Installation"

How to install:


The WB-Version can be used without any installation.


@endnode


@node "require" "Requirements:"

You need:

- an AMIGA (obviously ;-)
- ASL-library for the WB-Version
- a printer if you want to print the results
- the CLI-commands "execute", "sort" and "wait"

@endnode


@node "usage" "Usage"

How to use:

SHARKsoft-WB can be run by double-clicking its icon. It's so
simple to use that I don't want to write a doc.

But I have to...

Double-click the icon, then select the file to sort.
In the next requester select the name of the sorted file.

When it's ready then a requester will appear. Here you can
select if you want to sort a 2nd file, print the actual
file or just quit the program.

That's it.

@endnode


@node "copy" "Copyright"

!!!  C  A  R  D  W  A  R  E  !!!

SHARKsort is ©1996-1998 by Andreas Etzrodt/SHARKsoft

SHARKsort is CARDWARE, which means that you have to send a
picture-postcard from your home-town to me:

Andreas Etzrodt
Hauptstr. 15
49835 Wietmarschen-Lohne
GERMANY

E-Mail: the_shark@gmx.de


Also send Bugreports and suggestions to this address.

LEGAL: USE THIS SOFTWARE AT YOUR OWN RISK!!!! DON'T BLAME ME
IF IT CRASHES YOUR HARDDRIVE OR NUKES YOUR MONITOR! IT WORKS
FOR ME BUT I CANNOT GUARANTEE THAT IT WILL WORK ON ANY OTHER
MACHINE THAN MINE!!!!!!!

@endnode

@node "register" "Registering"

SHARKsort is CARDWARE, which means that you have to send a
picture-postcard from your home-town to me (I *love* it
to get letters and postcards (not E-Mail!)):

Andreas Etzrodt
Hauptstr. 15
49835 Wietmarschen-Lohne
GERMANY

E-Mail: the_shark@gmx.de

@endnode

@node "author" "Author"


Andreas Etzrodt
Hauptstr. 15
49835 Wietmarschen-Lohne
GERMANY

E-Mail: the_shark@gmx.de

Also send Bugreports and suggestions to this address.

@endnode

@node "history" "History"

New in 1.30 (June 10th, 1998):

- removed the cli-version. If you miss it, contact me
  and I will reintroduce it in the next release.

- it now uses the DOS-command "sort" to sort the
  file. This makes it much faster. It is still very
  usable - much more than "sort". Also it still has
  the advantage, that it removes blank lines and chars.

- the WB-Version now has a progress-bar.

- it displays now how long it took to sort.


New in 1.21 (April 22nd, 1998):

- optimized the WB-Version in the same way as the CLI-Version in
  V1.20

- removed a bug (in the about-window the line "Deleted lines:"
  always ended with a "0" though this wasn't right. This bug was
  harmless.

- a (this) guide

- removed an unneccessary variable in the cli-Version. Now it needs
  less memory and diskspace... some bytes...


New in 1.20:

- checks first how many items to be sorted -> less memory hungry
  but a bit slower (needs to load the list twice)
  (only the CLI-Version)

- some optimizations (removed unnecessary variables)

- some corrections in the Readme-file.


New in 1.11:

- a very bad bug was removed. I'm very sorry that I have released
  SHARKsort in such a state (it crashed the system). I hope this
  will never happen again. It worked fine (as it should) but AFTER
  saving the file it crashed. This bug only appeared in the CLI-
  version and has been fixed.

- some corrections in the Readme.


New in 1.10 (January, 22nd, 1998):

- optimized the way how SHARKsort deletes characters and lines
  (in 1.0 it used two passes - now it's only one pass)

- added a CLI-version. The CLI-version cannot print a file on
  the printer. Also it doesn't use ASL-requestors. Instead you
  have to pass two arguments: "inputfile" and "outputfile".


Version 1.0 (January 18th, 1998):

- first public release

@endnode

@node "future" "Future"

Future developments:

At first: my ideas are already done. So if you have ideas and suggestions
for a next release of SHARKsort -> please contact me. You don't HAVE to
send a postcard if you want to make a suggestion -> just contact me via
E-Mail.

- Bugfixes if any bugs will appear

- PowerPC-support (not really needed, but: who knows?)

- for PPC-support I need a different programming-language
  at this time I'm still using the amazing Blitz Basic II.
  I really like the easy to use Requester- and Gadtools-
  handling. Also: it IS system-friendly!!!
  I'm waiting for a first PPC-Pascal or PPC-Modula2 or
  PPC-Oberon-compiler. Does anyone know of one?
  If I get hold of SAS/C 6.5 I would also try to do the
  next version in C. Anyone who wants to sell his copy?
  Please contact me!

- I still hope that Phoenix will become available within one year.

- your suggestions? PLEASE TELL ME WHAT YOU THINK IS MISSING!


@endnode

@node "thanks" "Thanks"

Many thanks to:

- Rainer Lübkemeier for Beta-Testing
- Christian Steiner for support
- Heiner Schnieders for support
- Mark Sibly for Blitz Basic II
- Urban Müller for Aminet
- Commodore for the C64 and the Amiga
- Motorola for the MC680X0 and the PowerPC60Xe
- Sony for the Playstation (no Amiga-games? Get a PSX not a PC!)
- Savage Garden, Metallica, Therapy?, H-Blockx, Oasis and Manowar
  for the music during coding
- APC&TCP for many good friends out there!
- Phase5 for the Cyberstorm, the Cybervision and the PowerUP-boards!

- All people who sent a postcard to me !!!!!!!
- Especially Shane Cracknell for being the first one to send
  me a postcard - hey, he just sent a 2nd one - THAT's SUPPORT !!!!

@endnode
