comparison src/lib.rs @ 2:e69e2966ae0d

Replaces generated README
author Jesse Hallett <jesse@galois.com>
date Thu, 05 Mar 2015 16:33:43 -0800
parents b195a14058bb
children 2ec97116d72c
comparison
equal deleted inserted replaced
1:b195a14058bb 2:e69e2966ae0d
17 //! 17 //!
18 //! A typical authentication module will define an external function called 18 //! A typical authentication module will define an external function called
19 //! `pam_sm_authenticate()`, which will use functions in this library to 19 //! `pam_sm_authenticate()`, which will use functions in this library to
20 //! interrogate the program that requested authentication for more information, 20 //! interrogate the program that requested authentication for more information,
21 //! and to render a result. For a working example that uses this library, see 21 //! and to render a result. For a working example that uses this library, see
22 //! [tozny-pam][]. 22 //! [toznyauth-pam][].
23 //! 23 //!
24 //! [tozny-pam]: https://github.com/tozny/tozny-pam 24 //! [toznyauth-pam]: https://github.com/tozny/toznyauth-pam
25 //! 25 //!
26 //! Note that constants that are normally read from pam header files are 26 //! Note that constants that are normally read from pam header files are
27 //! hard-coded in the `constants` module. The values there are taken from 27 //! hard-coded in the `constants` module. The values there are taken from
28 //! a Linux system. That means that it might take some work to get this library 28 //! a Linux system. That means that it might take some work to get this library
29 //! to work on other platforms. 29 //! to work on other platforms.