mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 05:27:44 +00:00
c412c75def
The pod2man tool determines a man page title (set in the .TH macro) from the input filename, unless the -n (--name) option is specified. Our AFS::ukernel man page input file is named AFS.ukernel.pod to avoid colons in the filename (since colon characters are not supported on Windows), so the generated man page contains the title "AFS.ukernel" instead of "AFS::ukernel". Use the pod2man -n (--name) option when converting section 3 man pages to override the automatic title naming. This fixes the .TH macro in the generated AFS::ukernel.3 file. Fortunately, the -n (--name) option is only needed for section 3 man pages. Specifying the pod2man -n (--name) option is simpler and less invasive than renaming pod3/AFS.ukernel.pod to pod3/lib/AFS/ukernel.pod (which would also fix the embedded title). Change-Id: I495ea2d30ce1b34698519ffa34a39362c449ba09 Reviewed-on: https://gerrit.openafs.org/15363 Reviewed-by: Cheyenne Wills <cwills@sinenomine.net> Reviewed-by: Mark Vitale <mvitale@sinenomine.net> Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
What's in the "doc" subdirectory ** doc/man-pages pod sources for man pages (converted from original IBM html source). ** doc/xml xml sources for manuals (converted from original IBM html source). Note: The doc/xml/AdminRef uses doc/xml/AdminRef/pod2refentry to convert the pod man pages to xml for printing. pod goes directly to html just fine. ** doc/pdf Old Transarc (and possibly pre-Transarc) protocol and API documentation for which we have no other source. ** doc/txt Technical notes, Windows notes, and examples. ** doc/doxygen Configuration files for the doxygen tool to generate documentation from the annotated sources. See the 'dox' Makefile target in the top level Makefile.