fish-shell/doc_src/echo.txt

\section echo echo - display a line of text

\subsection echo-synopsis Synopsis
\fish{synopsis}
echo [OPTIONS] [STRING]
\endfish

\subsection echo-description Description

`echo` displays a string of text.

The following options are available:

- `-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 `-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

\fish
echo 'Hello World'
# Print hello world to stdout

echo -e 'Top\nBottom'
# Print Top and Bottom on separate lines, using an escape sequence
\endfish
Created the man page for echo and test 2012-07-04 05:54:00 +08:00			`\section echo echo - display a line of text`

			`\subsection echo-synopsis Synopsis`
Simplify styling 2014-08-01 20:25:41 +08:00			`\fish{synopsis}`
Tutorial auto colouring, Man page and Make fixes Completely fixes #1557 and the underlying Doxygen changes that caused it. Should make fish docs simpler and more robust, more consistent and generally prettier. todo: - trap unmarked text as arguments in context - test & fix sed portability - see in particular. (so far tested on BSD (Mac) and GNU sed). - test Makefile changes - last round of aesthetic changes and getting that ascii fish in there… 2014-08-08 10:44:37 +08:00			`echo [OPTIONS] [STRING]`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`\endfish`
Created the man page for echo and test 2012-07-04 05:54:00 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`\subsection echo-description Description`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`echo` displays a string of text.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00
			`The following options are available:`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `-n`, Do not output a newline
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `-s`, Do not separate arguments with spaces
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `-E`, Disable interpretation of backslash escapes (default)
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `-e`, Enable interpretation of backslash escapes
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Document -e and -E flags for echo, and provide some examples 2013-03-06 09:37:44 +08:00			`\subsection echo-escapes Escape Sequences`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			If `-e` is used, the following sequences are recognized:

			- `\` backslash
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\a` alert (BEL)
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\b` backspace
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\c` produce no further output
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\e` escape
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\f` form feed
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\n` new line
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\r` carriage return
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\t` horizontal tab
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\v` vertical tab
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\0NNN` byte with octal value NNN (1 to 3 digits)
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `\xHH` byte with hexadecimal value HH (1 to 2 digits)
Document -e and -E flags for echo, and provide some examples 2013-03-06 09:37:44 +08:00
Created the man page for echo and test 2012-07-04 05:54:00 +08:00			`\subsection echo-example Example`

Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`\fish`
			`echo 'Hello World'`
			`# Print hello world to stdout`
Document -e and -E flags for echo, and provide some examples 2013-03-06 09:37:44 +08:00
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`echo -e 'Top\nBottom'`
			`# Print Top and Bottom on separate lines, using an escape sequence`
			`\endfish`