@DATABASE MAT.guide
@AUTHOR Andreas Mayer-Gürr
@© 1997 by Andreas Mayer-Gürr
@$VER: MAT.guide V1.0
@FONT Xhelvetica.font 13


@NODE MAIN "MakeAminetTree (MAT) - Documentation/Dokumentation"
@NEXT MAIN
@FONT Xcourier.font 13
@{CODE}
@{JCENTER}




@{b}MAT@{ub} V1.0
written by @{FG Highlight}@{b}Andreas Mayer-Gürr@{ub}@{FG Text} in 1997



@{" Introduction " link E.intro} @{" Einführung      " link D.intro}
@{"    Copyright " link E.copyr} @{" Rechtliches     " link D.copyr}
@{" Requirements " link E.requi} @{" Voraussetzungen " link D.requi}
@{" Installation " link E.insta} @{" Installation    " link D.insta}
@{"        Usage " link E.usage} @{" Benutzung       " link D.usage}
@{"    Technical " link E.techn} @{" Technisches     " link D.techn}
@{"      History " link E.histo} @{" Geschichte      " link D.histo}
@{"       Thanks " link E.thank} @{" Danke           " link D.thank}
@{"       Author " link E.autho} @{" Autor           " link D.autho}







@{APEN 0}This guide is designed for AmigaOS V3.1 (V40).
@ENDNODE


@NODE D.intro "Einführung"
@PREV MAIN

@{FG Highlight}Einführung@{FG Text}

@{b}MakeAminetTree@{ub} (kurz @{b}MAT@{ub}) erzeugt die Verzeichnis-Struktur des Aminets aus der
Datei "TREE" ("ftp://ftp.uni-paderborn.de/aminet/TREE").
Wahlweise bekommt jedes Verzeichnis einen englischen Kommentar.

@{b}MAT@{ub} soll die Arbeit erleichtern, aus dem Aminet geladene Archive übersichtlich zu
verwalten und schnell wiederzufinden.  Man erzeugt mit @{b}MAT@{ub} und der Datei "TREE"
alle Verzeichnisse des Aminets, sortiert die Archive ein und kann sie dann mit Hilfe
einer INDEX-Datei leicht wiederfinden.  Programme, die INDEX-Dateien erzeugen,
sind im Aminet verfügbar.

Ruft man @{b}MAT@{ub} ein zweites mal mit dem gleichen Zielverzeichnis, aber mit einer neueren
Datei "TREE" auf, bleiben schon vorhandene Verzeichnisse mit ihren Inhalten erhalten
und neue Verzeichnisse werden hinzugefügt.


@ENDNODE


@NODE D.copyr "Rechtliches"

@{FG Highlight}MakeAminetTree (MAT) - Kopierrecht © 1997 bei Andreas Mayer-Gürr@{FG Text}

Das Programm ist FREEWARE und darf ohne Profit kopiert werden (maximal: Disketten-
preis + Porto). Das Programm darf nur unverändert, komplett und mit Kopierrecht-Notiz
weitergegeben werden. Es darf ohne schriftliche Genehmigung des Autors nicht in
kommerziellen Programmen benutzt werden.

Ich würde mich freuen, wenn Sie mir in einer kurzen @{" E-Mail " link D.autho} schreiben, was Sie von
@{b}MAT@{ub} halten.

Es wird keine Verantwortung oder Haftung für irgendwelche Schäden, die durch die
Benutzung des Programms enstehen können, übernommen. Jede Benutzung erfolgt
auf eigene Gefahr. Die Software wird "so wie sie ist" zur Verfügung gestellt, ohne
irgendeine direkte oder indirekte Garantie über die Tauglichkeit oder Genauigkeit der
Software und der Dokumentation. Die Dokumentation wird für korrekt gehalten, aber
der Autor behält sich das Recht vor, die Software und/oder die Dokumentation,
jederzeit ohne Ankündigung zu ändern.

@ENDNODE

@NODE D.requi "Voraussetzungen"

