The NAME heading for man pages can't contain a space in the program side
or the man pages won't index with some man implementations.
(cherry picked from commit 6ef9f3933595e4fef5c4af334ab580dbb08212c3)
Implement proper synopsis wrapping for HTML generation.
This was done in three pieces. First, add HTML-specific tags to the POD to
mark the synopsis for HTML purposes so that we can apply style information
to it. Second, update the style sheet to indent all lines except for the
first in the synopsis section. Third, add the appropriate S<> tags around
option and argument pairs so that we don't wrap between the option and its
argument.
Unfortunately, due to the <I<foo>> style that looks nicer for other reasons,
we have to use the very verbose S<<< >>>. Oh well.
(cherry picked from commit fc5acc01517260c661097cf84bddc359ca060bd3)
This completes the first editing pass of the man pages. Very little
content editing has been done, but the server and client versions of
various man pages have been combined into a single man page for the
file (affects CellServDB, ThisCell, NetInfo, and NetRestrict), the
descriptions of the various AFS cache files have been combined into one
afs_cache man page, and the descriptions of the two butc log files have
been combined into one butc_logs man page.
For man pages for databases with two files, symlinks are now created on
installation for the secondary file name.
All of the man pages should now be ready for public review, additional
editing and cleanup, and content editing.
(cherry picked from commit f64a78e7013ebafd9ce4a0a50822a6087ff62f6c)
This completes the initial editing pass of the section eight man pages.
Only small amounts of content editing has been done. Some known problems
have been noted in README, but there will doubtless be others, as well as
some lingering formatting problems. However, the quality should now be
good enough for general public review.
Some of the section eight man pages were really supposed to be section one,
the package apropros and package help commands are too useless to document,
and a few of the difficult-to-name section five man pages have now acquired
names.
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_apropos.pod,v
Working file: doc/man-pages/pod8/package_apropos.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_help.pod,v
Working file: doc/man-pages/pod8/package_help.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/package_test.pod,v
Working file: doc/man-pages/pod8/package_test.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/tapeconfig.pod,v
Working file: doc/man-pages/pod8/tapeconfig.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/xstat_cm_test.pod,v
Working file: doc/man-pages/pod8/xstat_cm_test.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
RCS file: /cvs/openafs/doc/man-pages/pod8/Attic/xstat_fs_test.pod,v
Working file: doc/man-pages/pod8/xstat_fs_test.pod
head: 1.2
branch:
locks: strict
access list:
keyword substitution: kv
total revisions: 4; selected revisions: 0
description:
(cherry picked from commit ab4abf15fef60308b982c73b6d1a17fa60577120)
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages. The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available. The Makefile only installs. The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).
This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.
This is only the first step, and this initial conversion has various
problems. In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later. Some of the
man pages have syntax problems and all of them have formatting errors. The
next editing pass, coming shortly, will clean up most of the remaining
mess.
(cherry picked from commit e3dfba8e6c10c296c09e9b0ac0c0355658ce0be7)
