Syntaxbeschreibung eines Kommandos ausgeben
Komponente: | SDF |
Funktionsbereich: | SDF-Steuerung |
Anwendungsbereich: | SDF |
Privilegierung: | STD-PROCESSING |
Funktionsbeschreibung
Das Kommando SHOW-CMD gibt die Syntaxbeschreibung eines Kommandos aus. Zusätzlich werden der Name und Typ der verwendeten Syntaxdatei angezeigt. Mit CMD-NAME=*ALL erhält der Benutzer eine Liste aller Kommandonamen. Durch Verwendung von Musterzeichen im Kommandonamen erhält der Benutzer eine Liste von Kommandonamen, die der Musterzeichenfolge entsprechen.
Die Ausgabe erfolgt wahlweise auf SYSOUT oder SYSLST.
Der Operand INFORMATION steuert den Umfang der Syntaxbeschreibung. Mit der Angabe INFORMATION=*MINIMUM erhält der Benutzer den Kommandonamen, den Namen der Syntaxdatei, die die Syntaxbeschreibung enthält, die Operandennamen und eventuelle Default-Werte. Alternative Operandenwerte werden bei INFORMATION=*MEDIUM zusätzlich angezeigt. Bei INFORMATION=*MAXIMUM enthält die Ausgabe auch Hilfetexte.
Bei der Ausgabe wird nur die Syntaxbeschreibung der zugewiesenen Syntaxdateien wiedergegeben. Insbesondere werden task-spezifische Default-Werte nicht angezeigt.
Der Operand FORM steuert die Ausgabe von Syntaxobjekten, deren Eingabe im geführten Dialog nicht zulässig ist. Mit FORM=*UNGUIDED erhält der Benutzer die Kommandosyntax, die auch im ungeführten Dialog eingegeben werden kann, bzw. eine Kommandoliste, die auch Aliasnamen der Kommandonamen enthält. Kommandos bzw. Operanden, die im geführten Dialog nicht zulässig sind, werden mit einem führenden Stern (*) gekennzeichnet.
Der Operand CHECK-PRIVILEGES bestimmt, ob bei der Ausgabe die Privilegien des Benutzers berücksichtigt werden. Mit CHECK-PRIVILEGES=*YES erhält er nur Informationen über Operanden und Operandenwerte von Kommandos, die er entsprechend seinen Privilegien auch verwenden darf. Bei der Ausgabe einer Liste von Kommandonamen sind Kommandos, die der Benutzer nicht verwenden darf, mit einem Stern (*) gekennzeichnet.
Der Operand CHECK-INPUT-MODE steuert die Ausgabe von Syntaxobjekten, deren Eingabe nur in einem bestimmten Eingabemodus zulässig ist. Der Benutzer kann sich somit informieren, welche Operanden bzw. Werte z.B. bei Eingabe im Batchbetrieb zulässig sind. Ohne Angabe eines Eingabemodus (*NO) werden Kommandos bzw. Operanden, bei denen Einschränkungen bezüglich der Eingabemodi (Dialog, Batchbetrieb, Prozedur im Dialog bzw. Batchbetrieb) bestehen, mit einem führenden Stern (*) gekennzeichnet.
Format
SHOW-CMD | ||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||
Operandenbeschreibung
CMD-NAME = *ALL / <structured-name 1..30 with-wild>
Name des gewünschten Kommandos.
CMD-NAME = *ALL
Listet alle Kommandos in alphabetischer Reihenfolge auf. Mit FORM=*UNGUIDED werden auch definierte Aliasnamen (in eigenen Ausgabezeilen) ausgegeben.
CMD-NAME = <structured-name 1..30 with-wild>
Name des Kommandos, dessen Syntax ausgegeben werden soll. Bei Angabe eines Aliasnamens wird der reale Kommandoname ausgegeben, gefolgt vom Aliasnamen in Klammern.
Bei Verwendung von Musterzeichen werden alle Kommandos in alphabetischer Reihenfolge aufgelistet, die der eingegebenen Musterzeichenfolge entsprechen. Dabei werden mit FORM=*UNGUIDED auch der Musterzeichenfolge entsprechende definierte Aliasnamen (in eigenen Ausgabezeilen) ausgegeben.
INFORMATION = *MINIMUM / *MEDIUM / *MAXIMUM
Bestimmt den Umfang der Ausgabe. Bei Ausgabe von Kommandolisten wird der Operand INFORMATION ignoriert.
INFORMATION = *MINIMUM
Die Ausgabe enthält den Kommandonamen, Operanden und voreingestellte Operandenwerte.
INFORMATION = *MEDIUM
Die Ausgabe enthält den Kommandonamen, Operanden, voreingestellte und alternative Operandenwerte.
INFORMATION = *MAXIMUM
Die Ausgabe enthält den Kommandonamen, Operanden, voreingestellte und alternative Operandenwerte. Zusätzlich werden alle Hilfetexte angezeigt.
FORM = *GUIDED / *UNGUIDED
Bestimmt, ob die Syntax für den geführten oder den ungeführten Dialog ausgegeben werden soll.
FORM = *GUIDED
Operanden und Operandenwerte, die im geführten Dialog nicht erlaubt sind, werden nicht ausgegeben.
FORM = *UNGUIDED
Die Ausgabe enthält auch Operanden und Operandenwerte, die im geführten Dialog nicht erlaubt sind. Bei Ausgabe von Kommandolisten (CMD=*ALL) werden Aliasnamen in eigenen Ausgabezeilen angezeigt.
CHECK-PRIVILEGES = *YES / *NO
Bestimmt, ob bei der Ausgabe die Privilegien des Benutzers berücksicht werden.
CHECK-PRIVILEGES = *YES
Der Benutzer erhält nur Informationen über Kommandos, Operanden und Operandenwerte, die er entsprechend seinen Privilegien auch verwenden darf.
CHECK-PRIVILEGES = *NO
Der Benutzer erhält unabhängig von seinen Privilegien Informationen über alle Kommandos, Operanden und Operandenwerte.
CHECK-INPUT-MODE = *CURRENT / *DIALOG / *DIALOG-PROC / *BATCH / *BATCH-PROC / *NO
Bestimmt, für welchen Eingabemodus die Syntax angezeigt werden soll. Dem Benutzer werden nur Syntaxobjekte angezeigt, die in dem angegebenen Eingabemodus zulässig sind.
CHECK-INPUT-MODE = *CURRENT
Die Ausgabe enthält nur für den aktuellen Eingabemodus zulässige Syntaxobjekte.
CHECK-INPUT-MODE = *DIALOG
Die Ausgabe enthält nur für den Dialogmodus zulässige Syntaxobjekte.
CHECK-INPUT-MODE = *DIALOG-PROC
Die Ausgabe enthält nur für den Dialogprozedurmodus zulässige Syntaxobjekte.
CHECK-INPUT-MODE = *BATCH
Die Ausgabe enthält nur für den Batchmodus zulässige Syntaxobjekte.
CHECK-INPUT-MODE = *BATCH-PROC
Die Ausgabe enthält nur für den Batchprozedurmodus zulässige Syntaxobjekte.
CHECK-INPUT-MODE = *NO
Die Ausgabe erfolgt unabhängig vom Eingabemodus. Die Ausgabezeilen mit Kommandos bzw. Operanden, die im aktuellen Eingabemodus nicht zulässig sind, werden mit einem führenden Stern (*) gekennzeichnet.
OUTPUT = *SYSOUT / *SYSLST(...)
Gibt an, wohin die Information auszugeben ist.
OUTPUT = *SYSOUT
Die Ausgabe erfolgt in die Systemdatei SYSOUT.
OUTPUT = *SYSLST(...)
Die Ausgabe erfolgt druckaufbereitet in die Systemdatei SYSLST.
Das erste Byte jedes Ausgabesatzes ist X'40'. Der Operand LINES-PER-PAGES bestimmt, nach wie vielen Ausgabesätzen eine Überschriftszeile mit Seitenvorschub erzeugt wird.
SYSLST-NUMBER = *STD / <integer 1..99>
Bestimmt, ob die Ausgabe in die Systemdatei SYSLST oder in eine SYSLST-Datei aus der Menge SYSLST01 bis SYSLST99 erfolgen soll.
Default-Wert ist *STD, d.h. die Ausgabe erfolgt in die Systemdatei SYSLST.
LINES-PER-PAGE = *STD / *UNLIMITED / <integer 1..200>
Gibt an, nach wie vielen Ausgabesätze eine neue Druckseite beginnen soll. Jede Druckseite beginnt mit einer Überschriftszeile, die im ersten Byte ein Seitenvorschub-Steuerzeichen enthält. In der Überschrift steht der Name des angezeigten Kommandos und die Seitennummer.
LINES-PER-PAGE = *STD
Nach 55 Ausgabesätzen beginnt eine neue Druckseite.
LINES-PER-PAGE = *UNLIMITED
Die Ausgabe wird nicht in Druckseiten aufgeteilt. Es werden keine Überschriftszeilen ausgegeben.
Kommando-Returncode
(SC2) | SC1 | Maincode | Bedeutung / garantierte Meldungen |
|---|---|---|---|
0 | CMD0001 | Kommando fehlerfrei ausgeführt | |
1 | 32 | CMD0500 | Syntaxbeschreibung in der aktuellen Syntaxdatei fehlerhaft |
1 | 64 | CMD0812 | Kommandoausführung nicht erfolgreich |
Beispiele
/show-cmd cmd=add-pass ————————————————————————————————————————————— (1)
%ADD-PASSWORD (ADD-PASS,ADPW) % FROM :2OSH:$TSOS.SYSSDF.BS2CP.190 (SYSTEM) % PASSWORD =
/show-cmd cmd=add-pass,information=max ——————————————————————————————— (2)
%ADD-PASSWORD (ADD-PASS,ADPW) % FROM :2OSH:$TSOS.SYSSDF.BS2CP.190 (SYSTEM) %Adds passwords for files or job variables to the password table of the %task % PASSWORD = % -list-possible (63)-: x-string_1..8 or c-string_1..4 or % integer_-2147483648..2147483647 % Specifies passwords to be added to the password table
/show-cmd cmd=write* ———————————————————————————————————————————————— (3)
% WRITE-ACCOUNTING-RECORD % WRITE-SPOOL-TAPE % WRITE-TEXT
(1) | Ausgabe der Syntax des Kommandos ADD-PASSWORD. |
(2) | Ausgabe der Syntax des Kommandos ADD-PASSWORD mit allen Operanden, Operandenwerten und Hilfetexten (INFORMATION=*MAXIMUM). |
(3) | Ausgabe aller Kommandos, die mit der Zeichenfolge „WRITE” beginnen. |