OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / LDP_man-pages / draft / man3 / putenv.3
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
6 .\"
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
11 .\"
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein.  The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
18 .\" professionally.
19 .\"
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
22 .\"
23 .\" References consulted:
24 .\"     Linux libc source code
25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26 .\"     386BSD man pages
27 .\"     Single UNIX Specification, Version 2
28 .\" Modified Thu Apr  8 15:00:12 1993, David Metcalfe
29 .\" Modified Sat Jul 24 18:44:45 1993, Rik Faith (faith@cs.unc.edu)
30 .\" Modified Fri Feb 14 21:47:50 1997 by Andries Brouwer (aeb@cwi.nl)
31 .\" Modified Mon Oct 11 11:11:11 1999 by Andries Brouwer (aeb@cwi.nl)
32 .\" Modified Wed Nov 10 00:02:26 1999 by Andries Brouwer (aeb@cwi.nl)
33 .\" Modified Sun May 20 22:17:20 2001 by Andries Brouwer (aeb@cwi.nl)
34 .\"
35 .\" Japanese Version Copyright (c) 1997 HIROFUMI Nishizuka
36 .\"     all rights reserved.
37 .\" Translated 1997-12-19, HIROFUMI Nishizuka <nishi@rpts.cl.nec.co.jp>
38 .\" Updated 2000-06-18, Kentaro Shirakata <argrath@ub32.org>
39 .\" Updated 2005-11-19, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
40 .\"
41 .TH PUTENV 3  2007-07-26 "GNU" "Linux Programmer's Manual"
42 .\"O .SH NAME
43 .SH Ì¾Á°
44 .\"O putenv \- change or add an environment variable
45 putenv \- ´Ä¶­ÊÑ¿ô¤ÎÊѹ¹¤Þ¤¿¤ÏÄɲÃ
46 .\"O .SH SYNOPSIS
47 .SH ½ñ¼°
48 .nf
49 .B #include <stdlib.h>
50 .sp
51 .BI "int putenv(char *" string );
52 .\" Not: const char *
53 .fi
54 .sp
55 .in -4n
56 .\"O Feature Test Macro Requirements for glibc (see
57 .\"O .BR feature_test_macros (7)):
58 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
59 .RB ( feature_test_macros (7)
60 »²¾È):
61 .in
62 .sp
63 .BR putenv ():
64 _SVID_SOURCE || _XOPEN_SOURCE
65 \"O .SH DESCRIPTION
66 .SH ÀâÌÀ
67 .\"O The
68 .\"O .BR putenv ()
69 .\"O function adds or changes the value of environment
70 .\"O variables.
71 .\"O The argument \fIstring\fP is of the form \fIname\fP=\fIvalue\fP.
72 .BR putenv ()
73 ´Ø¿ô¤Ï¡¢´Ä¶­ÊÑ¿ô¤ÎÄɲäޤ¿¤ÏÃͤÎÊѹ¹¤ò¹Ô¤¦¡£
74 °ú¿ô \fIstring\fP ¤Ï \fIname\fP=\fIvalue\fP ¤È¤¤¤¦·Á¼°¤ò¼è¤ë¡£
75 .\"O If \fIname\fP does not already exist in the environment, then
76 .\"O \fIstring\fP is added to the environment.
77 .\"O If \fIname\fP does exist,
78 .\"O then the value of \fIname\fP in the environment is changed to
79 .\"O \fIvalue\fP.
80 \fIname\fP ¤¬´Ä¶­¤Ë¸ºß¤·¤Ê¤¤¾ì¹ç¤Ï \fIstring\fP ¤¬´Ä¶­¤ËÄɲ䵤ì¤ë¡£
81 \fIname\fP ¤¬´Ä¶­¤Ë¸ºß¤¹¤ë¾ì¹ç¤Ï \fIname\fP ¤ÎÃͤϠ\fIvalue\fP ¤ËÊѹ¹¤µ¤ì¤ë¡£
82 .\"O The string pointed to by \fIstring\fP becomes part of the environment,
83 .\"O so altering the string changes the environment.
84 \fIstring\fP ¤¬»Ø¤·¤Æ¤¤¤ëʸ»úÎó¤Ï´Ä¶­¤Î°ìÉô¤È¤Ê¤ë¤Î¤Ç¡¢
85 ʸ»úÎó¤òÊѹ¹¤¹¤ë¤È´Ä¶­¤âÊѹ¹¤µ¤ì¤ë¡£
86 .\"O .SH "RETURN VALUE"
87 .SH ÊÖ¤êÃÍ
88 .\"O The
89 .\"O .BR putenv ()
90 .\"O function returns zero on success,
91 .\"O or nonzero if an error occurs.
92 .BR putenv ()
93 ´Ø¿ô¤Ï¡¢À®¸ù¤·¤¿¾ì¹ç 0 ¤ò¡¢
94 ¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç 0 °Ê³°¤òÊÖ¤¹¡£
95 .\"O .SH ERRORS
96 .SH ¥¨¥é¡¼
97 .TP
98 .B ENOMEM
99 .\"O Insufficient space to allocate new environment.
100 ¿·¤·¤¤´Ä¶­¤ò³ä¤êÅö¤Æ¤ë¤Î¤Ë½½Ê¬¤Ê¶õ¤­¤¬¤Ê¤¤¡£
101 .SH ½àµò
102 SVr4, POSIX.1-2001, 4.3BSD.
103 .\"O .SH NOTES
104 .SH Ãí°Õ
105 .\"O The
106 .\"O .BR putenv ()
107 .\"O function is not required to be reentrant, and the
108 .\"O one in libc4, libc5 and glibc 2.0 is not, but the glibc 2.1 version is.
109 .BR putenv ()
110 ¤Ï¥ê¥¨¥ó¥È¥é¥ó¥È¤Ç¤¢¤ë¤³¤È¤òµá¤á¤é¤ì¤Æ¤¤¤Ê¤¤¡£
111 libc4, libc5, glibc 2.0 ¤Ç¤Ï¥ê¥¨¥ó¥È¥é¥ó¥È¤Ç¤Ï¤Ê¤¤¡£
112 glibc 2.1 ¤Ç¤Ï¥ê¥¨¥ó¥È¥é¥ó¥È¤Ç¤¢¤ë¡£
113 .LP
114 .\"O Description for libc4, libc5, glibc:
115 libc4, libc5, glibc ¤Ë´Ø¤¹¤ëÀâÌÀ:
116 .\"O If the argument \fIstring\fP is of the form \fIname\fP,
117 .\"O and does not contain an \(aq=\(aq character, then the variable \fIname\fP
118 .\"O is removed from the environment.
119 ¤â¤·°ú¿ô  \fIstring\fP ¤¬ \fIname\fP Ã±ÆȤǡ¢
120 \(aq=\(aq Ê¸»ú¤ò´Þ¤ó¤Ç¤¤¤Ê¤¤¾ì¹ç¡¢´Ä¶­ÊÑ¿ô \fIname\fP ¤Ï´Ä¶­¤«¤é½üµî¤µ¤ì¤ë¡£
121 .\"O If
122 .\"O .BR putenv ()
123 .\"O has to allocate a new array \fIenviron\fP,
124 .\"O and the previous array was also allocated by
125 .\"O .BR putenv (),
126 .\"O then it will be freed.
127 .\"O In no case will the old storage associated
128 .\"O to the environment variable itself be freed.
129 ¤â¤·
130 .BR putenv ()
131 ¤¬¿·¤·¤¤ \fIenviron\fP ÇÛÎó¤ò³ÎÊݤ·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤»þ¡¢
132 °ÊÁ°¤Î \fIenviron\fP ÇÛÎó¤â
133 .BR putenv ()
134 ¤Ë¤è¤Ã¤Æ³ÎÊݤµ¤ì¤¿¤â¤Î¤Ê¤é¤Ð¡¢
135 ¤½¤ì¤Ï²òÊü¤µ¤ì¤ë¡£
136 ´Ä¶­ÊÑ¿ô¤½¤Î¤â¤Î¤Ë³ä¤êÅö¤Æ¤é¤ì¤¿¸Å¤¤µ­²±Îΰ褬²òÊü¤µ¤ì¤ë¤³¤È¤Ï¤Ê¤¤¡£
137 .LP
138 .\"O The libc4 and libc5 and glibc 2.1.2 versions conform to SUSv2:
139 .\"O the pointer \fIstring\fP given to
140 .\"O .BR putenv ()
141 .\"O is used.
142 libc4 ¤È libc5 ¤È glibc 2.1.2 ¤Ç¤Ï SUSv2 ¤Ë½àµò¤·¤Æ¤¤¤ë¡£
143 .BR putenv ()
144 ¤ÇÍ¿¤¨¤é¤ì¤¿¥Ý¥¤¥ó¥¿ \fIstring\fP ¤¬»È¤ï¤ì¤ë¡£
145 .\"O In particular, this string becomes part of the environment;
146 .\"O changing it later will change the environment.
147 ¤³¤Îʸ»úÎó¤Ï´Ä¶­¤Î°ìÉô¤È¤Ê¤ê¡¢¸å¤ÇÊѹ¹¤¹¤ë¤È´Ä¶­¤âÊѤï¤ë¡£
148 .\"O (Thus, it is an error is to call
149 .\"O .BR putenv ()
150 .\"O with an automatic variable
151 .\"O as the argument, then return from the calling function while \fIstring\fP
152 .\"O is still part of the environment.)
153 (½¾¤Ã¤Æ¡¢
154 .BR putenv ()
155 ¤ò¼«Æ°ÊÑ¿ô¤ò°ú¿ô¤È¤·¤Æ¸Æ¤Ó½Ð¤·¡¢
156 \fIstring\fP¤¬´Ä¶­¤Î°ìÉô¤Î¤Þ¤Þ¤Ç¸Æ¤Ó½Ð¤·¤¿´Ø¿ô¤«¤é return ¤¹¤ë¤È¥¨¥é¡¼¤Ë¤Ê¤ë)
157 .\"O However, glibc 2.0-2.1.1 differs: a copy of the string is used.
158 .\"O On the one hand this causes a memory leak, and on the other hand
159 .\"O it violates SUSv2.
160 .\"O This has been fixed in glibc2.1.2.
161 ¤·¤«¤·¡¢glibc 2.0-2.1.1 ¤Ç¤Ï°Û¤Ê¤ê¡¢Ê¸»úÎó¤Î¥³¥Ô¡¼¤¬»È¤ï¤ì¤ë¡£
162 ¤³¤ì¤Ï¥á¥â¥ê¥ê¡¼¥¯¤ò°ú¤­µ¯¤³¤¹¤À¤±¤Ç¤Ê¤¯¡¢ SUSv2 ¤Ë°ãÈ¿¤·¤Æ¤¤¤ë¡£
163 ¤³¤ì¤Ï glibc2.1.2 ¤Ç½¤Àµ¤µ¤ì¤¿¡£
164 .LP
165 .\"O The 4.4BSD version, like glibc 2.0, uses a copy.
166 4.4BSD ¥Ð¡¼¥¸¥ç¥ó¤Ç¤Ï¡¢glibc 2.0 ¤ÈƱÍͤ˥³¥Ô¡¼¤ò»È¤¦¡£
167 .LP
168 .\"O SUSv2 removes the \fIconst\fP from the prototype, and so does glibc 2.1.3.
169 SUSv2 ¤Ç¤Ï¥×¥í¥È¥¿¥¤¥×¤«¤é \fIconst\fP ¤¬¼è¤ê½ü¤«¤ì¤Æ¤ª¤ê¡¢
170 glibc 2.1.3 ¤â¤½¤Î¤è¤¦¤Ë¤Ê¤Ã¤Æ¤¤¤ë¡£
171 .SH ´ØÏ¢¹àÌÜ
172 .BR clearenv (3),
173 .BR getenv (3),
174 .BR setenv (3),
175 .BR unsetenv (3),
176 .BR environ (7)