ffmpeg 文档本地化生成

T-Bagwell

ffmpeg 文档本地化生成

好多人抱怨ffmpeg文档不多，ffmpeg开发文档不多，不全，却又懒得去看代码实现，或者不看ffmpeg代码注释，那么完全可以生成一个本地的文档以作为参考

做Linux/Unix开发要用man，windows开发要用MSDN，ffmpeg开发好歹也会有手册的，或者ffmpeg使用其实手册也很全的

下面介绍一下生成手册的方法：

首先

[Bash shell] 纯文本查看 复制代码

./configure

然后会生成Makefile，这个时候看一下Makefile里面的内容

一般手册的生成应该是pdf html或者doc docs之类的PHONY，可以看一下PHONY项;

当然在Makefile下面如果看不到对应的PHONY，我们还要注意Makefile里面的include这语句

[Bash shell] 纯文本查看 复制代码

include $(SRC_PATH)/doc/Makefile
include $(SRC_PATH)/tests/Makefile

这两行就是又包含了两个Makefile的内容进来，看到doc这一行，也就是说doc目录下面的Makefile也包含进来了

接下来看一下doc下面的Makefile

可以看到最后一行

1. .PHONY: apidoc doc documentation

复制代码

也就是说，又三种标签可以生成

apidoc  doc 和documentation

生成可以分别试一下如下命令

make doc过程如下：

make apidoc过程如下：

make documentation

然后分别

[Bash shell] 纯文本查看 复制代码

make doc install
make documentation install

这样的话可以查看手册了

命令手册可以如下方式查看

[Bash shell] 纯文本查看 复制代码

man ffserver
man ffmpeg
man ffplay
man ffprobe
man ffmpeg-all
man ffplay-all
man ffprobe-all
man ffserver-all
man ffmpeg-utils
man ffmpeg-scaler
man ffmpeg-resampler
man ffmpeg-codecs
man ffmpeg-bittream-filters
man ffmpeg-formats
man ffmpeg-protocols
man ffmpeg-devices
man ffmpeg-filters
man libavutil
man libswscale
man libswresample
man libavcodec
man libavformat
man libavdevice

这些手册都是可以使用man来查看的

我的是MacBook ,OSX，在./configure的时候

1. ./configure —prefix=/usr

复制代码

即可，CentOS或者Fedora这种红帽系列的，同样方法可以搞定

接下来就是开发者们的使用手册了

其实make apidoc已经将手册生成了，生成的路径为:

doc/doxy

在该目录下会有个html目录，里面的index.html为开发者手册的第一页，直接用webbrowser打开看就可以了，里面的说明都很全