Relevant BUGIDs:

Purpose of commit: cleanup

Commit summary:
---------------
2007-12-12  Eamon Walsh <ewalsh@tycho.nsa.gov>

        * doc/man/pam_item_types_ext.inc.xml: More appropriate wording
        for PAM_XDISPLAY doc.

1 files changed, 39 insertions, 29 deletions

diff --git a/doc/man/pam_set_data.3 b/doc/man/pam_set_data.3
index c3a2a689..1991b92a 100644
--- a/doc/man/pam_set_data.3
+++ b/doc/man/pam_set_data.3
@@ -1,22 +1,22 @@
 .\"     Title: pam_set_data
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\"      Date: 06/27/2006
-.\"    Manual: Linux\-PAM Manual
-.\"    Source: Linux\-PAM Manual
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\"      Date: 12/06/2007
+.\"    Manual: Linux-PAM Manual
+.\"    Source: Linux-PAM Manual
 .\"
-.TH "PAM_SET_DATA" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_SET_DATA" "3" "12/06/2007" "Linux-PAM Manual" "Linux-PAM Manual"
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-pam_set_data \- set module internal data
+pam_set_data - set module internal data
 .SH "SYNOPSIS"
 .sp
 .ft B
 .nf
-#include <security/pam_modules.h>
+#include <security/pam_modules\.h>
 .fi
 .ft
 .HP 17
@@ -29,30 +29,30 @@ function associates a pointer to an object with the (hopefully) unique string
 \fImodule_data_name\fR
 in the PAM context specified by the
 \fIpamh\fR
-argument.
+argument\.
 .PP
-PAM modules may be dynamically loadable objects. In general such files should not contain
+PAM modules may be dynamically loadable objects\. In general such files should not contain
 \fIstatic\fR
-variables. This function and its counterpart
+variables\. This function and its counterpart
 \fBpam_get_data\fR(3), provide a mechanism for a module to associate some data with the handle
-\fIpamh\fR. Typically a module will call the
+\fIpamh\fR\. Typically a module will call the
 \fBpam_set_data\fR
 function to register some data under a (hopefully) unique
-\fImodule_data_name\fR. The data is available for use by other modules too but
+\fImodule_data_name\fR\. The data is available for use by other modules too but
 \fInot\fR
-by an application. Since this functions stores only a pointer to the
-\fIdata\fR, the module should not modify or free the content of it.
+by an application\. Since this functions stores only a pointer to the
+\fIdata\fR, the module should not modify or free the content of it\.
 .PP
 The function
 \fBcleanup()\fR
 is associated with the
 \fIdata\fR
 and, if non\-NULL, it is called when this data is over\-written or following a call to
-\fBpam_end\fR(3).
+\fBpam_end\fR(3)\.
 .PP
 The
 \fIerror_status\fR
-argument is used to indicate to the module the sort of action it is to take in cleaning this data item. As an example, Kerberos creates a ticket file during the authentication phase, this file might be associated with a data item. When
+argument is used to indicate to the module the sort of action it is to take in cleaning this data item\. As an example, Kerberos creates a ticket file during the authentication phase, this file might be associated with a data item\. When
 \fBpam_end\fR(3)
 is called by the module, the
 \fIerror_status\fR
@@ -60,31 +60,41 @@ carries the return value of the
 \fBpam_authenticate\fR(3)
 or other
 \fIlibpam\fR
-function as appropriate. Based on this value the Kerberos module may choose to delete the ticket file (\fIauthentication failure\fR) or leave it in place.
+function as appropriate\. Based on this value the Kerberos module may choose to delete the ticket file (\fIauthentication failure\fR) or leave it in place\.
 .PP
 The
 \fIerror_status\fR
-may have been logically OR'd with either of the following two values:
-.TP 3n
+may have been logically OR\'d with either of the following two values:
+.PP
 PAM_DATA_REPLACE
+.RS 4
 When a data item is being replaced (through a second call to
-\fBpam_set_data\fR) this mask is used. Otherwise, the call is assumed to be from
-\fBpam_end\fR(3).
-.TP 3n
+\fBpam_set_data\fR) this mask is used\. Otherwise, the call is assumed to be from
+\fBpam_end\fR(3)\.
+.RE
+.PP
 PAM_DATA_SILENT
+.RS 4
 Which indicates that the process would prefer to perform the
 \fBcleanup()\fR
-quietly. That is, discourages logging/messages to the user.
+quietly\. That is, discourages logging/messages to the user\.
+.RE
 .SH "RETURN VALUES"
-.TP 3n
+.PP
 PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
+.RS 4
+Memory buffer error\.
+.RE
+.PP
 PAM_SUCCESS
-Data was successful stored.
-.TP 3n
+.RS 4
+Data was successful stored\.
+.RE
+.PP
 PAM_SYSTEM_ERR
-A NULL pointer was submitted as PAM handle or the function was called by an application.
+.RS 4
+A NULL pointer was submitted as PAM handle or the function was called by an application\.
+.RE
 .SH "SEE ALSO"
 .PP