Correct typos and formating

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

diff --git a/doc/rst_source/krb_build/doing_build.rst b/doc/rst_source/krb_build/doing_build.rst
index b54fb8caba83ccf4ef6172ece436c1cc4306937d..8c4e2068cac96c85c01c99f4df6bcc343517e595 100644 (file)
--- a/doc/rst_source/krb_build/doing_build.rst
+++ b/doc/rst_source/krb_build/doing_build.rst
@@ -111,7 +111,7 @@ Testing the build
 
 The Kerberos V5 distribution comes with built-in regression tests. 
 To run them, simply type the following command while in the top-level build directory 
-(i.e., the directory where you sent typed make to start building Kerberos; see :ref:`do_build`.)::
+(i.e., the directory where you sent typed make to start building Kerberos; see :ref:`do_build`)::
 
      make check
      
@@ -136,7 +136,7 @@ Cleaning up the build
 -------------------------
 
   - Use *make clean* to remove all files generated by running *make* command. 
-  - Use *make distclean* to remove all files generated by running *./configure * script.
+  - Use *make distclean* to remove all files generated by running *./configure* script.
     After running *make distclean* your source tree (ideally) should look like the raw (just un-tarred) source tree with executed *util/reconf* command.
 
     

diff --git a/doc/rst_source/krb_build/options2configure.rst b/doc/rst_source/krb_build/options2configure.rst
index c4f9a5ebe388ccbe5e9bd63f2a841c2968c445fd..d141a1b78f775bffa086fb826ee7bf277248f6a9 100644 (file)
--- a/doc/rst_source/krb_build/options2configure.rst
+++ b/doc/rst_source/krb_build/options2configure.rst
@@ -16,8 +16,8 @@ Most commonly used options
 \r
  --prefix=PREFIX\r
 \r
-    By default, Kerberos will install the package's files rooted at '/usr/local'\r
-    If you desire to place the binaries into the directory *PREFIX*, use this option \r
+    By default, Kerberos will install the package's files rooted at '/usr/local'.\r
+    If you desire to place the binaries into the directory *PREFIX*, use this option.\r
 \r
  --exec-prefix=EXECPREFIX\r
 \r
@@ -30,21 +30,22 @@ Most commonly used options
  \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
+   as they will be installed in *LOCALSTATEDIR/krb5kdc*, \r
+   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
     Some of the unit-tests in the build tree rely upon using a program in Tcl. \r
     The directory specified by *TCLPATH* specifies where the Tcl header file \r
     (TCLPATH/include/tcl.h) \r
-    as well as where the Tcl library should be found (TCLPATH/lib).\r
+    as well as where the Tcl library (TCLPATH/lib)  should be found.\r
 \r
  --enable-dns-for-realm\r
 \r
@@ -106,9 +107,9 @@ CPPFLAGS=CPPOPTS
     for use with the operating system's include files.\r
 \r
 CPP=CPP  \r
-     C preprocessor to use. (e,g, CPP='gcc -E')\r
+     C preprocessor to use. (e.g. CPP='gcc -E')\r
 \r
-DB_HEADER=headername.h\r
+DB_HEADER=headername\r
     If db.h is not the correct header file to include to compile against the Berkeley DB 1.85 API, \r
     specify the correct header file name with this option. For example, DB_HEADER=db3/db_185.h.\r
 \r
@@ -132,7 +133,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
@@ -179,7 +180,7 @@ Fine tuning of the installation directories
 \r
  --libdir=DIR    \r
 \r
-     Object code libraries [EXECPREFIX/lib]\r
+     Object code libraries.\r
      Defaults to  *EXECPREFIX/lib*, where *EXECPREFIX* is the path specified by "exec-prefix" configuration option.\r
 \r
  --includedir=DIR  \r
@@ -189,12 +190,12 @@ Fine tuning of the installation directories
 \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/share*, where *PREFIX* is the path specified by "prefix" configuration option.\r
   \r
 \r
  --datadir=DIR    \r
@@ -210,7 +211,7 @@ Fine tuning of the installation directories
  --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/locale*, where *DATAROOTDIR* is the path specified by "datarootdir" configuration option.\r
  \r
  --mandir=DIR     \r
 \r
