OpenPAM/OpenPAM
OpenPAM/OpenPAM
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix some markup issues pointed out by ru@.

Browse source 
git-svn-id: svn+ssh://svn.openpam.org/svn/openpam/trunk@249 185d5e19-27fe-0310-9dcf-9bff6b9f3609
This commit is contained in:
Dag-Erling Smørgrav 2003-06-02 21:41:24 +00:00
parent c25cf2c668
commit 0bca19fe3b
2 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/man/pam.man
View file

@ -1,5 +1,5 @@
.\" .\"
.\" $P4: //depot/projects/openpam/doc/man/pam.man#1 $ .\" $P4: //depot/projects/openpam/doc/man/pam.man#2 $
.\" .\"
.Sh DESCRIPTION .Sh DESCRIPTION
The Pluggable Authentication Modules (PAM) library abstracts a number The Pluggable Authentication Modules (PAM) library abstracts a number
@ -13,7 +13,7 @@ service name, which is often (but not necessarily) the program name.
.Pp .Pp
The user requesting authentication is called the applicant, while the The user requesting authentication is called the applicant, while the
user (usually, root) charged with verifying his identity and granting user (usually, root) charged with verifying his identity and granting
him the requested credentials is called the arbitrator. him the requested credentials is called the arbitrator.
.Pp .Pp
The sequence of operations the server goes through to authenticate a The sequence of operations the server goes through to authenticate a
user and perform whatever task he requested is a PAM transaction; the user and perform whatever task he requested is a PAM transaction; the
@ -32,7 +32,7 @@ devices.
See See
.Xr pam_conv 3 .Xr pam_conv 3
for details. for details.
.Ss Initialization And Cleanup .Ss Initialization and Cleanup
The The
.Fn pam_start .Fn pam_start
function initializes the PAM library and returns a handle which must function initializes the PAM library and returns a handle which must
@ -44,7 +44,7 @@ transactions in parallel.
The The
.Fn pam_end .Fn pam_end
function releases all resources associated with the specified context, function releases all resources associated with the specified context,
and can be called at any time to terminate a PAM transaction. and can be called at any time to terminate a PAM transaction.
.Ss Storage .Ss Storage
The The
.Fn pam_set_item .Fn pam_set_item
@ -54,12 +54,12 @@ functions set and retrieve a number of predefined items, including the
service name, the names of the requesting and target users, the service name, the names of the requesting and target users, the
conversation function, and prompts. conversation function, and prompts.
.Pp .Pp
The The
.Fn pam_set_data .Fn pam_set_data
and and
.Fn pam_get_data .Fn pam_get_data
manage named chunks of free-form data, generally used by modules to functions manage named chunks of free-form data, generally used by
store state from one invocation to another. modules to store state from one invocation to another.
.Ss Authentication .Ss Authentication
There are two authentication primitives: There are two authentication primitives:
.Fn pam_authenticate .Fn pam_authenticate
@ -84,7 +84,7 @@ The
function allows the server to change the user's password, either at function allows the server to change the user's password, either at
the user's request or because the password has expired. the user's request or because the password has expired.
.Ss Miscellaneous .Ss Miscellaneous
The The
.Fn pam_putenv , .Fn pam_putenv ,
.Fn pam_getenv .Fn pam_getenv
and and
@ -94,5 +94,5 @@ variables they want the server to export during the session.
.Pp .Pp
The The
.Fn pam_strerror .Fn pam_strerror
function returns a pointer to a string describing a the specified PAM function returns a pointer to a string describing the specified PAM
error code. error code.

20
misc/gendoc.pl
View file

@ -32,7 +32,7 @@
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE. # SUCH DAMAGE.
# #
# $P4: //depot/projects/openpam/misc/gendoc.pl#25 $ # $P4: //depot/projects/openpam/misc/gendoc.pl#26 $
# #
use strict; use strict;
@ -360,7 +360,7 @@ sub gendoc($) {
if ($func->{'name'} =~ m/openpam/) { if ($func->{'name'} =~ m/openpam/) {
$mdoc .= ".In security/openpam.h\n" $mdoc .= ".In security/openpam.h\n"
} }
$mdoc .= ".Ft $func->{'type'} $mdoc .= ".Ft \"$func->{'type'}\"
.Fn $func->{'name'} $func->{'args'} .Fn $func->{'name'} $func->{'args'}
.Sh DESCRIPTION .Sh DESCRIPTION
$func->{'man'} $func->{'man'}
@ -411,10 +411,11 @@ function is an OpenPAM extension.
$mdoc .= ".Sh AUTHORS $mdoc .= ".Sh AUTHORS
The The
.Nm .Nm
function and this manual page were developed for the FreeBSD Project function and this manual page were developed for the
by ThinkSec AS and Network Associates Laboratories, the Security .Fx
Research Division of Network Associates, Inc. under DARPA/SPAWAR Project by ThinkSec AS and Network Associates Laboratories, the
contract N66001-01-C-8035 Security Research Division of Network Associates, Inc. under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS , .Pq Dq CBOSS ,
as part of the DARPA CHATS research program. as part of the DARPA CHATS research program.
"; ";
@ -511,7 +512,7 @@ The following return codes are defined by
} }
print FILE ".Sh SEE ALSO print FILE ".Sh SEE ALSO
"; ";
print FILE ".Xr openpam 3\n" print FILE ".Xr openpam 3 ,\n"
if ($page eq 'pam'); if ($page eq 'pam');
foreach $func (keys(%FUNCTIONS)) { foreach $func (keys(%FUNCTIONS)) {
$xref{$func} = 3; $xref{$func} = 3;
@ -530,8 +531,9 @@ The following return codes are defined by
.Re .Re
.Sh AUTHORS .Sh AUTHORS
The OpenPAM library and this manual page were developed for the The OpenPAM library and this manual page were developed for the
FreeBSD Project by ThinkSec AS and Network Associates Laboratories, .Fx
the Security Research Division of Network Associates, Inc. under Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc. under
DARPA/SPAWAR contract N66001-01-C-8035 DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS , .Pq Dq CBOSS ,
as part of the DARPA CHATS research program. as part of the DARPA CHATS research program.