Commit Graph

197 Commits

Author SHA1 Message Date
Steven Jenkins
921774594f man-page-rmtsysd-20090518
LICENSE IPL10
FIXES 124792

New man page for rmtsysd.
2009-05-18 21:22:04 +00:00
Steven Jenkins
97b0d23014 man-page-restorevol-20090518
LICENSE IPL10
FIXES 124791

Add man page for restorevol.
2009-05-18 19:46:33 +00:00
Simon Wilkinson
d5c2efa499 man-pod-fileserver-20090515
LICENSE IPL10
FIXES 124778

-L sets the max number of threads
2009-05-15 14:30:07 +00:00
Derrick Brashear
c8ac7d1c49 man-pages-allow-dots-consistent-20090505
LICENSE IPL10

make all server man pages list -allow-dotted-principals (rather than
-allow-dotted-principal)
2009-05-05 13:30:24 +00:00
Derrick Brashear
e59b81c984 dynamic-vcache-allocation-20090319
LICENSE IPL10
FIXES 124334

add dynamic allocation of vcaches when possible (currently just for linux)
2009-03-20 02:30:49 +00:00
Steven Jenkins
43bcfaf9cc vldb-check-meaningful-return-codes-20090216
LICENSE IPL10
FIXES 124321

make vldb_check have meaningful return codes
2009-02-17 04:16:56 +00:00
Russ Allbery
d476340465 man-page-salvager-fixes-20090201
LICENSE BSD

Fix the -parallel example in the main description text: "5all" should be
"all5".  Reword the description a bit to hopefully make it clearer that
there are two separate values set here.  Note under the option description
of -parallel that multiple partitions on the same device are normally
processed serially.
2009-02-02 01:19:00 +00:00
Russ Allbery
a3c9b01f3a man-page-fileserver-fix-block-size-20081111
After code study, we've decided that additional blocks do add 32 octets,
not 16, despite messages to the contrary in the archives.
2008-11-12 02:30:58 +00:00
Jason Edgecombe
794967ed3e man-page-fileserver-updates-20081111
LICENSE BSD

Various file server man page updates: number of partitions, partition size
limits, directory file name block size, and a reference to the IBM manual
set.
2008-11-12 02:17:49 +00:00
Russ Allbery
196e995b25 man-page-fileserver-octet-20081111
LICENSE BSD

The sizing limit on directories is better expressed in octets than in
characters in the new possibly-Unicode world.
2008-11-12 02:00:27 +00:00
Derrick Brashear
12c8abc690 server-argument-consistency-and-jumbograms-off-20080824
LICENSE IPL10
FIXES 108703

go through and make servers able to take debug log level on command line;
add -jumbo; default to -nojumbo
2008-08-25 02:14:39 +00:00
Russ Allbery
8009b045aa man-page-fileserver-long-line-20080717
LICENSE BSD

Fix long line in the SYNOPSIS for the fileserver man page.
2008-07-18 07:14:12 +00:00
Jason Edgecombe
c766e74fd6 docs-max-part-size-20080713
LICENSE BSD
FIXES 86677

remove discussion of max partition size now that 1.5 has a limit of 2^64 KB.

add discussion of techinical nature of fs minidump on windows.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================
LICENSE BSD
FIXES 86677

update discussion of max partition size.
2008-07-14 00:33:59 +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
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
Steven Jenkins
9fbbc3f50c pthreaded-ubik-20080402
LICENSE IPL10

add pthreaded ubik and various binaries
2008-04-02 20:47:27 +00:00
Steven Jenkins
8cad4305ac demand-attach-docs-20080314
LICENSE IPL10

Additional documentation for the demand attach file server, plus a state
diagram.
2008-03-14 18:05:00 +00:00
Steven Jenkins
0e91773fd7 man-page-fileserver-update-20080311
LICENSE IPL10

Update the fileserver documentation for demand-attach and add documentation
of other missing options and notes where some options are only applicable
with particular builds.
2008-03-12 01:28:00 +00:00
Jason Edgecombe
6e18cd4108 man-page-afsd-afsdb-20080308
LICENSE BSD
FIXES 89288 89289

Reference RFC 1183 in the AFSDB documentation.
2008-03-09 05:57:29 +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
Simon Wilkinson
98a68f9b02 rxkad-v5-dot-check-20080122
LICENSE IPL10
FIXES 75101

