如何使用 heredoc 作为文本编辑器

在 Linux 和 Unix shell 中有一个有些晦涩的功能，它允许你为 cat 命令打开一种 do-while 循环。它被称为 heredoc，它或多或少地使你拥有一个文本编辑器，无论你使用什么 shell。语法是：

$ cat << EOF >> example.txt

中间的字符串本质上是一个停止循环的条件。也就是说，如果你单独在一行键入，循环就会结束。在循环期间，你键入到终端中的任何内容都会被管道输送到目标文件（在本例中）。

安装

只要你有一个终端，你就可以启动一个 heredoc。我已经在 Bash, tsch, 和 Korn shell 中使用了这种语法技巧。

使用 heredoc

要打开一个 heredoc “会话”，你可以使用带有重定向的 cat 命令，该重定向首先指向带有终止字符串的 cat（通常的约定是 EOF，表示“文件结束”，但实际上可以是任何东西）。 在终止关键字之后，将你的输出重定向到目标文件。 然后，你可以直接在终端中键入，使用大多数常见的 shell 键盘快捷键来浏览你的工作。 当你在一行中单独键入你指定的终止字符串时，你的会话结束。 你可以通过独特的提示符（通常是 > 字符）知道你是否处于 heredoc 循环中。

$ cat << EOF >> example.txt
> Everything you type here will be placed into example.txt when I type EOF on a line by itself. Until then, you can type...
>
> whatever...
>
> you want to type.
>
> EOF
$  

你在终端等待 EOF 时输入的所有内容都会放入目标文件中。 提示符字符被省略，EOF 本身不是文件的一部分。

Everything you type here will be placed into example.txt when I type EOF on a line by itself. Until then, you can type...

whatever...

you want to type.

实际上，你可能不会使用 heredoc 语法来替代好的文本编辑器。 这是一个很棒的快速技巧，可以输入多行，但是超过 10 行左右，它的实用性就开始下降。 例如，你无法在不触发 shell 的 history 功能的情况下向上编辑前面的行。 根据你的 shell 及其配置方式，你可以向上，然后向下调用你的文本，然后使用 Ctrl+B 在你的文本中向后移动。

你的 shell 的大多数功能都可以按预期工作，但可能没有撤消并且很少有错误恢复。

此外，即使是最少的安装也可能至少安装了 Vi 或 ed。

然而，heredoc 仍然有用！ 它比 echo 更加灵活，并且当你在 shell 脚本上工作时，它是必不可少的。 例如，假设你正在编写一个安装脚本，以便自动安装一组自定义应用程序。 其中一个应用程序未随附 .dekstop 文件一起分发，因此它不会出现在你的应用程序菜单中。 为了解决这个问题，你决定在安装时生成一个 .desktop 文件。

你可以使用 heredoc 在你的安装脚本本身中，而不是编写一个 .desktop 文件并将其作为安装脚本的外部依赖项随身携带。

#!/bin/sh

VERSION=${VERSION:-x.y.z}
PKGNAM=${VERSION:-example}
PKG="${PKGNAM}"-"${VERSION}"-`arch`.tgz

# download package
wget "${PKG}"
tar txvf "${PKG}"

# use here doc to create missing .desktop file
cat << EOF >> $HOME/.local/share/applications/example.desktop
[Desktop Entry]
Version=1.0
Type=Application
Name="${PKGNAM}"
Comment="${PKGNAM}"
Exec="${PKGNAM}" %F
EOF

# insert the rest of an install script...

你已将文本条目自动化到一个文件中，无需使用文本编辑器（显然，除了你用来编写脚本的那个）。 这是生成的 .desktop 文件的样子

[Desktop Entry]
Version=1.0
Type=Application
Name=example
Comment=example
Exec=example %F

如你所见，你可以在 heredoc 中使用变量，并且它们会被正确解析。EOF 字符串不会出现在文件中； 它仅表示 heredoc 的结尾。

比 echo 更好

通常认为 heredoc 技术比 echo 或 printf 更容易，因为一旦你“进入”该文档，你就可以自由地做任何你想做的事情。 从这个意义上说，它是解放的，但与适当的文本编辑器相比，它是有限的。

使用 heredoc 编写快速笔记和 shell 脚本，并且永远不要再为如何动态生成配置文件而烦恼。