Merge remote-tracking branch 'origin/vendor/XZ'
[dragonfly.git] / contrib / openpam / doc / man / openpam_free_envlist.3
1 .\" Generated from openpam_free_envlist.c by gendoc.pl
2 .\" $OpenPAM: openpam_free_envlist.c 938 2017-04-30 21:34:42Z des $
3 .Dd April 30, 2017
4 .Dt OPENPAM_FREE_ENVLIST 3
5 .Os
6 .Sh NAME
7 .Nm openpam_free_envlist
8 .Nd free an environment list
9 .Sh SYNOPSIS
10 .In sys/types.h
11 .In security/pam_appl.h
12 .In security/openpam.h
13 .Ft "void"
14 .Fn openpam_free_envlist "char **envlist"
15 .Sh DESCRIPTION
16 The
17 .Fn openpam_free_envlist
18 function is a convenience function which
19 frees all the environment variables in an environment list, and the
20 list itself.
21 It is suitable for freeing the return value from
22 .Xr pam_getenvlist 3 .
23 .Pp
24 .Sh SEE ALSO
25 .Xr pam 3 ,
26 .Xr pam_getenvlist 3
27 .Sh STANDARDS
28 The
29 .Fn openpam_free_envlist
30 function is an OpenPAM extension.
31 .Sh AUTHORS
32 The
33 .Fn openpam_free_envlist
34 function and this manual page were
35 developed by
36 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .