Como escrever um heredoc em um arquivo no script Bash?

Como posso escrever um documento aqui em um arquivo no script Bash?

Leia o Advanced Bash-Scripting Guide Capítulo 19. Aqui Documentos .

Aqui está um exemplo que gravará o conteúdo em um arquivo em /tmp/yourfilehere

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

Observe que o 'EOF' final (The LimitString) não deve ter nenhum espaço em branco na frente da palavra, porque isso significa que LimitStringele não será reconhecido.

Em um script de shell, convém usar o recuo para tornar o código legível, no entanto, isso pode ter o efeito indesejável de recuar o texto no documento aqui. Nesse caso, use <<-(seguido de um traço) para desativar as guias iniciais ( observe que para testar isso, você precisará substituir o espaço em branco inicial por um caractere de tabulação , pois não consigo imprimir caracteres de tabulação reais aqui.)

#!/usr/bin/env bash

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

Se você não quiser interpretar variáveis ​​no texto, use aspas simples:

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

Para canalizar o heredoc através de um pipeline de comando:

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

Resultado:

foo
bbr
bbz

... ou para escrever o heredoc em um arquivo usando sudo:

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

Em vez de usar cato redirecionamento de E / S, pode ser útil usá-lo tee:

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

É mais conciso, além do operador de redirecionamento, ele pode ser combinado sudose você precisar gravar em arquivos com permissões de root.

Nota:

• o seguinte condensa e organiza outras respostas neste tópico, especialmente o excelente trabalho de Stefan Lasiewski e Serge Stroobandt
• Lasiewski e eu recomendamos o Capítulo 19 (aqui documentos) no Guia Avançado de Bash-Scripting

A pergunta (como escrever um documento aqui (aka heredoc ) em um arquivo em um script bash?) Tem (pelo menos) três principais dimensões ou subquestões independentes:

1. Deseja sobrescrever um arquivo existente, anexá-lo a um arquivo existente ou gravar em um novo arquivo?
2. Seu usuário ou outro usuário (por exemplo, root) possui o arquivo?
3. Deseja escrever o conteúdo do seu heredoc literalmente ou fazer com que o bash interprete referências de variáveis ​​dentro do seu heredoc?

(Existem outras dimensões / subquestões que não considero importantes. Considere editar esta resposta para adicioná-las!) Aqui estão algumas das combinações mais importantes das dimensões da pergunta listada acima, com vários identificadores de delimitação diferentes - não há nada sagrado EOF, apenas certifique-se de que a string usada como seu identificador delimitante não ocorra dentro do seu heredoc:

1. Para substituir um arquivo existente (ou gravar em um novo arquivo) que você possui, substituindo as referências de variáveis ​​dentro do 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. Para anexar um arquivo existente (ou gravar em um novo arquivo) que você possui, substituindo referências de variáveis ​​dentro do 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. Para substituir um arquivo existente (ou gravar em um novo arquivo) que você possui, com o conteúdo literal do 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. Para anexar um arquivo existente (ou gravar em um novo arquivo) que você possui, com o conteúdo literal do 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. Para substituir um arquivo existente (ou gravar em um novo arquivo) pertencente à raiz, substituindo as referências de variáveis ​​dentro do 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. Para acrescentar um arquivo existente (ou gravar em um novo arquivo) de propriedade de user = foo, com o conteúdo literal do 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

Para aproveitar a resposta de @ Livven , aqui estão algumas combinações úteis.

1. substituição de variável, guia principal retido, sobrescrever arquivo, eco para stdout

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

2. nenhuma substituição de variável , guia principal retida, sobrescrever arquivo, eco para stdout

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

3. substituição de variável, guia inicial removido , sobrescrever arquivo, eco para stdout

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

4. substituição de variável, guia principal retido, anexado ao arquivo , eco ao stdout

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

5. substituição de variável, guia principal retido, sobrescrever arquivo, sem eco para stdout

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

6. o acima pode ser combinado com sudotambém

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

Quando permissões de raiz são necessárias

Quando permissões de raiz são necessárias para o arquivo de destino, use em |sudo teevez de >:

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

Para futuras pessoas que possam ter esse problema, o seguinte formato funcionou:

(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

Como exemplo, você pode usá-lo:

Primeiro (fazendo a conexão ssh):

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

Segundo (executando comandos):

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

Terceiro (executando comandos):

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

Quarto (usando variáveis):

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

Eu gosto deste método para concisão, legibilidade e apresentação em um script recuado:

<<-End_of_file >file
→       foo bar
End_of_file

Onde →       está um tabpersonagem.