Formating fixes and update per rev#25480

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25481 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
index b40511abafdce47e0eb3eb69477b1fea59bbfafa..2a6b964735d15657095483f1f8e454c36d8fb4c1 100644 (file)
--- a/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
+++ b/doc/rst_source/krb_admins/admin_commands/kadmin_local.rst
@@ -617,33 +617,33 @@ add_policy
 
               The following options are available:
 
-              **-maxlife time**
+              **-maxlife** *time*
                      sets the maximum lifetime of a password
 
-              **-minlife time**
+              **-minlife** *time*
                      sets the minimum lifetime of a password
 
-              **-minlength length**
+              **-minlength** *length*
                      sets the minimum length of a password
 
-              **-minclasses number**
+              **-minclasses** *number*
                      sets the minimum number of character classes allowed in a password
 
-              **-history number**
+              **-history** *number*
                      sets the number of past keys kept for a principal. This option is not supported for LDAP database
 
-              **-maxfailure maxnumber**
+              **-maxfailure** *maxnumber*
                      sets the maximum number of authentication failures before the principal is  locked.
                      Authentication failures are only tracked for principals which require preauthentication.
 
-              **-failurecountinterval failuretime**
+              **-failurecountinterval** *failuretime*
                      sets  the  allowable  time  between  authentication failures.  
                      If an authentication failure happens after *failuretime* has elapsed since the previous failure, 
                      the number of authentication failures is reset to 1.
 
-              **-lockoutduration lockouttime**
+              **-lockoutduration** *lockouttime*
                      sets the duration for which the principal is locked from authenticating if too many authentication failures occur without
-                     the specified failure count interval elapsing.
+                     the specified failure count interval elapsing. A duration of 0 means forever.
 
 
               EXAMPLES::

diff --git a/doc/rst_source/krb_build/options2configure.rst b/doc/rst_source/krb_build/options2configure.rst
index 489c922cf62120514bfece577aeab1be54559547..c4f9a5ebe388ccbe5e9bd63f2a841c2968c445fd 100644 (file)
--- a/doc/rst_source/krb_build/options2configure.rst
+++ b/doc/rst_source/krb_build/options2configure.rst
@@ -24,20 +24,20 @@ Most commonly used options
     This option allows one to separate the architecture independent programs\r
     from the host-dependent files (configuration files, manual pages).\r
     Use this option to install architecture-dependent programs in *EXECPREFIX*.\r
-    The default location is the value of specified by * --prefix* option.\r
+    The default location is the value of specified by *prefix* option.\r
 \r
  --localstatedir=LOCALSTATEDIR\r
  \r
    This option sets the directory for locally modifiable single-machine data. \r
-    In Kerberos, this mostly is useful for setting a location for the KDC data files, \r
-    as they will be installed in *LOCALSTATEDIR/krb5kdc*, which is by default *PREFIX/var/krb5kdc*.\r
+   In Kerberos, this mostly is useful for setting a location for the KDC data files, \r
+   as they will be installed in *LOCALSTATEDIR/krb5kdc*, which is by default *PREFIX/var/krb5kdc*.\r
 \r
  --with-netlib[=libs]\r
 \r
     Allows for suppression of or replacement of network libraries. \r
     By default, Kerberos V5 configuration will look for *-lnsl* and *-lsocket*. \r
     If your operating system has a broken resolver library \r
-    or fails to pass the tests in src/tests/resolv you will need to use this option.\r
+    or fails to pass the tests in 'src/tests/resolv' you will need to use this option.\r
 \r
  --with-tcl=TCLPATH\r
 \r
@@ -68,7 +68,7 @@ Most commonly used options
  --with-system-ss\r
 \r
     Use an installed version of the subsystem command-line interface software, \r
-    the *mk_cmds* program, the ss/ss.h header file and the ss library. \r
+    the *mk_cmds* program, the ss/ss.h header file and the *ss* library. \r
     If these are not in the default locations, you may wish to specify \r
     *CPPFLAGS=-I/some/dir* and *LDFLAGS=-L/some/other/dir* options \r
     at configuration time as well. See also the *SS_LIB* option.\r
@@ -90,24 +90,6 @@ Most commonly used options
     (We are not updating this version at this time because of licensing issues \r
     with newer versions that we haven't investigated sufficiently yet.)\r
 \r
- --with-system-verto\r
-\r
-    Use an installed version of libverto.  If the libverto header and\r
-    library are not in default locations, you may wish to specify\r
-    *CPPFLAGS=-I/some/dir* and *LDFLAGS=-L/some/other/dir* options at\r
-    configuration time as well.\r
-\r
-    If this option is not given, the build system will try to detect\r
-    an installed version of libverto and use it if it is found.\r
-    Otherwise, a version supplied with the Kerberos sources will be\r
-    built and installed.  The built-in version does not contain the\r
-    full set of back-end modules and is not a suitable general\r
-    replacement for the upstream version, but will work for the\r
-    purposes of Kerberos.\r
-\r
-    Specifying *--without-system-verto* will cause the built-in\r
-    version of libverto to be used unconditionally.\r
-\r
 \r
 Environment variables\r
 ----------------------------------------\r
@@ -150,7 +132,7 @@ SS_LIB=libs...
     Some variants of this library are around which allow for Emacs-like line editing, \r
     but different versions require different support libraries to be explicitly specified.\r
 \r
-    This option is ignored if \-\-with-system-ss is not specified.\r
+    This option is ignored if 'with-system-ss' is not specified.\r
 \r
 CXX     \r
      C++ compiler command\r
@@ -167,119 +149,98 @@ YFLAGS
      This script will default YFLAGS to the empty string to avoid a\r
      default value of '-d' given by some make applications.\r
 \r
-\r
-Examples\r
-----------\r
-\r
-For example, in order to configure Kerberos on a Solaris machine \r
-\r
-using the *suncc* compiler with the optimizer *turned on*, \r
-run the configure script with the following options::\r
-\r
-     % ./configure CC=suncc CFLAGS=-O\r
-     \r
-\r
-For a slightly more complicated example, consider a system \r
-where several packages to be used by Kerberos are installed in /usr/foobar,\r
-including Berkeley DB 3.3, and an ss library that needs to link against the curses library. \r
-The configuration of Kerberos might be done thus::\r
-\r
-      ./configure CPPFLAGS=-I/usr/foobar/include LDFLAGS=-L/usr/foobar/lib \-\-with-system-et \-\-with-system-ss \-\-with-system-db  SS_LIB='-lss -lcurses'  DB_HEADER=db3/db_185.h DB_LIB=-ldb-3.3\r
-     \r
-\r
-\r
 Fine tuning of the installation directories\r
 ----------------------------------------------\r
 \r
- --bindir=DIR    \r
+ ---bindir=DIR    \r
 \r
      User executables. \r
-     Defaults to  *EXECPREFIX/bin*, where *EXECPREFIX* is the path specified by "--exec-prefix" configuration option.\r
+     Defaults to  *EXECPREFIX/bin*, where *EXECPREFIX* is the path specified by "exec-prefix" configuration option.\r
 \r
  --sbindir=DIR    \r
 \r
      System admin executables.\r
-     Defaults to  *EXECPREFIX/sbin*, where *EXECPREFIX* is the path specified by "--exec-prefix" configuration option.\r
+     Defaults to  *EXECPREFIX/sbin*, where *EXECPREFIX* is the path specified by "exec-prefix" configuration option.\r
 \r
  --libexecdir=DIR \r
 \r
      Program executables.\r
-     Defaults to  *EXECPREFIX/libexec*, where *EXECPREFIX* is the path specified by "--exec-prefix" configuration option.\r
+     Defaults to  *EXECPREFIX/libexec*, where *EXECPREFIX* is the path specified by "exec-prefix" configuration option.\r
 \r
  --sysconfdir=DIR \r
 \r
      Read-only single-machine data.\r
-     Defaults to  *PREFIX/etc*, where *PREFIX* is the path specified by "--prefix" configuration option.\r
+     Defaults to  *PREFIX/etc*, where *PREFIX* is the path specified by "prefix" configuration option.\r
 \r
  --sharedstatedir=DIR\r
 \r
      Modifiable architecture-independent data.\r
-     Defaults to  *PREFIX/com*, where *PREFIX* is the path specified by "--prefix" configuration option.\r
+     Defaults to  *PREFIX/com*, where *PREFIX* is the path specified by "prefix" configuration option.\r
 \r
  --libdir=DIR    \r
 \r
      Object code libraries [EXECPREFIX/lib]\r
-     Defaults to  *EXECPREFIX/lib*, where *EXECPREFIX* is the path specified by "--exec-prefix" configuration option.\r
+     Defaults to  *EXECPREFIX/lib*, where *EXECPREFIX* is the path specified by "exec-prefix" configuration option.\r
 \r
  --includedir=DIR  \r
 \r
      C header files.\r
-     Defaults to  *PREFIX/include*, where *PREFIX* is the path specified by "--prefix" configuration option.\r
+     Defaults to  *PREFIX/include*, where *PREFIX* is the path specified by "prefix" configuration option.\r
 \r
  --oldincludedir=DIR \r
 \r
-     C header files for non-gcc. Default to  /usr/include\r
+     C header files for non-gcc. Default to  '/usr/include'\r
   \r
  --datarootdir=DATAROOTDIR \r
 \r
      Read-only architecture-independent data root.\r
-     Defaults to  *PREFIX/sharee*, where *PREFIX* is the path specified by "--prefix" configuration option.\r
+     Defaults to  *PREFIX/sharee*, where *PREFIX* is the path specified by "prefix" configuration option.\r
   \r
 \r
  --datadir=DIR    \r
 \r
      Read-only architecture-independent data. \r
-     Defaults to  *DATAROOTDIR* by "--datarootdir" configuration option.\r
+     Defaults to  *DATAROOTDIR* by "datarootdir" configuration option.\r
   \r
  --infodir=DIR   \r
 \r
      Info documentation.\r
-     Defaults to  *DATAROOTDIR/info*, where *DATAROOTDIR* is the path specified by "--datarootdir" configuration option.\r
+     Defaults to  *DATAROOTDIR/info*, where *DATAROOTDIR* is the path specified by "datarootdir" configuration option.\r
 \r
  --localedir=DIR  \r
 \r
      Locale-dependent data.\r
-     Defaults to  *DATAROOTDIR/locate*, where *DATAROOTDIR* is the path specified by "--datarootdir" configuration option.\r
+     Defaults to  *DATAROOTDIR/locate*, where *DATAROOTDIR* is the path specified by "datarootdir" configuration option.\r
  \r
  --mandir=DIR     \r
 \r
      Man documentation.\r
-     Defaults to  *DATAROOTDIR/man*, where *DATAROOTDIR* is the path specified by "--datarootdir" configuration option.\r
+     Defaults to  *DATAROOTDIR/man*, where *DATAROOTDIR* is the path specified by "datarootdir" configuration option.\r
   \r
  --docdir=DOCDIR    \r
 \r
      Documentation root.\r
-     Defaults to  *DATAROOTDIR/doc/krb5*, where *DATAROOTDIR* is the path specified by "--datarootdir" configuration option.\r
+     Defaults to  *DATAROOTDIR/doc/krb5*, where *DATAROOTDIR* is the path specified by "datarootdir" configuration option.\r
   \r
  --htmldir=DIR    \r
 \r
-     html documentation.\r
-     Defaults to  *DOCDIR*  path specified by "--docdir" configuration option.\r
+     *html* documentation.\r
+     Defaults to  *DOCDIR*  path specified by "docdir" configuration option.\r
   \r
  --dvidir=DIR    \r
 \r
-     dvi documentation.\r
-     Defaults to  *DOCDIR*  path specified by "--docdir" configuration option.\r
+     *dvi* documentation.\r
+     Defaults to  *DOCDIR*  path specified by "docdir" configuration option.\r
   \r
  --pdfdir=DIR      \r
 \r
-     pdf documentation.\r
-     Defaults to  *DOCDIR*  path specified by "--docdir" configuration option.\r
+     *pdf* documentation.\r
+     Defaults to  *DOCDIR*  path specified by "docdir" configuration option.\r
   \r
  --psdir=DIR     \r
 \r
-     ps documentation.\r
-     Defaults to  *DOCDIR*  path specified by "--docdir" configuration option.\r
+     *ps* documentation.\r
+     Defaults to  *DOCDIR*  path specified by "docdir" configuration option.\r
 \r
 \r
 Program names\r
@@ -288,13 +249,13 @@ Program names
  ---program-prefix=PREFIX      \r
 \r
      Prepend *PREFIX* to the names of the programs when installing them. For example, specifying \r
-     '\-\-program-prefix=mit-' at the configure time will cause the program named *abc* to be installed \r
+     'program-prefix=mit-' at the configure time will cause the program named *abc* to be installed \r
      as *mit-abc*.\r
   \r
  --program-suffix=SUFFIX        \r
 \r
      Append *SUFFIX*  to the names of the programs when installing them. For example, specifying \r
-     '\-\-program-suffix=-mit' at the configure time will cause the program named *abc* to be installed \r
+     'program-suffix=-mit' at the configure time will cause the program named *abc* to be installed \r
      as *abc-mit*.\r
   \r
  --program-transform-name=PROGRAM\r
@@ -312,7 +273,7 @@ System types
  --host=HOST  \r
 \r
      Cross-compile to build programs to run on *HOST*  (e.g. --host=x86_64-linux-gnu). \r
-     By default, Kerberos V5 configuration will look for "\-\-build" option).\r
+     By default, Kerberos V5 configuration will look for "build" option).\r
 \r
 \r
 Optional features\r
