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

diff --git a/doc/man-pages/pod1/vos.pod b/doc/man-pages/pod1/vos.pod
index 8d37408..b91eaff 100644 (file)
--- a/doc/man-pages/pod1/vos.pod
+++ b/doc/man-pages/pod1/vos.pod
@@ -242,6 +242,7 @@ L<vos_backup(1)>,
 L<vos_backupsys(1)>,
 L<vos_changeaddr(1)>,
 L<vos_convertROtoRW(1)>,
+L<vos_clone(1)>,
 L<vos_copy(1)>,
 L<vos_create(1)>,
 L<vos_delentry(1)>,
@@ -260,6 +261,7 @@ L<vos_remove(1)>,
 L<vos_remsite(1)>,
 L<vos_rename(1)>,
 L<vos_restore(1)>,
+L<vos_shadow(1)>,
 L<vos_size(1)>,
 L<vos_status(1)>,
 L<vos_syncserv(1)>,

diff --git a/doc/man-pages/pod5/CellServDB.pod b/doc/man-pages/pod5/CellServDB.pod
index 2cc7c1e..4e68375 100644 (file)
--- a/doc/man-pages/pod5/CellServDB.pod
+++ b/doc/man-pages/pod5/CellServDB.pod
@@ -12,13 +12,13 @@ servers and lists only the database servers in the local cell.
 
 =head2 Client CellServDB
 
-The client version of the CellServDB file lists the database server
-machines in the local cell and any foreign cell that is to be accessible
-from the local client machine. Database server machines run the
-Authentication Server, Backup Server, Protection Server, and Volume
-Location (VL) Server (the B<kaserver>, B<buserver>, B<ptserver>, and
-B<vlserver>) processes, which maintain the cell's administrative AFS
-databases.
+Along with AFSDB entries in DNS, the client version of the CellServDB file
+lists the database server machines in the local cell and any foreign cell
+that is to be accessible from the local client machine. Database server
+machines run the Authentication Server (optional), Backup Server,
+Protection Server, and Volume Location (VL) Server (the B<kaserver>,
+B<buserver>, B<ptserver>, and B<vlserver>) processes, which maintain the
+cell's administrative AFS databases.
 
 The Cache Manager and other processes running on a client machine use the
 list of a cell's database server machines when performing several common
@@ -47,11 +47,12 @@ information from the Protection Database.
 =back
 
 The Cache Manager reads the CellServDB file into kernel memory as it
-initializes, and not again until the machine next reboots. To enable users
-on the local machine to continue accessing the cell correctly, update the
-file whenever a database server machine is added to or removed from a
-cell. To update the kernel-resident list of database server machines
-without rebooting, use the B<fs newcell> command.
+initializes, and not again until the machine next reboots or the client
+service restarts. To enable users on the local machine to continue
+accessing the cell correctly, update the file whenever a database server
+machine is added to or removed from a cell. To update the kernel-resident
+list of database server machines without rebooting, use the B<fs newcell>
+command.
 
 The F<CellServDB> file is in ASCII format and must reside in the
 F</usr/vice/etc> directory on each AFS client machine. Use a text editor
@@ -67,15 +68,16 @@ server machines.
 =head2 Server CellServDB
 
 The server version of the F<CellServDB> file lists the local cell's
-database server machines. These machines run the Authentication Server,
-Backup Server, Protection Server, and Volume Location (VL) Server (the
-B<kaserver>, B<buserver>, B<ptserver>, and B<vlserver>) processes, which
-maintain the cell's administrative AFS databases. The initial version of
-the file is created with the B<bos setcellname> command during the
-installation of the cell's server machine, which is automatically recorded
-as the cell's first database server machine. When adding or removing
-database server machines, be sure to update this file appropriately. It
-must reside in the F</usr/afs/etc> directory on each AFS server machine.
+database server machines. These machines run the Authentication Server
+(optional), Backup Server, Protection Server, and Volume Location (VL)
+Server (the B<kaserver>, B<buserver>, B<ptserver>, and B<vlserver>)
+processes, which maintain the cell's administrative AFS databases. The
+initial version of the file is created with the B<bos setcellname> command
+during the installation of the cell's server machine, which is
+automatically recorded as the cell's first database server machine. When
+adding or removing database server machines, be sure to update this file
+appropriately. It must reside in the F</usr/afs/etc> directory on each AFS
+server machine.
 
 The database server processes consult the F<CellServDB> file to learn
 about their peers, with which they must maintain constant connections in
@@ -109,7 +111,7 @@ In cells that use the Update Server to distribute the contents of the
 F</usr/afs/etc> directory, it is customary to edit only the copy of the
 file stored on the system control machine. Otherwise, edit the file on
 each server machine individually. For instructions on adding and removing
-database server machine, see the I<IBM AFS Quick Beginnings> chapter on
+database server machine, see the I<OpenAFS Quick Start> chapter on
 installing additional server machines.
 
 =head2 CellServDB Format
@@ -178,6 +180,7 @@ F<CellServDB> file and illustrates the required format.
 
 =head1 SEE ALSO
 
+L<afsd(8)>,
 L<bos_addhost(8)>,
 L<bos_listhosts(8)>,
 L<bos_removehost(8)>,
@@ -191,7 +194,7 @@ L<vlserver(8)>,
 L<upclient(8)>,
 L<upserver(8)>
 
-I<IBM AFS Quick Beginnings>
+I<OpenAFS Quick Start>
 
 =head1 COPYRIGHT
 

diff --git a/doc/man-pages/pod5/afs.pod b/doc/man-pages/pod5/afs.pod
index 6d8ffb3..80fe159 100644 (file)
--- a/doc/man-pages/pod5/afs.pod
+++ b/doc/man-pages/pod5/afs.pod
@@ -73,6 +73,8 @@ Configuration files:
 
 =item L<cacheinfo(5)>
 
+=item L<krb.conf(5)>
+
 =item L<package(5)>
 
 =item L<sysid(5)>

diff --git a/doc/man-pages/pod5/krb.conf.pod b/doc/man-pages/pod5/krb.conf.pod
new file mode 100644 (file)
index 0000000..5afe29b
--- /dev/null
+++ b/doc/man-pages/pod5/krb.conf.pod
@@ -0,0 +1,21 @@
+=head1 NAME
+
+krb.conf - Configures the kerberos realm to AFS cell mapping
+
+=head1 DESCRIPTION
+
+/usr/vice/etc/krb.conf is an optional file that resides on an OpenAFS
+server and is used to specify which Kerberos5 realms are trusted to
+authenticate to the local AFS cell. The format of the file is one realm
+per line. If the Kerberos5 realm matches the AFS cell name
+(case-insensitive), then this file can be omitted. krb.conf is only needed
+when the Kerberos5 realm does not match the cell name or multiple
+Kerberos5 realms authenticate to the same AFS cell.
+
+=head1 COPYRIGHT
+
+Copyright 2008 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Jason Edgecombe for
+OpenAFS.