@database "Scrambler.guide"
@index "Index"

@node Main "Scrambler v1.0"
@next Features

                       @{b} Scrambler Version 1.0 @{ub}
                             by Alan Doyle
                       Released on 5th March 1996.


            @{" Features                   " link Features}
            @{" Required System            " link Requirement}
            @{" Installation               " link Installation}
            @{" Limitations                " link Limitations}
            @{" Copyright and Distribution " link Copyright}
            @{" Program History            " link History}
            @{" Contacting the Author      " link Contact}
            @{" Registration               " link Registration}

            @{" INDEX " link Index}

@endnode

@node Features "Features"
@prev Main
@next Requirement
@{b}Features@{ub}

    o   Supports UUEncoding/UUDecoding and XXEncoding/XXDecoding.

    o   Very fast @{"Encoding" Link Encoding} and @{"Decoding" Link Encoding}.

    o   @{"Multiple Files" Link Multiple}.(REGISTERED VERSION ONLY)

@endnode

@node Requirement "Required System"
@prev Features
@next Installation
@{b}Required System @{ub}

    Scrambler requires version 2.04 of the Amiga operating system or higher.
    Also the Asl.library v37+

    Nothing else.. =)

@endnode

@node Installation "Installation"
@prev Requirement
@next Limitations
@{b}Installation@{ub}

    Simply copy it onto your hard drive somewhere in your path eg C: or
    SYS:Utilities.

    Couldn't be simpler.

@endnode


@node Limitations  "Limitation"
@prev Installation
@next Copyright
@{b}Limitations@{ub}

    Only supports UUEncoding/UUDecoding & XXEncoding/XXDecoding at the moment.
    The next release will hopefully support MIME.

    If there is any feature you'd like added let me know.
    See my @{"address" Link Contact}.

@endnode

@node Copyright "Copyright"
@next History
@prev Limitations
@{b}Copyright and Distribution@{ub}

    Scrambler (the binary  and  documentation) is copyright © 1996 Alan
    Doyle.  All Rights reserved.

    Scrambler is  SHAREWARE. To register send £5 Sterling or $10 to @{"me" Link Contact}.

    I am not responsible for any loss or damage arising from the use of
    Scrambler; the user takes all such responsibility.

    No charge may be made for Scrambler, other than a nominal copy  fee.
    Scrambler may  not  be  distributed   with  a   commercial   product
    without  my  prior consent.  Scrambler must be distributed with  all
    documentation intact and unaltered.  Permission is expressly granted
    to Fred Fish to distribute on his fine collection of disks.

@endnode

@node History "History"
@next Contact
@prev Copyright
@{b} History @{ub}

    v0.1        CLI based UUEncoding/UUDecoding version (Slow & Unreliable)
                Not released. (20th Feb 1996)

    v0.2        Added XXEncoding/XXDecoding.
                Not released. (22nd Feb 1996)

    v0.3        Added GUI & removed CLI interface.
                Not released. (23rd Feb 1996)

    v0.4        Fixed bug in Outfile String gadget.
                Not released. (25th Feb 1996)

    v0.5        Added Asl.library support.
                Not released. (27th Feb 1996)

    v0.6        Disabled Multiple Files due to bug. Will be active and fixed in
                Registered Version.
                Not released. (29th Feb 1996)

    v0.7        Added Overwrite & Table Output.
                Not released. (1st Mar 1996)

    v0.8        Optomised Encoding Routine, now 500% faster.
                Not released. (2nd Mar 1996)

    v0.9        Optomised Decoding Routine, now 600% faster.
                Not released. (3rd Mar 1996)

    v1.0        First release of Scrambler.
                (5th March 1996)

@endnode

@node Contact "Contact the Author"
@next Encoding
@prev History
@{b}Contacting the author@{ub}

    I can be reached with comments, suggestions, bug reports, praise, money
    etc. at the following addresses:

                @{b}Alan Doyle,
                247 Ratoath Road,
                Cabra West,
                Dublin 7,
                IRELAND.@{ub}

    OR BY EMAIL (preferred): @{b}tgellen@grex.cyberspace.org@{ub}

    Before reporting a problem, try to figure out if it's really a problem,
    read carefully this doc.


@endnode

@node Encoding "Encoding and Decoding"
@next Multiple
@prev Contact
@{b}Encoding and Decoding@{ub}

    Scrambler allows you to encode and decode files for mailing via
    electronic  mail.  During  the  ENcoding  process, binary files
    are transformed into (larger) plain-text  ASCII  text  files so
    that the network's mail programs can  handle  them.  During the
    DEcoding  process, the  files  are  converted back into  binary
    form.

@endnode

