HELP

Art: transienter Befehl

Unter CP/M 3.0 gibt es die Möglichkeit, separate Hilfedateien anzulegen, die z.B. die Funktionsweise von einem bestimmten Programm oder von CP/M-Befehlen beschreiben. Der HELP-Befehl dient dazu, sich diese Dateien anzusehen, abzuändern oder neue HELP-Dateien zu erstellen. Als Dateiname ist nur HELP.HLP möglich.

Es handelt sich dabei nicht etwa um gewöhnliche Textdateien, sondern um ein gegliedertes Hilfe-System, das in zahlreiche Stichworte und Unterkategorien eingeteilt sein kann. Sie können sich beim Durchlesen gezielt die Stichworte auswählen, die Sie interessieren, ohne sich die gesamte Datei durchlesen zu müssen. Gesteuert wird dieser Zugriff durch ein einfaches Menüsystem, das von HELP.COM zur Verfügung gestellt wird, nachdem es die Datei HELP.HLP eingelesen hat. 
HELP-UTILITY V1.1

At "HELP>" enter topic {, subtopic}...

EXAMPLE:  HELP> DIR EXAMPLES

Topics available:

STICHWORT1   STICHWORT2   STICHWORT3   STICHWORT4   STICHWORT5   STICHWORT6
STICHWORT7   STICHWORT8   STICHWORT9   usw...

HELP>      ... hier wählen Sie das gewünschte Stichwort aus ...
Falls Sie das Menüsystem nicht benutzen möchten, können Sie stattdessen gleich beim Aufruf von HELP.COM das gewünschte Stichwort mit angeben. Es wird dann sofort an die gesuchte Stelle gesprungen, ohne vorher das Menü anzuzeigen.

Commodore hat auf der CP/M-Systemdiskette übrigens bereits eine sehr nützliche HELP-Datei mitgeliefert. Die Texte sind aber leider alle in englischer Sprache. Folgende Menüpunkte erscheinen:

Topics available:

C128_CP/M    COMMANDS     CNTRLCHARS   COPYSYS      DATE         DEVICE
DIR          DUMP         ED           ERASE        FILESPEC     GENCOM
GET          HELP         HEXCOM       INITDIR      KEYFIG       LIB
LINK         MAC          PATCH        PIP (COPY)   PUT          RENAME
RMAC         SAVE         SET          SETDEF       SHOW         SID
SUBMIT       TYPE         USER         XREF

HELP>
Optionen des HELP-Befehls

Option Beschreibung
NOPAGE Beim Anzeigen der Texte wird das Bildschirmschrolling nicht mehr nach 23 Zeilen angehalten. Die Texte werden in voller Länge an das jeweilige Ausgabegerät weitergeleitet. Diese Option ist nützlich, wenn man z.B. mit CONTROL-P die Bildschirmausgabe auf einen Drucker umgeleitet hat. Die Texte werden dann ohne Unterbrechung in voller Länge abgedruckt..
LIST Diese Option hat die gleiche Funktion wie NOPAGE.
CREATE Mit der Option CREATE kann man aus einer vorhandenen Textdatei eine neue HELP.HLP-Datei erstellen. Damit das funktioniert, muß die Textdatei muß nach einem bestimmten Muster aufgebaut sein. Mehr dazu siehe unten. Die Quelldatei muß den Namen HELP.DAT tragen.
EXTRACT Die Datei HELP.HLP wird in eine ASCII-Textdatei umgewandelt, die man mit jedem herkömmlichen Texteditor bearbeiten kann. Die erzeugte ASCII-Datei trägt den Namen HELP.DAT.

Format-Schablone

 HELP {Stichwort} {Unterbegriff1 ... Unterbegriff8} { [NOPAGE | LIST] }
HELP { [EXTRACT | CREATE] }

Beispiele

 HELP

Wenn der HELP-Befehl ohne weitere Optionen gestartet wird, zeigt HELP.COM ein Menü an, das alle Stichworte aus der Datei HELP.HLP zur Auswahl anbietet. Die Menüpunkte erscheinen unterhalb der Zeile "Topics available". Am HELP-Prompt muß man das gewünschte Hilfethema eingeben und kann dann die entsprechenden Texte lesen. Falls es zu dem Stichwort noch weitere Unterkategorien gibt können diese ebenfalls mit eingegeben werden. Wenn der Hilfe-Text länger als 23 Bildschirmzeilen ist, wird das Scrolling automatisch angehalten. Durch einen Tastendruch können Sie sich dann die nächsten 24 Zeilen ansehen.

HELP [NOPAGE]

HELP.COM wird gestartet wie im ersten Beispiel. Einziger Unterschied: Wenn beim Anzeigen der Texte eine Bildschirmseite vollgeschrieben ist, wird das Scrolling nicht mehr angehalten. Der Text läuft bis zum Ende durch.

HELP DEVICE

HELP.COM sucht in der Datei HELP.HLP den Text zum Stichwort DEVICE und zeigt ihn an.

HELP SET PASSWORD

HELP.COM sucht in der Datei HELP.HLPden Text zum Stichwort SET. Von diesem Text wird dann die Unterkategorie PASSWORD angezeigt.

Erstellen eigener HELP-Dateien und Bearbeiten vorhandener Texte

Die Hilfe-Datei muß immer den Namen HELP.HLP tragen, andere Dateinamen sind nicht möglich. Die Texte liegen in einem speziellen Format vor, das ohne Konvertierung von einem normalen Texteditor nicht gelesen werden kann. Um eine HELP-Datei zu verändern, muß diese erst einmal in eine gewöhnliche ASCII-Textdatei umgewandelt werden. Hierfür besitzt HELP.COM die Option EXTRACT. Danach erhält man eine Datei mit dem Namen HELP.DAT, die man mit jedem üblichen Texteditor weiterbearbeiten kann. Die einzelnen Stichworte werden in dieser Datei immer mit drei Schrägstrichen eingeleitet.

Der ASCII-Text muß nach folgendem Muster aufgebaut sein: 
///1DIR

Dies ist ein allgemeiner Beispieltext für die Anleitung zum DIR-Befehl
Foo fewf fwergfe egr rwegerwg reg gewrger ygre sd gg ehzu xcbj

///2OPTIONEN

... und hier werden z.B. die Optionen des DIR-Befehls erklart ...
wzszh gwe gbiew qdw io vio ceyw ew asp fsda ewv sfnw rasd

Hinweis: Die "OPTIONEN" sind in diesem Beispiel eine Unterkategorie des Stichwortes "DIR". Deshalb wird hinter den drei Schrägstrichen eine "2" als Hierarchiestufe angegeben. Beim späteren Aufruf würde man diese Unterkategorie mit HELP DIR OPTIONEN anzeigen können.

Um eine neue HELP-Datei aus dem ASCII-Text zu erzeugen, benutzt man die CREATE-Option von HELP.COM. Aus der vorhandenen Datei HELP.DAT wird dann eine neue Hilfe-Datei mit dem Namen HELP.HLP erzeugt.

1