Next: Man Page Generation, Up: Documentation
GCC整体的以及C和C++前端的手册,在文件doc/*.texi中。其它前端自己的手册在文件language/*.texi中。 通用文件doc/include/*.texi被提供用来在多个手册中包含; 下列文件在doc/include中:
DVI格式的手册通过‘make dvi’生成,其使用了texi2dvi(通过Makefile宏$(TEXI2DVI)
)。PDF格式的手册通过‘make pdf’生成,其使用了texi2pdf(通过Makefile宏$(TEXI2PDF)
)。HTML格式的手册通过make html生成。info手册通过‘make info’生成(作为bootstrap的一部分运行);这个是在源目录中生成手册,使用makeinfo,通过Makefile宏$(MAKEINFO)
,它们被包含在发现版本中。
手册在GCC网站上也有提供,HTML和PostScript格式的。这是通过脚本maintainer-scripts/update_web_docs生成的。在线提供的每个手册都必须在那个文件中的MANUALS
定义中列出;文件name.texi必须在源树中只出现一次,输出手册必须与源文件具有相同的名字。(但是,手册中包含的其它不是根文件的Texinfo文件,其名字可能会在源树中出现多次。)手册文件name.texi应该只包含它目录下或者doc/include下的其它文件。HTML手册将通过‘makeinfo --html’生成,PostScript手册将通过texi2dvi和dvips,PDF手册通过texi2pdf。为了使生成的在线手册可以工作,所有属于手册一部分的Texinfo文件都必须放入CVS,即使它们是被生成的文件。
安装手册,doc/install.texi,也在GCC网站上有提供。HTML版本通过脚本doc/install.texi2html生成。