将库的文档添加到手册页

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创建文档。 Doxygen可以配置为输出man格式。

修改文件doc/Doxyfile，如下所示，告诉doxygen你想要的手册页格式。

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

注意

doxygen为大多数api库生成的手册页只是指向真实源手册页的链接。

与man打开后，您必须使用键/进行搜索并跳转到所需的文档部分。