[ << Compiling ] | [Top][Contents] | [ Documentation work >> ] |
[ < Saving time with CPU_COUNT ] | [ Up : Generating documentation ] | [ Building documentation without compiling > ] |
Installing documentation
The HTML, PDF and if available Info files can be installed into the standard documentation path by issuing
make install-doc
This also installs Info documentation with images. The final installation of Info documentation (integrating it into the documentation directory) is printed on standard output.
To install the Info documentation separately, run:
make install-info
Note that to get the images in Info documentation, install-doc
target creates symbolic links to HTML and PDF installed documentation
tree in prefix/share/info, in order to save disk space,
whereas install-info
copies images in
prefix/share/info subdirectories.
It is possible to build a documentation tree in out-www/online-root/, with special processing, so it can be used on a website with content negotiation for automatic language selection; this can be achieved by issuing
make WEB_TARGETS=online doc
and both ‘offline’ and ‘online’ targets can be generated by issuing
make WEB_TARGETS="offline online" doc
Several targets are available to clean the documentation build and help with maintaining documentation; an overview of these targets is available with
make help
from every directory in the build tree. Most targets for documentation maintenance are available from Documentation/; for more information, see Documentation work.
The makefile variable QUIET_BUILD
may be set to 1
for a less verbose build output, just like for building the
programs.
[ << Compiling ] | [Top][Contents] | [ Documentation work >> ] |
[ < Saving time with CPU_COUNT ] | [ Up : Generating documentation ] | [ Building documentation without compiling > ] |