Commit Graph

33 Commits

Author SHA1 Message Date
Russ Allbery
cf816d535a man-page-readme-update-20080630
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.
2008-06-30 20:47:30 +00:00
Jason Edgecombe
d9dc7e28fe man-page-vldb_convert-20080626
FIXES 104192
LICENSE BSD

New man page for vldb_convert.
2008-06-27 04:29:12 +00:00
Jason Edgecombe
fbe10c8086 man-page-vos-clone-20080626
FIXES 104110
LICENSE BSD

Add man page for vos clone.
2008-06-27 04:19:07 +00:00
Russ Allbery
1473a8747a man-page-readme-fileserver-20080605
LICENSE BSD

Remove the note about missing file server options.  We think we got them
all.
2008-06-05 21:19:10 +00:00
Jason Edgecombe
1fdfac7065 man-page-pts-updates-20080605
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.
2008-06-05 20:31:13 +00:00
Jason Edgecombe
4bcb7d01b2 man-page-vos-shadow-20080331
LICENSE BSD

Man page for vos shadow.
2008-04-01 07:50:28 +00:00
Jason Edgecombe
897c360274 man-page-updates-20080219
LICENSE IPL10
FIXES 86677

note 2tb limit, add fs minidump document
2008-02-19 15:25:17 +00:00
Jason Edgecombe
84ef02b0f3 man-page-misc-updates-20071225
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.
2007-12-25 22:15:07 +00:00
Jason Edgecombe
3be37f4d1c man-page-fs-sysname-improvements-20071128
Update the fs sysname man page to document the behavior of multiple @sys
values.
2007-11-29 04:17:10 +00:00
Jason Edgecombe
f78f007dc5 man-page-fs-rxstatpeer-20071128
New man page for fs rxstatpeer.
2007-11-29 03:54:44 +00:00
Jason Edgecombe
2ecef5038e man-page-additions-20071128
Add new man pages for vos convertROtoRW, vos copy, and read_tape and add
a troubleshooting section to the fileserver man page.
2007-11-29 03:30:41 +00:00
Russ Allbery
6ef9f39335 man-page-name-underscore-20071111
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.
2007-11-11 22:54:56 +00:00
Russ Allbery
a6fe83d9a6 no-kseal-20070819
Don't build or install kseal by default.  It's a debugging tool with very
limited utility.
2007-08-19 23:04:31 +00:00
Jason Edgecombe
dfb2961b67 man-page-fixes-20070819
More details on how to run check-pod.  Restore the [] markup in the vos
changeloc SYNOPSIS since the flags really are optional.
2007-08-19 23:02:27 +00:00
Jason Edgecombe
dc5adbeaac man-page-vos-changeloc-20070817
Add a man page for vos changeloc.
2007-08-18 03:24:24 +00:00
Jason Edgecombe
024442b020 man-page-fs-updates-20070817
Add man pages for fs flushall and fs getcalleraccess.
2007-08-18 02:05:42 +00:00
Jason Edgecombe
815ac3c773 man-page-bos-util-20070817
Add a man page for bos_util.
2007-08-18 01:41:39 +00:00
Jason Edgecombe
87efbab4e8 man-page-updates-20070817
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.
2007-08-18 00:35:44 +00:00
Jason Edgecombe
a8172fca24 man-page-check-pod-20070817
Add check-pod script to test for POD syntax errors.
2007-08-17 20:57:20 +00:00
Jason Edgecombe
87d2f5cd3f man-page-vos-size-20070805
Add a new man page for vos size.
2007-08-05 22:58:35 +00:00
Jason Edgecombe
e7742db31f man-page-fs-newalias-20070805
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.
2007-08-05 22:38:10 +00:00
Jason Edgecombe
95cfc0cfaf man-page-fs-listaliases-20070805
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.
2007-08-05 22:16:47 +00:00
Russ Allbery
e735ef962d man-page-style-20070805
Some style fixes and some additional style documentation in README.
2007-08-05 22:08:22 +00:00
Jason Edgecombe
8761673c60 man-page-afsd-crypt-alias-20070805
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.
2007-08-05 22:01:42 +00:00
Russ Allbery
a8e9f2807b man-todo-update-20060803
Update the to-do list for the man pages given the conversion of the aklog
man page to POD and the removal of package and mpp.
2006-08-04 05:06:52 +00:00
Russ Allbery
db8d1da77a man-page-todo-20060322
More to-do items for the documentation.
2006-03-23 05:41:02 +00:00
Russ Allbery
fed1cdb022 html-style-todo-20060228
Some style sheet updates and lots of to-do updates based on feedback from
C. Alex North-Keys.
2006-03-01 00:12:52 +00:00
Russ Allbery
6321cca1a5 html-link-fixes-20060228
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.
2006-02-28 23:43:03 +00:00
Russ Allbery
6eb9f473ad man-page-html-20060124
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.
2006-01-25 05:59:38 +00:00
Russ Allbery
90bc5c0092 man-page-misc-improvements-20051221
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.)
2005-12-22 07:34:49 +00:00
Russ Allbery
f64a78e701 man5-editing-pass-20051213
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.
2005-12-14 01:30:20 +00:00
Russ Allbery
ab4abf15fe man8-editing-pass-20051213
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.
2005-12-13 19:21:13 +00:00
Russ Allbery
d60224477f man-page-readme-20051209
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.
2005-12-09 16:43:14 +00:00