Update the man pages pod source adding text to discourage use of
[openafs.git] / doc / man-pages / pod8 / uss_add.pod
index ae70a3b..5941601 100644 (file)
@@ -1,33 +1,48 @@
 =head1 NAME
 
-uss add - Creates a user account
+uss_add - Creates a user account
 
 =head1 SYNOPSIS
 
-B<uss add> B<-user> <I<login name>> [B<-realname> <I<full name in quotes>>]
-    [B<-pass> <I<initial password>>]
+=for html
+<div class="synopsis">
+
+B<uss add> S<<< B<-user> <I<login name>> >>> S<<< [B<-realname> <I<full name in quotes>>] >>>
+    S<<< [B<-pass> <I<initial password>>] >>>
     [B<-pwexpires> <I<< password expires in [0..254] days (0 => never) >>>]
-    [B<-server> <I<file server for home volume>>]
-    [B<-partition> <I<file server's disk partition for home volume>>]
-    [B<-mount> <I<home directory mount point>>]
-    [B<-uid> <I<uid to assign the user>>]
-    [B<-template> <I<pathname of template file>>]
-    [B<-verbose>] [B<-var> <I<auxiliary argument pairs (Num val)>>+]
-    [B<-cell> <I<cell name>>] [B<-admin> <I<administrator to authenticate>>]
+    S<<< [B<-server> <I<file server for home volume>>] >>>
+    S<<< [B<-partition> <I<file server's disk partition for home volume>>] >>>
+    S<<< [B<-mount> <I<home directory mount point>>] >>>
+    S<<< [B<-uid> <I<uid to assign the user>>] >>>
+    S<<< [B<-template> <I<pathname of template file>>] >>>
+    [B<-verbose>] S<<< [B<-var> <I<auxiliary argument pairs (Num val)>>+] >>>
+    S<<< [B<-cell> <I<cell name>>] >>> S<<< [B<-admin> <I<administrator to authenticate>>] >>>
     [B<-dryrun>] [B<-skipauth>] [B<-overwrite>] [B<-help>]
 
-B<uss ad> B<-us> <I<login name>> [B<-r> <I<full name in quotes>>]
-    [B<-pas> <I<initial password>>]
+B<uss ad> S<<< B<-us> <I<login name>> >>> S<<< [B<-r> <I<full name in quotes>>] >>>
+    S<<< [B<-pas> <I<initial password>>] >>>
     [B<-pw> <I<< password expires in [0..254] days (0 => never) >>>]
-    [B<-se> <I<FileServer for home volume>>]
-    [B<-par> <I<FileServer's disk partition for home volume>>]
-    [B<-m> <I<home directory mount point>>]
-    [B<-ui> <I<uid to assign the user>>]
-    [B<-t> <I<pathname of template file>>] [B<-ve>]
-    [B<-va> <I<auxiliary argument pairs (Num val)>>+] [B<-c> <I<cell name>>]
-    [B<-a> <I<administrator to authenticate>>] [B<-d>] [B<-sk>] [B<-o>]
+    S<<< [B<-se> <I<FileServer for home volume>>] >>>
+    S<<< [B<-par> <I<FileServer's disk partition for home volume>>] >>>
+    S<<< [B<-m> <I<home directory mount point>>] >>>
+    S<<< [B<-ui> <I<uid to assign the user>>] >>>
+    S<<< [B<-t> <I<pathname of template file>>] >>> [B<-ve>]
+    S<<< [B<-va> <I<auxiliary argument pairs (Num val)>>+] >>> S<<< [B<-c> <I<cell name>>] >>>
+    S<<< [B<-a> <I<administrator to authenticate>>] >>> [B<-d>] [B<-sk>] [B<-o>]
     [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 add> command creates entries in the Protection Database and
@@ -232,7 +247,7 @@ variable.
 
 =back
 
-See the chapter on uss in the I<IBM AFS Administration Guide> for further
+See the chapter on uss in the I<OpenAFS Administration Guide> for further
 explanation.
 
 =item B<-cell> <I<cell name>>