LDP: Update original to LDP v3.79

[linuxjm/LDP_man-pages.git] / original / man3 / setenv.3

diff --git a/original/man3/setenv.3 b/original/man3/setenv.3
index c40705d..fe63a88 100644 (file)
--- a/original/man3/setenv.3
+++ b/original/man3/setenv.3
@@ -1,6 +1,7 @@
 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
 .\" and Copyright (C) 2004, 2007 Michael kerrisk <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -20,6 +21,7 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"     Linux libc source code
@@ -32,7 +34,7 @@
 .\"     Noted nonstandard behavior of setenv() if name contains '='
 .\" 2005-08-12, mtk, glibc 2.3.4 fixed the "name contains '='" bug
 .\"
-.TH SETENV 3  2009-09-20 "GNU" "Linux Programmer's Manual"
+.TH SETENV 3  2013-10-11 "GNU" "Linux Programmer's Manual"
 .SH NAME
 setenv \- change or add an environment variable
 .SH SYNOPSIS
@@ -52,18 +54,37 @@ Feature Test Macro Requirements for glibc (see
 .ad l
 .BR setenv (),
 .BR unsetenv ():
+.RS 4
 _BSD_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600
+.RE
 .ad b
 .SH DESCRIPTION
 The
 .BR setenv ()
-function adds the variable \fIname\fP to the
-environment with the value \fIvalue\fP, if \fIname\fP does not
+function adds the variable
+.I name
+to the
+environment with the value
+.IR value ,
+if
+.I name
+does not
 already exist.
-If \fIname\fP does exist in the environment, then
-its value is changed to \fIvalue\fP if \fIoverwrite\fP is nonzero;
-if \fIoverwrite\fP is zero, then the value of \fIname\fP is not
-changed.
+If
+.I name
+does exist in the environment, then
+its value is changed to
+.IR value
+if
+.I overwrite
+is nonzero;
+if
+.IR overwrite
+is zero, then the value of
+.I name
+is not changed (and
+.BR setenv ()
+returns a success status).
 This function makes copies of the strings pointed to by
 .I name
 and
@@ -73,13 +94,15 @@ and
 .PP
 The
 .BR unsetenv ()
-function deletes the variable \fIname\fP from
+function deletes the variable
+.I name
+from
 the environment.
 If
 .I name
 does not exist in the environment,
 then the function succeeds, and the environment is unchanged.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 The
 .BR setenv ()
 function returns zero on success,
@@ -93,7 +116,7 @@ function returns zero on success,
 or \-1 on error, with
 .I errno
 set to indicate the cause of the error.
-.SH "ERRORS"
+.SH ERRORS
 .TP
 .B EINVAL
 .I name
@@ -102,9 +125,9 @@ or contains an \(aq=\(aq character.
 .TP
 .B ENOMEM
 Insufficient memory to add a new variable to the environment.
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 4.3BSD, POSIX.1-2001.
-.SH "NOTES"
+.SH NOTES
 POSIX.1-2001 does not require
 .BR setenv ()
 or
@@ -114,7 +137,9 @@ to be reentrant.
 Prior to glibc 2.2.2,
 .BR unsetenv ()
 was prototyped
-as returning \fIvoid\fP; more recent glibc versions follow the
+as returning
+.IR void ;
+more recent glibc versions follow the
 POSIX.1-2001-compliant prototype shown in the SYNOPSIS.
 .SH BUGS
 POSIX.1-2001 specifies that if
@@ -125,8 +150,17 @@ should fail with the error
 .BR EINVAL ;
 however, versions of glibc before 2.3.4 allowed an \(aq=\(aq sign in
 .IR name .
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR clearenv (3),
 .BR getenv (3),
 .BR putenv (3),
 .BR environ (7)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.