我一般都很喜欢无所事事，但有时候太无聊了也不行 —— 2015 年的一个星期天下午就是这样，我决定开始写一个开源项目来让我不那么无聊。

在我寻求创意时，我偶然发现了一个请求，要求构建一个由 Mathias Bynens 提出的“按 Web 标准构建的 Man 手册页查看器”。没有考虑太多，我开始使用 JavaScript 编写一个手册页解析器，经过大量的反复思考，最终做出了一个 Jroff。

那时候，我非常熟悉手册页这个概念，而且使用过很多次，但我知道的仅止于此，我不知道它们是如何生成的，或者是否有一个标准。在经过两年后，我有了一些关于此事的想法。

man 手册页是如何写的

当时令我感到惊讶的第一件事是，手册页的核心只是存储在系统某处的纯文本文件（你可以使用 manpath 命令检查这些目录）。

此文件中不仅包含文档，还包含使用了 20 世纪 70 年代名为 troff 的排版系统的格式化信息。

troff 及其 GNU 实现 groff 是处理文档的文本描述以生成适合打印的排版版本的程序。它更像是“你所描述的即你得到的”，而不是你所见即所得的。

• 摘自 troff.org

如果你对排版格式毫不熟悉，可以将它们视为 steroids 期刊用的 Markdown，但其灵活性带来的就是更复杂的语法：

groff 文件可以手工编写，也可以使用许多不同的工具从其他格式生成，如 Markdown、Latex、HTML 等。

为什么 groff 和 man 手册页绑在一起是有历史原因的，其格式随时间有变化，它的血统由一系列类似命名的程序组成：RUNOFF > roff > nroff > troff > groff。

但这并不一定意味着 groff 与手册页有多紧密的关系，它是一种通用格式，已被用于书籍，甚至用于照相排版。

此外，值得注意的是 groff 也可以调用后处理器将其中间输出结果转换为最终格式，这对于终端显示来说不一定是 ascii ！一些支持的格式是：TeX DVI、HTML、Canon、HP LaserJet4 兼容格式、PostScript、utf8 等等。

宏

该格式的其他很酷的功能是它的可扩展性，你可以编写宏来增强其基本功能。

鉴于 *nix 系统的悠久历史，有几个可以根据你想要生成的输出而将特定功能组合在一起的宏包，例如 man、mdoc、mom、ms、mm 等等。

手册页通常使用 man 和 mdoc 宏包编写。

区分原生的 groff 命令和宏的方式是通过标准 groff 包大写其宏名称。对于 man 宏包，每个宏的名称都是大写的，如 .PP、.TH、.SH 等。对于 mdoc 宏包，只有第一个字母是大写的： .Pp、.Dt、.Sh。

挑战

无论你是考虑编写自己的 groff 解析器，还是只是好奇，这些都是我发现的一些更具挑战性的问题。

上下文敏感的语法

表面上，groff 的语法是上下文无关的，遗憾的是，因为宏描述的是主体不透明的令牌，所以包中的宏集合本身可能不会实现上下文无关的语法。

这导致我在那时做不出来一个解析器生成器（不管好坏）。

嵌套的宏

mdoc 宏包中的大多数宏都是可调用的，这差不多意味着宏可以用作其他宏的参数，例如，你看看这个：

• 宏 Fl（Flag）会在其参数中添加破折号，因此 Fl s 会生成 -s
• 宏 Ar（Argument）提供了定义参数的工具
• 宏 Op（Optional）会将其参数括在括号中，因为这是将某些东西定义为可选的标准习惯用法
• 以下组合 .Op Fl s Ar file 将生成 [-s file]，因为 Op 宏可以嵌套。

缺乏适合初学者的资源

让我感到困惑的是缺乏一个规范的、定义明确的、清晰的来源，网上有很多信息，这些信息对读者来说很重要，需要时间来掌握。

有趣的宏

总结一下，我会向你提供一个非常简短的宏列表，我在开发 jroff 时发现它很有趣：

man 宏包：

• .TH：用 man 宏包编写手册页时，你的第一个不是注释的行必须是这个宏，它接受五个参数：title、section、date、source、manual。
• .BI：粗体加斜体（特别适用于函数格式）
• .BR：粗体加正体（特别适用于参考其他手册页）

