pam_misc_setenv.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. '\" t
  2. .\" Title: pam_misc_setenv
  3. .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 09/03/2021
  6. .\" Manual: Linux-PAM Manual
  7. .\" Source: Linux-PAM Manual
  8. .\" Language: English
  9. .\"
  10. .TH "PAM_MISC_SETENV" "3" "09/03/2021" "Linux-PAM Manual" "Linux-PAM Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. pam_misc_setenv \- BSD like PAM environment variable setting
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <security/pam_misc\&.h>
  37. .fi
  38. .ft
  39. .HP \w'int\ pam_misc_setenv('u
  40. .BI "int pam_misc_setenv(pam_handle_t\ *" "pamh" ", const\ char\ *" "name" ", const\ char\ *" "value" ", int\ " "readonly" ");"
  41. .SH "DESCRIPTION"
  42. .PP
  43. This function performs a task equivalent to
  44. \fBpam_putenv\fR(3), its syntax is, however, more like the BSD style function;
  45. \fBsetenv()\fR\&. The
  46. \fIname\fR
  47. and
  48. \fIvalue\fR
  49. are concatenated with an \*(Aq=\*(Aq to form a name=value and passed to
  50. \fBpam_putenv()\fR\&. If, however, the PAM variable is already set, the replacement will only be applied if the last argument,
  51. \fIreadonly\fR, is zero\&.
  52. .SH "SEE ALSO"
  53. .PP
  54. \fBpam_putenv\fR(3),
  55. \fBpam\fR(8)
  56. .SH "STANDARDS"
  57. .PP
  58. The
  59. \fBpam_misc_setenv\fR
  60. function is part of the
  61. \fBlibpam_misc\fR
  62. Library and not defined in any standard\&.