Explain the deviousness of the Perl “preamble”

by

The idea is that those three lines do 3 different things if they’re evaluated in a standard Bourne shell (sh), a C shell (csh), or Perl. This hack is only needed on systems that don’t support specifying an interpreter name using a #! line at the start of a script. If you execute a Perl script beginning with those 3 lines as a shell script, the shell will launch the Perl interpreter, passing it the script’s filename and the command line arguments.

In Perl, the three lines form one statement, terminated by the ;, of the form

eval '...' && eval '...' & eval '...' if $running_under_some_shell;

Since the script just started, $running_under_some_shell is undef, which is false, and the evals are never executed. It’s a no-op.

The devious part is that $?0 is parsed differently in sh versus csh. In sh, that means $? (the exit status of the last command) followed by 0. Since there is no previous command, $? will be 0, so $?0 evaluates to 00. In csh, $?0 is a special variable that is 1 if the current input filename is known, or 0 if it isn’t. Since the shell is reading these lines from a script, $?0 will be 1.

Therefore, in sh, eval '(exit $?0)' means eval '(exit 00)', and in csh it means eval '(exit 1)'. The parens indicate that the exit command should be evaluated in a subshell.

Both sh and csh understand && to mean “execute the previous command, then execute the following command only if the previous command exited 0”. So only sh will execute eval 'exec perl -wS $0 ${1+"$@"}'. csh will proceed to the next line.

csh will ignore “& ” at the beginning of a line. (I’m not sure exactly what that means to csh. Its purpose is to make this a single expression from Perl’s point of view.) csh then proceeds to evaluate eval 'exec /usr/bin/perl -wS $0 $argv:q'.

These two command lines are quite similar. exec perl means to replace the current process by launching a copy of perl. -wS means the same as -w (enable warnings) and -S (look for the specified script in $PATH). $0 is the filename of the script. Finally both ${1+"$@"} and $argv:q produce a copy of the current command line arguments (in sh and csh, respectively).

It uses ${1+"$@"} instead of the more usual "$@" to work around a bug in some ancient version of the Bourne shell. They mean the same thing. You can read the details in Bennett Todd’s explanation (copied in gbacon’s answer).

More Related Contents:

  1. How to extrace pg_backend_pid from postgresql in shell script and pass it to another process?
  2. How to use shell variables in perl command call in a bash shell script?
  3. Converting relative path into absolute path?
  4. How can i do this in perl, shortcut truthtable [closed]
  5. How to retrieve the values of required keys in Perl [closed]
  6. Perl: Meaning of double squared brackets after a string?
  7. What does this HTML::Parser() code do in Perl? [closed]
  8. How to print lines between two patterns, inclusive or exclusive (in sed, AWK or Perl)?
  9. Why use strict and warnings?
  10. Why does modern Perl avoid UTF-8 by default?
  11. Why is three-argument open calls with autovivified filehandles a Perl best practice?
  12. What’s the difference between Perl’s backticks, system, and exec?
  13. How can I parse dates and convert time zones in Perl?
  14. Which one is good practice, a lexical filehandle or a typeglob?
  15. How do I tell if a variable has a numeric value in Perl?
  16. Perl memory usage profiling and leak detection?
  17. How should I use the “my” keyword in Perl?
  18. Global symbol requires explicit package name
  19. How do I include functions from another file in my Perl script?
  20. Use of ‘use utf8;’ gives me ‘Wide character in print’
  21. How can I interact with ClearCase from Perl?
  22. What reasons are there to prefer glob over readdir (or vice-versa) in Perl?
  23. How do I convert a date/time to epoch time (unix time/seconds since 1970) in Perl?
  24. What is the meaning of @_ in Perl?
  25. What should I use for a Perl script’s shebang line?
  26. How do I list available methods on a given object or package in Perl?
  27. How can I find memory leaks in long-running Perl program?
  28. How can I calculate the number of days between two dates in Perl?
  29. How can I treat command-line arguments as UTF-8 in Perl?
  30. Why doesn’t Perl’s each() iterate through the entire hash the second time?

Leave a Comment