LICENSE BSD
Add additional missing commands to the to-do list. Add a section on man
page section numbers and their rationale. Document that embedding a
license in the man page isn't required if it's one of the licenses in our
LICENSE file.
(cherry picked from commit cf816d535a60a7a5f7efa5564b647ee87e33b7d7)
LICENSE BSD
Add documentation of foreign realm user registration and cross-realm PTS
groups. Add documentation of missing ptserver flags. Add some additional
to-do entries for the man pages.
(cherry picked from commit 1fdfac7065b85feafcfa3f9fc382cfd90680d67f)
LICENSE BSD
Add some additional cross-references, add some missing man pages, fix a
few references to the OpenAFS manuals, document the -live flag to vos
move, and add an example for rxdebug.
(cherry picked from commit 84ef02b0f392c761211adc7d5876217ad835c6c0)
Add new man pages for vos convertROtoRW, vos copy, and read_tape and add
a troubleshooting section to the fileserver man page.
(cherry picked from commit 2ecef5038e81386a002740f6b0112330117c4f6e)
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)
More details on how to run check-pod. Restore the [] markup in the vos
changeloc SYNOPSIS since the flags really are optional.
(cherry picked from commit dfb2961b677299a726be33e63b29476f003d03a7)
Add new man pages for pts interactive, quit, sleep, and source. Fix POD
errors in a few other man pages and update the to-do list in README.
(cherry picked from commit 87efbab4e8c0dc37c1938503eea88f7f319b7e5d)
Add a new fs newalias man page. Add -help to the synopsis and options of
the other new man pages. Add additional missing links in the fs man page.
Fix some wording in the CellAlias man page.
(cherry picked from commit e7742db31f68acf2d227c13840e0a0ed9291d247)
Add manual page for fs listaliases. Also add the links in the fs(1) man
page and update README more for the current to-do list.
(cherry picked from commit 95cfc0cfafe5c0a3f9f8ff07cb3c2be29fe9e3fc)
Complete the documentation of the afsd flags and update a few things like
-settime and -nosettime. Add man pages for fs setcrypt, fs getcrypt, and
CellAlias. Based on work by Jason Edgecombe and then extensively edited,
so any errors I probably introduced.
(cherry picked from commit 8761673c608986d32bb858b26441b09c24f41696)
Make the mentions of subcommands in the fs command introduction links to
the relevant pages, and add to README a to-do note to do this for the rest
of the introductory pages.
Fix links to man pages that contain underscores by working around a bug
in Pod::Simple.
Initial cut at an HTML conversion of the POD reference pages. Requires
Pod::Simple be installed (version 3.0 or later, probably). Also fix a POD
formatting bug in the afs(1) man page noticed while testing HTML output.
Add new man pages for livesys and voldump. Fix the man page for sys to say
what it actually does, rather than implying that it works like livesys, and
to recommend livesys instead. Fix a path error in the NetInfo
documentation. Update the README for the current status, including
listing all installed commands that don't have man pages. (There may still
be some subcommands that don't have man pages but aren't listed.)
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.
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.
Initial documentation for the man page project, including initial notes
on conversion, a start at a formatting guide, information on how to
contribute, and an initial issues list of things I happened to notice
while editing the section one pages.
