Here documents (<<EOF) in Bash Scripting

Introduction

Here documents let you send multiple lines of text or commands to a program easily without typing them one by one.

You want to provide input to a command that reads from standard input.

You need to create a multi-line text file quickly inside a script.

You want to run multiple commands inside another command like ssh or ftp.

You want to write a block of text to a file without using echo many times.

Syntax

Bash Scripting

<<EOF
Your text or commands here
EOF

EOF is a marker and can be any word, but it must match at start and end.

No spaces or tabs allowed before the ending marker (EOF) on its line.

Examples

Sends two lines 'Hello' and 'World' to the cat command which prints them.

Bash Scripting

cat <<EOF
Hello
World
EOF

Uses 'END' instead of 'EOF' as the marker. It works the same way.

Bash Scripting

cat <<END
Line 1
Line 2
END

Single quotes around EOF prevent variable expansion inside the here document.

Bash Scripting

cat <<'EOF'
$HOME is not expanded here
EOF

Sample Program

This script writes two lines into greetings.txt using a here document, then prints the file content.

Bash Scripting

#!/bin/bash
cat <<EOF > greetings.txt
Hello, friend!
Welcome to scripting.
EOF
cat greetings.txt

Important Notes

Make sure the ending marker (EOF) is alone on its line with no spaces or tabs before it.

If you quote the marker like <<'EOF', variables inside won't change to their values.

Here documents are great for feeding input to commands that expect typed input.

Summary

Here documents let you send multiple lines of text or commands easily.

Use <

You can prevent variable expansion by quoting the marker like <<'EOF'.

Practice

1. What is the main purpose of using a here document (<

easy

A. To provide multiple lines of input or text to a command easily

B. To create a new file automatically

C. To run commands in the background

D. To define a function in the script

Solution

1. Step 1: Understand the here document concept

   A here document lets you send multiple lines of text or commands as input to a command in a script.

2. Step 2: Identify the correct purpose

   It is not for creating files, running background commands, or defining functions, but for providing multiline input.

3. Final Answer:

   To provide multiple lines of input or text to a command easily -> Option A

4. Quick Check:

   Here document = multiline input [OK]

Hint: Here documents send blocks of text to commands [OK]

Common Mistakes:

• Thinking it creates files automatically
• Confusing with background job control
• Assuming it defines functions

2. Which of the following is the correct syntax to start a here document in bash?

easy

A. command <

B. <

C. command EOF<<

D. << command EOF

Solution

1. Step 1: Recall the here document syntax

   The correct syntax places the command first, then <

2. Step 2: Match the options

   Only command <

3. Final Answer:

   command < -> Option A

4. Quick Check:

   Command before <

Hint: Command comes before <

Common Mistakes:

• Putting <
• Swapping EOF and <<
• Adding spaces incorrectly

3. What will be the output of this script?

cat <

medium

A. Hello $USER

B. Hello (your username)

C. Syntax error

D. Hello EOF

Solution

1. Step 1: Understand variable expansion in here documents

   Without quotes around EOF, variables like $USER are expanded to their values.

2. Step 2: Predict the output

   The script prints Hello followed by your actual username, not the literal $USER.

3. Final Answer:

   Hello (your username) -> Option B

4. Quick Check:

   Unquoted EOF expands variables [OK]

Hint: Unquoted EOF expands variables inside [OK]

Common Mistakes:

• Expecting $USER to print literally
• Thinking it causes syntax error
• Confusing EOF marker as output

4. Identify the error in this script snippet:

cat <<'EOF'
Hello $USER
EOF

medium

A. The EOF marker should not be quoted

B. EOF must be uppercase

C. Missing semicolon after <<'EOF'

D. Variables inside quoted EOF are not expanded, so $USER prints literally

Solution

1. Step 1: Understand quoting effect on here documents

   Quoting the EOF marker disables variable expansion inside the here document.

2. Step 2: Identify the output behavior

   Because of quotes, $USER prints literally, which may be unexpected.

3. Final Answer:

   Variables inside quoted EOF are not expanded, so $USER prints literally -> Option D

4. Quick Check:

   Quoted EOF disables variable expansion [OK]

Hint: Quoted EOF means no variable expansion [OK]

Common Mistakes:

• Thinking quotes cause syntax error
• Expecting variables to expand inside quoted EOF
• Believing EOF must be uppercase

5. You want to create a script that sends this exact text to a file, including the literal string $PATH:

Path is: $PATH

Which here document syntax should you use?

hard

A. cat <<"EOF" > file.txt
Path is: $PATH
EOF

B. cat < file.txt
Path is: $PATH
EOF

C. cat <<'EOF' > file.txt
Path is: $PATH
EOF

D. cat < file.txt
Path is: \$PATH
EOF

Solution

1. Step 1: Understand how to prevent variable expansion

   To keep $PATH literal, quote the EOF marker to disable expansion.

2. Step 2: Choose the correct syntax

   Using <<'EOF' prevents $PATH from expanding, so the exact text is written.

3. Final Answer:

   cat <<'EOF' > file.txt Path is: $PATH EOF -> Option C

4. Quick Check:

   Quote EOF to keep variables literal [OK]

Hint: Quote EOF to keep variables literal in output [OK]

Common Mistakes:

• Not quoting EOF and expecting literal $PATH
• Using escape \$PATH inside unquoted EOF
• Using double quotes which still expand variables