fish-shell/doc_src/cmds/echo.rst
David Adam e23e52a8e9 docs: standardise on definition lists for options
Harmonizes the option listing including formatting in a similar manner to the
synopsis of each entry.
2022-03-12 00:21:12 +08:00

81 lines
1.2 KiB
ReStructuredText

.. _cmd-echo:
echo - display a line of text
=============================
Synopsis
--------
.. synopsis::
echo [OPTIONS] [STRING]
Description
-----------
``echo`` displays *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.
Unlike other shells, this echo accepts ``--`` to signal the end of the options.
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'
Hello World
> echo -e 'Top\nBottom'
Top
Bottom
> echo -- -n
-n
See Also
--------
- the :ref:`printf <cmd-printf>` command, for more control over output formatting