How can I write a heredoc to a file in Bash script

问题:

How can I write a here document to a file in Bash script?

回答1:

Read the Advanced Bash-Scripting Guide Chapter 19. Here Documents.

Here\'s an example which will write the contents to a file at /tmp/yourfilehere

cat << EOF > /tmp/yourfilehere
These contents will be written to the file.
        This line is indented.
EOF

Note that the final \'EOF\' (The LimitString) should not have any whitespace in front of the word, because it means that the LimitString will not be recognized.

In a shell script, you may want to use indentation to make the code readable, however this can have the undesirable effect of indenting the text within your here document. In this case, use <<- (followed by a dash) to disable leading tabs (Note that to test this you will need to replace the leading whitespace with a tab character, since I cannot print actual tab characters here.)

#!/usr/bin/env bash

if true ; then
    cat <<- EOF > /tmp/yourfilehere
    The leading tab is ignored.
    EOF
fi

If you don\'t want to interpret variables in the text, then use single quotes:

cat << \'EOF\' > /tmp/yourfilehere
The variable $FOO will not be interpreted.
EOF

To pipe the heredoc through a command pipeline:

cat <<\'EOF\' |  sed \'s/a/b/\'
foo
bar
baz
EOF

Output:

foo
bbr
bbz

... or to write the the heredoc to a file using sudo:

cat <<\'EOF\' |  sed \'s/a/b/\' | sudo tee /etc/config_file.conf
foo
bar
baz
EOF

回答2:

Instead of using cat and I/O redirection it might be useful to use tee instead:

tee newfile <<EOF
line 1
line 2
line 3
EOF

It\'s more concise, plus unlike the redirect operator it can be combined with sudo if you need to write to files with root permissions.

回答3:

Note:

• the following condenses and organizes other answers in this thread, esp the excellent work of Stefan Lasiewski and Serge Stroobandt
• Lasiewski and I recommend Ch 19 (Here Documents) in the Advanced Bash-Scripting Guide

The question (how to write a here document (aka heredoc) to a file in a bash script?) has (at least) 3 main independent dimensions or subquestions:

1. Do you want to overwrite an existing file, append to an existing file, or write to a new file?
2. Does your user or another user (e.g., root) own the file?
3. Do you want to write the contents of your heredoc literally, or to have bash interpret variable references inside your heredoc?

(There are other dimensions/subquestions which I don\'t consider important. Consider editing this answer to add them!) Here are some of the more important combinations of the dimensions of the question listed above, with various different delimiting identifiers--there\'s nothing sacred about EOF, just make sure that the string you use as your delimiting identifier does not occur inside your heredoc:

1. To overwrite an existing file (or write to a new file) that you own, substituting variable references inside the heredoc:

   cat << EOF > /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   EOF
   

2. To append an existing file (or write to a new file) that you own, substituting variable references inside the heredoc:

   cat << FOE >> /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   FOE
   

3. To overwrite an existing file (or write to a new file) that you own, with the literal contents of the heredoc:

   cat << \'END_OF_FILE\' > /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   END_OF_FILE
   

4. To append an existing file (or write to a new file) that you own, with the literal contents of the heredoc:

   cat << \'eof\' >> /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   eof
   

5. To overwrite an existing file (or write to a new file) owned by root, substituting variable references inside the heredoc:

   cat << until_it_ends | sudo tee /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, with the variable contents substituted.
   until_it_ends
   

6. To append an existing file (or write to a new file) owned by user=foo, with the literal contents of the heredoc:

   cat << \'Screw_you_Foo\' | sudo -u foo tee -a /path/to/your/file
   This line will write to the file.
   ${THIS} will also write to the file, without the variable contents substituted.
   Screw_you_Foo
   

回答4:

To build on @Livven\'s answer, here are some useful combinations.

1. variable substitution, leading tab retained, overwrite file, echo to stdout

   tee /path/to/file <<EOF
   ${variable}
   EOF
   

2. no variable substitution, leading tab retained, overwrite file, echo to stdout

   tee /path/to/file <<\'EOF\'
   ${variable}
   EOF
   

3. variable substitution, leading tab removed, overwrite file, echo to stdout

   tee /path/to/file <<-EOF
       ${variable}
   EOF
   

4. variable substitution, leading tab retained, append to file, echo to stdout

   tee -a /path/to/file <<EOF
   ${variable}
   EOF
   

5. variable substitution, leading tab retained, overwrite file, no echo to stdout

   tee /path/to/file <<EOF >/dev/null
   ${variable}
   EOF
   

6. the above can be combined with sudo as well

   sudo -u USER tee /path/to/file <<EOF
   ${variable}
   EOF
   

回答5:

When root permissions are required

When root permissions are required for the destination file, use |sudo tee instead of >:

cat << \'EOF\' |sudo tee /tmp/yourprotectedfilehere
The variable $FOO will *not* be interpreted.
EOF

回答6:

For future people who may have this issue the following format worked:

(cat <<- _EOF_
        LogFile /var/log/clamd.log
        LogTime yes
        DatabaseDirectory /var/lib/clamav
        LocalSocket /tmp/clamd.socket
        TCPAddr 127.0.0.1
        SelfCheck 1020
        ScanPDF yes
        _EOF_
) > /etc/clamd.conf

回答7:

As instance you could use it:

First(making ssh connection):

while read pass port user ip files directs; do
    sshpass -p$pass scp -o \'StrictHostKeyChecking no\' -P $port $files $user@$ip:$directs
done <<____HERE
    PASS    PORT    USER    IP    FILES    DIRECTS
      .      .       .       .      .         .
      .      .       .       .      .         .
      .      .       .       .      .         .
    PASS    PORT    USER    IP    FILES    DIRECTS
____HERE

Second(executing commands):

while read pass port user ip; do
    sshpass -p$pass ssh -p $port $user@$ip <<ENDSSH1
    COMMAND 1
    .
    .
    .
    COMMAND n
ENDSSH1
done <<____HERE
    PASS    PORT    USER    IP
      .      .       .       .
      .      .       .       .
      .      .       .       .
    PASS    PORT    USER    IP    
____HERE

Third(executing commands):

Script=$\'
#Your commands
\'

while read pass port user ip; do
    sshpass -p$pass ssh -o \'StrictHostKeyChecking no\' -p $port $user@$ip \"$Script\"

done <<___HERE
PASS    PORT    USER    IP
  .      .       .       .
  .      .       .       .
  .      .       .       .
PASS    PORT    USER    IP  
___HERE

Forth(using variables):

while read pass port user ip fileoutput; do
    sshpass -p$pass ssh -o \'StrictHostKeyChecking no\' -p $port $user@$ip fileinput=$fileinput \'bash -s\'<<ENDSSH1
    #Your command > $fileinput
    #Your command > $fileinput
ENDSSH1
done <<____HERE
    PASS    PORT    USER    IP      FILE-OUTPUT
      .      .       .       .          .
      .      .       .       .          .
      .      .       .       .          .
    PASS    PORT    USER    IP      FILE-OUTPUT
____HERE

回答8:

I like this method for concision, readability and presentation in an indented script:

<<-End_of_file >file
→       foo bar
End_of_file

Where →        is a tab character.