aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/index.hdr.in
diff options
context:
space:
mode:
authorGravatar David Adam <zanchey@ucc.gu.uwa.edu.au>2014-08-03 18:45:03 +0800
committerGravatar David Adam <zanchey@ucc.gu.uwa.edu.au>2014-08-03 18:54:10 +0800
commit8844f0c142ade7d6dfea20fc65432b4f97fb92c9 (patch)
tree2918f2a3d6063afa66355389ee7c01b79e2ed060 /doc_src/index.hdr.in
parent6cabd42ed2da1d48f34ba194f9311362996e47a3 (diff)
Clarify I/O redirection documentation
Fix the examples and try and improve the clarity of the section. Closes #1409.
Diffstat (limited to 'doc_src/index.hdr.in')
-rw-r--r--doc_src/index.hdr.in27
1 files changed, 14 insertions, 13 deletions
diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in
index 758a597b..a71bae4a 100644
--- a/doc_src/index.hdr.in
+++ b/doc_src/index.hdr.in
@@ -168,16 +168,16 @@ default through a simple mechanism called a redirection.
An example of a file redirection is <code> echo hello \>output.txt</code>,
which directs the output of the echo command to the file output.txt.
-- To redirect standard input, write <code>\<SOURCE_FILE</code>
-- To redirect standard output, write <code>\>DESTINATION</code>
-- To redirect standard error, write <code>^DESTINATION</code>
-- To redirect standard output to a file which will be appended, write <code>\>\>DESTINATION_FILE</code>
-- To redirect standard error to a file which will be appended, write <code>^^DESTINATION_FILE</code>
+- To read standard input from a file, write <code>\<SOURCE_FILE</code>
+- To write standard output to a file, write <code>\>DESTINATION</code>
+- To write standard error to a file, write <code>^DESTINATION</code>
+- To append standard output to a file, write <code>\>\>DESTINATION_FILE</code>
+- To append standard error to a file, write <code>^^DESTINATION_FILE</code>
<code>DESTINATION</code> can be one of the following:
- A filename. The output will be written to the specified file.
-- An ampersand (\&) followed by the number of another file descriptor. The file descriptor will be a duplicate of the specified file descriptor.
+- An ampersand (\&) followed by the number of another file descriptor. The output will be written to that file descriptor instead.
- An ampersand followed by a minus sign (\&-). The file descriptor will be closed.
Example:
@@ -186,15 +186,16 @@ To redirect both standard output and standard error to the file
all_output.txt, you can write <code>echo Hello \>all_output.txt
^\&1</code>.
-Any FD can be redirected in an arbitrary way by prefixing the
-redirection with the number of the FD.
+Any file descriptor can be redirected in an arbitrary way by prefixing the
+redirection with the file descriptor.
-- To redirect input of FD number N, write <code>N\<DESTINATION</code>
-- To redirect output of FD number N, write <code>N\>DESTINATION</code>
-- To redirect output of FD number N to a file which will be appended, write <code>N\>\>DESTINATION_FILE</code>
+- To redirect input of FD N, write <code>N\<DESTINATION</code>
+- To redirect output of FD N, write <code>N\>DESTINATION</code>
+- To append the output of FD N to a file, write <code>N\>\>DESTINATION_FILE</code>
-Example: <code>echo Hello 2\>-</code> and <code>echo Hello ^-</code> are
-equivalent.
+Example: <code>echo Hello 2\>output.stderr</code> and <code>echo Hello
+^output.stderr</code> are equivalent, and write the standard error (file
+descriptor 2) of the target program to <code>output.stderr</code>.
\subsection piping Piping