Commit Graph

24 Commits

Author SHA1 Message Date
Russ Allbery
3015ef6c59 Update bos addkey/listkeys and KeyFile man pages for asetkey
Clearly prefer asetkey to bos addkey in the KeyFile, bos addkey, and
bos listkeys man pages.  Reference asetkey list and asetkey delete as
alternatives to bos listkeys and bos removekey.  Distinguish between
Authentication Server cells and Kerberos v5 cells and mention the
preferred afs/<cell> principal format.  Add some cautions around
matching enctypes and salts when synchronizing keys with a v5 KDC.

Update man-pages/README for completion of this task, clean up some
other wording, and remove some other now-irrelevant information.

Change-Id: I29b83a61cbdb08de508bdb313524a307e385044b
Reviewed-on: http://gerrit.openafs.org/1938
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: Russ Allbery <rra@stanford.edu>
Reviewed-by: Russ Allbery <rra@stanford.edu>
2010-05-22 17:18:16 -07:00
Russ Allbery
75cf37f944 Explain in CellServDB man page that server lines can be omitted
It's possible to use AFSDB records only to locate the VLDB servers but
still list the cell in the client CellServDB so that the client is
aware of it and populates it into dynroot.  Describe doing this in the
man page.

Change-Id: I714cd515dc4b72a6e358bbd8f9332d4ddce5a5fc
Reviewed-on: http://gerrit.openafs.org/1710
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-04-07 16:19:27 -07:00
Jason Edgecombe
8ea6c727aa Some minor rewording and grammatical tweaks of the CellAlias man page
Added some text that the CellAlias file is only used on Unix.

LICENSE BSD

Change-Id: I913d6a0774240ffc16cf92cfa92c4b2d06f41fd6
Reviewed-on: http://gerrit.openafs.org/1307
Tested-by: Jason Edgecombe <jason@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-02-15 04:53:37 -08:00
Russ Allbery
5dd137c474 Turn on --enable-bos-new-config unconditionally
Remove the conditional and Autoconf flag for enabling BosConfig.new
handling and change bosserver to always rename BosConfig.new to BosConfig
on startup if the former exists.

Document BosConfig.new handling in the bosserver and BosConfig man pages.
Tone down the warning about the BosConfig file format changing and warn
that bosserver rewrites BosConfig when shutting down.

Reviewed-on: http://gerrit.openafs.org/211
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-09-01 09:46:37 -07:00
Jeffrey Altman
a767455f02 Correct description of afs krb.conf file format
The file format is a single line containing one or more realms
separated by white space.

LICENSE BSD

Reviewed-on: http://gerrit.openafs.org/352
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2009-08-27 13:15:05 -07:00
Derrick Brashear
6d973e499a man-page-cellservdb-extras-20090605
LICENSE IPL10

Document linked cells and non-voting replicas in the CellServDB man page
and note the need for better linked cell documentation.
2009-06-05 19:17:13 +00:00
Derrick Brashear
6cc155e8da krb-conf-manpage-path-fix-20090519
LICENSE IPL10

fix path to krb.conf, per IRC discussion
2009-05-19 19:40:09 +00:00
Steven Jenkins
6df6046813 man-page-cellservdb-updates-20090518
FIXES 124794
LICENSE IPL10

Note in CellServDB man page that it's also used to populate root.afs for
a -dynroot client.  Also document the dynamic lookup of database servers
with -afsdb and provide some more information about when CellServDB has to
contain the cell and when it doesn't.

Mark the backup server as optional, and indicate that the authentication
server is deprecated and CellServDB isn't required for authentication if
Kerberos v5 and aklog are used.
2009-05-18 21:42:26 +00:00
Jason Edgecombe
758366c26a netinfo-fake-address-text-20090427
LICENSE IPL10
FIXES 124699

explain fake address support for NetInfo files
2009-04-27 19:37:25 +00:00
Derrick Brashear
80fc888a92 netrestrict-no-wildcard-20090106
LICENSE IPL10

don't misadvertise network wildcard support
2009-01-06 13:40:04 +00:00
Jason Edgecombe
298fb5ce52 docs-ticket-104110-20080713
LICENSE BSD
FIXES 104110

add vos clone and vos shadow to overall list

====================
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 104110

add krb.conf

update CellServDB to discuss AFSDB DNS records
2008-07-14 00:51:35 +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
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
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
67ea3ae96b man-page-net-info-fixes-20070619
Fix a NetInfo reference in the NetRestrict man page that should be
NetRestrict and add cross-references in SEE ALSO.
2007-06-19 09:55:49 +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
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