diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/pam_getenv.3 | 60 | ||||
| -rw-r--r-- | doc/man/pam_getenv.3.xml | 67 |
2 files changed, 127 insertions, 0 deletions
diff --git a/doc/man/pam_getenv.3 b/doc/man/pam_getenv.3 new file mode 100644 index 0000000..56f32ba --- /dev/null +++ b/doc/man/pam_getenv.3 @@ -0,0 +1,60 @@ +'\" t +.\" Title: pam_getenv +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> +.\" Date: 09/03/2021 +.\" Manual: Linux-PAM Manual +.\" Source: Linux-PAM Manual +.\" Language: English +.\" +.TH "PAM_GETENV" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +pam_getenv \- get a PAM environment variable +.SH "SYNOPSIS" +.sp +.ft B +.nf +#include <security/pam_appl\&.h> +.fi +.ft +.HP \w'const\ char\ *pam_getenv('u +.BI "const char *pam_getenv(pam_handle_t\ *" "pamh" ", const\ char\ *" "name" ");" +.SH "DESCRIPTION" +.PP +The +\fBpam_getenv\fR +function searches the PAM environment list as associated with the handle +\fIpamh\fR +for an item that matches the string pointed to by +\fIname\fR +and returns a pointer to the value of the environment variable\&. The application is not allowed to free the data\&. +.SH "RETURN VALUES" +.PP +The +\fBpam_getenv\fR +function returns NULL on failure\&. +.SH "SEE ALSO" +.PP +\fBpam_start\fR(3), +\fBpam_getenvlist\fR(3), +\fBpam_putenv\fR(3), +\fBpam\fR(8) diff --git a/doc/man/pam_getenv.3.xml b/doc/man/pam_getenv.3.xml new file mode 100644 index 0000000..7e8db01 --- /dev/null +++ b/doc/man/pam_getenv.3.xml @@ -0,0 +1,67 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<refentry id='pam_getenv'> + <refmeta> + <refentrytitle>pam_getenv</refentrytitle> + <manvolnum>3</manvolnum> + <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo> + </refmeta> + + <refnamediv id="pam_getenv-name"> + <refname>pam_getenv</refname> + <refpurpose>get a PAM environment variable</refpurpose> + </refnamediv> + +<!-- body begins here --> + + <refsynopsisdiv> + <funcsynopsis id='pam_getenv-synopsis'> + <funcsynopsisinfo>#include <security/pam_appl.h></funcsynopsisinfo> + <funcprototype> + <funcdef>const char *<function>pam_getenv</function></funcdef> + <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef> + <paramdef>const char *<parameter>name</parameter></paramdef> + </funcprototype> + </funcsynopsis> + </refsynopsisdiv> + + + <refsect1 id='pam_getenv-description'> + <title>DESCRIPTION</title> + <para> + The <function>pam_getenv</function> function searches the + PAM environment list as associated with the handle + <emphasis>pamh</emphasis> for an item that matches the string + pointed to by <emphasis>name</emphasis> and returns a pointer + to the value of the environment variable. The application is + not allowed to free the data. + </para> + </refsect1> + + <refsect1 id="pam_getenv-return_values"> + <title>RETURN VALUES</title> + <para> + The <function>pam_getenv</function> function returns NULL + on failure. + </para> + </refsect1> + + <refsect1 id='pam_getenv-see_also'> + <title>SEE ALSO</title> + <para> + <citerefentry> + <refentrytitle>pam_start</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_getenvlist</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam_putenv</refentrytitle><manvolnum>3</manvolnum> + </citerefentry>, + <citerefentry> + <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum> + </citerefentry> + </para> + </refsect1> +</refentry> |