Skip navigation links
3 Documentation Tools »
Section Navigation      [Toggle]

2.3. Other Build Targets

The Makefile defines some additional targets which are used to help build, format and validate the DocBook XML. You can get a list of the valid targets for any directory by just running make in a directory. For example, within refman-5.1, the following list is produced: 

You must say what you want to do.
    Some commands supported by this Makefile:
    make dba-optvars-table.xml - generate option/variable table
    make file.valid           - validate file.xml with ID map checking
    make file.validwarn       - validate file.xml with ID map checking, showing warnings
    make file.validpure       - validate file.xml without ID map checking
    make idmap                - make ID maps for the current directory
    make idmap.refs           - make ID maps for all directories referenced by main document
    make idmap.reconcile      - reconcile ID maps for the current directory
    make idmap.reconcile.refs - reconcile ID maps for all directories referenced by main document
    make file.deepcheck       - perform deep check of file.xml
    make file.ulinkcheck      - checks <ulink> URLs for file.xml
    make file.format          - put file.xml in standard format
    make file.wc              - counts the words within XML tags
    make file.wcd             - counts the words within XML tags (with tag-by-tag counts
    make file.useless         - find suboptimal constructs in file.xml
    make file-prepped.xml     - preprocess file.xml for producing output
    make file-remprepped.xml  - preprocess file.xml for remark-counting
    make file-manprepped.xml  - preprocess file.xml for producing man pages
    make file.html            - convert file.xml to HTML, single file
    make file.html-dir        - convert file.xml to HTML, single file
                                (putting output in subdirectory)
    make file.html-section    - convert file.xml to HTML, 1 file/section
                                (putting output in subdirectory)
    make file.html-chapter    - convert file.xml to HTML, 1 file/chapter
                                (putting output in subdirectory)
    make file.html-web        - convert file.xml to online manual HTML
                                (putting output in subdirectory)
    make file.eclipse         - convert file.xml to HTML for Eclipse
    make file.chm-input       - prepare input for Windows CHM build
    make file.xhtml-dir       - convert file.xml to XHTML, single file
                                (putting output in subdirectory)
    make file.pdf             - convert file.xml to file.pdf (US letter)
    make file.a4.pdf          - convert file.xml to file.pdf (A4)
    make file-toc.txt         - produce table of contents from file.xml
    make file.txt             - convert file.xml to file.txt
    make file.texi            - convert file.xml to file.texi
    make file.info            - convert file.texi to file.info
    make file.man             - generate Unix man pages from file.xml
    make file.help            - extract help-table information from file.xml
    make file.remarks         - extract <remark> elements from file.xml
    make file.remark-count    - count <remark> elements in file.xml
    make file.titles          - convert file.xml to id/titles file
    make fragments            - generate refman 'fragment' files
    make depend               - regenerate document dependencies
    make file.check-listing   - check <programlisting> line lengths
    make clean                - remove files built by other targets
    make realclean            - remove files built by other targets and metadata directory
                                (as created by ID mapping process)

Key additional targets include:

  • document.format — reformat the XML in the document to help make it more readable.

  • document.valid — validates the XML of the document using xmllint. As standard, xmllint would normally report missing IDs that could be valid in terms of the overall document (that is, those in another file). The output of xmllint is parsed by the ID mapping system to correctly identify these IDs. For more information, see Section 3.2, “ID Mapping System”.

  • document.deepcheck — runs the document through a much more extensive DocBook XML checking process. This does more than validate the XML, this also checks for problems with the content, such as mismatches in the number of specified and actual columns in tables, missing IDs, duplicate IDs and other elements.