mdoc 宏包：

• .Dd、.Dt、.Os：类似于 man 宏包需要 .TH，mdoc 宏也需要这三个宏，需要按特定顺序使用。它们的缩写分别代表：文档日期、文档标题和操作系统。
• .Bl、.It、.El：这三个宏用于创建列表，它们的名称不言自明：开始列表、项目和结束列表。

via: https://monades.roperzh.com/memories-writing-parser-man-pages/

作者：Roberto Dip 译者：wxy 校对：wxy 选题：lujun9972

本文由 LCTT 原创编译，Linux中国 荣誉推出

我过去认为 makefile 只是一种将一组组的 shell 命令列出来的简便方法；过了一段时间我了解到它们是有多么的强大、灵活以及功能齐全。这篇文章带你领略其中一些有关规则的特性。

备注：这些全是针对 GNU Makefile 的，如果你希望支持 BSD Makefile ，你会发现有些新的功能缺失。感谢 zge 指出这点。

规则

规则 rule 是指示 make 应该如何并且何时构建一个被称作为 目标 target 的文件的指令。目标可以依赖于其它被称作为 前提 prerequisite 的文件。

你会指示 make 如何按 步骤 recipe 构建目标，那就是一套按照出现顺序一次执行一个的 shell 命令。语法像这样：

target_name : prerequisites
    recipe

一但你定义好了规则，你就可以通过从命令行执行以下命令构建目标：

$ make target_name

目标一经构建，除非前提改变，否则 make 会足够聪明地不再去运行该步骤。

关于前提的更多信息

前提表明了两件事情：

• 当目标应当被构建时：如果其中一个前提比目标更新，make 假定目的应当被构建。
• 执行的顺序：鉴于前提可以反过来在 makefile 中由另一套规则所构建，它们同样暗示了一个执行规则的顺序。

如果你想要定义一个顺序但是你不想在前提改变的时候重新构建目标，你可以使用一种特别的叫做“ 唯顺序 order only ”的前提。这种前提可以被放在普通的前提之后，用管道符（|）进行分隔。

样式

为了便利，make 接受目标和前提的样式。通过包含 % 符号可以定义一种样式。这个符号是一个可以匹配任何长度的文字符号或者空隔的通配符。以下有一些示例：

• %：匹配任何文件
• %.md：匹配所有 .md 结尾的文件
• prefix%.go：匹配所有以 prefix 开头以 .go 结尾的文件

特殊目标

有一系列目标名字，它们对于 make 来说有特殊的意义，被称作 特殊目标 special target 。

你可以在这个文档发现全套特殊目标。作为一种经验法则，特殊目标以点开始后面跟着大写字母。

以下是几个有用的特殊目标：

• .PHONY：向 make 表明此目标的前提可以被当成伪目标。这意味着 make 将总是运行，无论有那个名字的文件是否存在或者上次被修改的时间是什么。
• .DEFAULT：被用于任何没有指定规则的目标。
• .IGNORE：如果你指定 .IGNORE 为前提，make 将忽略执行步骤中的错误。

替代

当你需要以你指定的改动方式改变一个变量的值， 替代 substitution 就十分有用了。

替代的格式是 $(var:a=b)，它的意思是获取变量 var 的值，用值里面的 b 替代词末尾的每个 a 以代替最终的字符串。例如：

foo := a.o
bar : = $(foo:.o=.c) # sets bar to a.c

注意：特别感谢 Luis Lavena 让我们知道替代的存在。

档案文件

档案文件是用来一起将多个数据文档（类似于压缩文件的概念）收集成一个文件。它们由 ar Unix 工具所构建。ar 可以用于为任何目的创建档案，但除了静态库，它已经被 tar 大量替代。

在 make 中，你可以使用一个档案文件中的单独一个成员作为目标或者前提，就像这样：

archive(member) : prerequisite 
    recipe

最后的想法

关于 make 还有更多可探索的，但是至少这是一个起点，我强烈鼓励你去查看文档，创建一个笨拙的 makefile 然后就可以探索它了。

via: https://monades.roperzh.com/rediscovering-make-power-behind-rules/

作者：Roberto Dip 译者：tomjlw 校对：wxy

本文由 LCTT 原创编译，Linux中国 荣誉推出