diff options
author | Thorsten Kukuk <kukuk@thkukuk.de> | 2008-01-08 12:44:15 +0000 |
---|---|---|
committer | Thorsten Kukuk <kukuk@thkukuk.de> | 2008-01-08 12:44:15 +0000 |
commit | d48c90b14254794fcad9ccc37873a8c663cce02d (patch) | |
tree | 62e42b3fd242091e7fab171d1b816586c09e743c /doc/man/pam_end.3 | |
parent | 1f802e15b36f0ca69dc4127a9332983acfd70117 (diff) | |
download | pam-d48c90b14254794fcad9ccc37873a8c663cce02d.tar.gz pam-d48c90b14254794fcad9ccc37873a8c663cce02d.tar.bz2 pam-d48c90b14254794fcad9ccc37873a8c663cce02d.zip |
Relevant BUGIDs:
Purpose of commit: cleanup
Commit summary:
---------------
Remove autogenerated documentation from CVS
Diffstat (limited to 'doc/man/pam_end.3')
-rw-r--r-- | doc/man/pam_end.3 | 69 |
1 files changed, 0 insertions, 69 deletions
diff --git a/doc/man/pam_end.3 b/doc/man/pam_end.3 deleted file mode 100644 index 3b28a265..00000000 --- a/doc/man/pam_end.3 +++ /dev/null @@ -1,69 +0,0 @@ -.\" Title: pam_end -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/> -.\" Date: 06/27/2006 -.\" Manual: Linux\-PAM Manual -.\" Source: Linux\-PAM Manual -.\" -.TH "PAM_END" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.SH "NAME" -pam_end \- termination of PAM transaction -.SH "SYNOPSIS" -.sp -.ft B -.nf -#include <security/pam_appl.h> -.fi -.ft -.HP 12 -.BI "int pam_end(pam_handle_t\ *" "pamh" ", int\ " "pam_status" ");" -.SH "DESCRIPTION" -.PP -The -\fBpam_end\fR -function terminates the PAM transaction and is the last function an application should call in the PAM context. Upon return the handle -\fIpamh\fR -is no longer valid and all memory associated with it will be invalid. -.PP -The -\fIpam_status\fR -argument should be set to the value returned to the application by the last PAM library call. -.PP -The value taken by -\fIpam_status\fR -is used as an argument to the module specific callback function, -\fBcleanup()\fR -(See -\fBpam_set_data\fR(3) -and -\fBpam_get_data\fR(3)). In this way the module can be given notification of the pass/fail nature of the tear\-down process, and perform any last minute tasks that are appropriate to the module before it is unlinked. This argument can be logically OR'd with -\fIPAM_DATA_SILENT\fR -to indicate to indicate that the module should not treat the call too seriously. It is generally used to indicate that the current closing of the library is in a -\fBfork\fR(2)ed process, and that the parent will take care of cleaning up things that exist outside of the current process space (files etc.). -.PP -This function -\fIfree\fR's all memory for items associated with the -\fBpam_set_item\fR(3) -and -\fBpam_get_item\fR(3) -functions. Pointers associated with such objects are not valid anymore after -\fBpam_end\fR -was called. -.SH "RETURN VALUES" -.TP 3n -PAM_SUCCESS -Transaction was successful terminated. -.TP 3n -PAM_SYSTEM_ERR -System error, for example a NULL pointer was submitted as PAM handle or the function was called by a module. -.SH "SEE ALSO" -.PP - -\fBpam_get_data\fR(3), -\fBpam_set_data\fR(3), -\fBpam_start\fR(3), -\fBpam_strerror\fR(3) |