241

I have seen exec command used inside scripts to redirect all output to a file (as seen in this). But in simple words, what does it do?

Line
  • 351
  • 1
  • 4
  • 15
a06e
  • 13,223
  • 26
  • 70
  • 104

4 Answers4

182

man bash says:

exec [-cl] [-a name] [command [arguments]]
      If command is specified, it replaces the shell.  No new  process
      is  created.  The arguments become the arguments to command.  If
      the -l option is supplied,  the  shell  places  a  dash  at  the
      beginning  of  the  zeroth  argument passed to command.  This is
      what login(1) does.  The -c option causes command to be executed
      with  an empty environment.  If -a is supplied, the shell passes
      name as the zeroth argument to the executed command.  If command
      cannot  be  executed  for  some  reason, a non-interactive shell
      exits, unless the execfail shell option  is  enabled.   In  that
      case,  it returns failure.  An interactive shell returns failure
      if the file cannot be executed.  If command  is  not  specified,
      any  redirections  take  effect  in  the  current shell, and the
      return status is 0.  If there is a redirection error, the return
      status is 1.

The last two lines are what is important: If you run exec by itself, without a command, it will simply make the redirections apply to the current shell. You probably know that when you run command > file, the output of command is written to file instead of to your terminal (this is called a redirection). If you run exec > file instead, then the redirection applies to the entire shell: Any output produced by the shell is written to file instead of to your terminal. For example here

bash-3.2$ bash
bash-3.2$ exec > file
bash-3.2$ date
bash-3.2$ exit
bash-3.2$ cat file
Thu 18 Sep 2014 23:56:25 CEST

I first start a new bash shell. Then, in this new shell I run exec > file, so that all output is redirected to file. Indeed, after that I run date but I get no output, because the output is redirected to file. Then I exit my shell (so that the redirection no longer applies) and I see that file indeed contains the output of the date command I ran earlier.

Th. Ma.
  • 107
  • 1
  • 4
fkraiem
  • 12,555
  • 4
  • 35
  • 40
  • 100
    This is only partial explanation. exec serves to also replace current shell process with a command, so that parent goes a way and child owns pid. This is not only for redirection. Please add this info – Sergiy Kolodyazhnyy Aug 31 '16 at 13:23
  • 17
    Following up on @SergiyKolodyazhnyy's comment, the example I've just encountered which led me to this page is a docker-entrypoint.sh, where after performing various actions on the nginx config, the final line of the script is exec nginx <various nginx arguments>. This means that nginx takes over the pid of the bash script and now nginx is the main running process of the container, not the script. I assume this is just for cleanliness, unless someone else knows a more concrete reason for it? – Luke Griffiths Nov 21 '18 at 19:56
  • 6
    @Luke This is called "wrapper script". Example of that is also gnome-terminal, which at least on 14.04 had a wrapper script to set up arguments. And that's their only purpose, really - set arts and environment. Another case would be to clean up - kill previous instance of a process first and launch new one – Sergiy Kolodyazhnyy Nov 21 '18 at 20:18
  • 1
    another exec example similar to the nginx example given by @LukeGriffiths is the ~/.vnc/xstartup script which vncserver uses to configure a VNC server process and then exec gnome-session or exec startkde and so on. – Trevor Boyd Smith Jan 22 '19 at 13:57
  • 11
    @LukeGriffiths, the main reason for exec in a container startup script is that the PID 1, the container's ENTRYPOINT, has a special significance in Docker. It is a main process that receives signals, and when it exists, the container exits too. exec just a way to take sh out of this chain of command, and make the daemon the main process of the container. – kkm -still wary of SE promises Feb 13 '19 at 22:39
121

exec is a command with two very distinct behaviors, depending on whether at least one argument is used with it, or no argument is used at all.

  • If at least one argument is passed, the first one is taken as a command name and exec try to execute it as a command passing the remaining arguments, if any, to that command and managing the redirections, if any.

  • If the command passed as first argument doesn't exist, the current shell, not only the exec command, exits in error, unless the shell is interactive or the bash option execfail is set (shopt -s execfail). See also https://superuser.com/questions/992204/why-does-exec-non-existent-file-exits-the-shell-when-in-a-script-that-is-sourc

  • If the command exists and is executable, it replaces the current shell. That means that if exec appears in a script, the instructions following the exec call will never be executed (unless exec is itself in a subshell). A successful exec never returns. Shell traps like "EXIT" won't get triggered either.

  • If no argument is passed, exec is only used to redefine the current shell file descriptors. The shell continue after the exec, unlike with the previous case, but the standard input, output, error or whatever file descriptor has been redirected take effect.

  • If some of the redirections uses /dev/null, any input from it will return EOF and any output to it will be discarded.

  • You can close file descriptors by using - as source or destination, e.g. exec <&-. Subsequent read or writes will then fail.

Here are two examples:

echo foo > /tmp/bar
exec < /tmp/bar # exec has no arguments, will only affect current shell descriptors, here stdin
cat # simple command that read stdin and write it to stdout

