home *** CD-ROM | disk | FTP | other *** search
- DOCUMENT Man
-
- Man - © 1993-1995 by Markus Hillenbrand
- ---------------------------------------
-
- Man ist ein Hilfsprogramm zum Anzeigen von Texten aus der Shell heraus.
- Dazu muß das Commodity aber schon geladen sein.
-
-
- 1. Systemvoraussetzungen
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
- Benötigt werden: - asl.library v37
- - intuition.library v37
- - gadtools.library v37
- - graphics.library v37
- - dos.library v37
- - icon.library v37
- - commodities.library v37
- - workbench.library v37
- - utility.library v37
- - reqtools.llibrary v38 (c) by Nico François
-
- Unterstützt wird: - locale.library v38
-
- Empfohlen wird : - eine Festplatte zur effizienten Nutzung von Hilftexten
- - "Multiview" von OS3.0 zum automatischen Anzeigen von
- .guide-Dateien
- - "AmigaGuide" von OS2.0 als Ersatz für Multiview, wenn
- kein OS3.0 vorhanden
-
- 2. Installer
- ~~~~~~~~~~~~
-
- Da das Programm Installer (© by Commodore) nicht frei kopiert werden darf
- und für die Installation nötig ist, müssen Sie dafür sorgen, daß dieses
- Programm im Befehlspfad Ihrer Shell liegt (z.B. C:, SYS:Utilities, ...).
- Sie finden den Installer auf Ihrer Workbench-Diskette von OS2.0, OS2.1
- bzw OS3.0.
-
- Falls Ihre Version des Installers nicht mit der Installationsdatei von Man
- funktionieren sollte, gehen Sie wie folgt vor:
-
- 1. Klicken Sie das Icon 'Man' an und legen Sie es im Verzeichnis
- 'Workbench:WBStartup' ab.
- 2. Falls Sie über OS2.1 verfügen, kopieren Sie das Verzeichnis
- 'Catalogs' nach 'Locale:catalogs'.
-
-
- 3. ToolTypes
- ~~~~~~~~~~~~
-
- Das Programm sucht beim Start nach den folgenden Tooltypes:
-
- 3.1. CX_PRIORITY
- ~~~~~~~~~~~~~~~~
-
- CX_PRIORITY=x, wobei x für einen Wert mit -128<x<127 steht. Dieser Wert
- gibt die Priorität des Commodities an. Voreingestellt ist 0.
-
- 3.2. CX_POPKEY
- ~~~~~~~~~~~~~~
-
- Hier kann man den Hotkey angeben, bei dem das Konfigurationsfenster ge-
- öffnet werden soll. Voreingestellt ist 'ctrl lalt m'.
-
- 3.3. DONOTWAIT
- ~~~~~~~~~~~~~~
-
- Dieser Eintrag ist nicht weiter von Bedeutung; er ist nur für den System-
- start wichtig.
-
- 3.4. HOTKEY
- ~~~~~~~~~~~
-
- Hier kann man den Hotkey angeben, bei dem der Text-Requester angezeigt
- werden soll. Voreigestellt ist 'ctrl help'.
-
- 3.5. DATA
- ~~~~~~~~~
-
- Der hier angegebene Dateiname ist für die Liste der Texte. Unter diesem
- Namen werden die Text-Namen und ihre Pfade gespeichert. Voreingestellt
- ist 'Work:Man.LST'.
-
- 3.6. GUIDE
- ~~~~~~~~~~
-
- Das hier angegebene Programm wird benutzt, wenn eine Hypertext-Datei an-
- gezeigt werden soll.
-
- 3.7. DVI
- ~~~~~~~~
-
- Das hier angegebene Programm wird benutzt, wenn eine .dvi Datei angezeigt
- werden soll.
-
- 3.8. UNIX
- ~~~~~~~~~
-
- Das hier angegebene Programm wird benutzt, wenn eine UNIX man-page ange-
- zeigt werden soll.
-
- 3.9. PROGRAM
- ~~~~~~~~~~~~
-
- Das hier angegebene Programm wird benutzt, wenn ein normaler Hilftext an-
- gezeigt werden soll. Ein im Konfigurationsfenster eingegebenes Programm
- wird in den Tooltypes gespeichert, falls Sie im Konfigurationsfenster
- 'Speichern' gedrückt wird.
-
- 3.10. REQX bzw REQY
- ~~~~~~~~~~~~~~~~~~~
-
- Dies gibt die linke obere Ecke des Requesters an, der geöffnet wird, wenn
- man den Hotkey drückt oder 'man' in der Shell eingibt. Die Fensterposition
- kann gespeichert werden, wenn man im Konfigurationsfenster 'Speichern'
- drückt.
-
- 3.11. WINX bzw WINY
- ~~~~~~~~~~~~~~~~~~~
-
- Dies gibt die linke obere Ecke des Konfigurationsfensters an. Die Fenster-
- position kann gespeichert werden, wenn man im Konfigurationsfenster 'Spei-
- chern' drückt.
-
- 3.12. REQENTRIES
- ~~~~~~~~~~~~~~~~
-
- Gibt die maximal zulässige Zahl von Einträgen an, die im Listview des
- Auswahlrequesters sichtbar sind. Falls diese Zahl zu groß sein sollte,
- so wird ein angemessener Wert errechnet, so daß noch alles auf den Screen
- paßt.
-
- 4. Konfiguration
- ~~~~~~~~~~~~~~~~
-
- Das Programm wird konfiguriert, indem man in der Shell "man -c" oder
- "man -config" eingibt. Danach erscheint ein Window, in dem verschiedene
- Einstellungen gemacht werden können.
-
- Das Konfigurationsfenster wird aber auch geöffnet, indem man das Icon
- des Programmes zweimal anklickt oder aber (wenn das Commodity schon in-
- stalliert ist) bei Exchange (© by Comodore) das Gadget 'Fenster öffnen'
- anklickt.
-
- Das geöffnete Fenster ist ein App-Window, d.h. daß Icons, die auf dieses
- Fenster gezogen werden, automatisch in die Liste im Listview-Gadget über-
- nommen werden.
-
- Das Fenster ist in drei Sektionen unterteilt:
-
- 4.1. Liste der Hilfs-Texte
- ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- In der oberen Hälfte des Fensters ist ein Listviewgadget, in dem alle zur
- Zeit aktuellen Texte angezeigt sind. Rechts daneben befinden sich einige
- Gadgets, die folgendes bewirken:
-
- 4.1.1. Zufügen|Add
- ~~~~~~~~~~~~~~~~~~
-
- Klickt man dieses Gadgets an, so wird ein Requester geöffnet, mit dem man
- einen einzelnen Text hinzufügen kann.
-
- 4.1.2. Löschen|Delete
- ~~~~~~~~~~~~~~~~~~~~~
-
- Der im Listview-Gadget hervorgehobene Text wird (ohne Sicherheitsabfrage)
- aus der Liste gelöscht.
-
- 4.1.3. Ändern|Edit
- ~~~~~~~~~~~~~~~~~~
-
- Der im Listview-Gadget hervorgehobene Text kann mit diesem Gadget geändert
- werden (falls sich z.B. der Pfad geändert hat).
-
- 4.1.4. Einlesen|ScanDir
- ~~~~~~~~~~~~~~~~~~~~~~~
-
- Mit diesem Gadget kann ein ganzes Verzeichnis rekursiv durchsucht werden.
- Alle gefundenen Texte werden in das Listview-Gadget übernommen. Dieses
- Gadget ist bei der ersten Benutzung von Man besonders angebracht, da es
- viel Arbeit spart, z.B. den gesamten Pfad DH1: zu durchsuchen.
-
- 4.1.5. LöschAll|DelAll
- ~~~~~~~~~~~~~~~~~~~~~~
-
- Das soll heißen: Alles Löschen. Dieses Gadget bewirkt ein Löschen der ge-
- samten Liste. Aber keine Angst, es gibt eine Sicherheitsabfrage.
-
-
- 4.2. Anzeigeprogramm
- ~~~~~~~~~~~~~~~~~~~~
-
- Im Gadget "Anzeigeprogramm" kann man einen Textanzeiger angeben, mit dem
- die Hilftexte angezeigt werden sollen. Das Gadget rechts neben dem String
- Gadget öffnet einen Requester, mit dem das Programm ausgewählt werden
- kann.
-
- 4.3. Standard-Gadgets
- ~~~~~~~~~~~~~~~~~~~~~
-
- Mit 'Speichern' wird die aktuelle Konfiguration in gespeichert. Mit 'Verber-
- gen' wird das Fenster geschlossen und mit 'Beenden' wird das Commodity aus
- dem Speicher entfernt (eventuelle Änderungen werden NICHT gespeichert!!!)
-
-
- 5. Benutzung von der Shell aus
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- Um von der Shell aus einen Text anzeigen zu lassen, muß man diesen angeben.
- Dabei ist die Endung wegzulassen. "Man lha" sucht demnach in der Liste der
- Texte nach lha.doc, lha.dok, lha.man oder lha.guide oder ...
- Der Text wird dann mit dem voreingestellten Textanzeiger angezeigt.
- Gibt man "man -l" an, so wird eine Liste der Texte ausgegeben. Ruft man das
- Programm ohne Parameter auf, so wird eine Liste aller verfügbaren Hilfstexte
- angezeigt, in der man einen Text auswählen kann.
- Gibt man einen Pattern an (#?, ? usw.), so werden alle Texte, die zu diesem
- Pattern passen, aufgelistet. Paßt nur ein Text, so wird dieser gleich ange-
- zeigt.
- Mit "man -q" wird von der Shell aus das Kommodity verlassen.
-
- 6. Lokalisierung unter WB2.1+
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- Ab der Workbench 2.1 kann das Programm lokalisiert werden, das heißt es
- kann leicht in andere Sprachen übersetzt werden. Dazu ist der C-Quelltext
- von MAN.catalog dem Programm beigefügt. Im Original werden nur deutsch,
- schwedisch und englisch unterstützt.
- Der C-Text kann jedoch erweitert werden und mit einem geeigneten Programm
- (z.B. MakeCAT - © by Paladin-Software) wieder in einen Katalog umgewandelt
- werden.
- Wenn Sie den Katalog in eine andere Sprache übersetzen, so wäre es sehr nett,
- wenn Sie mir den Quelltext dieses neuen Katalogs per e-mail zusenden würden,
- damit die Sprache in neueren Versionen von Man schon von vornherein unter-
- stützt wird!
-
-
- 7. Copyright und Anderes
- ~~~~~~~~~~~~~~~~~~~~~~~~
-
- Copyright (C) 1993-95 by Markus Hillenbrand
-
- Dieses Programm darf kopiert und weitergegeben werden solange die Copyright-
- Notiz und diese Dokumentation unverändert auf allen Kopien enthalten ist.
-
- Es wird keine Garantie gegeben, daß das Programm 100%ig zuverlässig ist.
- Sie benutzen dieses Programm auf eigene Gefahr. Der Autor kann auf *keinen*
- Fall für irgendwelche Schäden verantwortlich gemacht werden, die durch die
- Anwendung dieses Programmes entstehen.
-
- ACHTUNG:
- Seit der Version 3.1 ist 'Man' CARDWARE, d.h. wenn Sie das Programm regel-
- mäßig benutzen, müssen Sie mir eine Postkarte mit einem Motiv aus Ihrer
- Heimat/Stadt/Ort/... zuschicken und ein paar Worte (in Ihrer Sprache ?)
- daraufschreiben.
-
- Das Copyright liegt weiterhin bei Markus Hillenbrand. Dies bedeutet, daß
- es von jedem kopiert werden darf, solange er nicht mehr als eine angemes-
- sene Kopiergebühr dafür verlangt.
-
- Dieses Paket darf in Public-Domain Sammlungen aufgenommen werden, in
- Mailboxsystemen oder auf FTP Servern abgelegt werden. Wenn Sie dieses
- Paket weitergeben wollen, dann *müssen* Sie die originale
- Distributionsdatei "man??.lha" benutzen.
-
- Dieses Programm darf nicht ohne eine schriftliche Genehmigung des Autors in
- kommerziellen Programmen benutzt werden.
-
-
- 8. Adresse des Autors
- ~~~~~~~~~~~~~~~~~~~~~
-
- Hier ist meine Adresse (für Anregungen, Bug-Report, die Postkarte oder
- Sonstiges):
-
- Markus Hillenbrand
- Hauptstraße 9
- 36124 Eichenzell-Löschenrod
-
- GERMANY
-
-
- oder e-mail: m_hillen@informatik.uni-kl.de
-
-
- 9. Man-Pages
- ~~~~~~~~~~~~
-
- Wenn Sie Interesse daran haben, eine Hilfs-Datei zu schreiben, so beachten
- Sie bitte die Hinweise in Verzeichnis "ManPages".
- Außerdem können Sie Lars Oloffson (e-mail: pt93lo@pt.hk-r.se) kontaktieren,
- um ein Archiv von Hilfs-Texten für die original AmigaDOS Befehle zu bekommen.
-
-
- 10. Danksagungen
- ~~~~~~~~~~~~~~~~
-
- - Nico François für seine berühmte reqtools.library
- - Lars Oloffson für die Schwedisch-Lokalisierung
- - Marcus Flehmig fürs Beta-Testen
- - Stephan Sürken für sein Program 'Text2Guide'
- - Roman Patzner für seine RomIcons
-