freebsd-dev/contrib/openpam/doc/man/openpam_free_envlist.3
2014-09-15 13:40:09 +00:00

39 lines
885 B
Groff

.\" Generated from openpam_free_envlist.c by gendoc.pl
.\" $Id: openpam_free_envlist.c 648 2013-03-05 17:54:27Z des $
.Dd September 12, 2014
.Dt OPENPAM_FREE_ENVLIST 3
.Os
.Sh NAME
.Nm openpam_free_envlist
.Nd free an environment list
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.In security/openpam.h
.Ft "void"
.Fn openpam_free_envlist "char **envlist"
.Sh DESCRIPTION
The
.Fn openpam_free_envlist
function is a convenience function which
frees all the environment variables in an environment list, and the
list itself.
It is suitable for freeing the return value from
.Xr pam_getenvlist 3 .
.Pp
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_getenvlist 3
.Sh STANDARDS
The
.Fn openpam_free_envlist
function is an OpenPAM extension.
.Sh AUTHORS
The
.Fn openpam_free_envlist
function and this manual page were
developed by
.An Dag-Erling Sm\(/orgrav Aq des@des.no .