This script will output "foo" as the cat command, instead of waiting for user input as it would have done in the usual case will take its input from the /tmp/bar file which contains foo.

echo foo > /tmp/bar
exec wc -c < /tmp/bar # exec has two arguments, the control flow will switch to the wc command
cat

This script will display 4 (the number of bytes in /tmp/bar) and immediately ends. The cat command won't be executed.

jlliagre
  • 5,833
  • 10
    `Some old posts never really get old ... +1. – Cbhihe Mar 23 '17 at 11:33
  • 4
    If some of the redirections uses /dev/null, the associated file descriptor is closed. No, it really does redirect to/from /dev/null, so writes still succeed and reads return EOF. close(2) on an fd would cause read/write system calls to return errors, and you do that with exec 2>&- for example. – Peter Cordes Jul 07 '17 at 02:59
  • 3
    Try it yourself: exec 3</dev/null; ls -l /proc/self/fd: note that fd 3 will be open read-only on /dev/null. Then close it again with exec 3<&-, and you can see (with ls -l /proc/$$/fd again) that your shell process has no fd 3 anymore. (closing stdin with exec <&- can be useful in scripts, but interactively it's a logout.) – Peter Cordes Jul 07 '17 at 03:01
  • @PeterCordes You are absolutely right. Answer updated. Thanks! – jlliagre Jul 07 '17 at 05:43
  • re "exec never returns": see here for more info if you had the question "why does exec never return?" – Trevor Boyd Smith Jan 22 '19 at 14:04
  • 4
    This answer is great because it explains the two use-cases of exec the current most-upvoted answer only talks about the one use-case and the other answer by g_p only talks about the other use-case. And this answer is nice and concise/readable for such a complex subject matter. – Trevor Boyd Smith Jan 22 '19 at 14:09
  • I am here as I suddenly am wondering if there is a connection between the two use cases of exec. I am wondering if this description is correct "do what you normally do, but skip fork: don't fork, do file redirection, then conditionally (if command is specified), exec the command." – ctrl-alt-delor Jan 27 '21 at 20:25
  • 1
    @ctrl-alt-delor That's a way to describe it but might deserve some rephrasing. The exec command is simple to implement, there isn't even the need for it to handle the redirections, as the shell does it already. "Skip fork" indeed: the exec command never forks. – jlliagre Jan 27 '21 at 21:09
  • From man bash: If command cannot be executed for some reason, a non-interactive shell exits, unless the shell option execfail is enabled, in which case it returns failure. An interactive shell returns failure if the file cannot be executed. I assume this means that, in case of non-existing command passed as first argument in an interactive shell, current shell will not exit. – matthiash Jan 29 '21 at 09:38
  • @matthiash You are right, answer updated with this precision. – jlliagre Jan 29 '21 at 11:02
52

To understand exec you need to first understand fork. I am trying to keep it short.

  • When you come to a fork in the road you generally have two options. Linux programs reach this fork in the road when they hit a fork() system call.

  • Normal programs are system commands that exist in a compiled form on your system. When such a program is executed, a new process is created. This child process has the same environment as its parent, only the process ID number is different. This procedure is called forking.

  • Forking provides a way for an existing process to start a new one. However, there may be situations where a child process is not the part of the same program as parent process. In this case exec is used. exec will replace the contents of the currently running process with the information from a program binary.
  • After the forking process, the address space of the child process is overwritten with the new process data. This is done through an exec call to the system.
David Foerster
  • 36,264
  • 56
  • 94
  • 147
g_p
  • 18,504
  • 4
    can you explain why exec can redirect a script output, as in the link I posted? – a06e Sep 18 '14 at 21:45
  • 8
    I found this unclear "However, there may be situations where a child process is not the part of the same program as parent process" – cdosborn Oct 15 '18 at 22:34
  • Indeed, is it possible to rephrase "part of the same program as parent process"? – Artfaith May 28 '22 at 06:31
14

In bash, if you do help exec:

$ help exec
exec: exec [-cl] [-a name] [command [arguments ...]] [redirection ...]
    Replace the shell with the given command.

    Execute COMMAND, replacing this shell with the specified program.
    ARGUMENTS become the arguments to COMMAND.  If COMMAND is not specified,
    any redirections take effect in the current shell.

    Options:
      -a name   pass NAME as the zeroth argument to COMMAND
      -c        execute COMMAND with an empty environment
      -l        place a dash in the zeroth argument to COMMAND

    If the command cannot be executed, a non-interactive shell exits, unless
    the shell option `execfail' is set.

    Exit Status:
    Returns success unless COMMAND is not found or a redirection error occurs.

The relevant bit:

If COMMAND is not specified, any redirections take effect in the current shell.

exec is a shell builtin, which is the shell equivalent of the exec family of system calls that G_P speaks of (and whose manpages you appear to have read). It just has the POSIX mandated functionality of affecting the current shell if no command is specified.

muru
  • 197,895
  • 55
  • 485
  • 740