<commit_before>***************
Powerline Theme
***************

The included ``themes/powerline/powerline.theme`` file includes two themes:

.. contents::
   :local:

Powerline
*********

The ``powerline`` theme is a clone of the `Powerline prompt`_. It copies the
`default segments`_ of the Powerline prompt for Shell.

This prompt is a proof of (a specific) concept: that Liquidprompt can do what
Powerline does, but faster.
That said, this is a fully usable theme.

.. versionadded:: 2.0

.. _`Powerline prompt`: https://github.com/powerline/powerline
.. _`default segments`: https://github.com/powerline/powerline/blob/2.8/powerline/config_files/themes/shell/default.json

Preview
=======

If there is nothing special about the current context, the appearance of
Powerline might be as simple as this:

.. image:: powerline-short.png
   :alt:  user  ~  

If you are running a background command and are also in the "main" branch of a
Git repository on a server:

.. image:: powerline-med.png
   :alt:   server  user  ~  liquidprompt  1   main  

When Liquidprompt is displaying nearly everything, it may look like this:

.. image:: powerline-long.png
   :alt:   server  user  (e) pyenv  ~ …   code  liquidprompt  3   main  ST 1  125  

.. note::
   The above "everything" image looks like it is missing some parts because this
   theme does not implement all data sources of Liquidprompt. This is by design
   to clone basic Powerline. For a Powerline theme that does show all data
   sources, see :ref:`Powerline Full <powerline_full>` below.

Setup
=====

By default, the dividers and markers used are the Powerline private characters.
You will either need a compatible font, or to configure the dividers and markers
to use other characters.

See the `Powerline Fonts installation docs`_ for help.

.. _`Powerline fonts installation docs`: https://powerline.readthedocs.io/en/latest/installation.html#fonts-installation

Configuation
============

Liquidprompt Configuration
--------------------------
The following Liquidprompt config options are respected:

* :attr:`LP_DISABLED_VCS_PATHS`
* :attr:`LP_ENABLE_BZR`
* :attr:`LP_ENABLE_COLOR`
* :attr:`LP_ENABLE_ERROR`
* :attr:`LP_ENABLE_FOSSIL`
* :attr:`LP_ENABLE_FQDN`
* :attr:`LP_ENABLE_GIT`
* :attr:`LP_ENABLE_HG`
* :attr:`LP_ENABLE_JOBS`
* :attr:`LP_ENABLE_RUNTIME_BELL`
* :attr:`LP_ENABLE_SCREEN_TITLE`
* :attr:`LP_ENABLE_SHORTEN_PATH`
* :attr:`LP_ENABLE_SVN`
* :attr:`LP_ENABLE_TITLE`
* :attr:`LP_ENABLE_VCS_ROOT`
* :attr:`LP_ENABLE_VIRTUALENV`
* :attr:`LP_HOSTNAME_ALWAYS`
* :attr:`LP_PATH_DEFAULT`
* :attr:`LP_PATH_KEEP`
* :attr:`LP_PATH_LENGTH`
* :attr:`LP_RUNTIME_BELL_THRESHOLD`
* :attr:`LP_USER_ALWAYS`

Theme Configuration
-------------------
<commit_msg>Fix Powerline docs on what options it supports<commit_after>***************
Powerline Theme
***************

The included ``themes/powerline/powerline.theme`` file includes two themes:

.. contents::
   :local:

Powerline
*********

The ``powerline`` theme is a clone of the `Powerline prompt`_. It copies the
`default segments`_ of the Powerline prompt for Shell.

This prompt is a proof of (a specific) concept: that Liquidprompt can do what
Powerline does, but faster.
That said, this is a fully usable theme.

.. versionadded:: 2.0

.. _`Powerline prompt`: https://github.com/powerline/powerline
.. _`default segments`: https://github.com/powerline/powerline/blob/2.8/powerline/config_files/themes/shell/default.json

Preview
=======

If there is nothing special about the current context, the appearance of
Powerline might be as simple as this:

.. image:: powerline-short.png
   :alt:  user  ~  

If you are running a background command and are also in the "main" branch of a
Git repository on a server:

.. image:: powerline-med.png
   :alt:   server  user  ~  liquidprompt  1   main  

When Liquidprompt is displaying nearly everything, it may look like this:

.. image:: powerline-long.png
   :alt:   server  user  (e) pyenv  ~ …   code  liquidprompt  3   main  ST 1  125  

.. note::
   The above "everything" image looks like it is missing some parts because this
   theme does not implement all data sources of Liquidprompt. This is by design
   to clone basic Powerline. For a Powerline theme that does show all data
   sources, see :ref:`Powerline Full <powerline_full>` below.

Setup
=====

By default, the dividers and markers used are the Powerline private characters.
You will either need a compatible font, or to configure the dividers and markers
to use other characters.

See the `Powerline Fonts installation docs`_ for help.

.. _`Powerline fonts installation docs`: https://powerline.readthedocs.io/en/latest/installation.html#fonts-installation

Configuation
============

Liquidprompt Configuration
--------------------------
The following Liquidprompt config options are respected:

* :attr:`LP_DISABLED_VCS_PATHS`
* :attr:`LP_ENABLE_BZR`
* :attr:`LP_ENABLE_COLOR`
* :attr:`LP_ENABLE_ERROR`
* :attr:`LP_ENABLE_FOSSIL`
* :attr:`LP_ENABLE_FQDN`
* :attr:`LP_ENABLE_GIT`
* :attr:`LP_ENABLE_HG`
* :attr:`LP_ENABLE_JOBS`
* :attr:`LP_ENABLE_RUNTIME_BELL`
* :attr:`LP_ENABLE_SCREEN_TITLE`
* :attr:`LP_ENABLE_SHORTEN_PATH`
* :attr:`LP_ENABLE_SVN`
* :attr:`LP_ENABLE_TITLE`
* :attr:`LP_ENABLE_VCS_ROOT`
* :attr:`LP_ENABLE_VIRTUALENV`
* :attr:`LP_HOSTNAME_ALWAYS`
* :attr:`LP_PATH_CHARACTER_KEEP`
* :attr:`LP_PATH_KEEP`
* :attr:`LP_PATH_LENGTH`
* :attr:`LP_PATH_METHOD`
* :attr:`LP_PATH_VCS_ROOT`
* :attr:`LP_RUNTIME_BELL_THRESHOLD`
* :attr:`LP_USER_ALWAYS`

Theme Configuration
-------------------

{'fraction_non_alphanumeric': 0.1407593123209169, 'fraction_numerical': 0.0035816618911174787, 'mean_word_length': 4.52970297029703, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1862550', 'n_tokens_mistral': 2036, 'n_tokens_neox': 1936, 'n_words': 595}