@{FG Highlight}Voraussetzungen@{FG Text}

- AmigaOS 2.04 oder höher
- die Datei "TREE" aus dem Aminet ("ftp://ftp.uni-paderborn.de/aminet/TREE")

Dem Archiv ("MakeAminetTree.lha") liegen zwei CPU-Versionen (68000 und 68020+)
von @{b}MAT@{ub} bei. @{b}MAT@{ub} benutzt einige Betriebssystemfunktionen, die erst ab AmigaOS 2.04
oder höher vorhanden sind und fehlerfrei funktionieren.

@ENDNODE


@NODE D.insta "Installation"

@{FG Highlight}Installation@{FG Text}

1: Besorgen Sie sich die Datei "TREE", wenn Sie sie nicht schon haben.
2: Wählen Sie eine CPU-Version (z.B. "MAT020") und benennen Sie sie um (z.B. in
   "MAT").
3: Kopieren Sie nun das Programm irgendwo in Ihren Befehls-Pfad (z.B. nach "C:")
   und die Dokumentation wohin Sie wollen.

Fertig!
@ENDNODE


@NODE D.usage "Benutzung"

@{FG Highlight}Benutzung@{FG Text}

@{b}MAT@{ub} kann nur von einer Shell aus aufgerufen werden. Rufen Sie @{b}MAT@{ub} mit "?" als
Argument auf, bekommen Sie folgende Syntax angezeigt:

@{b}FILE/A,DIR/A,NC=NOCOMMENT/S,Q=QUIET/S:@{ub}

Nach dem Doppelpunkt können Sie jetzt noch Ihre Argumente und Optionen angeben
und @{b}MAT@{ub} damit starten. Natürlich können Sie @{b}MAT@{ub} auch direkt (ohne den Umweg über
"?") starten.

FILE:
Hier @{u}muß@{uu} die Datei "TREE" mit Pfad angegeben werden. Die Pfadangabe kann
weggelassen werden, wenn sich die Datei "TREE" im aktuellen Verzeichnis befindet.

DIR:
Hier @{u}muß@{uu} das Zielverzeichnis angegeben werden, in dem der gesamte Verzeichnis-
baum erzeugt werden soll. ACHTUNG: Die Verzeichnisse werden genauso im Zielver-
zeichnis erzeugt, wie sie in der Datei "TREE" stehen. D.h., es wird @{u}kein@{uu} übergeordnetes
Verzeichnis erzeugt!

NC=NOCOMMENT:
Wenn dieser Schalter gesetzt ist, werden die erzeugten Verzeichnisse @{u}nicht@{uu} mit einem
Kommentar versehen. Anderenfalls, wird der entsprechende Kommentar aus der Datei
"TREE" verwendet. Wenn @{b}MAT@{ub} ein Verzeichnis erzeugen soll, das schon existiert,
bekommt dieses Verzeichnis einen Kommentar, es sei denn der Schalter NOCOM-
MENT ist gesetzt.

Q=QUIET:
Wenn dieser Schalter gesetzt ist, wird jede Ausgabe unterdrückt. Auf Amiga's ohne
Grafikkarte bewirkt das eine erhebliche Geschwindigkeitssteigerung. Anderenfalls
wird angezeigt, welches Verzeichnis wo erzeugt wurde und (wenn die Option NO-
COMMENT nicht gesetzt ist) daß das Verzeichnis kommentiert wurde.

@{b}Beispielaufruf:@{ub}
> MAT DH0:Ablage/TREE RAM: Q

@{b}MAT@{ub} lädt die Datei "TREE" aus dem Verzeichnis "DH0:Ablage" und erzeugt daraus in
"RAM:" die gesamte Verzeichnisstruktur. Die Ausgabe wird unterdrückt.

Während der Programmausführung kann @{b}MAT@{ub} jederzeit mit der Tastenkombination
"CTRL-C" abgebrochen werden.
@ENDNODE

@NODE D.techn "Technisches"

