raw/man3/exec.3

   1 .\" Copyright (c) 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)exec.3      6.4 (Berkeley) 4/19/91
  33 .\"
  34 .\" Converted for Linux, Mon Nov 29 11:12:48 1993, faith@cs.unc.edu
  35 .\" Updated more for Linux, Tue Jul 15 11:54:18 1997, pacman@cqc.com
  36 .\"
  37 .TH EXEC 3  1993-11-29 "BSD MANPAGE" "Linux Programmer's Manual"
  38 .SH NAME
  39 execl, execlp, execle, execv, execvp \- execute a file
  40 .SH SYNOPSIS
  41 .B #include <unistd.h>
  42 .sp
  43 .B extern char **environ;
  44 .sp
  45 .BI "int execl(const char *" path ", const char *" arg ", ...);"
  46 .br
  47 .BI "int execlp(const char *" file ", const char *" arg ", ...);"
  48 .br
  49 .BI "int execle(const char *" path ", const char *" arg
  50 .BI ", ..., char * const " envp "[]);"
  51 .br
  52 .BI "int execv(const char *" path ", char *const " argv "[]);"
  53 .br
  54 .BI "int execvp(const char *" file ", char *const " argv "[]);"
  55 .SH DESCRIPTION
  56 The
  57 .B exec
  58 family of functions replaces the current process image with a new process
  59 image.  The functions described in this manual page are front-ends for the
  60 function
  61 .BR execve (2).
  62 (See the manual page for
  63 .B execve
  64 for detailed information about the replacement of the current process.)
  65 .PP
  66 The initial argument for these functions is the pathname of a file which is
  67 to be executed.
  68 .PP
  69 The
  70 .I "const char *arg"
  71 and subsequent ellipses in the
  72 .BR execl ,
  73 .BR execlp ,
  74 and
  75 .B execle
  76 functions can be thought of as
  77 .IR arg0 ,
  78 .IR arg1 ,
  79 \&...,
  80 .IR argn .
  81 Together they describe a list of one or more pointers to null-terminated
  82 strings that represent the argument list available to the executed program.
  83 The first argument, by convention, should point to the file name associated
  84 with the file being executed.  The list of arguments
  85 .I must
  86 be terminated by a
  87 .B NULL
  88 pointer.
  89 .PP
  90 The
  91 .B execv
  92 and
  93 .B execvp
  94 functions provide an array of pointers to null-terminated strings that
  95 represent the argument list available to the new program.  The first
  96 argument, by convention, should point to the file name associated with the
  97 file being executed.  The array of pointers
  98 .I must
  99 be terminated by a
 100 .B NULL
 101 pointer.
 102 .PP
 103 The
 104 .B execle
 105 function also specifies the environment of the executed process by following
 106 the
 107 .B NULL
 108 pointer that terminates the list of arguments in the parameter list or the
 109 pointer to the argv array with an additional parameter.  This additional
 110 parameter is an array of pointers to null-terminated strings and
 111 .I must
 112 be terminated by a
 113 .B NULL
 114 pointer.  The other functions take the environment for the new process
 115 image from the external variable
 116 .I environ
 117 in the current process.
 118 .PP
 119 Some of these functions have special semantics.
 120 .PP
 121 The functions
 122 .B execlp
 123 and
 124 .B execvp
 125 will duplicate the actions of the shell in searching for an executable file
 126 if the specified file name does not contain a slash (/) character.  The
 127 search path is the path specified in the environment by the
 128 .B PATH
 129 variable.  If this variable isn't specified, the default path
 130 ``:/bin:/usr/bin'' is used.  In addition, certain
 131 errors are treated specially.
 132 .PP
 133 If permission is denied for a file (the attempted
 134 .B execve
 135 returned
 136 .BR EACCES ),
 137 these functions will continue searching the rest of the search path.  If no
 138 other file is found, however, they will return with the global variable
 139 .I errno
 140 set to
 141 .BR EACCES .
 142 .PP
 143 If the header of a file isn't recognized (the attempted
 144 .B execve
 145 returned
 146 .BR ENOEXEC ),
 147 these functions will execute the shell with the path of the file as its
 148 first argument.  (If this attempt fails, no further searching is done.)
 149 .SH "RETURN VALUE"
 150 If any of the
 151 .B exec
 152 functions returns, an error will have occurred.  The return value is \-1,
 153 and the global variable
 154 .I errno
 155 will be set to indicate the error.
 156 .SH FILES
 157 .I /bin/sh
 158 .SH ERRORS
 159 All of these functions may fail and set
 160 .I errno
 161 for any of the errors specified for the library function
 162 .BR execve (2).
 163 .SH "SEE ALSO"
 164 .BR sh (1),
 165 .BR execve (2),
 166 .BR fork (2),
 167 .BR environ (5),
 168 .BR ptrace (2)
 169 .SH COMPATIBILITY
 170 On some other systems the default path (used when the environment
 171 does not contain the variable \fBPATH\fR) has the current working
 172 directory listed after
 173 .I /bin
 174 and
 175 .IR /usr/bin ,
 176 as an anti-Trojan-horse measure. Linux uses here the
 177 traditional "current directory first" default path.
 178 .PP
 179 The behavior of
 180 .B execlp
 181 and
 182 .B execvp
 183 when errors occur while attempting to execute the file is historic
 184 practice, but has not traditionally been documented and is not specified by
 185 the POSIX standard. BSD (and possibly other systems) do an automatic
 186 sleep and retry if ETXTBSY is encountered. Linux treats it as a hard
 187 error and returns immediately.
 188 .PP
 189 Traditionally, the functions
 190 .B execlp
 191 and
 192 .B execvp
 193 ignored all errors except for the ones described above and
 194 .B ENOMEM
 195 and
 196 .BR E2BIG ,
 197 upon which they returned.  They now return if any error other than the ones
 198 described above occurs.
 199 .SH "CONFORMING TO"
 200 .BR execl ,
 201 .BR execv ,
 202 .BR execle ,
 203 .B execlp
 204 and
 205 .B execvp
 206 conform to
 207 IEEE Std1003.1-88 (``POSIX.1'').