HOWTO · Bash
cat EOF in Bash
Dies erklärt, was cat-EOF ist und die Verwendung von cat-EOF in Bash.
Auf dieser Seite
Ein Here-Dokument ermöglicht es einer Shell, mehrere Textzeilen als Standardeingabe an einen Befehl zu übergeben. In Bash liest die Shell diese Zeilen; cat kopiert lediglich die Eingabe, die es erhält. EOF ist eine gebräuchliche Bezeichnung für das Trennwort, aber weder ein Befehl noch ein Schlüsselwort oder eine vorgeschriebene Schreibweise. Du kannst ein anderes Trennwort wählen, sofern die Abschlusszeile exakt damit übereinstimmt. Die Shell liest den Textblock, bevor sie den Befehl startet. Daher wertet cat das Trennwort nicht aus und entfernt es auch nicht.
So funktioniert ein Here-Dokument
Die allgemeine Form lautet command << DELIMITER, gefolgt von der Eingabe und einer Zeile, die nur das passende Trennwort enthält. Die Shell verarbeitet das Here-Dokument, bevor sie den Befehl ausführt, sodass dieser den Text über die Standardeingabe erhält. Das abschließende Trennwort muss am Zeilenanfang stehen, außer du verwendest die weiter unten beschriebene Form, die Tabulatoren entfernt. Vermeide Leerzeichen am Ende der Abschlusszeile: Sie werden Teil des Trennworts und verhindern, dass es erkannt wird. Als Trennwort eignet sich jedes Wort, das nicht allein in einer Zeile des Textblocks vorkommt. EOF und END sind gebräuchliche Varianten, bei denen die Abschlusszeile leicht zu erkennen ist.
Führe dieses Beispiel aus. Der Code und die angezeigte Ausgabe bleiben unverändert auf Englisch:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
cat <<'EOF'
A short note
with two lines.
EOF
Ausgabe:
A short note
with two lines.
Trennwort wählen und Expansion steuern
Bei einem Trennwort ohne Anführungszeichen expandiert Bash Parameter, Befehlssubstitutionen und arithmetische Ausdrücke im Textblock. Zum Beispiel kann cat <<EOF $HOME expandieren, bevor cat die Zeile erhält. Setze einen beliebigen Teil des Trennworts in Anführungszeichen, etwa bei <<'EOF', damit der Text wörtlich übergeben wird. Das ist hilfreich, wenn du Shell-Code mit $-Zeichen schreibst oder den Text genau so erhalten möchtest, wie du ihn eingegeben hast. Die Anführungszeichen bestimmen, wie Bash den Textblock behandelt; sie gehören nicht zum Trennwort, das den Block abschließt.
Die Form <<- entfernt führende Tabulatoren im Textblock und in der Abschlusszeile. Leerzeichen werden dabei nicht entfernt. Eine mit Leerzeichen eingerückte Abschlusszeile kann deshalb verhindern, dass das Trennwort erkannt wird. Verwende Tabulatoren bewusst, wenn du diese Form wählst; andernfalls setze das Trennwort an den linken Zeilenrand. Die Tabulatoren werden auch aus der weitergeleiteten Eingabe entfernt. Das ist wichtig, wenn sie am Zeilenanfang bedeutungsvolle Daten darstellen.
Datei mit cat erstellen oder erweitern
Leite die Standardausgabe um, um den Text zu speichern. > erstellt eine Datei oder ersetzt ihren bisherigen Inhalt; >> erstellt die Datei, falls sie noch nicht existiert, und hängt den Text andernfalls an. Jedes der folgenden Codebeispiele legt ein eigenes temporäres Verzeichnis an und setzt daher keine vorhandene Datei voraus. Du kannst die Umleitung je nach zulässiger Shell-Syntax vor oder nach dem Here-Dokument in die Befehlszeile setzen; der Textblock endet trotzdem an seinem Trennwort. Verwende > nur, wenn der bisherige Inhalt absichtlich ersetzt werden soll. Der Code und die angezeigten Ausgaben in diesem Abschnitt bleiben unverändert auf Englisch.
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
tmpdir=$(mktemp -d)
trap 'rm -rf "$tmpdir"' EXIT
cat <<'EOF' > "$tmpdir/notes.txt"
First line
Second line
EOF
cat <<'EOF' >> "$tmpdir/notes.txt"
Appended line
EOF
cat "$tmpdir/notes.txt"
Ausgabe:
First line
Second line
Appended line
Lass das Trennwort in Anführungszeichen stehen, wenn Variablen oder Substitutionen der Shell im Text nicht expandiert werden sollen.
Ein Bash-Skript mit einem Here-Dokument schreiben
Mit einem Here-Dokument kannst du ein Skript als reinen Text schreiben. Die Datei wird dadurch weder ausgeführt noch ausführbar gemacht. Das Beispiel schreibt ein Skript und startet anschließend Bash ausdrücklich; ausführbare Dateirechte sind dafür nicht erforderlich. Das Trennwort steht hier in Anführungszeichen, damit $ und andere Shell-Syntax im erzeugten Skript nicht von der Shell expandiert werden, die die Datei schreibt. Der Code und die angezeigte Ausgabe in diesem Abschnitt bleiben unverändert auf Englisch.
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
tmpdir=$(mktemp -d)
trap 'rm -rf "$tmpdir"' EXIT
cat <<'SCRIPT' > "$tmpdir/hello.sh"
#!/usr/bin/env bash
printf '%s\n' 'Hello from the script.'
SCRIPT
bash "$tmpdir/hello.sh"
Ausgabe:
Hello from the script.
Das Trennwort SCRIPT in Anführungszeichen sorgt dafür, dass die äußere Shell den Skripttext unverändert schreibt. Der Shebang legt fest, welches Bash verwendet wird, wenn die Datei später als Programm gestartet wird; bash path/to/file wählt Bash direkt aus. Wenn du die Datei über ihren Pfad starten möchtest, musst du sie zuerst ausführbar machen. Ein Skript mit cat zu erstellen oder zu erweitern, schreibt lediglich Bytes in die Datei; das Skript wird dadurch weder geprüft noch ausgeführt.
Eingabe eines Here-Dokuments durch eine Pipeline leiten
Die Shell kann ein Here-Dokument wie andere Standardeingaben an eine Pipeline anschließen. Hier wählt grep die passenden Zeilen aus, und tee schreibt diese Zeilen in eine Datei und gibt sie zugleich über die Standardausgabe weiter. So bleibt eine Kopie im Terminal und eine weitere in der Datei; Zeilen, die nicht passen, verwirft grep. Der Code und die angezeigte Ausgabe in diesem Abschnitt bleiben unverändert auf Englisch:
Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.
tmpdir=$(mktemp -d)
trap 'rm -rf "$tmpdir"' EXIT
cat <<'EOF' | grep 'keep' | tee "$tmpdir/selected.txt"
keep this line
drop this line
keep this one too
EOF
Ausgabe:
keep this line
keep this one too
Verwende ein Trennwort in Anführungszeichen, wenn der Beispieltext die Shell unverändert durchlaufen soll, bevor er die Pipeline erreicht.