创建Linux内核函数的Man手册

【前言】
    编写驱动程序的时候,一般情况下使用的都不是 C标准库的函数,而是 Linux内核中的函数。所以即使用 man命令 也找不到很多函数的帮助信息,这很不利于 Linux内核的学习。
    好在 Linux内核虽然没有直接提供手册,却提供了创建手册的工具。我们 可以手动生成 Linux内核的 Man手册

【创建步骤】
    1、下载一个稳定版本的内核,例如:linux-4.4.8。
        一般情况下用 Linux系统自带的源码不行,建议到官方网站下载最新版本:http://kernel.org/

    2、在顶层目录下执行 make mandocs 创建 Man手册。 这一步很费时间

    3、再执行 sudo make installmandocs 进行安装。

    4、现在可以使用 man命令 查看内核函数了。

【注意事项】
    1、如果 make mandocs 命令执行失败,可能是没有安装 xmlto 导致的,可以使用命令 sudo apt-get install xmlto 进行安装。

    2、 可以将创建好的 Man手册文档 复制到别的设备上进行安装,从而避免了非常费时的创建过程
        创建好的 Man手册 存放于 /linux-4.4.8/Documentation/Docbook/man/ 目录下,将该目录中各子目录及其包含的 *.9.gz 文件复制到需要安装手册的设备的相同目录下(如果没有就创建一个)。
        然后以 root权限运行以下命令进行手册的安装:
        mkdir -p /usr/local/man/man9
        install Docbook/man/*.9.gz /usr/local/man/man9

        命令执行成功后就可以在目标设备上同样使用 Man命令 查看内核函数的帮助文档了。

【参考文献】
    [1] 博客 雪夜流星
    [2] 博客 star_shining的博客

你可能感兴趣的:(linux,内核,man,手册,manual)