aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/echo.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc_src/echo.txt')
-rw-r--r--doc_src/echo.txt67
1 files changed, 44 insertions, 23 deletions
diff --git a/doc_src/echo.txt b/doc_src/echo.txt
index 01ddf5a5..75e9ce10 100644
--- a/doc_src/echo.txt
+++ b/doc_src/echo.txt
@@ -1,39 +1,60 @@
\section echo echo - display a line of text
\subsection echo-synopsis Synopsis
- <tt>echo [STRING]</tt>
+\fish{synopsis}
+echo [OPTIONS] [STRING]
+\endfish
\subsection echo-description Description
-\c echo displays a string of text.
+`echo` displays a string of text.
The following options are available:
-- \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
+- `-n`, Do not output a newline
+
+- `-s`, Do not separate arguments with spaces
+
+- `-E`, Disable interpretation of backslash escapes (default)
+
+- `-e`, Enable interpretation of backslash escapes
\subsection echo-escapes Escape Sequences
-If \c -e is used, 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)
+If `-e` is used, the following sequences are recognized:
+
+- `\` 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
+\fish
+echo 'Hello World'
+\endfish
+Print hello world to stdout
-<tt>echo -e 'Top\\nBottom'</tt> Print Top and Bottom on separate lines, using an escape sequence
+\fish
+echo -e 'Top\nBottom'
+\endfish
+Print Top and Bottom on separate lines, using an escape sequence