Linux man-pages 中缺失的手册页

以下是可能应该添加到 man-pages 集合中的页面列表。如果您正在考虑编写其中一个或多个页面，那么

• 明智的做法是提前告知维护者，以防其他人已经开始编写该页面或相关页面。维护者也可能会为您指出手册页的有用信息来源。
  
  
• 您需要对该主题有相当程度的理解，或者准备投入时间（例如，阅读源代码、编写测试程序）来获得这种理解。编写测试程序很重要：在准备手册页期间，在编写测试程序时，已经发现了很多内核和 glibc 的错误。
  
  
• 请遵循手册页的现有格式约定。有关格式的一些信息在 man(7) 和 man-pages(7) 手册页中提供。作为如何使用这些约定的示例，请查看 fcntl(2) 手册页并阅读其源文件 (man2/fcntl.2)。
  
  
• 该页面必须以某种允许自由重新分发和修改的许可证提交。请在手册页的源代码中包含该许可证或对其的引用。有关首选的自由许可证列表，请点击此处。
  
  
• 说明您是如何获得页面中的信息的：是通过阅读（或编写）相关的内核或 (g)libc 源代码；通过编写测试程序（如果需要，并且如果它清晰且易于使用，则将其与补丁一起发送）；来自标准文档；来自其他文档；来自邮件列表或 Usenet 线程（如果可能，请提供 URL）？
  
  
• 请按照提交补丁的项目指南提交页面。请务必抄送给任何其他相关方，包括您知道的可能适合审查该页面的任何人员。
  
  
• GNU C 库使用 info(1) 记录它提供的许多函数。由于许多程序员更喜欢 man 格式的文档，因此这并不妨碍为已经使用 info(1) 记录的函数编写手册页。理想情况下，手册页至少应包含与 info(1) 页面中包含的信息一样多的信息，并且还应包含 info(1) 页面通常不涵盖的详细信息，例如，有关该函数在各个 glibc 版本中如何更改的历史信息，或者 C 库中操作的差异；此类信息通常不存在于 info(1) 页面中）。（另一种需要考虑的替代方案是，如果更合适，则向 glibc 文档的维护者提交补丁。）

系统调用

/sys 文件系统

没有针对 /sys 文件系统的手册页：可能应该有一个类似于 proc(5) 的 sys(5) 页面。内核源文件 Documentation/filesystems/sysfs.txt 为此页面提供了一个起点；另请参阅 Documentation/ 目录下的许多其他 *sysfs*.txt 文件。

GNU C 库命令

GNU C 库提供了一些命令（可执行文件、脚本），例如 ldd(1) 和 time(1)。这些命令在 man-pages 的第 1 节和第 8 节中进行了记录。至少缺少以下页面

库函数

下面列出了未记录的 (GNU) C 库函数。像以下这样的搜索可能会建议其他需要记录的函数

MPDIR=~/man-pages       # Directory containing uncompressed man-pages
GLIBCDIR=/SOME_DIR      # Directory containing glibc tree

for f in  $(cat $(find $GLIBCDIR -name Versions |
                egrep -v '/(hurd|mach)/') |
        egrep -v '({|}|^%)' |
        sed -e 's/#.*//' |
        tr ';' '\012' |
        sed 's/^  *//' |
        grep -v '^[_.]' |
        sort -u); do
    if ! test -f "$MPDIR/man3/$f.3" > /dev/null 2>&1 &&
                ! test -f "$MPDIR/man2/$f.2" > /dev/null 2>&1 ; then
        echo $f;
    fi
done

或者，可以查看特定库导出的文本符号（除非库符号已被剥离），以查看是否有相应的手册页。这里，使用 libm 的示例

nm -D /lib/libm.so.6 | sed -re '/^[0-9a-f]* T /!d; s///; /^_/d' |
	xargs whatis | sed -ne 's/: nothing appropriate\.$//p' | sort -u

在许多情况下，下面列出的接口是使用此类脚本找到的，并且尚未检查这些接口是否是可能最好不记录的过时接口。

POSIX 线程 API

最后但同样重要的是 POSIX 线程 API。请注意，glibc 提供了一组现有的、过时的页面，这些页面记录了旧的 LinuxThreads 实现。（这些页面是在允许重用的许可下编写的，因此它们包含的一些材料可以在新页面中使用。）

需要的是一组文档完整 API 的页面，描述 LinuxThreads 和 NPTL 与标准不同的细节。现有的 pthreads(7) 手册页提供了 Linux 上 Pthreads 实现的概述，旨在作为这些手册页的背景文档。

所需的手册页列表很长（相关函数可以分组在单个页面上）；标有更多星号的页面可能最希望首先完成。