Next:Miscellaneous Documentation, Previous:Texinfo Manuals, Up:Building Documentation [Contents][Index]
Because of user demand, in addition to full Texinfo manuals, man pagesare provided which contain extracts from those manuals. These manpages are generated from the Texinfo manuals usingcontrib/texi2pod.pl andpod2man. (The man page forg++,cp/g++.1, just contains a ‘.so’ referencetogcc.1, but all the other man pages are generated fromTexinfo manuals.)
Because many systems may not have the necessary tools installed togenerate the man pages, they are only generated if theconfigure script detects that recent enough tools areinstalled, and the Makefiles allow generating man pages to failwithout aborting the build. Man pages are also included in releasedistributions. They are generated in the source directory.
Magic comments in Texinfo files starting ‘@c man’ control whatparts of a Texinfo file go into a man page. Only a subset of Texinfois supported bytexi2pod.pl, and it may be necessary to addsupport for more Texinfo features to this script when generating newman pages. To improve the man page output, some special Texinfomacros are provided indoc/include/gcc-common.texi whichtexi2pod.pl understands:
@gcctaboptUse in the form ‘@table @gcctabopt’ for tables of options,where for printed output the effect of ‘@code’ is better thanthat of ‘@option’ but for man page output a different effect iswanted.
@gccoptlistUse for summary lists of options in manuals.
FIXME: describe thetexi2pod.pl input language and magiccomments in more detail.
Next:Miscellaneous Documentation, Previous:Texinfo Manuals, Up:Building Documentation [Contents][Index]