8354 sync regcomp(3C) with upstream (fix make catalog)
[unleashed/tickless.git] / usr / src / lib / libast / common / man / setenviron.3
blob818f7fc0d49683944efd24c358e5b9ff2130b3ff
1 .fp 5 CW
2 .de Af
3 .ds ;G \\*(;G\\f\\$1\\$3\\f\\$2
4 .if !\a\\$4\a\a .Af \\$2 \\$1 "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
5 ..
6 .de aF
7 .ie \a\\$3\a\a .ft \\$1
8 .el \{\
9 .ds ;G \&
10 .nr ;G \\n(.f
11 .Af "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
12 \\*(;G
13 .ft \\n(;G \}
15 .de L
16 .aF 5 \\n(.f "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
18 .de LR
19 .aF 5 1 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
21 .de RL
22 .aF 1 5 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
24 .de EX          \" start example
25 .ta 1i 2i 3i 4i 5i 6i
26 .PP
27 .RS 
28 .PD 0
29 .ft 5
30 .nf
32 .de EE          \" end example
33 .fi
34 .ft
35 .PD
36 .RE
37 .PP
39 .TH LIBAST 3
40 .SH NAME
41 setenviron \- set environment value
42 .SH SYNOPSIS
43 .EX
44 #include <ast.h>
46 char*     setenviron(const char* \fIkey\fP);
47 .EE
48 .SH DESCRIPTION
49 .L setenviron
50 controls environment
51 .I name=value
52 pairs.
53 .L setenviron("\fIname=value\fP")
54 adds
55 .I name
56 to the environment and returns a pointer to a
57 .IR strdup (3)
58 copy of
59 .IR name=value .
60 .L setenviron("\fIname\fP")
61 removes
62 .I name
63 from the environment and returns the empty string.
64 .L setenviron(0)
65 reserves a few slots in an internal array and is usually called by
66 a parent process that expects many children.
67 0 is returned on error.
68 .L setenviron
69 preserves the
70 .IR ksh (1)
71 convention of
72 .L _
73 as the first environment variable name.
74 .SH "SEE ALSO"
75 env(1), exec(2)
76 .SH BUGS
77 POSIX will eventually settle on an interface.
78 It has already picked a few of the names we did in .2 drafts.
79 This is about the third name change for ours.