summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man1p/export.1p
blob: d9b609475390fb53110b4f877e18c1e4a9679241 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
'\" et
.TH EXPORT "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.

.SH NAME
export
\(em set the export attribute for variables
.SH SYNOPSIS
.LP
.nf
export name\fB[\fR=\fIword\fB]\fR...
.P
export\fR \(mip
.fi
.SH DESCRIPTION
The shell shall give the
.IR export
attribute to the variables corresponding to the specified
.IR name s,
which shall cause them to be in the environment of subsequently
executed commands. If the name of a variable is followed by =\c
.IR word ,
then the value of that variable shall be set to
.IR word .
.P
The
.IR export
special built-in shall support the Base Definitions volume of POSIX.1\(hy2008,
.IR "Section 12.2" ", " "Utility Syntax Guidelines".
.P
When
.BR \(mip
is specified,
.IR export
shall write to the standard output the names and values of all exported
variables, in the following format:
.sp
.RS 4
.nf
\fB
"export %s=%s\en", <\fIname\fR>, <\fIvalue\fR>
.fi \fR
.P
.RE
.P
if
.IR name
is set, and:
.sp
.RS 4
.nf
\fB
"export %s\en", <\fIname\fR>
.fi \fR
.P
.RE
.P
if
.IR name
is unset.
.P
The shell shall format the output, including the proper use of quoting,
so that it is suitable for reinput to the shell as commands that
achieve the same exporting results, except:
.IP " 1." 4
Read-only variables with values cannot be reset.
.IP " 2." 4
Variables that were unset at the time they were output need not be
reset to the unset state if a value is assigned to the variable between
the time the state was saved and the time at which the saved output is
reinput to the shell.
.P
When no arguments are given, the results are unspecified. If a variable
assignment precedes the command name of
.IR export
but that variable is not also listed as an operand of
.IR export ,
then that variable shall be set in the current shell execution environment
after the completion of the
.IR export
command, but it is unspecified whether that variable is marked for export.
.SH OPTIONS
See the DESCRIPTION.
.SH OPERANDS
See the DESCRIPTION.
.SH STDIN
Not used.
.SH "INPUT FILES"
None.
.SH "ENVIRONMENT VARIABLES"
None.
.SH "ASYNCHRONOUS EVENTS"
Default.
.SH STDOUT
See the DESCRIPTION.
.SH STDERR S
The standard error shall be used only for diagnostic messages.
.SH "OUTPUT FILES"
None.
.SH "EXTENDED DESCRIPTION"
None.
.SH "EXIT STATUS"
Zero.
.SH "CONSEQUENCES OF ERRORS"
Default.
.LP
.IR "The following sections are informative."
.SH "APPLICATION USAGE"
None.
.SH EXAMPLES
Export
.IR PWD
and
.IR HOME
variables:
.sp
.RS 4
.nf
\fB
export PWD HOME
.fi \fR
.P
.RE
.P
Set and export the
.IR PATH
variable:
.sp
.RS 4
.nf
\fB
export PATH=/local/bin:$PATH
.fi \fR
.P
.RE
.P
Save and restore all exported variables:
.sp
.RS 4
.nf
\fB
export \(mip > \fItemp-file\fR
unset \fIa lot of variables\fR
\&... \fIprocessing\fR
\&. \fItemp-file\fR
.fi \fR
.P
.RE
.SH "RATIONALE"
Some historical shells use the no-argument case as the functional
equivalent of what is required here with
.BR \(mip .
This feature was left unspecified because it is not historical practice
in all shells, and some scripts may rely on the now-unspecified results
on their implementations. Attempts to specify the
.BR \(mip
output as the default case were unsuccessful in achieving consensus.
The
.BR \(mip
option was added to allow portable access to the values that can be
saved and then later restored using; for example, a
.IR dot
script.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "Section 2.14" ", " "Special Built-In Utilities"
.P
The Base Definitions volume of POSIX.1\(hy2008,
.IR "Section 12.2" ", " "Utility Syntax Guidelines"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.unix.org/online.html .

Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .