mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-14 17:07:44 +00:00
5e880bb1c3
This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages.
75 lines
1.2 KiB
ReStructuredText
75 lines
1.2 KiB
ReStructuredText
.. _cmd-echo:
|
|
|
|
echo - display a line of text
|
|
=============================
|
|
|
|
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
|