@node Multiple "Multiple Files"
@next Cells
@prev Encoding
@{b}Multiple File Handling@{ub}(REGISTERED VERSIONS ONLY)

    For most cases, you can just use Scrambler's default settings,
    which will encode or decode  any  size  file with the standard
    format.  Some  mail  systems,  however,  cannot  handle  files
    larger than some  maximum  size (usually around 32 kilobytes).
    For the case of posting especially large files, you can change
    Scrambler's settings to accomodate this.

    If you select option (Multiple) then Scrambler will split the output
    data into sections no larger than the size  indicated  by @{"Max Size" Link MaxSize}.
    The actualy file size will be a little larger because of some extra
    data written to the file. Further, each output file will have
    "---cut here---" lines added before and after the data in order
    to facilitate posting to the net.

    If you choose the  "Multiple" option,  Scrambler  will  search  for
    all files which have sequenced extensions with the same filename...
    that is to say, if you have 3 files  that  belong  together,  named
    FILE.1 FILE.2 and FILE.3,  and  you  choose  the  "Multiple" option,
    Scrambler will decode each one, appending the  data  to  the output
    file as it goes.  The  numbers  must  be  in  the correct order for
    Scrambler to assemble them properly!  Additionally, Scrambler  will
    attempt to skip over all headers and trailers,  but will inform you
    if it is not able to distiguish normal text from UUENCODED data, in
    which  case  you  will  have to trim this text out yourself.  It is
    possible  (though  unlikely)  that  some  normal  text  might  fool
    Scrambler into thinking that it has encountered uuencoded data...if
    you   encounter   such   cases,  please  notify   the   author   at
    @{b}tgellen@grex.cyberspace.org@{ub}, and include a sample of the text which
    caused the problem.

@endnode

@node Cells "Cells per Line"
@next UseXXSet
@{b}Cells per Line@{ub}

    You may change the number of 4-byte cells of output data with
    option Cells, although this is not recommended.  Under normal
    circumstances, the default setting of 15 will  produce  lines
    of data which almost any mail system will be able to  handle.
    Under no circumstances should you raise this number above 19;
    in  fact,  Scrambler  will  not  allow  you to do so.  Again,
    changing  this  setting,  as   they  say  in   the  army,  is
    contra-indicated.

@endnode

@node UseXXset "Use XX Set"
@next Table
@prev Cells
@{b}Use XX Set@{ub}

    Scrambler also supports another common form of data encoding, namely
    the XX-encode  standard,  which  is used primarily to avoid problems
    associated with  transferring  files  between IBM mainframes and the
    rest of the world.  If  you  encounter  an XX-encoded  file you wish
    to decode, no special steps are necessary; Scrambler w ill recognize
    these files and decode them automatically.  If  you  wish  to ENcode
    a file with the  XX  character set this  option  will  toggle the XX
    character set on & off.

@endnode

@node Table "Table Output"
@next Overwrite
@prev UseXXSet
@{b}Table Output@{ub}

    Sometimes encoders use nonstandard character sets, for reasons I
    don't understand.  Usually they will place a 'table' line before
    the data starts  in  order to provide other decoders with a list
    of  the  characters used in the encoding process.  Again, if you
    only wish to DEcode  files with these tables, no extra steps are
    needed.  If you wish to write one of these tables at the head of
    your data, you may this option.

@endnode

@node Overwrite "Overwrite"
@next MaxSize
@prev Table
@{b}Overwrite@{ub}

    If Scrambler finds that a target file already exists, it will warn you
    about  the  problem,  unless  you  specify  Overwrite,  in  which case
    Scrambler will be silent.

@endnode

@node MaxSize "Max Output Size"
@next Registration
@prev Overwrite
@{b}Max Output Size@{ub}

    This is the MAXIMUM size in bytes for a ENcoded file.   This is
    only used in conjunction with the @{"Multiple Files" Link Multiple} option.

@endnode

@node Registration "Registration"
@next Index
@prev MaxSize
@{b}Registration@{ub}

    Scrambler v1.0 is shareware, which means that you are free to distribute
    it to anyone, as long  as  you  distribute  all associated files (namely
    Scrambler, Scrambler.020 and Scrambler.guide).  Further, you are free to
    use  Scrambler without payment  for a  period of up to thirty (30) days,
    after which you must register it if you are to continue using it.

    Registered users will receive updates of Scrambler as  they are written;
    updates will be sent free  of charge via electronic mail, or on diskette
    (if available for user's computer) for a nominal fee.

    To register your copy of Scrambler,  simply  fill  out  the  form below
    (or just  write  the  requested  information down on a piece of paper),
    and send it with a check  or  money  order for $10 or £5 Sterling (made
    payable to Alan Doyle) to:


    Registration form for Scrambler ver. 1.0:

    Your name    :________________________________________

    Your address :________________________________________

            city :_____________________

            state:_______

            zip  :_______

    How did you obtain your copy of Scrambler v1.0?

    [  ]  From an anonymous ftp archive

    [  ]  From UseNet (NetNews)

    [  ]  From a bulletin board

    [  ]  From a friend

    [  ]  Other (please specify: __________________________________________)

@endnode

@node Index "Index"
@prev Main
@next Index
@{b}Index@{ub}

    @{" Overwrite                 " link Overwrite}
    @{" Use XX Set                " link UseXXSet}
    @{" Table Output              " link Table}
    @{" Cells per Line            " link Cells}
    @{" Max Output Size           " link MaxSize}
    @{" Multiple Files            " link Multiple} (REGISTERED VERSION ONLY)

@endnode