#
# $Id: README,v 1.8 1996/07/08 00:11:51 morgan Exp $
#

Hello!

Thanks for downloading Linux-PAM-0.50.

--------------------------------------------------------------------
Before you begin:

  * This distribution requires GNU's Make

--------------------------------------------------------------------

First thing to do (I assume you have successfully unpacked it!) is to
run:

    make check

This will check that the distribution has arrived intact. If you
change some things, running this command from this directory will show
you what files you have altered.

[ For the paranoid, there is an md5 checksum for the whole tar.gz file
to accompany this release at

	http://gluon.physics.ucla.edu/~morgan/pam

]

If you choose to get and install the RCS files that accompany this
release, you may also run

	make RCScheck

from this directory.

If you are running an ELF based Linux system you should be able to
compile the distribution straight from the box. If you are running an
a.out based system, then some of the functionality of Linux-PAM will
be unavailable to you. Instead, you must switch the DYNAMIC variables
*off* in the top level makefile: comment out the DYNAMIC and
DYNAMIC_LIBPAM defines and uncomment the STATIC and STATIC_LIBPAM
defines. NOTE, for ELF based systems, almost any combination of these
four definitions is legal... If you have ELF, I recommend the default
however.

Second, try to compile it. Use the following command in this
directory:

	make

[ or 'make all' if you prefer ]. The first time you type make, it is
likely to complain. This is to remind you to remove any libraries from
previous versions of the distribution that are likely to confuse this
make...

Third, to install the stuff you need to be root. Do the following:

	su
	make install
	exit

If everything has worked as intended there should now be

	some executables		in	./bin/
	some filters for pam_filter	in	/usr/sbin/pam_filter/
if dynamically linked:
	libpam.so.XXX (shared library)	in	/usr/lib/
	pam_*.so (modules)		in	/usr/lib/security/
if statically linked:
	libpam.a (static library)	in	/usr/lib/

* the unix module is only partially STATIC-aware. Watch the list for an
updated version.

NOTES:

* The documentation, what there is of it, is in ./doc. I am only
including the sgml format source-files. But try to make .ps files
available from the above http address. To locally use these sgml files
you should have linuxdoc-sgml installed [try sunsite, I found it
didn't compile well until I removed the check for the section 3 manual
ctype, which I don't have!]. Sorry. But I'm conserving net bandwidth
by only including sources!

* The source for each module is to be found in ./modules/XXX. If you
want to add a new one, make a directory like XXX for it. Add the name
(XXX) to MODDIRS in ./modules/Makefile and hopefully it will become
part of the overall make. Note, the makefile in ./modules/ is now
smart enough to check if the directory is there before it changes into
it, so if you want to start working on a module then send me its name
and I will add it to the "official" Makefile.. This way, you should be
able to insert your developing module into any new release, and not
have to worry at first about letting it out to the public. This may
also give other people some idea about whether a module is currently
being worked on or not.

* Currently, you have to 'make' binaries from this directory. 'make
clean', however, works in any directory that has a Makefile.

* Also, you can 'make remove' (as root) from this directory and it
will delete the various files dotted around the system.

* 'make sterile' does 'make remove' and then 'make extraclean', this
might be required if you are alternating your choice of
STATIC(_LIBPAM) and DYNAMIC(_LIBPAM) compilation.

Best wishes

Andrew Morgan

Email bugs/comments to: the Linux-PAM list <pam-list@redhat.com>
or me <morgan@physics.ucla.edu>

To see about joining the mailing list, send the following email:
--------------------------------
To: pam-list-request@redhat.com
Subject: help
<empty text>
--------------------------------

Additionally, Linux-PAM files have been known to be found at one
or more of the following places (they are not always the most up to
date):

ftp://tsx-11.mit.edu/pub/linux/ALPHA/PAM/
ftp://bach.cis.temple.edu/pub/People/Alex/private/PAM
ftp://ftp.redhat.com/pub/misc/
ftp://linux.nrao.edu/pub/linux/ALPHA/PAM/
http://www.redhat.com/pam
