usr/src/man/man1/exec.1

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Copyright (c) 2007 Sun Microsystems, Inc. - All Rights Reserved.
   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 EXEC 1 "Apr 8, 2008"
   9 .SH NAME
  10 exec, eval, source \- shell built-in functions to execute other commands
  11 .SH SYNOPSIS
  12 .SS "sh"
  13 .LP
  14 .nf
  15 \fBexec\fR [\fIargument\fR]...
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBeval\fR [\fIargument\fR]...
  21 .fi
  22
  23 .SS "csh"
  24 .LP
  25 .nf
  26 \fBexec\fR \fIcommand\fR
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBeval\fR \fIargument\fR...
  32 .fi
  33
  34 .LP
  35 .nf
  36 \fBsource\fR [\fB-h\fR] \fIname\fR
  37 .fi
  38
  39 .SS "ksh"
  40 .LP
  41 .nf
  42 \fB*exec\fR [\fIargument\fR]...
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fB*eval\fR [\fIargument\fR]...
  48 .fi
  49
  50 .SS "ksh93"
  51 .LP
  52 .nf
  53 \fB+exec\fR [\fB-c\fR] [\fB-a\fR \fIname\fR] [\fIcommand\fR [\fIargument\fR ... ]]
  54 .fi
  55
  56 .LP
  57 .nf
  58 \fB+eval\fR [\fIargument\fR]...
  59 .fi
  60
  61 .SH DESCRIPTION
  62 .SS "sh"
  63 .sp
  64 .LP
  65 The \fBexec\fR command specified by the arguments is executed in place of this
  66 shell without creating a new process. Input/output arguments and appear and, if
  67 no other arguments are specified, cause the shell input/output to be modified.
  68 .sp
  69 .LP
  70 The \fIargument\fRs to the \fBeval\fR built-in are read as input to the shell
  71 and the resulting command(s) executed.
  72 .SS "csh"
  73 .sp
  74 .LP
  75 \fBexec\fR executes \fBcommand\fR in place of the current shell, which
  76 terminates.
  77 .sp
  78 .LP
  79 \fBeval\fR reads its \fIargument\fRs as input to the shell and executes the
  80 resulting command(s). This is usually used to execute commands generated as the
  81 result of command or variable substitution.
  82 .sp
  83 .LP
  84 \fBsource\fR reads commands from \fIname\fR. \fBsource\fR commands can be
  85 nested, but if they are nested too deeply the shell can run out of file
  86 descriptors. An error in a sourced file at any level terminates all nested
  87 \fBsource\fR commands.
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fB-h\fR\fR
  92 .ad
  93 .RS 6n
  94 Place commands from the file \fIname\fR on the history list without executing
  95 them.
  96 .RE
  97
  98 .SS "ksh"
  99 .sp
 100 .LP
 101 With the \fBexec\fR built-in, if \fIarg\fR is specified, the command specified
 102 by the arguments is executed in place of this shell without creating a new
 103 process. Input/output arguments can appear and affect the current process. If
 104 no arguments are specified the effect of this command is to modify file
 105 descriptors as prescribed by the input/output redirection list. In this case,
 106 any file descriptor numbers greater than 2 that are opened with this mechanism
 107 are closed when invoking another program.
 108 .sp
 109 .LP
 110 The arguments to \fBeval\fR are read as input to the shell and the resulting
 111 command(s) executed.
 112 .sp
 113 .LP
 114 On this man page, \fBksh\fR(1) commands that are preceded by one or two *
 115 (asterisks) are treated specially in the following ways:
 116 .RS +4
 117 .TP
 118 1.
 119 Variable assignment lists preceding the command remain in effect when the
 120 command completes.
 121 .RE
 122 .RS +4
 123 .TP
 124 2.
 125 \fBI/O\fR redirections are processed after variable assignments.
 126 .RE
 127 .RS +4
 128 .TP
 129 3.
 130 Errors cause a script that contains them to abort.
 131 .RE
 132 .RS +4
 133 .TP
 134 4.
 135 Words, following a command preceded by ** that are in the format of a
 136 variable assignment, are expanded with the same rules as a variable assignment.
 137 This means that tilde substitution is performed after the \fB=\fR sign and word
 138 splitting and file name generation are not performed.
 139 .RE
 140 .SS "ksh93"
 141 .sp
 142 .LP
 143 \fBexec\fR is a special built-in command that can be used to manipulate file
 144 descriptors or to replace the current shell with a new command.
 145 .sp
 146 .LP
 147 If \fIcommand\fR is specified, then the current shell process is replaced by
 148 \fIcommand\fR rather than running \fIcommand\fR and waiting for it to complete.
 149 There is no need to use \fBexec\fR to enhance performance since the shell
 150 implicitly uses the \fBexec\fR mechanism internally whenever possible.
 151 .sp
 152 .LP
 153 If no operands are specified, \fBexec\fR can be used to open or close files, or
 154 to manipulate file descriptors from \fB0\fR to \fB9\fR in the current shell
 155 environment using the standard redirection mechanism available with all
 156 commands. The close-on-exec flags is set on file descriptor numbers greater
 157 than \fB2\fR that are opened this way so that they are closed when another
 158 program is invoked.
 159 .sp
 160 .LP
 161 Because \fBexec\fR is a special command, any failure causes the script that
 162 invokes it to exit. This can be prevented by invoking \fBexec\fR from the
 163 \fBcommand\fR  utility.
 164 .sp
 165 .LP
 166 \fBexec\fR cannot be invoked from a restricted shell to create files or to open
 167 a file for writing or appending.
 168 .sp
 169 .LP
 170 \fBeval\fR is a shell special built-in command that constructs a command by
 171 concatenating the \fIargument\fRs together, separating each with a space. The
 172 resulting string is taken as input to the shell and evaluated in the current
 173 environment. command words are expanded twice, once to construct
 174 \fIargument\fR, and again when the shell executes the constructed command. It
 175 is not an error if \fIargument\fR is not specified.
 176 .sp
 177 .LP
 178 On this manual page, \fBksh93\fR commands that are preceded by one or two
 179 \fB+\fR symbols are special built-in commands and are treated specially in the
 180 following ways:
 181 .RS +4
 182 .TP
 183 1.
 184 Variable assignment lists preceding the command remain in effect when the
 185 command completes.
 186 .RE
 187 .RS +4
 188 .TP
 189 2.
 190 I/O redirections are processed after variable assignments.
 191 .RE
 192 .RS +4
 193 .TP
 194 3.
 195 Errors cause a script that contains them to abort.
 196 .RE
 197 .RS +4
 198 .TP
 199 4.
 200 They are not valid function names.
 201 .RE
 202 .RS +4
 203 .TP
 204 5.
 205 Words following a command preceded by \fB++\fR that are in the format of a
 206 variable assignment are expanded with the same rules as a variable assignment.
 207 This means that tilde substitution is performed after the \fB=\fR sign and
 208 field splitting and file name generation are not performed.
 209 .RE
 210 .SH OPTIONS
 211 .SS "ksh93"
 212 .sp
 213 .LP
 214 The following options are supported by \fBksh93 exec\fR:
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fB-a\fR \fIname\fR\fR
 219 .ad
 220 .RS 11n
 221 \fBargv[0]\fR is set to \fIname\fR for command.
 222 .RE
 223
 224 .sp
 225 .ne 2
 226 .na
 227 \fB\fB-c\fR\fR
 228 .ad
 229 .RS 11n
 230 Clear all environment variables before executions except variable assignments
 231 that are part of the current \fBexec\fR command.
 232 .RE
 233
 234 .SH EXIT STATUS
 235 .SS "ksh"
 236 .sp
 237 .LP
 238 The following exit values are returned by \fBexec\fR:
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fB0\fR\fR
 243 .ad
 244 .RS 9n
 245 Successful completion.
 246 .RE
 247
 248 .sp
 249 .ne 2
 250 .na
 251 \fB\fB1-125\fR\fR
 252 .ad
 253 .RS 9n
 254 A redirection error occurred.
 255 .RE
 256
 257 .sp
 258 .ne 2
 259 .na
 260 \fB\fB127\fR\fR
 261 .ad
 262 .RS 9n
 263 \fIcommand\fR was not found.
 264 .RE
 265
 266 .sp
 267 .ne 2
 268 .na
 269 \fB\fB126\fR\fR
 270 .ad
 271 .RS 9n
 272 \fIcommand\fR was found, but it is not an executable utility.
 273 .RE
 274
 275 .SS "ksh93"
 276 .sp
 277 .LP
 278 The following exit values are returned by \fBexec\fR. If \fIcommand\fR is
 279 specified, \fBexec\fR does not return.
 280 .sp
 281 .ne 2
 282 .na
 283 \fB\fB0\fR\fR
 284 .ad
 285 .RS 6n
 286 Successful completion. All I/O redirections were successful.
 287 .RE
 288
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fB>0\fR\fR
 293 .ad
 294 .RS 6n
 295 An error occurred.
 296 .RE
 297
 298 .sp
 299 .LP
 300 The following exit values are returned by \fBeval\fR:
 301 .sp
 302 .LP
 303 If \fIargument\fR is not specified, the exit status is \fB0\fR. Otherwise, it
 304 is the exit status of the command defined by the \fIargument\fR operands.
 305 .SH ATTRIBUTES
 306 .sp
 307 .LP
 308 See \fBattributes\fR(5) for descriptions of the following attributes:
 309 .sp
 310
 311 .sp
 312 .TS
 313 box;
 314 c | c
 315 l | l .
 316 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 317 .TE
 318
 319 .SH SEE ALSO
 320 .sp
 321 .LP
 322 \fBcsh\fR(1), \fBksh\fR(1), \fBksh93\fR(1), \fBsh\fR(1), \fBattributes\fR(5)