我正在使用 Ubuntu 12.04.1 。我正在学习使用 C 中的 FFmpeg 库制作基本的视频播放器。我的手册页没有显示 library 的 headers/functions 的任何条目。有人可以告诉我一种将文档添加到我的手册页的方法吗?
这样搜索比每次都在网页上搜索要容易得多。
PS:我尝试使用 Synaptic 包管理器将文档添加到手册页。我安装了一个ffmpeg-doc包。但它似乎不起作用。
谢谢 。
我正在使用 Ubuntu 12.04.1 。我正在学习使用 C 中的 FFmpeg 库制作基本的视频播放器。我的手册页没有显示 library 的 headers/functions 的任何条目。有人可以告诉我一种将文档添加到我的手册页的方法吗?
这样搜索比每次都在网页上搜索要容易得多。
PS:我尝试使用 Synaptic 包管理器将文档添加到手册页。我安装了一个ffmpeg-doc包。但它似乎不起作用。
谢谢 。
FFmpeg
项目用于doxygen
创建文档。Doxygen 可以配置为输出 man 格式。
像下面这样修改文件doc/Doxyfile
,告诉 doxygen 你想要手册页格式。
GENERATE_MAN = YES
MAN_LINKS = YES
MAN_LINKS
选项非常重要,因为如果省略它,您将无法通过名称找到正确的 api 调用。
通过 invoke 配置 ffmpeg 项目后./configure ...
,使用目标apidoc
创建手册页。
$ make apidoc
手册页将输出到doc/doxy/man/man3
,然后将此路径附加到您的手册页搜索路径。
$ export MANPATH=$MANPATH:`pwd`/doc/doxy/man
然后您可以查找 ffmpeg 库 api 的手册页。
$ man av_register_all
doxygen 为大多数 api 库生成的手册页只是一个指向真实源手册页的链接。
使用 man 打开后,您必须使用 key/
搜索并跳转到您想要的文档部分。