Skip to content

Commit

Permalink
Topic escape characters (ros2#3802)
Browse files Browse the repository at this point in the history
* doc fix for rcutils environmental variables.

* RCUTILS_CONSOLE_OUTPUT_FORMAT escape sequences support table.

Signed-off-by: Tomoya.Fujita <Tomoya.Fujita@sony.com>
  • Loading branch information
fujitatomoya committed Sep 15, 2023
1 parent 4b87388 commit c1837c4
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion source/Tutorials/Demos/Logging-and-logger-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ Restart the demo including the following command line arguments:
Console output formatting
^^^^^^^^^^^^^^^^^^^^^^^^^

If you would like more or less verbose formatting, you can use RCUTILS_CONSOLE_OUTPUT_FORMAT environment variable.
If you would like more or less verbose formatting, you can use the ``RCUTILS_CONSOLE_OUTPUT_FORMAT`` environment variable.
For example, to additionally get the timestamp and location of the log calls, stop the demo and restart it with the environment variable set:

.. tabs::
Expand Down Expand Up @@ -406,6 +406,24 @@ For example, to additionally get the timestamp and location of the log calls, st
You should see the timestamp in seconds and the function name, filename and line number additionally printed with each message.
*The ``time`` option is only supported as of the ROS 2 Bouncy release.*

``RCUTILS_CONSOLE_OUTPUT_FORMAT`` also supports the following escape character syntax.

.. list-table::
:header-rows: 1

* - Escape character syntax
- Character represented
* - ``\a``
- Alert
* - ``\b``
- Backspace
* - ``\n``
- New line
* - ``\r``
- Carriage return
* - ``\t``
- Horizontal tab

Console output colorizing
^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit c1837c4

Please sign in to comment.