share/man/man1/set.1

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