Documentation 将库的文档添加到手册页

Documentation 将库的文档添加到手册页,documentation,ffmpeg,shared-libraries,ubuntu-12.04,manpage,Documentation,Ffmpeg,Shared Libraries,Ubuntu 12.04,Manpage,我正在使用Ubuntu 12.04.1。我正在学习使用C语言中的FFmpeg库制作一个基本的视频播放器。我的手册页面不显示库的标题/函数的任何条目。有人能告诉我如何将文档添加到手册页面中。 用这种方式搜索要比每次在网页上搜索容易得多 PS:我曾尝试使用Synaptic package manager向手册页添加文档。我安装了一个ffmpeg-doc包。但它似乎不起作用 谢谢。这能解决您的问题吗- FFmpeg项目使用doxygen创建文档。可以将Doxygen配置为输出man格式 像下面那样修改

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

PS:我曾尝试使用Synaptic package manager向手册页添加文档。我安装了一个ffmpeg-doc包。但它似乎不起作用


谢谢。

这能解决您的问题吗-


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打开后,您必须使用键
/
搜索并跳转到所需的文档部分。

谢谢您的回答。但我不确定我现在需要遵循哪些步骤。我的环境不同,我通过Synaptic Package Manager安装了所有库,而不是从命令行安装。你能给我具体的步骤只获取FFmpeg库的手册页吗?