Skip to content

Commit

Permalink
minor #5031 Reworded the note about Windows console and output colori…
Browse files Browse the repository at this point in the history
…ng (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Reworded the note about Windows console and output coloring

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3+
| Fixed tickets | -

Two changes:

  * The note about *"Windows + Console colors"* is moved to the section that explains console colors.
  * The note itself is reworded to be a bit more friendly.

Commits
-------

ec85112 Suggested ConEmu in addition to ANSICON to solve the Windows coloring limitation
71f30a2 Minor rewording
59624f6 Reworded the note about Windows console and output coloring
  • Loading branch information
weaverryan committed Mar 14, 2015
2 parents df72862 + ec85112 commit 5eb52e3
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions components/console/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,6 @@ You can install the component in 2 different ways:
* :doc:`Install it via Composer </components/using_components>` (``symfony/console`` on `Packagist`_);
* Use the official Git repository (https://github.com/symfony/Console).

.. note::

Windows does not support ANSI colors by default so the Console component detects and
disables colors where Windows does not have support. However, if Windows is not
configured with an ANSI driver and your console commands invoke other scripts which
emit ANSI color sequences, they will be shown as raw escape characters.

To enable ANSI color support for Windows, please install `ANSICON`_.

Creating a basic Command
------------------------

Expand Down Expand Up @@ -124,6 +115,14 @@ This prints::
Coloring the Output
~~~~~~~~~~~~~~~~~~~

.. note::

By default, the Windows command console doesn't support output coloring. The
Console component disables output coloring for Windows systems, but if your
commands invoke other scripts which emit color sequences, they will be
wrongly displayed as raw escape characters. Install the `ConEmu`_ or `ANSICON`_
free applications to add coloring support to your Windows command console.

Whenever you output text, you can surround the text with tags to color its
output. For example::

Expand Down Expand Up @@ -506,4 +505,5 @@ Learn More!
* :doc:`/components/console/console_arguments`

.. _Packagist: https://packagist.org/packages/symfony/console
.. _ConEmu: https://code.google.com/p/conemu-maximus5/
.. _ANSICON: https://github.com/adoxa/ansicon/releases

0 comments on commit 5eb52e3

Please sign in to comment.