HOWTO · Bash
Cat EOF en Bash
Esto explica qué es cat EOF y el uso de cat EOF en bash.
En esta página
Un here-document permite que el shell pase varias líneas de texto a un comando como entrada estándar. En Bash, el shell lee esas líneas; cat simplemente copia la entrada que recibe. EOF es una etiqueta convencional para el delimitador, no un comando, una palabra clave ni una escritura obligatoria. Puedes elegir otro delimitador, siempre que la línea de cierre coincida exactamente con él. El shell lee el cuerpo antes de iniciar el comando, así que cat no interpreta ni elimina el delimitador.
Cómo funciona un here-document
La forma general es command << DELIMITER, seguida de la entrada y de una línea que contiene únicamente el delimitador correspondiente. El shell consume el here-document antes de ejecutar el comando, así que este recibe el texto por la entrada estándar. La línea de cierre debe empezar al principio de la línea, salvo que uses la forma que elimina tabulaciones que se describe más adelante. Evita los espacios al final de la línea de cierre, porque pasan a formar parte del texto del delimitador e impiden que coincida. El delimitador puede ser cualquier palabra adecuada que no aparezca sola en una línea del cuerpo; EOF y END son convenciones que facilitan reconocer la línea de cierre.
Ejecuta este ejemplo:
El código y las etiquetas o salidas visibles de esta sección se mantienen en inglés.
cat <<'EOF'
A short note
with two lines.
EOF
Salida:
A short note
with two lines.
Elige un delimitador y controla la expansión
Si el delimitador no está entre comillas, Bash expande los parámetros, las sustituciones de comandos y las expresiones aritméticas del cuerpo. Por ejemplo, cat <<EOF puede expandir $HOME antes de que cat reciba la línea. Pon entre comillas cualquier parte del delimitador, como en <<'EOF', para pasar el cuerpo literalmente. Esto resulta útil al escribir código de shell que contiene caracteres $ o cuando quieres conservar el texto tal como lo escribiste. Las comillas afectan la forma en que Bash procesa el cuerpo; no forman parte del delimitador de cierre.
La forma <<- elimina las tabulaciones iniciales del cuerpo y del delimitador de cierre. No elimina los espacios, por lo que una sangría hecha con espacios puede impedir que coincida el delimitador de cierre. Si eliges esta forma, usa tabulaciones deliberadamente; de lo contrario, coloca el delimitador al principio de la línea. Esta eliminación de tabulaciones también afecta a la entrada que se envía al comando, algo que importa si esas tabulaciones iniciales son datos significativos.
Crea o añade contenido a un archivo con cat
Redirige la salida estándar para guardar el texto. > crea un archivo o reemplaza su contenido existente; >> crea el archivo si hace falta y, si ya existe, añade texto al final. Cada ejemplo de código crea su propio directorio temporal, así que no depende de que haya un archivo previo. Según permita la sintaxis del shell, coloca la redirección en la línea del comando antes o después del cuerpo del here-document; el cuerpo termina igualmente en su delimitador. Usa > solo cuando quieras reemplazar el contenido anterior.
El código y las etiquetas o salidas visibles de esta sección se mantienen en inglés.
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"
Salida:
First line
Second line
Appended line
Mantén el delimitador entre comillas cuando no quieras que se expandan las variables ni las sustituciones del shell.
Escribe un script de Bash con un here-document
Un here-document permite escribir un script como texto sin formato. Crear el archivo no lo ejecuta ni le concede permisos de ejecución. El ejemplo escribe un script y luego invoca Bash explícitamente, así que no depende de esos permisos. Aquí es importante usar un delimitador entre comillas: así se evita que el shell que escribe el archivo expanda $ y otros elementos de la sintaxis del shell incluidos en el script generado.
El código y las etiquetas o salidas visibles de esta sección se mantienen en inglés.
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"
Salida:
Hello from the script.
El delimitador entre comillas SCRIPT mantiene literal el cuerpo del script mientras el shell externo lo escribe. La línea shebang identifica Bash cuando más adelante se ejecuta el archivo como programa; bash path/to/file selecciona Bash directamente. Si quieres ejecutar el archivo indicando su ruta, primero asígnale permisos de ejecución. Crear un script o añadirle contenido con cat solo escribe bytes; no valida ni ejecuta el script.
Pasa la entrada del here-document por una tubería
El shell puede conectar un here-document a una tubería igual que cualquier otra entrada estándar. En este caso, grep selecciona las líneas coincidentes y tee escribe esas líneas en un archivo y, a la vez, las envía a la salida estándar. Así se conserva una copia en la terminal y otra en el archivo, mientras que grep descarta las líneas que no coinciden:
El código y las etiquetas o salidas visibles de esta sección se mantienen en inglés.
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
Salida:
keep this line
keep this one too
Usa un delimitador entre comillas cuando quieras que el texto de ejemplo llegue sin cambios a la tubería, sin que el shell lo expanda antes.