aboutsummaryrefslogtreecommitdiff
path: root/Linux-PAM/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'Linux-PAM/doc/man')
-rw-r--r--Linux-PAM/doc/man/Makefile.in1
-rw-r--r--Linux-PAM/doc/man/pam.32
-rw-r--r--Linux-PAM/doc/man/pam.3.xml2
-rw-r--r--Linux-PAM/doc/man/pam.conf-syntax.xml7
-rw-r--r--Linux-PAM/doc/man/pam.conf.54
-rw-r--r--Linux-PAM/doc/man/pam_end.32
-rw-r--r--Linux-PAM/doc/man/pam_end.3.xml2
-rw-r--r--Linux-PAM/doc/man/pam_putenv.372
-rw-r--r--Linux-PAM/doc/man/pam_putenv.3.xml10
9 files changed, 68 insertions, 34 deletions
diff --git a/Linux-PAM/doc/man/Makefile.in b/Linux-PAM/doc/man/Makefile.in
index ed2f5fdb..a2fb53a6 100644
--- a/Linux-PAM/doc/man/Makefile.in
+++ b/Linux-PAM/doc/man/Makefile.in
@@ -149,6 +149,7 @@ POSUB = @POSUB@
RANLIB = @RANLIB@
SCONFIGDIR = @SCONFIGDIR@
SECUREDIR = @SECUREDIR@
+SED = @SED@
SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
diff --git a/Linux-PAM/doc/man/pam.3 b/Linux-PAM/doc/man/pam.3
index f1cd729c..a3582242 100644
--- a/Linux-PAM/doc/man/pam.3
+++ b/Linux-PAM/doc/man/pam.3
@@ -47,7 +47,7 @@ function creates the PAM context and initiates the PAM transaction. It is the fi
.PP
The
\fBpam_end\fR(3)
-function terminates the PAM transaction and is the last function an application should call in the PAM contenxt. Upon return the handle pamh is no longer valid and all memory associated with it will be invalid. It can be called at any time to terminate a PAM transaction.
+function terminates the PAM transaction and is the last function an application should call in the PAM context. Upon return the handle pamh is no longer valid and all memory associated with it will be invalid. It can be called at any time to terminate a PAM transaction.
.SS "Authentication"
.PP
The
diff --git a/Linux-PAM/doc/man/pam.3.xml b/Linux-PAM/doc/man/pam.3.xml
index 3ae2d343..3cf71b2d 100644
--- a/Linux-PAM/doc/man/pam.3.xml
+++ b/Linux-PAM/doc/man/pam.3.xml
@@ -57,7 +57,7 @@
<citerefentry>
<refentrytitle>pam_end</refentrytitle><manvolnum>3</manvolnum>
</citerefentry> function terminates the PAM transaction and is the last
- function an application should call in the PAM contenxt. Upon return
+ function an application should call in the PAM context. Upon return
the handle pamh is no longer valid and all memory associated with it
will be invalid. It can be called at any time to terminate a PAM
transaction.
diff --git a/Linux-PAM/doc/man/pam.conf-syntax.xml b/Linux-PAM/doc/man/pam.conf-syntax.xml
index 60c64b75..f098a26a 100644
--- a/Linux-PAM/doc/man/pam.conf-syntax.xml
+++ b/Linux-PAM/doc/man/pam.conf-syntax.xml
@@ -211,7 +211,8 @@
<emphasis>authtok_disable_aging</emphasis>,
<emphasis>try_again</emphasis>, <emphasis>ignore</emphasis>,
<emphasis>abort</emphasis>, <emphasis>authtok_expired</emphasis>,
- <emphasis>module_unknown</emphasis>, <emphasis>bad_item</emphasis>
+ <emphasis>module_unknown</emphasis>, <emphasis>bad_item</emphasis>,
+ <emphasis>conv_again</emphasis>, <emphasis>incomplete</emphasis>,
and <emphasis>default</emphasis>.
</para>
<para>
@@ -221,7 +222,7 @@
<filename>/usr/include/security/_pam_types.h</filename>. The
<emphasis>actionN</emphasis> can be: an unsigned integer,
<emphasis>n</emphasis>, signifying an action of 'jump over the
- next <emphasis>n</emphasis> modules in the stack', or take one
+ next <emphasis>n</emphasis> modules in the stack'; or take one
of the following forms:
</para>
<variablelist>
@@ -355,7 +356,7 @@
When using this convention, you can include `[' characters
inside the string, and if you wish to include a `]' character
inside the string that will survive the argument parsing, you
- should use `\['. In other words:
+ should use `\]'. In other words:
</para>
<programlisting>
[..[..\]..] --> ..[..]..
diff --git a/Linux-PAM/doc/man/pam.conf.5 b/Linux-PAM/doc/man/pam.conf.5
index 3a76ba45..850a8fa1 100644
--- a/Linux-PAM/doc/man/pam.conf.5
+++ b/Linux-PAM/doc/man/pam.conf.5
@@ -175,7 +175,9 @@ corresponds to the return code from the function invoked in the module for which
\fIabort\fR,
\fIauthtok_expired\fR,
\fImodule_unknown\fR,
-\fIbad_item\fR
+\fIbad_item\fR,
+\fIconv_again\fR,
+\fIincomplete\fR,
and
\fIdefault\fR.
.PP
diff --git a/Linux-PAM/doc/man/pam_end.3 b/Linux-PAM/doc/man/pam_end.3
index 27cf95d2..3b28a265 100644
--- a/Linux-PAM/doc/man/pam_end.3
+++ b/Linux-PAM/doc/man/pam_end.3
@@ -25,7 +25,7 @@ pam_end \- termination of PAM transaction
.PP
The
\fBpam_end\fR
-function terminates the PAM transaction and is the last function an application should call in the PAM contenxt. Upon return the handle
+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
diff --git a/Linux-PAM/doc/man/pam_end.3.xml b/Linux-PAM/doc/man/pam_end.3.xml
index fd4a4250..039bb3cd 100644
--- a/Linux-PAM/doc/man/pam_end.3.xml
+++ b/Linux-PAM/doc/man/pam_end.3.xml
@@ -34,7 +34,7 @@
<para>
The <function>pam_end</function> function terminates the PAM
transaction and is the last function an application should call
- in the PAM contenxt. Upon return the handle <emphasis>pamh</emphasis>
+ in the PAM context. Upon return the handle <emphasis>pamh</emphasis>
is no longer valid and all memory associated with it will be
invalid.
</para>
diff --git a/Linux-PAM/doc/man/pam_putenv.3 b/Linux-PAM/doc/man/pam_putenv.3
index 60b49651..b0edc103 100644
--- a/Linux-PAM/doc/man/pam_putenv.3
+++ b/Linux-PAM/doc/man/pam_putenv.3
@@ -1,22 +1,22 @@
.\" Title: pam_putenv
.\" 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.1 <http://docbook.sf.net/>
+.\" Date: 09/28/2007
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
.\"
-.TH "PAM_PUTENV" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_PUTENV" "3" "09/28/2007" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pam_putenv \- set or change PAM environment variable
+pam_putenv - set or change PAM environment variable
.SH "SYNOPSIS"
.sp
.ft B
.nf
-#include <security/pam_appl.h>
+#include <security/pam_appl\.h>
.fi
.ft
.HP 15
@@ -27,43 +27,65 @@ The
\fBpam_putenv\fR
function is used to add or change the value of PAM environment variables as associated with the
\fIpamh\fR
-handle.
+handle\.
.PP
The
\fIpamh\fR
-argument is an authentication handle obtained by a prior call to pam_start(). The
+argument is an authentication handle obtained by a prior call to pam_start()\. The
\fIname_value\fR
argument is a single NUL terminated string of one of the following forms:
-.TP 3n
+.PP
NAME=value of variable
+.RS 4
In this case the environment variable of the given NAME is set to the indicated value:
-\fIvalue of variable\fR. If this variable is already known, it is overwritten. Otherwise it is added to the PAM environment.
-.TP 3n
+\fIvalue of variable\fR\. If this variable is already known, it is overwritten\. Otherwise it is added to the PAM environment\.
+.RE
+.PP
NAME=
-This function sets the variable to an empty value. It is listed separately to indicate that this is the correct way to achieve such a setting.
-.TP 3n
+.RS 4
+This function sets the variable to an empty value\. It is listed separately to indicate that this is the correct way to achieve such a setting\.
+.RE
+.PP
NAME
-Without an '=' the pam_putenv() function will delete the corresponding variable from the PAM environment.
+.RS 4
+Without an \'=\' the
+\fBpam_putenv\fR() function will delete the corresponding variable from the PAM environment\.
+.RE
+.PP
+
+\fBpam_putenv\fR() operates on a copy of
+\fIname_value\fR, which means in contrast to
+\fBputenv\fR(3), the application is responsible to free the data\.
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_PERM_DENIED
+.RS 4
Argument
\fIname_value\fR
-given is a NULL pointer.
-.TP 3n
+given is a NULL pointer\.
+.RE
+.PP
PAM_BAD_ITEM
-Variable requested (for deletion) is not currently set.
-.TP 3n
+.RS 4
+Variable requested (for deletion) is not currently set\.
+.RE
+.PP
PAM_ABORT
+.RS 4
The
\fIpamh\fR
-handle is corrupt.
-.TP 3n
+handle is corrupt\.
+.RE
+.PP
PAM_BUF_ERR
-Memory buffer error.
-.TP 3n
+.RS 4
+Memory buffer error\.
+.RE
+.PP
PAM_SUCCESS
-The environment variable was successfully updated.
+.RS 4
+The environment variable was successfully updated\.
+.RE
.SH "SEE ALSO"
.PP
diff --git a/Linux-PAM/doc/man/pam_putenv.3.xml b/Linux-PAM/doc/man/pam_putenv.3.xml
index 5efef381..619b218a 100644
--- a/Linux-PAM/doc/man/pam_putenv.3.xml
+++ b/Linux-PAM/doc/man/pam_putenv.3.xml
@@ -67,12 +67,20 @@
<term>NAME</term>
<listitem>
<para>
- Without an '=' the pam_putenv() function will delete the
+ Without an '=' the <function>pam_putenv</function>() function
+ will delete the
corresponding variable from the PAM environment.
</para>
</listitem>
</varlistentry>
</variablelist>
+ <para>
+ <function>pam_putenv</function>() operates on a copy of
+ <emphasis>name_value</emphasis>, which means in contrast to
+ <citerefentry>
+ <refentrytitle>putenv</refentrytitle><manvolnum>3</manvolnum>
+ </citerefentry>, the application is responsible to free the data.
+ </para>
</refsect1>
<refsect1 id="pam_putenv-return_values">