Update the man pages pod source adding text to discourage use of

uss.  Usually the text added was a copy of a CAUTION section that
had already been added in a few places. This change applies it
consistently across all uss-related man pages. In pod1/afs.pod that
text would be excessively wordy; a briefer note is used there to
direct the reader to the full text.

This is a partial fix for RT bug #128018. It does not fully close
the bug; the AFS Administrators Guide needs to be updated as well.

Change-Id: Id64646d20a9b22c0e11c9654842fa255fb4258ea
Reviewed-on: http://gerrit.openafs.org/2637
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>

diff --git a/doc/man-pages/pod1/afs.pod b/doc/man-pages/pod1/afs.pod
index c991c78..9c37d1e 100644 (file)
--- a/doc/man-pages/pod1/afs.pod
+++ b/doc/man-pages/pod1/afs.pod
@@ -40,7 +40,9 @@ membership information.
 
 =item uss
 
-Interface for automated administration of user accounts.
+Interface for automated administration of user accounts. Deprecated, may
+be removed from a future version of OpenAFS. See B<uss> man page for more
+detail.
 
 =item vos
 
@@ -66,8 +68,8 @@ name>.
 The I<command_suite> specifies the group of related commands to which the
 command belongs, and indicates which command interpreter and server
 process perform the command.  AFS has several command suites, including
-B<bos>, B<fs>, B<kas>, B<package>, B<pts>, B<uss> and B<vos>.  Some of
-these suites have an interactive mode in which the issuer omits the
+B<bos>, B<fs>, B<kas>, B<package>, B<pts>, B<uss> (deprecated) and B<vos>.
+Some of these suites have an interactive mode in which the issuer omits the
 I<operation_code> portion of the command name.
 
 The I<operation_code> tells the command interpreter and server process

diff --git a/doc/man-pages/pod5/uss.pod b/doc/man-pages/pod5/uss.pod
index 1e4ee4c..f0598f6 100644 (file)
--- a/doc/man-pages/pod5/uss.pod
+++ b/doc/man-pages/pod5/uss.pod
@@ -1,6 +1,15 @@
 =head1 NAME
 
-uss - Provides instructions for the uss add command
+uss - Provides instructions for the uss add command (deprecated)
+
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
 
 =head1 DESCRIPTION
 

diff --git a/doc/man-pages/pod5/uss_bulk.pod b/doc/man-pages/pod5/uss_bulk.pod
index da97578..69d3a9b 100644 (file)
--- a/doc/man-pages/pod5/uss_bulk.pod
+++ b/doc/man-pages/pod5/uss_bulk.pod
@@ -2,6 +2,15 @@
 
 uss_bulk - Provides instructions for the uss bulk command
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The uss bulk input file lists instructions for the B<uss> command

diff --git a/doc/man-pages/pod8/uss.pod b/doc/man-pages/pod8/uss.pod
index 3b45590..f71a5a8 100644 (file)
--- a/doc/man-pages/pod8/uss.pod
+++ b/doc/man-pages/pod8/uss.pod
@@ -2,6 +2,15 @@
 
 uss - Introduction to the uss command suite
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The commands in the B<uss> command suite help administrators to create AFS
@@ -33,15 +42,6 @@ The B<uss delete> command removes most parts of a user account.
 
 To obtain help, issue the B<uss apropos> and B<uss help> commands.
 
-=head1 CAUTIONS
-
-The B<uss> command suite is currently designed for cells using the
-obsolete Authentication Server, and therefore is primarily useful for
-sites that have not yet migrated to a Kerberos version 5 KDC. The
-Authentication Server and supporting commands will be removed in a future
-version of OpenAFS, which may include B<uss> unless someone who finds it
-useful converts it to work with a Kerberos version 5 KDC.
-
 =head1 OPTIONS
 
 The following arguments and flags are available on many commands in the

diff --git a/doc/man-pages/pod8/uss_add.pod b/doc/man-pages/pod8/uss_add.pod
index b9027d8..5941601 100644 (file)
--- a/doc/man-pages/pod8/uss_add.pod
+++ b/doc/man-pages/pod8/uss_add.pod
@@ -34,6 +34,15 @@ B<uss ad> S<<< B<-us> <I<login name>> >>> S<<< [B<-r> <I<full name in quotes>>]
 =for html
 </div>
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The B<uss add> command creates entries in the Protection Database and

diff --git a/doc/man-pages/pod8/uss_apropos.pod b/doc/man-pages/pod8/uss_apropos.pod
index 1977669..036b473 100644 (file)
--- a/doc/man-pages/pod8/uss_apropos.pod
+++ b/doc/man-pages/pod8/uss_apropos.pod
@@ -14,6 +14,15 @@ B<uss ap> S<<< B<-t> <I<help string>> >>> [B<-h>]
 =for html
 </div>
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The B<uss apropos> command displays the first line of the online help

diff --git a/doc/man-pages/pod8/uss_bulk.pod b/doc/man-pages/pod8/uss_bulk.pod
index 6de7bbe..b86c5d5 100644 (file)
--- a/doc/man-pages/pod8/uss_bulk.pod
+++ b/doc/man-pages/pod8/uss_bulk.pod
@@ -24,6 +24,15 @@ B<uss b> S<<< B<-f> <I<bulk input file>> >>> S<<< [B<-t> <I<pathname of template
 =for html
 </div>
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The B<uss bulk> command executes the uss commands listed in the I<bulk

diff --git a/doc/man-pages/pod8/uss_delete.pod b/doc/man-pages/pod8/uss_delete.pod
index 1828bc7..e082e5a 100644 (file)
--- a/doc/man-pages/pod8/uss_delete.pod
+++ b/doc/man-pages/pod8/uss_delete.pod
@@ -20,6 +20,15 @@ B<uss d> S<<< B<-u> <I<login name>> >>> S<<< [B<-m> <I<mountpoint for user's vol
 =for html
 </div>
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The B<uss delete> command removes the Authentication Database and

diff --git a/doc/man-pages/pod8/uss_help.pod b/doc/man-pages/pod8/uss_help.pod
index b337926..a269e82 100644 (file)
--- a/doc/man-pages/pod8/uss_help.pod
+++ b/doc/man-pages/pod8/uss_help.pod
@@ -14,6 +14,15 @@ B<uss h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>]
 =for html
 </div>
 
+=head1 CAUTIONS
+
+The B<uss> command suite is currently designed for cells using the
+obsolete Authentication Server, and therefore is primarily useful for
+sites that have not yet migrated to a Kerberos version 5 KDC. The
+Authentication Server and supporting commands will be removed in a future
+version of OpenAFS, which may include B<uss> unless someone who finds it
+useful converts it to work with a Kerberos version 5 KDC.
+
 =head1 DESCRIPTION
 
 The B<uss help> command displays the complete online help entry (short