diff options
author | Mattias Andrée <maandree@kth.se> | 2018-10-20 15:34:27 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-10-20 15:40:29 +0200 |
commit | 8eaa42a7905748955b23aa08b28ce420670847fe (patch) | |
tree | 6152e117389b066e76f9ef4c225e48258c8baee2 /man/libsimple_getenv_e.3 | |
parent | Fix a typo. (diff) | |
download | libsimple-8eaa42a7905748955b23aa08b28ce420670847fe.tar.gz libsimple-8eaa42a7905748955b23aa08b28ce420670847fe.tar.bz2 libsimple-8eaa42a7905748955b23aa08b28ce420670847fe.tar.xz |
Add man pages for putenvf and getenv functions
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r-- | man/libsimple_getenv_e.3 | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/man/libsimple_getenv_e.3 b/man/libsimple_getenv_e.3 new file mode 100644 index 0000000..ba9cd04 --- /dev/null +++ b/man/libsimple_getenv_e.3 @@ -0,0 +1,74 @@ +.\" -*- nroff -*- +.TH LIBSIMPLE_GETENV_E 3 2018-10-20 libsimple +.SH NAME +libsimple_getenv_e \- get value of an environment variable or the empty string +.SH SYNOPSIS +.nf +#include <libsimple.h> + +static inline const char *libsimple_getenv_e(const char *\fIname\fP); + +#ifndef getenv_e +# define getenv_e libsimple_getenv_e +#endif +.fi + +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_getenv_e () +function searches the environment of the calling +process for the environment variable +.IR name . +If it exists, its value is returned. If it does +not exist, the empty string is returned. +.PP +Modifications to the environment variable made from +within the process, its parent, or other ancestor, +that have not be come visible to other process via +replacement of the process image, are visible to the +.BR libsimple_getenv_e () +function. +.SH RETURN VALUE +If the environment variable +.I name +is defined, its value is returned, otherwise the +empty string is returned. +.SH ERRORS +The +.BR libsimple_getenv_e () +function cannot fail. +.SH ATTRIBUTES +For an explanation of the terms used in this section, see +.BR attributes (7). +.TS +allbox; +lb lb lb +l l l. +Interface Attribute Value +T{ +.BR libsimple_getenv_e () +T} Thread safety MT-Safe env +T{ +.BR libsimple_getenv_e () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_getenv_e () +T} Async-cancel safety AC-Safe +.TE +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR libsimple_getenv_ne (3), +.BR getenv (3) |