@@ -249,13 +250,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
@@ -273,7 +274,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
@@ -281,51 +282,52 @@ Optional features
 \r
  ---disable-FEATURE   \r
 \r
-     Do not include FEATURE (same as  --enable-FEATURE=no)\r
+     Do not include FEATURE (same as  --enable-FEATURE=no).\r
   \r
  --disable-option-checking\r
 \r
-     Ignore unrecognized --enable/--with options\r
+     Ignore unrecognized --enable/--with options.\r
   \r
  --enable-FEATURE[=ARG]  \r
 \r
-     Include FEATURE [ARG=yes]\r
+     Include FEATURE [ARG=yes].\r
   \r
  --enable-dns-for-realm\r
 \r
-     Enable DNS lookups of Kerberos realm names\r
+     Enable DNS lookups of Kerberos realm names.\r
   \r
  --enable-maintainer-mode\r
 \r
-     Enable rebuilding of source files, Makefiles, etc\r
+     Enable rebuilding of source files, Makefiles, etc.\r
   \r
  --disable-delayed-initialization\r
 \r
-     Initialize library code when loaded [delay until first use]\r
+     Initialize library code when loaded.\r
+     Defaults to delay until first use.\r
   \r
  --disable-thread-support\r
 \r
-     Don't enable thread support [enabled]\r
+     Don't enable thread support. Defaults to enabled.\r
 \r
  --disable-rpath   \r
 \r
-     Suppress run path flags in link lines\r
+     Suppress run path flags in link lines.\r
   \r
  --enable-athena   \r
 \r
-     Build with MIT Project Athena configuration\r
+     Build with MIT Project Athena configuration.\r
   \r
  --enable-fortuna-test\r
 \r
-     Build to test Fortuna PRNG\r
+     Build to test Fortuna PRNG.\r
   \r
  --disable-kdc-lookaside-cache\r
 \r
-     Disable the cache which detects client retransmits\r
+     Disable the cache which detects client retransmits.\r
 \r
  --disable-pkinit    \r
 \r
-     Disable PKINIT plugin support\r
+     Disable PKINIT plugin support.\r
 \r
 \r
 Optional packages\r
@@ -339,11 +341,11 @@ Optional packages
 \r
  --without-*PACKAGE* \r
 \r
-     Do not use *PACKAGE* (same as \-\-with-PACKAGE=no) (e.g. --without-libedit)\r
+     Do not use *PACKAGE* (same as \-\-with-PACKAGE=no) (e.g. --without-libedit).\r
 \r
  --with-size-optimizations\r
 \r
-     Enable a few optimizations to reduce code size possibly at some run-time cost\r
+     Enable a few optimizations to reduce code size possibly at some run-time cost.\r
   \r
  --with-hesiod=path\r
 \r
@@ -352,11 +354,11 @@ Optional packages
   \r
  --with-ldap   \r
 \r
-     Compile OpenLDAP database backend module\r
+     Compile OpenLDAP database backend module.\r
   \r
  --with-edirectory \r
 \r
-     Compile eDirectory database backend module\r
+     Compile eDirectory database backend module.\r
   \r
  --with-vague-errors \r
 \r
@@ -365,27 +367,29 @@ Optional packages
   \r
  --with-crypto-impl=IMPL\r
 \r
-     Use specified crypto implementation (e.g. --with-crypto=openssl). \r
-     Default is a native MIT Kerberos implementation *builtin*\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. \r
+     For example, to use the OS native prng specify *--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
+     Default is the *fortuna* PRNG algorithm. \r
+     For the *nss* crypto backend use one must explicitly specify *--with-prng-alg=nss*. \r
      (See :ref:`mitK5features`)\r
 \r
  --with-kdc-kdb-update \r
 \r
      Update the KDC database with the information about \r
-     - the last successful authentication;\r
-     - the last failed authentication attempt;\r
-     - the number of the failed authentication attempts.\r
+ \r
+         - the last successful authentication;\r
+         - the last failed authentication attempt;\r
+         - the number of the failed authentication attempts.\r
 \r
-     By default the kdb is not updated with this information..\r
+     By default the kdb is not updated with this information.\r
   \r
  --with-system-verto\r
 \r
@@ -411,7 +415,6 @@ Examples
 ----------\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