18

As a simple example, I have a bunch of source code files. I want to store the "head" command output to a variable for all these files.

I tried:

output=$(head $file)

but what happened is that this automatically trimmed all \n characters when storing the output to a variable.

How do I store the command output as is without removing \n characters?

Kusalananda
  • 333,661
return 0
  • 317

3 Answers3

15

It is a known flaw of "command expansion" $(...) or `...` that the last newline is trimmed.

If that is your case:

$ output="$(head -- "$file"; echo x)"     ### capture the text with an x added.
$ output="${output%?}"                    ### remove the last character (the x).

Will correct the value of output.

Gilles 'SO- stop being evil'
  • 829,060
  • 4
    Also, outputting the value with e.g. echo would never preserve the internal newlines if the variable expansion wasn't quoted. See e.g. the difference between echo $multiline and echo "$multiline". Also: Why is printf better than echo? – Kusalananda Nov 26 '19 at 18:33
  • 2
    Hi :-) I would say "the last newlines are trimmed". Am I right ? – leaf Jan 26 '20 at 09:51
  • You could avoid the need to remove x by using $ output=$(head -- "$file"; echo '')" (i.e. echo an empty string, will still make echo print the newline). – Capt. Crunch May 12 '21 at 02:58
  • 1
    Related: https://mywiki.wooledge.org/CommandSubstitution (Command substitutions strip all trailing newlines from the output of the command inside them). – Artfaith Jun 05 '21 at 22:51
  • 1
    "the last newline is trimmed" incorrectly implies that command substitution trims at most one trailing newline, when, in reality, "sequences of one or more characters at the end of the substitution" are removed. – POSIX – Robin A. Meade Jul 17 '21 at 20:25
12

output=$(head $file) keeps embedded newlines in the value of output, and trims all trailing newlines.

It's how you reference the variable that makes the difference.

Placing the variable reference within double quotes, for example:

echo "$output"

prints the embedded newlines, but not the trailing newlines, which were deleted by the command expansion $(...).

This works because the shell interprets only dollar sign, command expansion (back quotes and $(...)), and back slashes within double quotes; the shell does not interpret whitespace (including newlines) as field separators when inside double quotes.

RobertL
  • 6,780
3

To also preserve the exit status:

output=$(head < "$file"; r=$?; echo /; exit "$r")
exit_status=$?
output=${output%/}

Note that using / is safer than x as there are some character sets used by some locales where the encoding of some characters end in the encoding of x (while the encoding of / would generally not be found in other characters as that would make path lookup problematic for instance).

Stéphane Chazelas
  • 544,893