tput - Datensichtstation initialisieren oder Datenbank terminfo abfragen

(initialize terminal or query terminfo database)

Dieses Kommando ist nur dann sinnvoll, wenn der Zugang zur POSIX-Shell via ssh oder rlogin von einem Zeichenterminal erfolgt.

Mit tput können Sie

• eine Eigenschaft einer Datensichtstation ausgeben (Format 1)

• mehrere Eigenschaften einer Datensichtstation ausgeben (Format 2)

• eine Datensichtstation initialisieren (Format 3)

• eine Datensichtstation zurücksetzen (Format 4)

• den ausführlichen Namen eines Datensichtstationstyps ausgeben (Format 5)

• den Bildschirm löschen (Format 6).

Syntax

Format 1:	tput[ -T typ] capname[ parameter...]
Format 2:	tput[ -T typ] -S
Format 3:	tput[ -T typ] init
Format 4:	tput[ -T typ] reset
Format 5:	tput[ -T typ] longname
Format 6:	tput[ -T typ] clear

Eine Eigenschaft einer Datensichtstation ausgeben

Format 1:

tput[ -T typ] capname[ parameter...]

Eine Eigenschaft einer Datensichtstation wird ausgegeben. Diese Eigenschaften sind in der Datenbank terminfo festgelegt.

Je nach Typ der Eigenschaft gibt tput folgendes aus:

• Eigenschaft vom Typ Boolescher Wert:
  tput liefert nur einen Endestatus zurück und zwar 0 für wahr, falls die Datensichtstation die Eigenschaft hat, und andernfalls 1 für falsch.
  In der POSIX-Shell kann der Endestatus mit echo $? angezeigt werden.
• Eigenschaft vom Typ Numerischer Wert:
  tput gibt eine ganze Zahl aus.
  Wenn der Eigenschaft für den angegebenen Datensichtstationstyp kein Wert zugewiesen ist, gibt tput -1 aus.
• Eigenschaft vom Typ Zeichenkette:
  tput gibt die entsprechende Zeichenkette (Steuerzeichensequenz) auf die Datensichtstation aus. Dadurch können der Cursor oder der Bildschirm der Datensichtstation entsprechend der Bedeutung der Eigenschaft manipuliert werden.
  Wenn der Eigenschaft für den angegebenen Datensichtstationstyp kein Wert zugewiesen ist, liefert tput den Endestatus 1 zurück.

Im Abschnitt "Terminal-Eigenschaften" des Handbuchs "POSIX Kommandos" gibt es eine Übersicht der Eigenschaften des Terminal-Typs "xterm" sowie der zugehörigen terminfo-Namen (siehe Spalte "terminfo-Name").

-T typ

Mit typ wird der Typ der Datensichtstation angegeben, deren Eigenschaft ausgegeben werden soll.

-T typ nicht angegeben:
Für typ wird der Wert der Umgebungsvariablen TERM eingesetzt.

capname

(capability name)

capname ist die Kurzbezeichnung einer Eigenschaft der Datensichtstation, wie in der Spalte terminfo-Name im Abschnitt "Terminal-Eigenschaften" des Handbuchs "POSIX Kommandos" angegeben. Um eine bestimmte Eigenschaft einer Datensichtstation auszugeben, muss die zugehörige Kurzbezeichnung capname angegeben werden.

parameter

Wenn die Eigenschaft capname eine Zeichenkette ist, welche Parameter benötigt, dann werden diese Parameter hinter capname angegeben.

Mehrere Eigenschaften einer Datensichtstation ausgeben

Format 2:

tput[ -T typ] -S

Mit diesem Format von tput können mehrere Eigenschaften der Datensichtstation ausgegeben werden. Die Kurzbezeichnungen der Eigenschaften und ggfs. die Parameter werden von der Standard-Eingabe gelesen. Pro Eingabezeile darf nur eine Eigenschaft angegeben werden. Wenn die Standard-Eingabe von der Datensichtstation gelesen wird, muss die Eingabe mit CTRL+D beendet werden.

Die Eingabezeilen haben das Format: 

capname[ parameter...]

-T typ, capname, parameter

Siehe Format 1.

Datensichtstation initialisieren

Format 3:

tput[ -T typ] init

Enthält die Datenbank terminfo einen Eintrag für den Datensichtstationstyp, initialisiert tput die Datensichtstation entsprechend wie folgt:

• Falls vorhanden, werden die Initialisierungszeichenketten der Datensichtstation ausgegeben. Die Kurzbezeichnungen dieser Eigenschaften lauten is1, is2, is3, if und iprog.
• Alle im Eintrag der Datensichtstation angegebenen Verzögerungen (z. B. für Zeilenumbrüche) werden im Terminaltreiber eingestellt.
• Die Tabulatorerweiterung wird entsprechend der Spezifikation im Eintrag der Datensichtstation ein- oder ausgeschaltet.
• Wenn keine Tabulatorerweiterung im Eintrag der Datensichtstation festgelegt ist, werden die Standard-Tabulatoren (an jedem achten Zeichen) gesetzt.

Falls der terminfo-Eintrag die Informationen für einen der Schritte nicht enthält, entfällt dieser Schritt ohne Fehlermeldung.

-T typ

Siehe Format 1.

Datensichtstation zurücksetzen

Format 4:

tput[ -T typ] reset

Enthält die Datenbank terminfo einen Eintrag für den Datensichtstationstyp, gibt tput die Zeichenketten für das Zurücksetzen der Datensichtstation aus. Die Kurzbezeichnungen dieser Eigenschaften lauten rs1, rs2, rs3 und rf. Falls für das Zurücksetzen keine Zeichenketten definiert sind, jedoch für die Initialisierung, dann werden die Zeichenketten für die Initialisierung ausgegeben.