give an option to not enforce the dotted principal check. document it.
2008-01-23 04:13:55 +00:00
Jason Edgecombe
efba39ead0 man-page-fileserver-limits-20080119
LICENSE BSD

Document the 2TB volume and partition limits and the -abortthreshold flag
to the AFS fileserver.
2008-01-20 00:06:49 +00:00
Jason Edgecombe
7dc4925cd3 man-page-license-change-20071225
LICENSE BSD

Update man pages submitted by Jason Edgecombe to the BSD license.
2007-12-25 22:22:22 +00:00
Andrew Deason
9f97c5cf74 man-page-fileserver-debug-20071225
LICENSE BSD

The file server debug flag is -d, not -debug.
2007-12-25 22:02:19 +00:00
Steven Jenkins
a7291b3349 man-page-fileserver-auditlog-20071128
Remove duplicate -auditlog in the fileserver synopsis.
2007-11-29 03:32:52 +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
Jason Edgecombe
815ac3c773 man-page-bos-util-20070817
Add a man page for bos_util.
2007-08-18 01:41:39 +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
Steven Jenkins
b741b29b4b man-page-demand-attach-20070726
Document additional bos flags for the demand attach file server.
2007-07-26 21:53:42 +00:00
Jason Edgecombe
2367c273bb man-page-updates-20070726
FIXES 65988

Mention aklog and kinit in klog's man page, add -dynroot to the afsd man
page, and mention that -skipauth tells uss not to create any Kerberos
principal and this has to be done separately.
2007-07-26 21:46:46 +00:00
Lars Wilke
ee37fd74ef man-fileserver-args-20070611
Add additional arguments to the SYNOPSIS that the file server recognizes.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

Missed another erroneous option argument.
2007-06-12 04:49:56 +00:00
Russ Allbery
f820125521 afsd-shutdown-doc-improvement-20061105
Change the CAUTIONS about afsd -shutdown to be less dire and more accurate,
as this now mostly works on Linux.
2006-11-06 04:16:09 +00:00
Marcus Watts
f5e9182848 pt_util-man-page-20061005
Initial man page for pt_util.
2006-10-06 06:37:38 +00:00
Russ Allbery
b405868ca0 death-to-package-20060801
Remove package, mpp, and wsadmin, along with the remainder of configure
support for obsolete programs and the corresponding documentation.
2006-08-01 23:27:20 +00:00
Russ Allbery
cc37bc5ae4 ka-forwarder-20060731
Add ka-forwarder.
2006-07-31 18:34:26 +00:00
Russ Allbery
5b20ed3511 man-page-asetkey-20060329
Add a man page for asetkey.
2006-03-29 21:44:16 +00:00
Russ Allbery
5f70d9bb3c man-page-kaserver-fix-20060329
SYNOPSIS was mislabelled DESCRIPTION and the man page was therefore missing
the HTML formatting fixes.
2006-03-29 21:00:50 +00:00
Russ Allbery
fc5acc0151 pretty-html-synopsis-20060228
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.
2006-03-01 05:02:29 +00:00
Chas Williams
9243beff2b pod-updates-20060227
FIXES 26463

update pod files to deal with some section number changes
2006-02-27 20:46:25 +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
160854bd2b man-page-whitespace-20051220
Remove all trailing whitespace while we have the chance and there are no
merge issues yet.
2005-12-21 00:41:17 +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
03b9fcc883 man1-editing-pass-20051209
Complete an initial editing and cleanup pass for all section one man pages.
Fix various conversion problems, formatting inconsistencies, and obvious
problems.  Please note that no editing for content has yet been done; this
is solely editing for formatting and correct conversion to POD.

Also, add some additional section five man pages that were omitted from the
first conversion run due to unusual file names, and globally replace
CAVEATS with CAUTIONS in the man pages to match the original section name.

The section one man pages should now be in reasonable shape and ready for
additional review and further updates, although there are probably still
remaining obvious problems.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

This file got the wrong name when it was originally committed.  Fix.
2005-12-09 14:48:56 +00:00
Russ Allbery
e3dfba8e6c man-page-conversion-20051208
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.
2005-12-08 12:14:33 +00:00