@{FG Highlight}Technisches@{FG Text}

@{b}MAT@{ub} liest die Datei "TREE" ein und beachtet dabei die ersten acht Zeilen nicht, weil
diese überflüssig sind. Der Text vom Zeilenanfang bis zum nächsten Leerzeichen wird
als Verzeichnisname interpretiert. Zeilen, die aus einem Zeilenvorschub bestehen,
werden ignoriert. Nachdem ein Verzeichnis erzeugt wurde, wird es mit dem
entsprechenden Kommentar versehen, der in der Datei "TREE" hinter dem Verzeichnis-
namen steht.
@ENDNODE


@NODE D.histo "Geschichte"

@{FG Highlight}Geschichte@{FG Text}

@{u}Version 1.0:@{uu} (03.07.97)
· Erste Veröffentlichung
@ENDNODE

@NODE D.thank "Danke"
@{JCENTER}


@{FG Highlight}Danke@{FG Text}

Mein Dank gebührt folgenden Personen:

@{b}Alexander Kazik@{ub}

der viel Geduld und Zeit aufbrachte, mit vielen Tips und Tricks erste
Hilfe leistete, und es überhaupt ermöglichte, @{b}MAT@{ub} zu vollenden

@{b}Matthias Henze@{ub}

für die stormamiga.lib (Aminet:dev/c/stormamiga_lib.lha), die @{b}MAT@{ub} viel
kleiner und schneller macht und für die schnelle, gute Unterstützung
@ENDNODE

@NODE D.autho "Autor"
@NEXT D.autho
@FONT Xcourier.font 13
@{CODE}
@{JCENTER}

Wenn Sie irgendwelche Fragen, Anregungen, Wünsche oder
Fehler-Berichte haben, schreiben Sie mir bitte:

Andreas Mayer-Gürr

E-Mail: @{FG Highlight}andreas@amigaworld.com@{FG Text}
WWW: @{FG Highlight}http://www.amigaworld.com/andreas@{FG Text}
@ENDNODE

@NODE E.intro "Introduction"
@PREV MAIN

@{b}MakeAminetTree@{ub} (short @{b}MAT@{ub}) makes the directory-structure of Aminet from the file
"TREE" ("ftp://ftp.uni-paderborn.de/aminet/TREE").
Alternatively every directory gets an english comment.

@{b}MAT@{ub} should make work easier to manage and find archives fast, which are downloaded
from Aminet. With @{b}MAT@{ub} and the file "TREE" you make all directories of Aminet, sort the
archives in and can find them easy with the aid of an INDEX-file. Programs, which
generates INDEX-files, are available from Aminet.

If @{b}MAT@{ub} is started a second time with the same destination-directory but a newer file
"TREE", then allready existing directories will be preserved with their contents and new
directories will be added.
@ENDNODE

@NODE E.copyr "Copyright"

@{FG Highlight}MakeAminetTree (MAT) - Copyright © 1997 by Andreas Mayer-Gürr@{FG Text}

The program is FREEWARE and may be copied without profit (maximum: costs of a disk
+ postage). The program may be only distributed unchanged, complete and with copyright
message. It can not be used for commercial purposes without the prior written permission
of the author.

I'm really pleased when you write me in a short @{" E-Mail " link E.autho}, what you think about @{b}MAT@{ub}.

No responsibility or liability will be accepted for any damage that may appear to have
resulted from use of this program. All use is at your own risk. The software is provided
"as is", without any expressed or implied warranty about the fitness or accuracy of the
software and documentation. The documentation is believed to be correct but the
author reserves the right to update the software and/or documentation without notice.
@ENDNODE

@NODE E.requi "Requirements"

@{FG Highlight}Requirements@{FG Text}

- AmigaOS 2.04 or above
- the file "TREE" from Aminet ("ftp://ftp.uni-paderborn.de/aminet/TREE")

