| blob | a299fb438447184476c3bd53f780b7a52c4c4931 |
1 '\" te
2 .\" Copyright (c) 2007 Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright 1989 AT&T
4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
8 .TH SET 1 "Nov 20, 2007"
9 .SH NAME
10 set, unset, setenv, unsetenv, export \- shell built-in functions to determine
11 the characteristics for environmental variables of the current shell and its
12 descendents
13 .SH SYNOPSIS
14 .SS "sh"
15 .LP
16 .nf
17 \fBset\fR [\fB--aefhkntuvx\fR [\fIargument\fR]]...
18 .fi
20 .LP
21 .nf
22 \fBunset\fR [\fIname\fR]...
23 .fi
25 .LP
26 .nf
27 \fBexport\fR [\fIname\fR]...
28 .fi
30 .SS "csh"
31 .LP
32 .nf
33 \fBset\fR [\fIvar\fR [= \fIvalue\fR]]
34 .fi
36 .LP
37 .nf
38 \fBset\fR \fIvar\fR [\fIn\fR] = \fIword\fR
39 .fi
41 .LP
42 .nf
43 \fBunset\fR \fIpattern\fR
44 .fi
46 .LP
47 .nf
48 \fBsetenv\fR [\fIVAR\fR [\fIword\fR]]
49 .fi
51 .LP
52 .nf
53 \fBunsetenv\fR \fIvariable\fR
54 .fi
56 .SS "ksh"
57 .LP
58 .nf
59 \fBset\fR [\(+-abCefhkmnopstuvx] [\(+-o \fIoption\fR]... [\(+-A \fIname\fR]
60 [\fIarg\fR]...
61 .fi
63 .LP
64 .nf
65 \fBunset\fR [\fB-f\fR] \fIname\fR...
66 .fi
68 .LP
69 .nf
70 \fB**export\fR [\fIname\fR [=\fIvalue\fR]]...
71 .fi
73 .LP
74 .nf
75 \fB**export\fR [\fB-p\fR]
76 .fi
78 .SS "ksh93"
79 .LP
80 .nf
81 \fB+set\fR [\(+-abCefGhkmnoprstuvx] [\(+-o \fIoption\fR]... [\(+-A \fIvname\fR]
82 [\fIarg\fR]...
83 .fi
85 .LP
86 .nf
87 \fB+unset\fR [\fB-fnv\fR] \fIvname\fR...
88 .fi
90 .LP
91 .nf
92 \fB++export\fR [\fB-p\fR] [\fIname\fR[=\fIvalue\fR]]...
93 .fi
95 .SH DESCRIPTION
96 .SS "sh"
97 .LP
98 The \fBset\fR built-in command has the following options:
99 .sp
100 .ne 2
101 .na
102 \fB\fB--\fR\fR
103 .ad
104 .RS 6n
105 Does not change any of the flags. This option is useful in setting \fB$1\fR to
106 \fB\(mi\fR\&.
107 .RE
109 .sp
110 .ne 2
111 .na
112 \fB\fB-a\fR\fR
113 .ad
114 .RS 6n
115 Marks variables which are modified or created for export.
116 .RE
118 .sp
119 .ne 2
120 .na
121 \fB\fB-e\fR\fR
122 .ad
123 .RS 6n
124 Exits immediately if a command exits with a non-zero exit status.
125 .RE
127 .sp
128 .ne 2
129 .na
130 \fB\fB-f\fR\fR
131 .ad
132 .RS 6n
133 Disables file name generation.
134 .RE
136 .sp
137 .ne 2
138 .na
139 \fB\fB-h\fR\fR
140 .ad
141 .RS 6n
142 Locates and remembers function commands as functions are defined. Function
143 commands are normally located when the function is executed.
144 .RE
146 .sp
147 .ne 2
148 .na
149 \fB\fB-k\fR\fR
150 .ad
151 .RS 6n
152 All keyword arguments are placed in the environment for a command, not just
153 those that precede the command name.
154 .RE
156 .sp
157 .ne 2
158 .na
159 \fB\fB-n\fR\fR
160 .ad
161 .RS 6n
162 Reads commands but does not execute them.
163 .RE
165 .sp
166 .ne 2
167 .na
168 \fB\fB-t\fR\fR
169 .ad
170 .RS 6n
171 Exits after reading and executing one command.
172 .RE
174 .sp
175 .ne 2
176 .na
177 \fB\fB-u\fR\fR
178 .ad
179 .RS 6n
180 Treats unset variables as an error when substituting.
181 .RE
183 .sp
184 .ne 2
185 .na
186 \fB\fB-v\fR\fR
187 .ad
188 .RS 6n
189 Prints shell input lines as they are read.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB-x\fR\fR
196 .ad
197 .RS 6n
198 Prints commands and their arguments as they are executed.
199 .RE
201 .sp
202 .LP
203 Using \fB+\fR rather than \fB\(mi\fR causes these flags to be turned off. These
204 flags can also be used upon invocation of the shell. The current set of flags
205 can be found in \fB$\(mi\fR. The remaining \fIargument\fRs are positional
206 parameters and are assigned, in order, to \fB$1\fR, \fB$2\fR,
207 \fB\&.\|.\|.\|.\fR If no \fIargument\fRs are specified the values of all names
208 are printed.
209 .sp
210 .LP
211 For each \fIname\fR, \fBunset\fR removes the corresponding variable or function
212 value. The variables \fBPATH\fR, \fBPS1\fR, \fBPS2\fR, \fBMAILCHECK\fR, and
213 \fBIF\fR cannot be unset.
214 .sp
215 .LP
216 With the \fBexport\fR built-in, the specified \fIname\fRs are marked for
217 automatic export to the \fIenvironment\fR of subsequently executed commands. If
218 no arguments are specified, variable names that have been marked for export
219 during the current shell's execution are listed. Function names are \fBnot\fR
220 exported.
221 .SS "csh"
222 .LP
223 With no arguments, \fBset\fR displays the values of all shell variables.
224 Multiword values are displayed as a parenthesized list. With the \fIvar\fR
225 argument alone, \fBset\fR assigns an empty (null) value to the variable
226 \fIvar\fR. With arguments of the form \fIvar\fR \fB=\fR \fIvalue\fR \fBset\fR
227 assigns \fIvalue\fR to \fIvar\fR, where \fIvalue\fR is one of:
228 .sp
229 .ne 2
230 .na
231 \fB\fIword\fR\fR
232 .ad
233 .RS 14n
234 A single word (or quoted string).
235 .RE
237 .sp
238 .ne 2
239 .na
240 \fB\fB(\fR\fIwordlist\fR\fB)\fR\fR
241 .ad
242 .RS 14n
243 A space-separated list of words enclosed in parentheses.
244 .RE
246 .sp
247 .LP
248 Values are command and filename expanded before being assigned. The form
249 \fBset\fR \fIvar\fR\fB[\fR\fIn\fR\fB]=\fR\fIword\fR replaces the \fIn\fR'th
250 word in a multiword value with \fIword\fR.
251 .sp
252 .LP
253 \fBunset\fR removes variables whose names match (filename substitution)
254 \fIpattern\fR. All variables are removed by `\fBunset *\fR'.
255 .sp
256 .LP
257 With no arguments, \fBsetenv\fR displays all environment variables. With the
258 \fIVAR\fR argument, \fBsetenv\fR sets the environment variable
259 \fB\fR\fIVAR\fR\fB \fR to an empty (null) value. (By convention, environment
260 variables are normally specified upper-case names.) With both \fIVAR\fR and
261 \fIword\fR arguments specified, \fBsetenv\fR sets \fIVAR\fR to \fIword\fR,
262 which must be either a single word or a quoted string. The \fBPATH\fR variable
263 can take multiple \fIword\fR arguments, separated by colons (see EXAMPLES). The
264 most commonly used environment variables, \fBUSER\fR, \fBTERM\fR, and
265 \fBPATH\fR, are automatically imported to and exported from the \fBcsh\fR
266 variables \fBuser\fR, \fBterm\fR, and \fBpath\fR. Use \fBsetenv\fR if you need
267 to change these variables. In addition, the shell sets the \fBPWD\fR
268 environment variable from the \fBcsh\fR variable \fBcwd\fR whenever the latter
269 changes.
270 .sp
271 .LP
272 The environment variables \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR,
273 \fBLC_COLLATE\fR, \fBLC_NUMERIC\fR, and \fBLC_MONETARY\fR take immediate effect
274 when changed within the C shell. See \fBenviron\fR(5) for descriptions of these
275 environment variables.
276 .sp
277 .LP
278 \fBunsetenv\fR removes \fIvariable\fR from the environment. As with
279 \fBunset\fR, pattern matching is not performed.
280 .SS "ksh"
281 .LP
282 The flags for the \fBset\fR built-in have meaning as follows:
283 .sp
284 .ne 2
285 .na
286 \fB\fB-A\fR\fR
287 .ad
288 .RS 13n
289 Array assignment. Unsets the variable \fIname\fR and assigns values
290 sequentially from the list \fIarg\fR. If \fB+A\fR is used, the variable
291 \fIname\fR is not unset first.
292 .RE
294 .sp
295 .ne 2
296 .na
297 \fB\fB-a\fR\fR
298 .ad
299 .RS 13n
300 All subsequent variables that are defined are automatically exported.
301 .RE
303 .sp
304 .ne 2
305 .na
306 \fB\fB-b\fR\fR
307 .ad
308 .RS 13n
309 Causes the shell to notify the user asynchronously of background job
310 completions.
311 .RE
313 .sp
314 .ne 2
315 .na
316 \fB\fB-C\fR\fR
317 .ad
318 .RS 13n
319 Prevents existing files from being overwritten by the shell's \fB>\fR
320 redirection operator. The \fB>|\fR redirection operator overrides this
321 noclobber option for an individual file.
322 .RE
324 .sp
325 .ne 2
326 .na
327 \fB\fB-e\fR\fR
328 .ad
329 .RS 13n
330 If a command has a non-zero exit status, executes the \fBERR\fR trap, if set,
331 and exits. This mode is disabled while reading profiles.
332 .RE
334 .sp
335 .ne 2
336 .na
337 \fB\fB-f\fR\fR
338 .ad
339 .RS 13n
340 Disables file name generation.
341 .RE
343 .sp
344 .ne 2
345 .na
346 \fB\fB-h\fR\fR
347 .ad
348 .RS 13n
349 Each command becomes a tracked alias when first encountered.
350 .RE
352 .sp
353 .ne 2
354 .na
355 \fB\fB-k\fR\fR
356 .ad
357 .RS 13n
358 All variable assignment arguments are placed in the environment for a command,
359 not just those that precede the command name.
360 .RE
362 .sp
363 .ne 2
364 .na
365 \fB\fB-m\fR\fR
366 .ad
367 .RS 13n
368 Background jobs run in a separate process group and a line prints upon
369 completion. The exit status of background jobs is reported in a completion
370 message. On systems with job control, this flag is turned on automatically for
371 interactive shells.
372 .RE
374 .sp
375 .ne 2
376 .na
377 \fB\fB-n\fR\fR
378 .ad
379 .RS 13n
380 Reads commands and checks them for syntax errors, but does not execute them.
381 Ignored for interactive shells.
382 .RE
384 .sp
385 .ne 2
386 .na
387 \fB\fB+o\fR\fR
388 .ad
389 .RS 13n
390 Writes the current option settings to standard output in a format that is
391 suitable for reinput to the shell as commands that achieve the same option
392 settings.
393 .RE
395 .sp
396 .ne 2
397 .na
398 \fB\fB-o\fR \fIoption\fR\fR
399 .ad
400 .RS 13n
401 The \fIoption\fR argument can be one of the following option names:
402 .sp
403 .ne 2
404 .na
405 \fB\fBallexport\fR\fR
406 .ad
407 .RS 14n
408 Same as \fB-a\fR.
409 .RE
411 .sp
412 .ne 2
413 .na
414 \fB\fBerrexit\fR\fR
415 .ad
416 .RS 14n
417 Same as \fB-e\fR.
418 .RE
420 .sp
421 .ne 2
422 .na
423 \fB\fBbgnice\fR\fR
424 .ad
425 .RS 14n
426 All background jobs are run at a lower priority. This is the default mode.
427 \fBemacs\fR Puts you in an \fBemacs\fR style in-line editor for command entry.
428 .RE
430 .sp
431 .ne 2
432 .na
433 \fB\fBgmacs\fR\fR
434 .ad
435 .RS 14n
436 Puts you in a \fBgmacs\fR style in-line editor for command entry.
437 .RE
439 .sp
440 .ne 2
441 .na
442 \fB\fBignoreeof\fR\fR
443 .ad
444 .RS 14n
445 The shell does not exit on end-of-file. The command \fBexit\fR must be used.
446 .RE
448 .sp
449 .ne 2
450 .na
451 \fB\fBkeyword\fR\fR
452 .ad
453 .RS 14n
454 Same as \fB-k\fR.
455 .RE
457 .sp
458 .ne 2
459 .na
460 \fB\fBmarkdirs\fR\fR
461 .ad
462 .RS 14n
463 All directory names resulting from file name generation have a trailing \fB/\fR
464 appended.
465 .RE
467 .sp
468 .ne 2
469 .na
470 \fB\fBmonitor\fR\fR
471 .ad
472 .RS 14n
473 Same as \fB-m\fR.
474 .RE
476 .sp
477 .ne 2
478 .na
479 \fB\fBnoclobber\fR\fR
480 .ad
481 .RS 14n
482 Prevents redirection operator \fB>\fR from truncating existing files. Requires
483 the \fB>|\fR operator to truncate a file when turned on. Same as \fB-C\fR.
484 .RE
486 .sp
487 .ne 2
488 .na
489 \fB\fBnoexec\fR\fR
490 .ad
491 .RS 14n
492 Same as \fB-n\fR.
493 .RE
495 .sp
496 .ne 2
497 .na
498 \fB\fBnoglob\fR\fR
499 .ad
500 .RS 14n
501 Same as \fB-f\fR.
502 .RE
504 .sp
505 .ne 2
506 .na
507 \fB\fBnolog\fR\fR
508 .ad
509 .RS 14n
510 Does not save function definitions in history file.
511 .RE
513 .sp
514 .ne 2
515 .na
516 \fB\fBnotify\fR\fR
517 .ad
518 .RS 14n
519 Same as \fB-b\fR.
520 .RE
522 .sp
523 .ne 2
524 .na
525 \fB\fBnounset\fR\fR
526 .ad
527 .RS 14n
528 Same as \fB-u\fR.
529 .RE
531 .sp
532 .ne 2
533 .na
534 \fB\fBprivileged\fR\fR
535 .ad
536 .RS 14n
537 Same as \fB-p\fR.
538 .RE
540 .sp
541 .ne 2
542 .na
543 \fB\fBverbose\fR\fR
544 .ad
545 .RS 14n
546 Same as \fB-v\fR.
547 .RE
549 .sp
550 .ne 2
551 .na
552 \fB\fBtrackall\fR\fR
553 .ad
554 .RS 14n
555 Same as \fB-h\fR.
556 .RE
558 .sp
559 .ne 2
560 .na
561 \fB\fBvi\fR\fR
562 .ad
563 .RS 14n
564 Puts you in insert mode of a \fBvi\fR style in-line editor until you hit escape
565 character \fB033\fR. This puts you in control mode. A return sends the line.
566 .RE
568 .sp
569 .ne 2
570 .na
571 \fB\fBviraw\fR\fR
572 .ad
573 .RS 14n
574 Each character is processed as it is typed in \fBvi\fR mode.
575 .RE
577 .sp
578 .ne 2
579 .na
580 \fB\fBxtrace\fR\fR
581 .ad
582 .RS 14n
583 Same as \fB-x\fR.
584 .RE
586 .RE
588 .sp
589 .LP
590 If no option name is supplied then the current option settings are printed.
591 .sp
592 .ne 2
593 .na
594 \fB\fB-p\fR\fR
595 .ad
596 .RS 8n
597 Disables processing of the \fB$HOME/.profile\fR file and uses the file
598 \fB/etc/suid_profile\fR instead of the \fBENV\fR file. This mode is on whenever
599 the effective uid is not equal to the real uid, or when the effective gid is
600 not equal to the real gid. Turning this off causes the effective uid and gid to
601 be set to the real uid and gid.
602 .RE
604 .sp
605 .ne 2
606 .na
607 \fB\fB-s\fR\fR
608 .ad
609 .RS 8n
610 Sorts the positional parameters lexicographically.
611 .RE
613 .sp
614 .ne 2
615 .na
616 \fB\fB-t\fR\fR
617 .ad
618 .RS 8n
619 Exits after reading and executing one command.
620 .RE
622 .sp
623 .ne 2
624 .na
625 \fB\fB-u\fR\fR
626 .ad
627 .RS 8n
628 Treats unset parameters as an error when substituting.
629 .RE
631 .sp
632 .ne 2
633 .na
634 \fB\fB-v\fR\fR
635 .ad
636 .RS 8n
637 Prints shell input lines as they are read.
638 .RE
640 .sp
641 .ne 2
642 .na
643 \fB\fB-x\fR\fR
644 .ad
645 .RS 8n
646 Prints commands and their arguments as they are executed.
647 .RE
649 .sp
650 .ne 2
651 .na
652 \fB\fB\(mi\fR\fR
653 .ad
654 .RS 8n
655 Turns off \fB-x\fR and \fB-v\fR flags and stops examining arguments for flags.
656 .RE
658 .sp
659 .ne 2
660 .na
661 \fB\fB-\fR\fR
662 .ad
663 .RS 8n
664 Does not change any of the flags. This option is useful in setting \fB$1\fR to
665 a value beginning with \fB\(mi\fR\&. If no arguments follow this flag then the
666 positional parameters are unset.
667 .RE
669 .sp
670 .LP
671 Using \fB+\fR rather than \fB\(mi\fR causes these flags to be turned off. These
672 flags can also be used upon invocation of the shell. The current set of flags
673 can be found in \fB$\(mi\fR. Unless \fB-A\fR is specified, the remaining
674 arguments are positional parameters and are assigned, in order, to \fB$1\fR
675 \fB$2\fR .\|.\|.. If no arguments are specified then the names and values of
676 all variables are printed on the standard output.
677 .sp
678 .LP
679 The variables specified by the list of \fIname\fRs are unassigned, that is,
680 their values and attributes are erased. \fBreadonly\fR variables cannot be
681 unset. If the \fB-f\fR flag is set, then the names refer to \fBfunction\fR
682 names. Unsetting \fBERRNO\fR, \fBLINENO\fR, \fBMAILCHECK\fR, \fBOPTARG\fR,
683 \fBOPTIND\fR, \fBRANDOM\fR, \fBSECONDS\fR, \fBTMOUT\fR, and \fB_\fR removes
684 their special meaning even if they are subsequently assigned.
685 .sp
686 .LP
687 When using \fBunset\fR, the variables specified by the list of \fIname\fRs are
688 unassigned, i.e., their values and attributes are erased. \fBreadonly\fR
689 variables cannot be unset. If the \fB-f\fR, flag is set, then the names refer
690 to \fBfunction\fR names. Unsetting \fBERRNO\fR, \fBLINENO\fR, \fBMAILCHECK\fR,
691 \fBOPTARG\fR, \fBOPTIND\fR, \fBRANDOM\fR, \fBSECONDS\fR, \fBTMOUT\fR, and
692 \fB_\fR removes their special meaning even if they are subsequently assigned.
693 .sp
694 .LP
695 With the \fBexport\fR built-in, the specified \fIname\fRs are marked for
696 automatic export to the \fBenvironment\fR of subsequently-executed commands.
697 .sp
698 .LP
699 When \fB-p\fR is specified, \fBexport\fR writes to the standard output the
700 names and values of all exported variables in the following format:
701 .sp
702 .in +2
703 .nf
704 "export %s=%s\en", \fIname\fR, \fIvalue\fR
705 .fi
706 .in -2
707 .sp
709 .sp
710 .LP
711 if \fIname\fR is set, and:
712 .sp
713 .in +2
714 .nf
715 "export %s\en", \fIname\fR
716 .fi
717 .in -2
718 .sp
720 .sp
721 .LP
722 if \fIname\fR is unset.
723 .sp
724 .LP
725 The shell formats the output, including the proper use of quoting, so that it
726 is suitable for reinput to the shell as commands that achieve the same
727 exporting results, except for the following:
728 .RS +4
729 .TP
730 1.
731 Read-only variables with values cannot be reset.
732 .RE
733 .RS +4
734 .TP
735 2.
736 Variables that were unset at the time they were output are not reset to the
737 unset state if a value is assigned to the variable between the time the state
738 was saved and the time at which the saved output is reinput to the shell.
739 .RE
740 .sp
741 .LP
742 On this manual page, \fBksh\fR(1) commands that are preceded by one or two
743 \fB*\fR (asterisks) are treated specially in the following ways:
744 .RS +4
745 .TP
746 1.
747 Variable assignment lists preceding the command remain in effect when the
748 command completes.
749 .RE
750 .RS +4
751 .TP
752 2.
753 I/O redirections are processed after variable assignments.
754 .RE
755 .RS +4
756 .TP
757 3.
758 Errors cause a script that contains them to abort.
759 .RE
760 .RS +4
761 .TP
762 4.
763 Words, following a command preceded by \fB**\fR that are in the format of a
764 variable assignment, are expanded with the same rules as a variable assignment.
765 This means that tilde substitution is performed after the \fB=\fR sign and word
766 splitting and file name generation are not performed.
767 .RE
768 .SS "ksh93"
769 .LP
770 \fBset\fR sets or unsets options and positional parameters. Options that are
771 specified with a \fB-\fR cause the options to be set. Options that are
772 specified with a \fB+\fR cause the option to be unset.
773 .sp
774 .LP
775 \fBset\fR without any options or arguments displays the names and values of all
776 shell variables in the order of the collation sequence in the current locale.
777 The values are quoted so that they are suitable for input again to the shell.
778 .sp
779 .LP
780 If no arguments are specified, not even the end of options argument \fB--\fR,
781 the positional parameters are unchanged. Otherwise, unless the \fB-A\fR option
782 has been specified, the positional parameters are replaced by the list of
783 arguments. A first argument of \fB--\fR is ignored when setting positional
784 parameters.
785 .sp
786 .LP
787 For backwards compatibility, a \fBset\fR command without any options specified,
788 whose first argument is \fB-\fR turns off the \fB-v\fR and \fB-x\fR options. If
789 any additional arguments are specified, they replace the positional parameters.
790 .sp
791 .LP
792 The options for set in \fBksh93\fR are:
793 .sp
794 .ne 2
795 .na
796 \fB\fB-a\fR\fR
797 .ad
798 .RS 15n
799 Set the export attribute for each variable whose name does not contain a . that
800 you assign a value in the current shell environment.
801 .RE
803 .sp
804 .ne 2
805 .na
806 \fB\fB-A\fR \fIname\fR\fR
807 .ad
808 .RS 15n
809 Assign the arguments sequentially to the array named by \fIname\fR starting at
810 subscript \fB0\fR rather than to the positional parameters.
811 .RE
813 .sp
814 .ne 2
815 .na
816 \fB\fB-b\fR\fR
817 .ad
818 .RS 15n
819 The shell writes a message to standard error as soon it detects that a
820 background job completes rather than waiting until the next prompt.
821 .RE
823 .sp
824 .ne 2
825 .na
826 \fB\fB-B\fR\fR
827 .ad
828 .RS 15n
829 Enable \fB{...}\fR group expansion. On by default.
830 .RE
832 .sp
833 .ne 2
834 .na
835 \fB\fB-C\fR\fR
836 .ad
837 .RS 15n
838 Prevents existing regular files from being overwritten using the > redirection
839 operator. The \fB>|\fR redirection overrides this \fBnoclobber\fR option.
840 .RE
842 .sp
843 .ne 2
844 .na
845 \fB\fB-e\fR\fR
846 .ad
847 .RS 15n
848 A simple command that has a \fBnon-zero\fR exit status causes the shell to exit
849 unless the simple command is:
850 .RS +4
851 .TP
852 .ie t \(bu
853 .el o
854 contained in an \fB&&\fR or \fB||\fR list
855 .RE
856 .RS +4
857 .TP
858 .ie t \(bu
859 .el o
860 the command immediately following \fBif\fR, \fBwhile\fR, or \fBuntil\fR
861 .RE
862 .RS +4
863 .TP
864 .ie t \(bu
865 .el o
866 contained in the pipeline following \fB!\fR
867 .RE
868 .RE
870 .sp
871 .ne 2
872 .na
873 \fB\fB-f\fR\fR
874 .ad
875 .RS 15n
876 Pathname expansion is disabled.
877 .RE
879 .sp
880 .ne 2
881 .na
882 \fB\fB-G\fR\fR
883 .ad
884 .RS 15n
885 Causes \fB**\fR by itself to also match all sub-directories during pathname
886 expansion.
887 .RE
889 .sp
890 .ne 2
891 .na
892 \fB\fB-h\fR\fR
893 .ad
894 .RS 15n
895 Obsolete. Causes each command whose name has the syntax of an alias to become a
896 tracked alias when it is first encountered.
897 .RE
899 .sp
900 .ne 2
901 .na
902 \fB\fB-H\fR\fR
903 .ad
904 .RS 15n
905 Enable \fB!\fR-style history expansion similar to csh.
906 .RE
908 .sp
909 .ne 2
910 .na
911 \fB\fB-k\fR\fR
912 .ad
913 .RS 15n
914 This is obsolete. All arguments of the form \fIname\fR\fB=\fR\fIvalue\fR are
915 removed and placed in the variable assignment list for the command. Ordinarily,
916 variable assignments must precede command arguments.
917 .RE
919 .sp
920 .ne 2
921 .na
922 \fB\fB-m\fR\fR
923 .ad
924 .RS 15n
925 When enabled, the shell runs background jobs in a separate process group and
926 displays a line upon completion. This mode is enabled by default for
927 interactive shells on systems that support job control.
928 .RE
930 .sp
931 .ne 2
932 .na
933 \fB\fB-n\fR\fR
934 .ad
935 .RS 15n
936 The shell reads commands and checks for syntax errors, but does not execute the
937 command. Usually specified on command invocation.
938 .RE
940 .sp
941 .ne 2
942 .na
943 \fB\fB-o\fR [\fIoption\fR]\fR
944 .ad
945 .RS 15n
946 If option is not specified, the list of options and their current settings is
947 written to standard output. When invoked with a \fB+\fR the options are written
948 in a format that can be input again to the shell to restore the settings. This
949 option can be repeated to enable or disable multiple options.
950 .sp
951 The value of \fIoption\fR must be one of the following:
952 .sp
953 .ne 2
954 .na
955 \fB\fBallexport\fR\fR
956 .ad
957 .RS 15n
958 Same as \fB-a\fR.
959 .RE
961 .sp
962 .ne 2
963 .na
964 \fB\fBbgnice\fR\fR
965 .ad
966 .RS 15n
967 All background jobs are run at lower priorities.
968 .RE
970 .sp
971 .ne 2
972 .na
973 \fB\fBbraceexpand\fR\fR
974 .ad
975 .RS 15n
976 Same as \fB-B\fR.
977 .RE
979 .sp
980 .ne 2
981 .na
982 \fB\fBemacs\fR\fR
983 .ad
984 .RS 15n
985 Enables or disables \fBemacs\fR editing mode.
986 .RE
988 .sp
989 .ne 2
990 .na
991 \fB\fBerrexit\fR\fR
992 .ad
993 .RS 15n
994 Same as \fB-e\fR.
995 .RE
997 .sp
998 .ne 2
999 .na
1000 \fB\fBglobstar\fR\fR
1001 .ad
1002 .RS 15n
1003 Equivalent to \fB-\fRG.
1004 .RE
1006 .sp
1007 .ne 2
1008 .na
1009 \fB\fBgmacs\fR\fR
1010 .ad
1011 .RS 15n
1012 Enables or disables \fBgmacs\fR. \fBgmacs\fR editing mode is the same as
1013 \fBemacs\fR editing mode, except for the handling of CTRL-T.
1014 .RE
1016 .sp
1017 .ne 2
1018 .na
1019 \fB\fBhistexpand\fR\fR
1020 .ad
1021 .RS 15n
1022 Same as \fB-H\fR.
1023 .RE
1025 .sp
1026 .ne 2
1027 .na
1028 \fB\fBignoreeof\fR\fR
1029 .ad
1030 .RS 15n
1031 The interactive shell does not exit on end-of-file.
1032 .RE
1034 .sp
1035 .ne 2
1036 .na
1037 \fB\fBkeyword\fR\fR
1038 .ad
1039 .RS 15n
1040 Same as \fB-k\fR.
1041 .RE
1043 .sp
1044 .ne 2
1045 .na
1046 \fB\fBmarkdirs\fR\fR
1047 .ad
1048 .RS 15n
1049 All directory names resulting from file name generation have a trailing \fB/\fR
1050 appended.
1051 .RE
1053 .sp
1054 .ne 2
1055 .na
1056 \fB\fBmonitor\fR\fR
1057 .ad
1058 .RS 15n
1059 Same as \fB-m\fR.
1060 .RE
1062 .sp
1063 .ne 2
1064 .na
1065 \fB\fBmultiline\fR\fR
1066 .ad
1067 .RS 15n
1068 Use multiple lines when editing lines that are longer than the window width.
1069 .RE
1071 .sp
1072 .ne 2
1073 .na
1074 \fB\fBnoclobber\fR\fR
1075 .ad
1076 .RS 15n
1077 Same as \fB-C\fR.
1078 .RE
1080 .sp
1081 .ne 2
1082 .na
1083 \fB\fBnoexec\fR\fR
1084 .ad
1085 .RS 15n
1086 Same as \fB-n\fR.
1087 .RE
1089 .sp
1090 .ne 2
1091 .na
1092 \fB\fBnoglob\fR\fR
1093 .ad
1094 .RS 15n
1095 Same as \fB-f\fR.
1096 .RE
1098 .sp
1099 .ne 2
1100 .na
1101 \fB\fBnolog\fR\fR
1102 .ad
1103 .RS 15n
1104 This has no effect. It is provided for backward compatibility.
1105 .RE
1107 .sp
1108 .ne 2
1109 .na
1110 \fB\fBnotify\fR\fR
1111 .ad
1112 .RS 15n
1113 Same as \fB-b\fR.
1114 .RE
1116 .sp
1117 .ne 2
1118 .na
1119 \fB\fBnounset\fR\fR
1120 .ad
1121 .RS 15n
1122 Same as \fB-u\fR.
1123 .RE
1125 .sp
1126 .ne 2
1127 .na
1128 \fB\fBpipefail\fR\fR
1129 .ad
1130 .RS 15n
1131 A pipeline does not complete until all components of the pipeline have
1132 completed, and the exit status of the pipeline is the value of the last command
1133 to exit with \fBnon-zero\fR exit status, or is \fBzero\fR if all commands
1134 return zero exit status.
1135 .RE
1137 .sp
1138 .ne 2
1139 .na
1140 \fB\fBprivileged\fR\fR
1141 .ad
1142 .RS 15n
1143 Same as \fB-p\fR.
1144 .RE
1146 .sp
1147 .ne 2
1148 .na
1149 \fB\fBshowme\fR\fR
1150 .ad
1151 .RS 15n
1152 Simple commands preceded by a ; are traced as if \fB-x\fR were enabled but not
1153 executed.
1154 .RE
1156 .sp
1157 .ne 2
1158 .na
1159 \fB\fBtrackall\fR\fR
1160 .ad
1161 .RS 15n
1162 Same as \fB-h\fR.
1163 .RE
1165 .sp
1166 .ne 2
1167 .na
1168 \fB\fBverbose\fR\fR
1169 .ad
1170 .RS 15n
1171 Same as \fB-v\fR.
1172 .RE
1174 .sp
1175 .ne 2
1176 .na
1177 \fB\fBvi\fR\fR
1178 .ad
1179 .RS 15n
1180 Enables or disables \fBvi\fR editing mode.
1181 .RE
1183 .sp
1184 .ne 2
1185 .na
1186 \fB\fBviraw\fR\fR
1187 .ad
1188 .RS 15n
1189 Does not use canonical input mode when using vi edit mode
1190 .RE
1192 .sp
1193 .ne 2
1194 .na
1195 \fB\fBxtrace\fR\fR
1196 .ad
1197 .RS 15n
1198 Same as \fB-x\fR.
1199 .RE
1201 .RE
1203 .sp
1204 .ne 2
1205 .na
1206 \fB\fB-p\fR\fR
1207 .ad
1208 .RS 15n
1209 Privileged mode. Disabling \fB-p\fR sets the effective user id to the real user
1210 id, and the effective group id to the real group id. Enabling \fB-p\fR restores
1211 the effective user and group ids to their values when the shell was invoked.
1212 The \fB-p\fR option is on whenever the real and effective user id is not equal
1213 or the real and effective group id is not equal. User profiles are not
1214 processed when \fB-p\fR is enabled.
1215 .RE
1217 .sp
1218 .ne 2
1219 .na
1220 \fB\fB-r\fR\fR
1221 .ad
1222 .RS 15n
1223 Restricted. Enables restricted shell. This option cannot be unset once enabled.
1224 .RE
1226 .sp
1227 .ne 2
1228 .na
1229 \fB\fB-s\fR\fR
1230 .ad
1231 .RS 15n
1232 Sort the positional parameters
1233 .RE
1235 .sp
1236 .ne 2
1237 .na
1238 \fB\fB-t\fR\fR
1239 .ad
1240 .RS 15n
1241 Obsolete. The shell reads one command and then exits.
1242 .RE
1244 .sp
1245 .ne 2
1246 .na
1247 \fB\fB-u\fR\fR
1248 .ad
1249 .RS 15n
1250 If enabled, the shell displays an error message when it tries to expand a
1251 variable that is unset.
1252 .RE
1254 .sp
1255 .ne 2
1256 .na
1257 \fB\fB-v\fR\fR
1258 .ad
1259 .RS 15n
1260 Verbose. The shell displays its input onto standard error as it reads it.
1261 .RE
1263 .sp
1264 .ne 2
1265 .na
1266 \fB\fB-x\fR\fR
1267 .ad
1268 .RS 15n
1269 Execution trace. The shell displays each command after all expansion and before
1270 execution preceded by the expanded value of the \fBPS4\fR parameter.
1271 .RE
1273 .sp
1274 .LP
1275 The following exit values are returned by \fBset\fR in \fBksh93\fR:
1276 .sp
1277 .ne 2
1278 .na
1279 \fB\fB0\fR\fR
1280 .ad
1281 .RS 6n
1282 Successful completion.
1283 .RE
1285 .sp
1286 .ne 2
1287 .na
1288 \fB\fB>0\fR\fR
1289 .ad
1290 .RS 6n
1291 An error occurred.
1292 .RE
1294 .sp
1295 .LP
1296 For each name specified, \fBunset\fR unsets the variable, or function if
1297 \fB-f\fR is specified, from the current shell execution environment. Read-only
1298 variables cannot be unset.
1299 .sp
1300 .LP
1301 The options for \fBunset\fR in \fBksh93\fR are:
1302 .sp
1303 .ne 2
1304 .na
1305 \fB\fB-f\fR\fR
1306 .ad
1307 .RS 6n
1308 Where \fIname\fR refers to a function name, the shell unsets the function
1309 definition.
1310 .RE
1312 .sp
1313 .ne 2
1314 .na
1315 \fB\fB-n\fR\fR
1316 .ad
1317 .RS 6n
1318 If \fIname\fR refers to variable that is a reference, the variable \fIname\fR
1319 is unset rather than the variable it references. Otherwise, this option is
1320 equivalent to the \fB-v\fR option.
1321 .RE
1323 .sp
1324 .ne 2
1325 .na
1326 \fB\fB-v\fR\fR
1327 .ad
1328 .RS 6n
1329 Where \fIname\fR refers to a variable name, the shell unsets it and removes it
1330 from the environment. This is the default behavior.
1331 .RE
1333 .sp
1334 .LP
1335 The following exit values are returned by \fBunset\fR in \fBksh93\fR:
1336 .sp
1337 .ne 2
1338 .na
1339 \fB\fB0\fR\fR
1340 .ad
1341 .RS 6n
1342 Successful completion. All names were successfully unset.
1343 .RE
1345 .sp
1346 .ne 2
1347 .na
1348 \fB\fB>0\fR\fR
1349 .ad
1350 .RS 6n
1351 An error occurred, or one or more \fIname\fR operands could not be unset
1352 .RE
1354 .sp
1355 .LP
1356 \fBexport\fR sets the export attribute on each of the variables specified by
1357 name which causes them to be in the environment of subsequently executed
1358 commands. If \fB=\fR\fIvalue\fR is specified, the variable \fIname\fR is set to
1359 \fIvalue\fR.
1360 .sp
1361 .LP
1362 If no \fIname\fR is specified, the names and values of all exported variables
1363 are written to standard output.
1364 .sp
1365 .LP
1366 \fBexport\fR is built-in to the shell as a declaration command so that field
1367 splitting and pathname expansion are not performed on the arguments. Tilde
1368 expansion occurs on value.
1369 .sp
1370 .LP
1371 The options for \fBexport\fR in \fBksh93\fR are:
1372 .sp
1373 .ne 2
1374 .na
1375 \fB\fB-p\fR\fR
1376 .ad
1377 .RS 6n
1378 Causes the output to be in the form of \fBexport\fR commands that can be used
1379 as input to the shell to recreate the current exports.
1380 .RE
1382 .sp
1383 .LP
1384 The following exit values are returned by \fBexport\fR in \fBksh93\fR:
1385 .sp
1386 .ne 2
1387 .na
1388 \fB\fB0\fR\fR
1389 .ad
1390 .RS 6n
1391 Successful completion.
1392 .RE
1394 .sp
1395 .ne 2
1396 .na
1397 \fB\fB>0\fR\fR
1398 .ad
1399 .RS 6n
1400 An error occurred.
1401 .RE
1403 .sp
1404 .LP
1405 On this manual page, \fBksh93\fR(1) commands that are preceded by one or two
1406 \fB+\fR are treated specially in the following ways:
1407 .RS +4
1408 .TP
1409 1.
1410 Variable assignment lists preceding the command remain in effect when the
1411 command completes.
1412 .RE
1413 .RS +4
1414 .TP
1415 2.
1416 I/O redirections are processed after variable assignments.
1417 .RE
1418 .RS +4
1419 .TP
1420 3.
1421 Errors cause a script that contains them to abort.
1422 .RE
1423 .RS +4
1424 .TP
1425 4.
1426 They are not valid function names.
1427 .RE
1428 .RS +4
1429 .TP
1430 5.
1431 Words, following a command preceded by \fB++\fR that are in the format of a
1432 variable assignment, are expanded with the same rules as a variable assignment.
1433 This means that tilde substitution is performed after the \fB=\fR sign and
1434 field splitting and file name generation are not performed.
1435 .RE
1436 .SH EXAMPLES
1437 .SS "csh"
1438 .LP
1439 The following example sets the \fBPATH\fR variable to search for files in the
1440 \fB/bin\fR, \fB/usr/bin\fR, and \fB/usr/sbin\fR
1441 directories, in that order:
1442 .sp
1443 .in +2
1444 .nf
1445 setenv PATH "/bin:/usr/bin:/usr/sbin"
1446 .fi
1447 .in -2
1448 .sp
1450 .SH SEE ALSO
1451 .LP
1452 \fBcsh\fR(1), \fBksh\fR(1), \fBksh93\fR(1), \fBread\fR(1), \fBsh\fR(1),
1453 \fBtypeset\fR(1), \fBattributes\fR(5), \fBenviron\fR(5)