*****************************************
*	    `FormaText'  v1.0		*
*       An OriginalWare release by      *
*	    Troglobyte/Darkness		*
*****************************************
$VER:FormaText.doc v1.0 25.May.97 Troglobyte/Darkness


Contents
========

 1. Introduction
 2. Workbench usage and ToolTypes
 3. CLI usage
 4. History
 5. Bugs
 6. OriginalWare?
 7. Also available...
 8. Thanks to...
 9. Credits


1. Introduction
===============

   FormaText is an utility to reformat ASCII text to a new width, you can
   select the number of columns of the text (by default columns is formated
   to 80 columns) and if you want to justify the text, inserting spaces
   between words to align the end of the lines. 
   It can be very useful for disk magazines editors or anyone who reads
   text files, to adjust the width of the text to the size of the window.

The main features are:

 - Fast, written 100% in assembler.
   (Even faster with the CLI option -w or the ToolType WINDOW disabled)
 - Small but powerful utility (only 1000 bytes, uncrunched).
 - CLI and Workbench usage.
 - ToolTypes support.
 - Admit filenames as CLI parameters (can be launched from a
   DiskMaster/DirOpus type program to autoformat multiples text files).
 - Filename suffix could be changed to your own defined text extension.
 - The program will report any kind of errors.
 - Very easy to use...just try it.
 - Great results (complex AI routines used *8).
 - No annoying requesters when starting/using/quitting program.
 - It's OriginalWare (OriginalWhat?) and it's only Amiga (Yeah!).
 
The only requirement is the "ReqTools.library" by Nico Francois and Magnus
Holmgren who fortunately is continuing the development of the indispensable
reqtools library.

If you need a custom version of this program (for a personal project);
contact me and I will try to make a customized version for you (if it isn't
too difficult or too much work).

If you think the sources (100% assembler) could be useful for you (to include
in a program you are developing or for learning purposes) just contact me and
ask for them.


2. Workbench usage and ToolTypes
================================

2.1 Workbench usage:

Just launch the program and use the file requester to select the file to
load and to choose the name to save the text file.
The program will ask for another filename after saving the formated file,
when you don't have more files to format, Cancel or Close the file
requester to exit. (Use the icon ToolType SINGLE for just one use).

2.2 ToolTypes

The ToolTypes of the icon will be used as default configuration.
The ToolTypes are equivalent to the CLI options, but if used, all the CLI
options will prevail over the ToolTypes options.

COLUMNS=x	Number of columns to format the text (x is a number, 0<x<9999)
		(If x=0 the text will be `formated' like the original file)
JUSTIFY		Insert spaces between words to align the end of the lines.
WINDOW		Open a Workbench window to display info.
SINGLE		Convert just one file and exit without asking for a new file.
AUTOSAVE	Save the text without a file requester.
OVERWRITE	Overwrite the original HTML file, so use with caution.
EXTENSION=text  Add a text extension to the savename.
PATH=Dir	Select the default start directory.

To disable options use brackets with the ToolType.
Example : 
WINDOW		Window enabled
(WINDOW)	Window disabled


3. CLI usage
==============

Just write the command `FormaText' with your favourite options in any CLI/Shell
window.

 `FormaText [?] [-Cxx] [-J] [-W] [-S] [-A] [-O] [-E...] [-P] [filename/path]'

Write just the options or the options and the path or filename (if not
filename is given or if there is any kind of problem a file requester
will be used with your defined path).
Options must be ahead of the file name and must be after a "-" char.
Options can be together or alone (-c20h or -c -h20),  and written in capital
or small letters (-HC5, -hc5 or -hC5)
The -Etext option must be used separated from the others options (-hc5 -e.txt)
to avoid the confusion of taking the text as a CLI option.

The available options are: 
 ?, -? or -help : give CLI USAGE: info.
 -cXXXX : XXXX are 1 to 4 numbers (-c10,-c200,-c0080) to select the size of
          the columns of the formated text (default size is 80 columns).
	  If the number is zero, text won't be formatted (-c0,-c0000)
 -j     : Don't justify.Left unjustified the end of the lines.
 -w     : when used the info window won't be opened.And the conversion will
          be really faster; try it.Errors will be reported to the CLI
          window, if there is any opened.
 -s     : Single use, 
 -a     : AutoSave, save without a requester asking for the filename. 
 -o     : Overwrite, use with caution, will overwrite original file.
 -e.TXT : Add a text extension to the original filename (you define the text).
 -p     : you can define the path to your favourite HTML directory
	  Used without specifying later a [path] is useless.


Examples:

1. FormaText File1.txt
   Results : With the defalt option the file is formated and justified to 80
             columns and saved.

2. FormaText -c80 File1.txt
   Results : The file is formated and justified to 80 columns and saved.

3. FormaText -c36 -j File2.txt
   Results : The file is formated to 36 columns and saved.


Common errors :

1. Options must be after a "-" char always.
   BAD: FormaText c60 File1.html
   OK : FormaText -c60 File1.html

2. Options must be ahead of the filename.
   BAD: FormaText File1.txt -c20
   OK : FormaText -c20 File1.txt
   

4. History
==========

Version 1.0 (25.May.1997) :
 - First official release.


ToDo List:
 - Fix all the bugs that will be discovered by users (Don't try so hard *8)


5. Bugs
=======

There isn't KNOWN bugs at the moment in all the Amigas tested but...

If you find any bug or problem, contact me at the previous address.Please,
send me a detailed report of the problem and of your Amiga computer if
possible; thanks.

If you found the problem with a particular file, send me too a copy of
the file.

Don't forget to tell me the current version of my program you are using.


6. OriginalWare ?
=================

This  utility  is OriginalWare.That means if you like this program you must
buy  an  original Amiga program or game, or send the money to the author of
any ShareWare program or game you are using often.
(This includes me, $5, $10 or a program made by you will be welcome *8)

There  are  lots  of  great Amiga software like `DiskMaster', `Remind',
`MultiCX', `Spot', `ReqTools.library', `Deluxe Galaga', `APlayer' and a
lot more that you won't never regret to spend your money.

If you do this you support the Amiga, and if you support AMIGA you support
US.Support software authors and you will get more and better software.


This program could be included in any PD compilation at a symbolic price,
but you must send me a copy of the CD/Floppy Disk/... compilation or get
a written permission from me.

Aminet and Fred Fish collections are specifically allowed to include it
absolutely free.

This program could be freely included in any Web page or FTP site, but
send me an EMail to know it (I can include your page address in this doc).

For using this in commercial products, my written permission is required.
Inclusion in magazines and diskmags will be allowed, if you send me a copy of
this publication.
       

7. Also available...
====================

Others quality Amiga PD products available from me :

Aminet recent uploads :

FormaText.lha v1.0   text/misc	 12K v1.0 Format and justify text files. 
HTMLess.lha   v2.5   text/hyper	 17K v2.5 Converts HTML files in text files.
DarkSound.lha v2.5   util/boot   53K v2.5 Changes Workbench Sounds each boot.
MagiCA64.lha  v1.1   misc/emu     6K Converts A64/64 files to MagiC64 format.  
Progress.lha  v1.0   demo/intro  73K In Progress/Darkness.1st at Euskal Party
Vectoram.lha  v1.3   dev/misc    15K Draw and edit 2D vectors for demos/games
TheRace5.lha  v1.5   game/2play  59K Great 100m Running game, 0-4 players.

Available soon:

ELF.lha       v1.0   text/misc	     Erase Line Feeds.Use for Word Procesors.
HTMLess.lha   v2.6   text/hyper      v2.6 Converts HTML files in text files.

All them are 100% written in pure assembler for speed and are very system 
friendly in all types of Amiga computers (or that is what I hope *8).


8. Thanks to...
===============

First a very special THANKS to Jon B. Peterson from San Angelo (Texas, USA),
Mick Domoney (Lincs, UK) and Brian Jones (Calgary, Canada), for being the
first persons to send me some money for my work.

Humphrey / Jose Antonio Diaz.es for the first ßeta testing.

Hipnooxis / Ricardo MArtinez.es for show me to use and respect the Amiga O.S.

Rüediger Prang.de for being my best `invisible' friend.

To the `Atletico de Madrid', the best football team in Spain.

To all the Amiga developers for all the new, fun and useful stuff.

To all the Amiga users (you!) worldwide for their trust in the Amiga.

To Amiga Technologies for continue the development of the Amiga...for a while.

To Gateway 2000 for ...

To whoever will be the next to bring light to the Amiga...

To the Amiga...


9. Credits
==========

All code © 1997 by Troglobyte/Darkness.

Send money ($), JOB offers, BUGS, comments, improvements, ideas, advices,
suggestions, mags, complains, and nice  PD  stuff  (like Demos, Games or
Utilities).

			M. Martin Vivaldi
			 Av. America 60
			  Madrid 28028
			     SPAIN

Or NetMail me at :

 Internet : manuel@webmedia.es


Remember:

      Only Amiga make it possible... Only Amiga make it fun.