Notes on Clarifying Man Pages
8 days ago
- #usability
- #documentation
- #man-pages
- man手册页通常难以导航，这促使人们需要在其中加入更好的速查表。
- rsync的man手册页设有'OPTIONS SUMMARY'（选项摘要）部分，提供每个选项的简明描述。
- strace的man手册页按类别组织选项，提高了可用性。
- Perl的man手册页包含速查表，例如'man perlcheat'，这些速查表广受好评。
- man手册页中的示例非常受欢迎，有些手册页将示例放在开头以便快速参考。
- 在man手册页的HTML版本中添加目录和超链接可以增强导航功能。
- curl的man手册页为每个选项提供示例，并在其HTML版本中提供目录。
- 'man ascii'页面因其表格格式而受到称赞，使信息易于浏览。
- GNU coreutils更喜欢使用'info'手册而非man手册页，这些手册单独维护并提供更详细的文档。
- 像tldr.sh和Dash Mac文档浏览器这样的工具提供了访问man手册页信息的替代方式，并增加了额外功能。