Examples for the tcpdump and dig man pages

来源: Julia Evans Blog | 发布日期: 2026-03-10

核心观点

Julia Evans 分享了她为 tcpdump 和 dig 两个工具的 man 页面添加示例的经历。她的主要收获是:

1. 为初学者添加最基本的示例

目标是为偶尔使用或从未使用过这些工具的人提供最基本的用法示例。她的策略是说"我想为初学者和不频繁用户编写示例部分",这个说法很容易解释,也让维护者觉得有说服力。

2. 为什么改进 man 页面有价值

3. 处理 roff 语言的方法

tcpdump 的 man 页面是用 roff 语言写的,很难用。她写了一个简单的 Markdown 转 roff 脚本来转换格式。

4. 关于 man 页面的有趣事实

相关链接


← 返回索引