@@ -404,17 +365,17 @@ Optional packages
   \r
  --with-crypto-impl=IMPL\r
 \r
-     Use specified crypto implementation (e.g.* --with-crypto=openssl*). \r
+     Use specified crypto implementation (e.g. --with-crypto=openssl). \r
      Default is a native MIT Kerberos implementation *builtin*\r
      The other currently implemented crypto backends are *openssl* and *nss*.\r
      (See :ref:`mitK5features`)\r
 \r
  --with-prng-alg=ALG\r
 \r
-     Use specified PRNG algorithm (e.g. * --with-prng-alg=os*).\r
+     Use specified PRNG algorithm (e.g. --with-prng-alg=os).\r
 \r
      Default is the *fortuna* PRNG algorithm. For the *nss* crypto backend use one must explicitly\r
-     specify * --with-prng-alg=nss*. \r
+     specify --with-prng-alg=nss. \r
      (See :ref:`mitK5features`)\r
 \r
  --with-kdc-kdb-update \r
@@ -428,7 +389,40 @@ Optional packages
   \r
  --with-system-verto\r
 \r
-     Always use system *verto* library\r
+     Use an installed version of libverto.  If the libverto header and\r
+     library are not in default locations, you may wish to specify\r
+     *CPPFLAGS=-I/some/dir* and *LDFLAGS=-L/some/other/dir* options at\r
+     configuration time as well.\r
+\r
+     If this option is not given, the build system will try to detect\r
+     an installed version of libverto and use it if it is found.\r
+     Otherwise, a version supplied with the Kerberos sources will be\r
+     built and installed.  The built-in version does not contain the\r
+     full set of back-end modules and is not a suitable general\r
+     replacement for the upstream version, but will work for the\r
+     purposes of Kerberos.\r
+\r
+     Specifying *--without-system-verto* will cause the built-in\r
+     version of libverto to be used unconditionally.\r
+\r
+\r
+\r
+Examples\r
+----------\r
+\r
+For example, in order to configure Kerberos on a Solaris machine \r
+\r
+using the *suncc* compiler with the optimizer *turned on*, \r
+run the configure script with the following options::\r
 \r
+     % ./configure CC=suncc CFLAGS=-O\r
+     \r
 \r
+For a slightly more complicated example, consider a system \r
+where several packages to be used by Kerberos are installed in /usr/foobar,\r
+including Berkeley DB 3.3, and an ss library that needs to link against the curses library. \r
+The configuration of Kerberos might be done thus::\r
+\r
+      ./configure CPPFLAGS=-I/usr/foobar/include LDFLAGS=-L/usr/foobar/lib --with-system-et --with-system-ss --with-system-db  SS_LIB='-lss -lcurses'  DB_HEADER=db3/db_185.h DB_LIB=-ldb-3.3\r
+     \r
 \r