aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/echo.txt
diff options
context:
space:
mode:
authorGravatar ridiculousfish <corydoras@ridiculousfish.com>2013-03-05 17:37:44 -0800
committerGravatar ridiculousfish <corydoras@ridiculousfish.com>2013-03-05 17:37:44 -0800
commitb2012467b327db8d518f2b01eed3d529609f7349 (patch)
tree7e53f8b732c434f8c26db3648fd35af16cd81690 /doc_src/echo.txt
parentdaf5ef1bbd4b8ceb005294c512004010010897b8 (diff)
Document -e and -E flags for echo, and provide some examples
Diffstat (limited to 'doc_src/echo.txt')
-rw-r--r--doc_src/echo.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc_src/echo.txt b/doc_src/echo.txt
index 697e88ae..cfa9849e 100644
--- a/doc_src/echo.txt
+++ b/doc_src/echo.txt
@@ -9,8 +9,29 @@ Display a line of text.
- \c -n, \c Do not output a newline
- \c -s, \c Do not separate arguments with spaces
+- \c -E, \c Disable interpretation of backslash escapes (default)
+- \c -e, \c Enable interpretation of backslash escapes
- \c -h, \c --help Display this help
+\subsection echo-escapes Escape Sequences
+
+If -e is in effect, the following sequences are recognized:
+
+- \c \\\\ \c backslash
+- \\a alert (BEL)
+- \\b backspace
+- \\c produce no further output
+- \\e escape
+- \\f form feed
+- \\n new line
+- \\r carriage return
+- \\t horizontal tab
+- \\v vertical tab
+- \\0NNN byte with octal value NNN (1 to 3 digits)
+- \\xHH byte with hexadecimal value HH (1 to 2 digits)
+
\subsection echo-example Example
<tt>echo 'Hello World'</tt> Print hello world to stdout
+
+<tt>echo -e 'Top\\nBottom'</tt> Print Top and Bottom on separate lines, using an escape sequence