fish-shell/sphinx_doc_src/cmds/echo.rst
David Adam 02d82dcf85 docs: update all command synopsis formatting
Adds synopses for those commands missing them.

Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as
fish code may not be the ideal appearance.
2019-09-17 17:59:04 +08:00

75 lines
1.0 KiB
ReStructuredText

.. _cmd-echo:
echo - display a line of text
=============================
Synopsis
--------
::
echo [OPTIONS] [STRING]
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
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)
Example
-------
::
echo 'Hello World'
Print hello world to stdout
::
echo -e 'Top\\nBottom'
Print Top and Bottom on separate lines, using an escape sequence