fish-shell/doc_src/cmds/echo.rst
Fabian Boehm 38b24c2325 docs: Use :doc: role when linking to commands
This makes it so we link to the very top of the document instead of a
special anchor we manually include.

So clicking e.g. :doc:`string <cmds/string>` will link you to
cmds/string.html instead of cmds/string.html#cmd-string.

I would love to have a way to say "this document from the root of the
document path", but that doesn't appear to work, I tried
`/cmds/string`.

So we'll just have to use cmds/string in normal documents and plain
`string` from other commands.
2022-09-24 10:56:43 +02: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 :doc:`printf <printf>` command, for more control over output formatting