📄 here-docs.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><HTML><HEAD><TITLE>Here Documents</TITLE><METANAME="GENERATOR"CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINKREL="HOME"TITLE="Advanced Bash-Scripting Guide"HREF="index.html"><LINKREL="UP"TITLE="Beyond the Basics"HREF="part3.html"><LINKREL="PREVIOUS"TITLE="Applications"HREF="redirapps.html"><LINKREL="NEXT"TITLE="Recess Time"HREF="recess-time.html"><METAHTTP-EQUIV="Content-Style-Type"CONTENT="text/css"><LINKREL="stylesheet"HREF="common/kde-common.css"TYPE="text/css"><METAHTTP-EQUIV="Content-Type"CONTENT="text/html; charset=iso-8859-1"><METAHTTP-EQUIV="Content-Language"CONTENT="en"><LINKREL="stylesheet"HREF="common/kde-localised.css"TYPE="text/css"TITLE="KDE-English"><LINKREL="stylesheet"HREF="common/kde-default.css"TYPE="text/css"TITLE="KDE-Default"></HEAD><BODYCLASS="CHAPTER"BGCOLOR="#FFFFFF"TEXT="#000000"LINK="#AA0000"VLINK="#AA0055"ALINK="#AA0000"STYLE="font-family: sans-serif;"><DIVCLASS="NAVHEADER"><TABLEWIDTH="100%"BORDER="0"CELLPADDING="0"CELLSPACING="0"><TR><THCOLSPAN="3"ALIGN="center">Advanced Bash-Scripting Guide: An in-depth exploration of the art of shell scripting</TH></TR><TR><TDWIDTH="10%"ALIGN="left"VALIGN="bottom"><AHREF="redirapps.html">Prev</A></TD><TDWIDTH="80%"ALIGN="center"VALIGN="bottom"></TD><TDWIDTH="10%"ALIGN="right"VALIGN="bottom"><AHREF="recess-time.html">Next</A></TD></TR></TABLE><HRALIGN="LEFT"WIDTH="100%"></DIV><DIVCLASS="CHAPTER"><H1><ANAME="HERE-DOCS">Chapter 17. Here Documents</A></H1><TABLEBORDER="0"WIDTH="100%"CELLSPACING="0"CELLPADDING="0"CLASS="EPIGRAPH"><TR><TDWIDTH="45%"> </TD><TDWIDTH="45%"ALIGN="LEFT"VALIGN="TOP"><I><P><I>Here and now, boys.</I></P></I></TD></TR><TR><TDWIDTH="45%"> </TD><TDWIDTH="45%"ALIGN="RIGHT"VALIGN="TOP"><I><SPANCLASS="ATTRIBUTION">Aldous Huxley, <SPANCLASS="QUOTE">"Island"</SPAN></SPAN></I></TD></TR></TABLE><P><ANAME="HEREDOCREF"></A></P><P>A <ICLASS="FIRSTTERM">here document</I> is a special-purpose code block. It uses a form of <AHREF="io-redirection.html#IOREDIRREF">I/O redirection</A> to feed a command list to an interactive program or a command, such as <AHREF="communications.html#FTPREF">ftp</A>, <AHREF="external.html#CATREF">cat</A>, or the <ICLASS="FIRSTTERM">ex</I> text editor.</P><P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 COMMAND <<InputComesFromHERE 2 ... 3 InputComesFromHERE</PRE></TD></TR></TABLE></P><P>A <ICLASS="FIRSTTERM">limit string</I> delineates (frames) the command list. The special symbol <SPANCLASS="TOKEN"><<</SPAN> designates the limit string. This has the effect of redirecting the output of a file into the <TTCLASS="FILENAME">stdin</TT> of the program or command. It is similar to <TTCLASS="USERINPUT"><B>interactive-program < command-file</B></TT>, where <TTCLASS="FILENAME">command-file</TT> contains <TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 command #1 2 command #2 3 ...</PRE></TD></TR></TABLE></P><P>The <ICLASS="EMPHASIS">here document</I> alternative looks like this:</P><P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 interactive-program <<LimitString 3 command #1 4 command #2 5 ... 6 LimitString</PRE></TD></TR></TABLE></P><P>Choose a <ICLASS="EMPHASIS">limit string</I> sufficiently unusual that it will not occur anywhere in the command list and confuse matters.</P><P>Note that <ICLASS="EMPHASIS">here documents</I> may sometimes be used to good effect with non-interactive utilities and commands, such as, for example, <AHREF="system.html#WALLREF">wall</A>.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX70"></A><P><B>Example 17-1. <BCLASS="COMMAND">broadcast</B>: Sends message to everyone logged in</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 3 wall <<zzz23EndOfMessagezzz23 4 E-mail your noontime orders for pizza to the system administrator. 5 (Add an extra dollar for anchovy or mushroom topping.) 6 # Additional message text goes here. 7 # Note: 'wall' prints comment lines. 8 zzz23EndOfMessagezzz23 9 10 # Could have been done more efficiently by 11 # wall <message-file 12 # However, embedding the message template in a script 13 #+ is a quick-and-dirty one-off solution. 14 15 exit 0</PRE></TD></TR></TABLE><HR></DIV><P>Even such unlikely candidates as <ICLASS="FIRSTTERM">vi</I> lend themselves to <ICLASS="EMPHASIS">here documents</I>.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX69"></A><P><B>Example 17-2. <BCLASS="COMMAND">dummyfile</B>: Creates a 2-line dummy file</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 3 # Non-interactive use of 'vi' to edit a file. 4 # Emulates 'sed'. 5 6 E_BADARGS=65 7 8 if [ -z "$1" ] 9 then 10 echo "Usage: `basename $0` filename" 11 exit $E_BADARGS 12 fi 13 14 TARGETFILE=$1 15 16 # Insert 2 lines in file, then save. 17 #--------Begin here document-----------# 18 vi $TARGETFILE <<x23LimitStringx23 19 i 20 This is line 1 of the example file. 21 This is line 2 of the example file. 22 ^[ 23 ZZ 24 x23LimitStringx23 25 #----------End here document-----------# 26 27 # Note that ^[ above is a literal escape 28 #+ typed by Control-V <Esc>. 29 30 # Bram Moolenaar points out that this may not work with 'vim', 31 #+ because of possible problems with terminal interaction. 32 33 exit 0</PRE></TD></TR></TABLE><HR></DIV><P> The above script could just as effectively have been implemented with <BCLASS="COMMAND">ex</B>, rather than <BCLASS="COMMAND">vi</B>. <ICLASS="EMPHASIS">Here documents</I> containing a list of <BCLASS="COMMAND">ex</B> commands are common enough to form their own category, known as <ICLASS="FIRSTTERM">ex scripts</I>. <TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 # Replace all instances of "Smith" with "Jones" 3 #+ in files with a ".txt" filename suffix. 4 5 ORIGINAL=Smith 6 REPLACEMENT=Jones 7 8 for word in $(fgrep -l $ORIGINAL *.txt) 9 do 10 # ------------------------------------- 11 ex $word <<EOF 12 :%s/$ORIGINAL/$REPLACEMENT/g 13 :wq 14 EOF 15 # :%s is the "ex" substitution command. 16 # :wq is write-and-quit. 17 # ------------------------------------- 18 done</PRE></TD></TR></TABLE> </P><P><ANAME="CATSCRIPTREF"></A></P><P>Analogous to <SPANCLASS="QUOTE">"ex scripts"</SPAN> are <ICLASS="FIRSTTERM">cat scripts</I>.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX71"></A><P><B>Example 17-3. Multi-line message using <BCLASS="COMMAND">cat</B></B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 3 # 'echo' is fine for printing single line messages, 4 #+ but somewhat problematic for for message blocks. 5 # A 'cat' here document overcomes this limitation. 6 7 cat <<End-of-message 8 ------------------------------------- 9 This is line 1 of the message. 10 This is line 2 of the message. 11 This is line 3 of the message. 12 This is line 4 of the message. 13 This is the last line of the message. 14 ------------------------------------- 15 End-of-message 16 17 # Replacing line 7, above, with 18 #+ cat > $Newfile <<End-of-message 19 #+ ^^^^^^^^^^ 20 #+ writes the output to the file $Newfile, rather than to stdout. 21 22 exit 0 23 24 25 #-------------------------------------------- 26 # Code below disabled, due to "exit 0" above. 27 28 # S.C. points out that the following also works. 29 echo "------------------------------------- 30 This is line 1 of the message. 31 This is line 2 of the message. 32 This is line 3 of the message. 33 This is line 4 of the message. 34 This is the last line of the message. 35 -------------------------------------" 36 # However, text may not include double quotes unless they are escaped.</PRE></TD></TR></TABLE><HR></DIV><P>The <TTCLASS="OPTION">-</TT> option to mark a here document limit string (<TTCLASS="USERINPUT"><B><<-LimitString</B></TT>) suppresses leading tabs (but not spaces) in the output. This may be useful in making a script more readable.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX71A"></A><P><B>Example 17-4. Multi-line message, with tabs suppressed</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 # Same as previous example, but... 3 4 # The - option to a here document <<- 5 #+ suppresses leading tabs in the body of the document, 6 #+ but *not* spaces. 7 8 cat <<-ENDOFMESSAGE 9 This is line 1 of the message. 10 This is line 2 of the message. 11 This is line 3 of the message. 12 This is line 4 of the message. 13 This is the last line of the message. 14 ENDOFMESSAGE 15 # The output of the script will be flush left. 16 # Leading tab in each line will not show. 17 18 # Above 5 lines of "message" prefaced by a tab, not spaces. 19 # Spaces not affected by <<- . 20 21 # Note that this option has no effect on *embedded* tabs. 22 23 exit 0</PRE></TD></TR></TABLE><HR></DIV><P>A <ICLASS="EMPHASIS">here document</I> supports parameter and command substitution. It is therefore possible to pass different parameters to the body of the here document, changing its output accordingly.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX71B"></A><P><B>Example 17-5. Here document with parameter substitution</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 # Another 'cat' here document, using parameter substitution. 3 4 # Try it with no command line parameters, ./scriptname 5 # Try it with one command line parameter, ./scriptname Mortimer 6 # Try it with one two-word quoted command line parameter, 7 # ./scriptname "Mortimer Jones" 8 9 CMDLINEPARAM=1 # Expect at least command line parameter. 10 11 if [ $# -ge $CMDLINEPARAM ] 12 then 13 NAME=$1 # If more than one command line param, 14 #+ then just take the first. 15 else 16 NAME="John Doe" # Default, if no command line parameter. 17 fi 18 19 RESPONDENT="the author of this fine script" 20 21 22 cat <<Endofmessage 23 24 Hello, there, $NAME. 25 Greetings to you, $NAME, from $RESPONDENT. 26 27 # This comment shows up in the output (why?). 28 29 Endofmessage 30 31 # Note that the blank lines show up in the output. 32 # So does the "comment". 33 34 exit 0</PRE></TD></TR></TABLE><HR></DIV><P>This is a useful script containing a here document with parameter substitution.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX72"></A><P><B>Example 17-6. Upload a file pair to <SPANCLASS="QUOTE">"Sunsite"</SPAN> incoming directory</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 # upload.sh 3 4 # Upload file pair (Filename.lsm, Filename.tar.gz) 5 #+ to incoming directory at Sunsite/UNC (ibiblio.org). 6 # Filename.tar.gz is the tarball itself. 7 # Filename.lsm is the descriptor file. 8 # Sunsite requires "lsm" file, otherwise will bounce contributions. 9 10 11 E_ARGERROR=65 12 13 if [ -z "$1" ] 14 then 15 echo "Usage: `basename $0` Filename-to-upload" 16 exit $E_ARGERROR 17 fi 18 19 20 Filename=`basename $1` # Strips pathname out of file name. 21 22 Server="ibiblio.org" 23 Directory="/incoming/Linux" 24 # These need not be hard-coded into script, 25 #+ but may instead be changed to command line argument. 26 27 Password="your.e-mail.address" # Change above to suit. 28 29 ftp -n $Server <<End-Of-Session 30 # -n option disables auto-logon 31 32 user anonymous "$Password" 33 binary 34 bell # Ring 'bell' after each file transfer. 35 cd $Directory 36 put "$Filename.lsm" 37 put "$Filename.tar.gz" 38 bye 39 End-Of-Session 40 41 exit 0</PRE></TD></TR></TABLE><HR></DIV><P>Quoting or escaping the <SPANCLASS="QUOTE">"limit string"</SPAN> at the head of a here document disables parameter substitution within its body.</P><DIVCLASS="EXAMPLE"><HR><ANAME="EX71C"></A><P><B>Example 17-7. Parameter substitution turned off</B></P><TABLEBORDER="0"BGCOLOR="#E0E0E0"WIDTH="100%"><TR><TD><PRECLASS="PROGRAMLISTING"> 1 #!/bin/bash 2 # A 'cat' here document, but with parameter substitution disabled. 3 4 NAME="John Doe" 5 RESPONDENT="the author of this fine script" 6 7 cat <<'Endofmessage' 8 9 Hello, there, $NAME. 10 Greetings to you, $NAME, from $RESPONDENT. 11 12 Endofmessage 13 14 # No parameter substitution when the "limit string" is quoted or escaped. 15 # Either of the following at the head of the here document would have the same effect. 16 # cat <<"Endofmessage" 17 # cat <<\Endofmessage 18 19 exit 0</PRE></TD></TR></TABLE><HR></DIV><P>Disabling parameter substitution permits outputting literal text. Generating scripts or even program code is one use for this.</P><DIVCLASS="EXAMPLE"><HR><ANAME="GENERATESCRIPT"></A⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -