我有时会看到人们提到工具,例如ls
在括号中附加手册页部分编号,就像手册页本身ls(1)
在散文/文本中所做的那样(在 ls 的情况下),例如 stackexchange 上的答案和评论。这是好的做法吗?有关于这种做法的任何来源吗?有任何著名的“实体”,例如大公司、邮件列表等这样做吗?
答案1
在某些情况下,当单个名称引用多个联机帮助页时,它有助于避免歧义。
例如,unlink
手册页分为三个部分:
- unlink(1),描述用户级命令。
- unlink(2),它描述了实现取消链接功能的内核级别的系统调用。
- unlink(3p),它描述了包装系统调用的库函数。本页是 POSIX 程序员手册的一部分。
为了澄清您想要在特定上下文中引用哪个部分,指定部分编号会很有帮助。
由于问题中提到了该命令,因此该ls
命令有两个联机帮助页 -ls(1)
用于本地实现和ls(1p)
POSIX 定义。在这种情况下指定节号可能很有用。
对于明确的联机帮助页,节号不会增加太多价值。示例: 1) fstab
,第五节下有一个页面; 2) cron
,第八节下有一个页面。
此处列出了上面引用的所有联机帮助页:https://www.man7.org/linux/man-pages/dir_all_alphabetic.html