Diff for "BashFAQ/082"

Differences between revisions 3 and 27 (spanning 24 versions)

Why is $(...) preferred over `...` (backticks)?

`...` is the legacy syntax required by only the very oldest of non-POSIX-compatible bourne-shells. There are several reasons to always prefer the $(...) syntax:

Important differences

Backslashes (\) inside backticks are handled in a non-obvious manner:
```
   1 $ echo "`echo \\a`" "$(echo \\a)"
   2 a \a
   3 $ echo "`echo \\\\a`" "$(echo \\\\a)"
   4 \a \\a
   5 # Note that this is true for *single quotes* too!
   6 $ foo=`echo '\\'`; bar=$(echo '\\'); echo "foo is $foo, bar is $bar"
   7 foo is \, bar is \\
```
Nested quoting inside $() is far more convenient.
```
   1 echo "x is $(sed ... <<<"$y")"
```
In this example, the quotes around $y are treated as a pair, because they are inside $(). This is confusing at first glance, because most C programmers would expect the quote before x and the quote before $y to be treated as a pair; but that isn't correct in shells. On the other hand,
```
   1 echo "x is `sed ... <<<\"$y\"`"
```
requires backslashes around the internal quotes in order to be portable. Bourne and Korn shells require these backslashes, while Bash and dash don't.
It makes nesting command substitutions easier. Compare:
```
   1 x=$(grep "$(dirname "$path")" file)
   2 x=`grep "\`dirname \"$path\"\`" file`
```
It just gets uglier and uglier after two levels. $() forces an entirely new context for quoting, so that everything within the command substitution is protected and can be treated as though it were on its own, with no special concern over quoting and escaping.

Other advantages

The function of $(...) as being an expansion is visually clear. The syntax of a $-prefixed token is consistent with all other expansions that are parsed from within double-quotes, at the same time, from left-to-right. Backticks are the only exception. This improves human and machine readability, and consistent syntax makes the language more intuitive for readers.
Per the above, people are (hopefully) accustomed to seeing double-quoted expansions and substitutions with the usual "$..." syntax. Quoting command substitutions is almost always the correct thing to do, yet the great majority of `...` specimens we find in the wild are left unquoted, perhaps because those who still use the legacy syntax are less experienced, or they don't associate it with the other expansions due to the different syntax. In addition, the ` character is easily camouflaged when adjacent to " making it even more difficult to read, especially with small or unusual fonts.
The backtick is also easily confused with a single quote.

-  ⇤ ← Revision 3 as of 2007-09-13 19:19:33 → 
  Size: 895
  Editor: BetterWorld
  Comment: Add example for non-obvious backslashing behaviour
+   ← Revision 27 as of 2021-07-17 17:46:09 → ⇥
  Size: 3223
  Editor: 198-48-193-243
  Comment: Fix leading whitespace. Add Bash syntax highlighting.
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-[[Anchor(faq82)]]
+<<Anchor(faq82)>>
-Line 3:
+Line 4:
+{{{`...`}}} is the legacy syntax required by only the very oldest of non-POSIX-compatible bourne-shells. There are several reasons to always prefer the {{{$(...)}}} syntax:
-Line 4:
+Line 6:
-For several reasons:
+=== Important differences ===
 * Backslashes (\) inside backticks are handled in a non-obvious manner:
 {{{#!highlight bash
$ echo "`echo \\a`" "$(echo \\a)"
a \a
$ echo "`echo \\\\a`" "$(echo \\\\a)"
\a \\a
# Note that this is true for *single quotes* too!
$ foo=`echo '\\'`; bar=$(echo '\\'); echo "foo is $foo, bar is $bar"
foo is \, bar is \\
}}}

 * Nested quoting inside {{{$()}}} is far more convenient.
 {{{#!highlight bash
echo "x is $(sed ... <<<"$y")"
}}}
 In this example, the quotes around {{{$y}}} are treated as a pair, because they are inside {{{$()}}}.  This is confusing at first glance, because most C programmers would expect the quote before {{{x}}} and the quote before {{{$y}}} to be treated as a pair; but that isn't correct in shells.  On the other hand,
 {{{#!highlight bash
echo "x is `sed ... <<<\"$y\"`"
}}}
 requires backslashes around the internal quotes in order to be portable.  Bourne and Korn shells require these backslashes, while Bash and dash don't.
-Line 7:
+Line 29:
+ {{{#!highlight bash
x=$(grep "$(dirname "$path")" file)
x=`grep "\`dirname \"$path\"\`" file`
}}}
 It just gets uglier and uglier after two levels. {{{$()}}} forces an entirely new context for quoting, so that everything within the command substitution is protected and can be treated as though it were on its own, with no special concern over quoting and escaping.
-Line 8:
+Line 35:
-  {{{
  x=$(grep $(dirname "$path") file)
  x=`grep \`dirname "$path"\` file`}}}
+=== Other advantages ===
 * The function of {{{$(...)}}} as being an expansion is visually clear. The syntax of a {{{$}}}-prefixed token is consistent with all other expansions that are parsed from within double-quotes, at the same time, from left-to-right. Backticks are the only exception. This improves human and machine readability, and consistent syntax makes the language more intuitive for readers.
-Line 12:
+Line 38:
- It just gets uglier and uglier after two levels.
+ * Per the above, people are (hopefully) accustomed to seeing double-quoted expansions and substitutions with the usual {{{"$..."}}} syntax. Quoting command substitutions is almost always the correct thing to do, yet the great majority of {{{`...`}}} specimens we find in the wild are left unquoted, perhaps because those who still use the legacy syntax are less experienced, or they don't associate it with the other expansions due to the different syntax. In addition, the {{{`}}} character is easily camouflaged when adjacent to {{{"}}} making it even more difficult to read, especially with small or unusual fonts.
-Line 14:
+Line 40:
- * It's easier to read.
 * Newbies who see {{{$()}}} don't normally press the wrong keys.  On the other hand, newbies who see {{{`cmd`}}} often mangle it into {{{'cmd'}}} because they don't know what a backtick is.
 * Backslashes (\) inside backticks are handled in a non-obvious manner:
+ * The backtick is also easily confused with a single quote.
-Line 18:
+Line 42:
-  {{{
  echo "`echo \\a`"      # prints a
  echo "`echo \\\a`"     # prints \a
  echo "`echo \\\\a`"    # prints \a}}}

Inside {{{$()}}}, there are no such surprises.

The only time backticks are preferred is when writing code for the oldest Bourne shells, which do not know about {{{$()}}}.
+=== See also: ===
 * [[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_03|POSIX standard section "2.6.3 Command Substitution"]]
 * [[http://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xcu_chap02.html#tag_23_02_06_03|POSIX rationale for including the $() syntax]]
 * CommandSubstitution
 * [[http://wiki.bash-hackers.org/syntax/expansion/cmdsubst|bash-hackers: command substitution]]