将库的文档添加到手册页

Question

我正在使用Ubuntu 12.04.1。我正在学习使用C中的FFmpeg库制作一个基本的视频播放器。我的手册页没有显示库的头/函数的任何条目。谁能告诉我如何将文档添加到我的手册页?
这种方式比每次都在网页上搜索要容易得多。

PS:我已经尝试使用Synaptic包管理器将文档添加到手册页。我安装了一个ffmpeg-doc包。但这似乎不起作用。

谢谢。

Answer 1

这能解决你的问题吗-

http://ffmpeg-users.933282.n4.nabble.com/Building-man-pages-td934441.html

Answer 2

FFmpeg项目使用doxygen创建文档。氧可以配置为输出man格式。

像下面这样修改文件doc/Doxyfile，告诉氧你想要手册页的格式。

GENERATE_MAN           = YES
MAN_LINKS              = YES

MAN_LINKS选项非常重要，因为如果省略它，您将无法通过名称找到正确的api调用。

通过调用./configure ...配置ffmpeg项目后，使用目标apidoc创建手册页。

$ make apidoc

手册页将输出到doc/doxy/man/man3，然后将此路径附加到手册页搜索路径。

$ export MANPATH=$MANPATH:`pwd`/doc/doxy/man

然后你可以查找ffmpeg库api的手册页。

$ man av_register_all

注意

氧生成的手册页为大多数api库调用只是一个链接到真正的源手册页。

使用man打开后，您必须使用/键搜索并跳转到您想要的文档部分。