mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 16:34:47 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tutorial text for auto-formatted prompt string

Browse source
This commit is contained in:
Marcel Bollmann 2015-03-15 15:11:19 +01:00
parent df2ad6200b
commit f4e908b635
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/tutorial.rst
View file

@ -168,6 +168,9 @@ variable default description
================== =========================== ================================
PROMPT xosh.environ.default_prompt The prompt text, may be str or
function which returns a str.
The str may contain keyword
arguments which are
auto-formatted (see below).
MULTILINE_PROMPT ``'.'`` Prompt text for 2nd+ lines of
input, may be str or
function which returns a str.
@ -182,8 +185,19 @@ BASH_COMPLETIONS ``[] or ['/etc/...']`` This is a list of strings that
dependent, but sane.
================== =========================== ================================
Customizing the prompt is probably the most common reason for altering an
environment variable.
Customizing the prompt is probably the most common reason for altering an
environment variable. To make this easier, you can use keyword
arguments in a prompt string that will get replaced automatically:
.. code-block:: bash
>>> $PROMPT = '{user}@{hostname}:{cwd} > '
snail@home:~ > # it works!
You can also color your prompt easily by inserting keywords such as ``{GREEN}``
or ``{BOLD_BLUE}`` -- for the full list of keyword arguments, refer to the API
documentation of :py:func:`xonsh.environ.format_prompt`.
Environment Lookup with ``${}``
================================