In the archive ("MakeAminetTree.lha") are two CPU versions (68000 and 68020+) of
@{b}MAT@{ub} included. @{b}MAT@{ub} uses some operatingsystemfunctions, which exists and are working
correct not until AmigaOS 2.04 or above.
@ENDNODE

@NODE E.insta "Installation"

@{FG Highlight}Installation@{FG Text}

1: Get the file "TREE", if you did not allready have it.
2: Choose one CPU version (e.g. "MAT020") and rename it (e.g. to "MAT").
3: Now copy the program somewhere into your command path (e.g. to "C:") and the
   documentation wherever you want.

Ready!
@ENDNODE


@NODE E.usage "Usage"

@{FG Highlight}Usage@{FG Text}

@{b}MAT@{ub} can be only started from Shell. When you start @{b}MAT@{ub} with "?" as argument, the
following syntax will be shown to you:

@{b}FILE/A,DIR/A,NC=NOCOMMENT/S,Q=QUIET/S:@{ub}

After the colon you can still enter your arguments and options and start @{b}MAT@{ub} with them.
Of course you can start @{b}MAT@{ub} directly (without the detour about "?").

FILE:
The file "TREE" with path @{u}have to@{uu} be given here. The path can be leaved out, if the file
"TREE" is in the current directory.

DIR:
The destination-directory @{u}have to@{uu} be given here, in which the whole directory-tree
should be generated. ATTENTION: The directories will be generated in the destination-
directory in the same way, they are written in the file "TREE". I.e., @{u}no@{uu} parent directory
will be generated!

NC=NOCOMMENT:
If this switch is set, the generated directories will be @{u}not@{uu} provided with a comment.
Otherwise, the corresponding comment from the file "TREE" will be used. If @{b}MAT@{ub}
should make a directory which allready exists, this directory gets a comment, except
when the switch NOCOMMENT is set.

Q=QUIET:
If this switch is set, every output will be suppressed. On Amiga's without graficcard this
will result in a considerable speed up. Otherwise, it will be shown which directory will
be where generated and (if the option NOCOMMENT is not set) that the directory have
been commented.

@{b}Examplecall:@{ub}
> MAT DH0:Storage/TREE RAM: Q

@{b}MAT@{ub} loads the file "TREE" from the directory "DH0:Storage" and generates from it in
"RAM:" the whole directory-structure. The output will be suppressed.

While the program is running, @{b}MAT@{ub} can be everytime interrupted with the key combi-
nation "CTRL-C".
@ENDNODE

@NODE E.techn "Technical"

@{FG Highlight}Technical@{FG Text}

@{b}MAT@{ub} reads the file "TREE" in and ingores the first eight lines, because they are unnec-
essary. The text from the beginning of a line upto the next space will be interpreted as
directoryname, lines with a linefeed will be ignored. After generating a directory, it will
be provided with a corresponding comment, which is written in the file "TREE" after the
directoryname.
@ENDNODE

@NODE E.histo "History"

@{FG Highlight}History@{FG Text}

@{u}Version 1.0@{uu} (03.07.97)
· First release
@ENDNODE

@NODE E.thank "Thanks"
@{JCENTER}


@{FG Highlight}Thanks@{FG Text}

I have to thank the following persons:

@{b}Alexander Kazik@{ub}

who has been patience and spent much time, gives me first aid with much
tips and tricks, and makes it in general possible to finish @{b}MAT@{ub}

@{b}Matthias Henze@{ub}

for the stormamiga.lib (Aminet:dev/c/stormamiga_lib.lha), which makes @{b}MAT@{ub}
much more smaller and faster, and for the fast, good support
@ENDNODE

@NODE E.autho "Author"
@NEXT E.autho
@FONT Xcourier.font 13
@{CODE}
@{JCENTER}

If you have any questions, suggestions, wishes or
bug reports, please write me:

Andreas Mayer-Gürr

E-Mail: @{FG Highlight}andreas@amigaworld.com@{FG Text}
WWW: @{FG Highlight}http://www.amigaworld.com/andreas@{FG Text}
@ENDNODE