Add section on win_unicode_console to windiws.rst

This commit is contained in:
Morten Enemark Lund 2016-03-06 22:20:30 +01:00
parent 2061157597
commit 76bd9c66c6

View file

@ -66,6 +66,10 @@ Next, run xonsh:
Usage
================
Name space conflicts
--------------------
Due to ambiguity with the Python ``dir`` builtin, to list the current
directory via the ``cmd.exe`` builtin you must explicitly request
the ``.``, like this:
@ -95,3 +99,22 @@ typing and avoid the ambiguity altogether:
You can add aliases to your ``~/.xonshrc`` to have it always
available when xonsh starts.
Unicode support for Windows
----------------------------
Python's utf-8 unicode is not compatible with the default shell 'cmd.exe' on Windows. The package ``win_unicode_console`` fixes this. Xonsh will use ``win_unicode_console`` if it is installed. This can be disabled/enabled with the ``$WIN_UNICODE_CONSOLE``` environment variable.
.. note:: Even with unicode support enabled the symbols available will depend on the font used in cmd.exe.
The packages ``win_unicode_console`can be installed using pip or conda.
.. code-block:: bat
> pip install win_unicode_console
.. code-block:: bat
> conda install --channel xonsh win_unicode_console