fish-shell/doc_src/cmds/echo.rst

.. _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

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
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-echo:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`echo - display a line of text`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`=============================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
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 09:59:04 +00:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
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 09:59:04 +00:00			`echo [OPTIONS] [STRING]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``echo`` displays a string of text.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`The following options are available:`

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-n``, Do not output a newline
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-s``, Do not separate arguments with spaces
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-E``, Disable interpretation of backslash escapes (default)
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-e``, Enable interpretation of backslash escapes
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Document that echo takes `--` [ci skip] 2020-08-19 17:00:20 +00:00			Unlike other shells, this echo accepts ``--`` to signal the end of the options.

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Escape Sequences`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`----------------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			If ``-e`` is used, the following sequences are recognized:
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\`` backslash
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\a`` alert (BEL)
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\b`` backspace
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\c`` produce no further output
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\e`` escape
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\f`` form feed
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\n`` new line
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\r`` carriage return
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\t`` horizontal tab
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\v`` vertical tab
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\0NNN`` byte with octal value NNN (1 to 3 digits)
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``\xHH`` byte with hexadecimal value HH (1 to 2 digits)
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`::`

Document that echo takes `--` [ci skip] 2020-08-19 17:00:20 +00:00			`> echo 'Hello World'`
			`Hello World`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
docs: Use \ instead of \\ in examples (#7286) Instead of informing the bell character (hex 07), the example was using an escaped \ followed by x07. $ echo \\x07 \x07 $ echo \x07 $ echo \x07 \| od -a 0000000 bel nl 0000002 $ * docs: Use \u instead of \\u Instead of informing the Unicode character 慡, this example was using an escaped \ followed by u6161. $ echo \\u6161 \u6161 $ echo \u6161 慡 Before: $ string escape --style=var 'a1 b2'\\u6161 \| string unescape --style=var a1 b2\u6161 Now: $ string escape --style=var 'a1 b2'\u6161 \| string unescape --style=var a1 b2慡 2020-08-26 16:29:03 +00:00			`> echo -e 'Top\nBottom'`
Document that echo takes `--` [ci skip] 2020-08-19 17:00:20 +00:00			`Top`
			`Bottom`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
Document that echo takes `--` [ci skip] 2020-08-19 17:00:20 +00:00			`> echo -- -n`
			`-n`
doc: add interlinks between `echo` ←→ `printf` commands 2020-03-01 12:43:14 +00:00
			`See Also`
			`--------`

			- the :ref:`printf <cmd-printf>` command, for more control over output formatting