-T typ

Siehe Format 1.

Ausführlichen Namen eines Datensichtstationstyps ausgeben

Format 5:

tput[ -T typ] longname

Enthält die Datenbank terminfo einen Eintrag für den Datensichtstationstyp, gibt tput den ausführlichen Namen des Datensichtstationstyps aus.

-T typ

Siehe Format 1.

Bildschirm löschen

Format 6:

tput[ -T typ] clear

Enthält die Datenbank terminfo einen Eintrag für den Datensichtstationstyp, gibt tput die Steuerzeichenkette für das Löschen des Bildschirms aus.

-T typ

Siehe Format 1.

Endestatus

Eigenschaft vom Typ Boolescher Wert:

0	Der angegebene Datensichtstationstyp hat die Eigenschaft.
1	Der angegebene Datensichtstationstyp hat die Eigenschaft nicht.

Eigenschaft vom Typ Zeichenkette:

0	Die Eigenschaft ist für diesen Datensichtstationstyp definiert.
1	Die Eigenschaft ist für diesen Datensichtstationstyp nicht definiert. Auf die Standard-Ausgabe wird nichts ausgegeben.

Eigenschaft vom Typ ganze Zahl:

0	Der Endestatus ist immer 0. Wird -1 auf die Standard-Ausgabe ausgegeben, dann ist die Eigenschaft für diesen Datensichtstationstyp nicht definiert.

Format 2 (tput -S):

0	Alle Zeilen wurden ohne Fehler abgearbeitet.

Fehlersituationen:

2	Fehlerhafter Aufruf, z.B. keine Angabe des Datensichtstationstyps.
3	Fehlerhafte Konfiguration, z.B. Datensichtstationstyp unbekannt.
4	Angabe einer unbekannten Datensichtstationseigenschaft.

Fehler

Je nach Endestatus gibt tput folgende Fehlermeldungen aus:

tput: Unbekanntes Terminal "type"
Der Datensichtstationstyp ist unbekannt, oder die Datenbank terminfo ist nicht vorhanden.
Endestatus 3

tput: Unbekannte terminfo-Faehigkeit 'capname'
Die angegebene Datensichtstationseigenschaft ist unbekannt.
Endestatus 4

Variable

TERM

Standard-Wert für den Typ der Datensichtstation, der eingesetzt wird, wenn die Option -T typ nicht angegeben ist.

Datei

/etc/termcap

Datei mit allen Eigenschaften aller Datensichtstationstypen in lesbarem Format.

/usr/share/lib/terminfo/?/*

Dateien mit allen Eigenschaften je eines Datensichtstationstyps in binärem (kompilertem) Format.

Internationale Umgebung

Die folgenden Umgebungsvariablen beeinflussen die Meldungsausgabe des Kommandos tput:

LANG

Gibt einen Standardwert für die Variablen für die internationale Umgebung an, die nicht gesetzt oder Null sind. Ist LANG nicht gesetzt oder Null, wird der entsprechende Standardwert der internationalen Umgebung verwendet. Enthält eine der Internationalisierungsvariablen eine ungültige Einstellung, verhält sich das Kommando so, als sei keine der Variablen definiert worden.

LC_ALL

Ist diese Variable auf einen Wert gesetzt, d. h. ist sie nicht leer, überschreibt dieser Wert die Werte aller übrigen Internationalisierungsvariablen.

LC_CTYPE

Legt die internationale Umgebung für die Interpretation der Byte-Folgen eines Datentexts als Zeichen fest (z.B. Singlebytezeichen im Unterschied zu Mehrbytezeichen in Argumenten und Eingabedateien) sowie die Einteilung der Zeichen in Groß- und Kleinbuchstaben und deren Übereinstimmung.

LC_MESSAGES

Legt die internationale Umgebung für Format und Inhalt der Diagnosemeldungen fest, die in die Standardfehlerausgabe geschrieben werden.

NLSPATH

Legt den Pfad der Meldungsdateien für LC_MESSAGES fest.

Beispiel 1

Akustisches Signal ausgeben

$ tput bel

Die Datensichtstation gibt ein akustisches Signal aus. Je nach Einstellungen der Datensichtstation kann auch ein optisches oder gar kein Signal ausgegeben werden.

Beispiel 2

Anzahl der Spalten der aktuellen Datensichtstation ausgeben

$ tput cols
80

Das Terminal hat (derzeit) 80 Spalten.

Beispiel 3

Abfragen, ob die aktuelle Datensichtstation ein Hardcopy-Terminal ist

$ tput hc
$ echo $?
1

Da hc ist vom Typ Boolescher Wert ist, liefert tput nur einen Endestatus zurück. Dieser Endestatus wird mit echo $? abgefragt. Der Endestatus ist 1, die aktuelle Datensichtstation ist also kein Hardcopy-Terminal.

Beispiel 4

Ausgabe von mehreren Eigenschaften der Datensichtstation mit einem tput-Aufruf

Die Datei geom hat den Inhalt:

cols
lines

$ tput -S <geom
120
42
$


Die Datensichtstation hat 120 Spalten (Eigenschaft cols) und 42 Zeilen (Eigenschaft lines).

Beispiel 5

Ausgabe von Text in einem alternativen Anzeigemodus

$ echo "Das ist der $(tput smul)unterstrichene$(tput rmul) Modus."
Das ist der unterstrichene Modus.
$

Die Ausgabe der Eigenschaft smul schaltet den unterstrichenen Modus ein, und die Ausgabe der Eigenschaft rmul schaltet ihn wieder aus.

Siehe auch

stty, tabs