In der Dokumentation verwendete Konventionen
In dieser Dokumentation werden verschiedene Konventionen für bestimmte Begriffe, Aktionen und Befehle, für betriebssystemabhängige Pfade sowie für plattformspezifische und produktspezifische Informationen verwendet.
Schriftbildkonventionen
In der Dokumentation werden die
folgenden Schriftbildkonventionen verwendet:
- Fettdruck
-
- Befehle in Kleinbuchstaben und mit gemischter Schreibweise, Parameter und Umgebungsvariablen, die andernfalls nur schwer vom übrigen Text zu unterscheiden sind.
- Steuerelemente der Schnittstelle (Kontrollkästchen, Schaltflächen, Optionsfelder, Drehfelder, Felder, Ordner, Symbole, Listenfelder, Einträge in Listenfeldern, mehrspaltige Listen, Container, Menüoptionen, Menünamen, Registerkarten, Merkmalseiten) und Markierungen (zum Beispiel Tipp:).
- Schlüsselwörter und Parameter im Text.
- Kursivdruck
-
- Zitate (Beispiele: Titel von Veröffentlichungen, Disketten und CDs).
- Im Text definierte Wörter und Ausdrücke (z. B. '... eine Standleitung wird auch als Punkt-zu-Punkt-Leitung bezeichnet.').
- Hervorhebungen von Wörtern und Buchstaben (Beispiel: 'Die LUN-Adresse muss mit dem Buchstaben L beginnen.').
- Neue Begriffe im Text (außer in einer Definitionsliste). Beispiel: Eine Ansicht ist ein Rahmen in einem Arbeitsbereich, der Daten enthält.
- Variablen und Werte, die vom Benutzer angegeben werden müssen (Beispiel: '...hierbei steht mein_name für...').
Monospaceschrift-
- Beispiele und Codebeispiele.
- Dateinamen, Verzeichnisnamen, Pfadnamen, Programmierungsschlüsselwörter, Eigenschaften und andere Elemente, die vom umgebenden Text schwer zu unterscheiden sind.
- Texte von Nachrichten und Systemanfragen.
- Vom Benutzer einzugebender Text.
- Werte für Argumente oder Befehlsoptionen.
- Monospaceschrift in Fettdruck
-
- Befehlsnamen und Namen von Makros und Dienstprogrammen, die Sie als Befehle eingeben können.
- Namen von Umgebungsvariablen im Text.
- Schlüsselwörter
- Parameternamen im Text: API-Strukturparameter, Befehlsparameter und -argumente, sowie Konfigurationsparameter.
- Prozessnamen.
- Namen von Registry-Variablen im Text.
- Scriptnamen.
Betriebssystemabhängige Variablen und Pfadangaben
Die
Darstellung des Schrägstrichs in Verzeichnispfaden (d. h. Schrägstrich oder Backslash)
wird in der vorliegenden Dokumentation möglicherweise nicht einheitlich
verwendet. Befolgen Sie unabhängig von der Darstellung in der Dokumentation die folgenden Richtlinien:
Verwenden Sie einen Schrägstrich (/).
Verwenden Sie einen Backslash, d. h., einen umgekehrten Schrägstrich (\).
Die Namen von Umgebungsvariablen können unter Windows und AIX variieren. So ist beispielsweise %TEMP% unter Windows gleichbedeutend mit $TMPDIR unter AIX oder Linux.
Befolgen Sie bei Umgebungsvariablen die folgenden Richtlinien:
Verwenden Sie die Schreibweise $variable.
Verwenden Sie die Schreibweise %variable%.
Wenn Sie auf einem
Windows-System mit der Bash-Shell arbeiten,
können Sie die AIX-Konventionen verwenden.
Variable für das Installationsverzeichnis und Pfadangaben für Agenten
installationsverzeichnis ist das Installationsverzeichnis
für die Agenten. Die Standardposition hängt vom Betriebssystem ab:
C:\IBM\APM
/opt/ibm/apm/agent
/opt/ibm/apm/agent