Examples for the tcpdump and dig man pages
核心观点
Julia Evans 分享了她为 tcpdump 和 dig 两个工具的 man 页面添加示例的经历。她的主要收获是:
1. 为初学者添加最基本的示例
目标是为偶尔使用或从未使用过这些工具的人提供最基本的用法示例。她的策略是说"我想为初学者和不频繁用户编写示例部分",这个说法很容易解释,也让维护者觉得有说服力。
2. 为什么改进 man 页面有价值
- 准确性: man 页面可以接近 100% 准确,通过审查流程确保信息真实
- 发现新功能: 即使是"最常用的 tcpdump 标志是什么"这样的基本问题,维护者也知道的比用户多。例如她学到如果用
tcpdump -w out.pcap保存包,传-v可以打印已捕获包的实时摘要
3. 处理 roff 语言的方法
tcpdump 的 man 页面是用 roff 语言写的,很难用。她写了一个简单的 Markdown 转 roff 脚本来转换格式。
4. 关于 man 页面的有趣事实
- BSD 系统使用 mandoc 项目来格式化 man 页面
- Git 的错误消息被翻译成 19 种语言