]> eyrie.org Git - kerberos/kadmin-remctl.git/commitdiff
Update README to current format, update install instructions
authorRuss Allbery <rra@stanford.edu>
Mon, 25 Mar 2013 16:42:59 +0000 (09:42 -0700)
committerRuss Allbery <rra@stanford.edu>
Mon, 25 Mar 2013 16:42:59 +0000 (09:42 -0700)
Use my new layout for README with a separate LICENSE section.
Update the installation instructions around how finding the
Kerberos libraries works.

README

diff --git a/README b/README
index a75f9f0059b70f819a9393160ccef70d02846eae..87c93dd3d98e00111f4523e14efb0c1adb87a694 100644 (file)
--- a/README
+++ b/README
@@ -3,10 +3,10 @@
 
                 Written by Russ Allbery <rra@stanford.edu>
 
-  Copyright 1997, 2003, 2007, 2008, 2009, 2010, 2011 The Board of Trustees
-  of the Leland Stanford Junior University.  This software is distributed
-  under a BSD-style license.  Please see the file LICENSE in the
-  distribution for more information.
+  Copyright 1997, 2003, 2007, 2008, 2009, 2010, 2011, 2013 The Board of
+  Trustees of the Leland Stanford Junior University.  This software is
+  distributed under a BSD-style license.  Please see the section LICENSE
+  below for more information.
 
 BLURB
 
@@ -68,7 +68,7 @@ REQUIREMENTS
 
   The kadmin backend is written in Perl and requires the Perl Expect
   module.  The Heimdal version also requires the IPC::Run module.  The MIT
-  version (kadmin-backend) calls the MIT Kerberos v5 kadmin and kpasswd
+  version (kadmin-backend) calls the MIT Kerberos kadmin and kpasswd
   programs and therefore requires that they be available.  The Heimdal
   version similarly requires kpasswd, but uses the Perl module
   Heimdal::Kadm5 for kadmin operations and requires it be installed.  For
@@ -136,11 +136,12 @@ INSTALLATION
   instance of remctl should be run with the KRB5_KTNAME environment
   variable set, pointing it at the keytab for this designated principal.
 
-  Before building the passwd_change client, you may want to modify the
+  Before building the passwd_change client, you will want to modify the
   settings at the top of the passwd_change.c code to point it to the
-  correct server and port and to use the correct designated principal for
-  the password changing service.  (If you don't, you'll have to always
-  have appropriate configuration in your krb5.conf file.)  Then, run:
+  correct server and port, to use the correct designated principal for the
+  password changing service, and to set the path to the passwd file.  (If
+  you don't, you'll have to always have appropriate configuration in your
+  krb5.conf file.)  Then, run:
 
       ./configure
       make
@@ -175,15 +176,15 @@ INSTALLATION
   searched by your compiler.  If the the krb5-config script first in your
   path is not the one corresponding to the Kerberos libraries you want to
   use or if your Kerberos libraries and includes aren't in a location
-  searched by default by your compiler, you need to specify
-  --with-krb5=PATH:
+  searched by default by your compiler, you need to specify a different
+  Kerberos installation root via --with-krb5=PATH.  For example:
 
-      ./configure --with-kerberos=/usr/pubsw
+      ./configure --with-krb5=/usr/pubsw
 
-  As with remctl, you can use --with-krb5-lib and --with-krb5-include to
-  specify the paths to the library and include directories separately,
-  although this is only necessary (or used) if a krb5-config script can't
-  be found.
+  You can also individually set the paths to the include directory and the
+  library directory with --with-krb5-include and --with-krb5-lib.  You may
+  need to do this if Autoconf can't figure out whether to use lib, lib32,
+  or lib64 on your platform.
 
   To specify a particular krb5-config script to use, either set the
   PATH_KRB5_CONFIG environment variable or pass it to configure like:
@@ -194,7 +195,10 @@ INSTALLATION
   krb5-config script on your path, set PATH_KRB5_CONFIG to a nonexistent
   path:
 
-      ./configure KRB5_CONFIG=/nonexistent
+      ./configure PATH_KRB5_CONFIG=/nonexistent
+
+  krb5-config is not used and library probing is always done if either
+  --with-krb5-include or --with-krb5-lib are given.
 
   You can build kadmin-remctl in a different directory from the source if
   you wish.  To do this, create a new empty directory, cd to that
@@ -213,7 +217,7 @@ INSTALLATION
   shared library migrations more difficult.  If none of the above made any
   sense to you, don't bother with this flag.
 
-HOMEPAGE AND SOURCE REPOSITORY
+SUPPORT
 
   The kadmin-remctl web page at:
 
@@ -222,6 +226,13 @@ HOMEPAGE AND SOURCE REPOSITORY
   will always have the current version of this package, the current
   documentation, and pointers to any additional resources.
 
+  I welcome bug reports and patches for this package at rra@stanford.edu.
+  However, please be aware that I tend to be extremely busy and work
+  projects often take priority.  I'll save your mail and get to it as soon
+  as I can, but it may take me a couple of months.
+
+SOURCE REPOSITORY
+
   kadmin-remctl is maintained using Git.  You can access the current
   source by cloning the repository at:
 
@@ -231,6 +242,9 @@ HOMEPAGE AND SOURCE REPOSITORY
 
       http://git.eyrie.org/?p=kerberos/kadmin-remctl.git
 
+  When contributing modifications, patches (possibly generated by
+  git-format-patch) are preferred to Git pull requests.
+
 THANKS
 
   To Jon Robertson for the port of kadmin-backend to Heimdal.
@@ -238,3 +252,40 @@ THANKS
   To Derrick Brashear and Ken Hornstein of Sine Nomine Associates, who did
   work on behalf of Stanford University on realm synchronization that was
   a predecessor of the ksetpass program.
+
+LICENSE
+
+  The kadmin-remctl package as a whole covered by the following copyright
+  statement and license:
+
+    Copyright 1997, 2003, 2006, 2007, 2008, 2009, 2010, 2011, 2013
+        The Board of Trustees of the Leland Stanford Junior University
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+  All individual files without an explicit exception below are released
+  under this license.  Some files may have additional copyright holders as
+  noted in those files.  There is detailed information about the licensing
+  of each file in the LICENSE file in this distribution.
+
+  Some files in this distribution are individually released under
+  different licenses, all of which are compatible with the above general
+  package license but which may require preservation of additional
+  notices.  All required notices are preserved in the LICENSE file.