From 8bc5bb3ff4368588334cd2b3ad8f362aaad10f87 Mon Sep 17 00:00:00 2001 From: ZyX Date: Sat, 2 Aug 2014 22:24:23 +0400 Subject: [PATCH] Update documentation --- .../installation/troubleshooting-common.rst | 7 +------ docs/source/overview.rst | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/source/installation/troubleshooting-common.rst b/docs/source/installation/troubleshooting-common.rst index bb688d7e..55345394 100644 --- a/docs/source/installation/troubleshooting-common.rst +++ b/docs/source/installation/troubleshooting-common.rst @@ -124,12 +124,7 @@ I am suffering bad lags before displaying shell prompt To get rid of these lags there currently are two options: -* Take ``powerline-daemon`` script and one of ``powerline-client`` - implementations from ``feature/daemon`` branch (all ``powerline-client`` - implementations leave in ``client`` folder: you need to either compile - ``powerline.c`` or install ``socat`` and use ``powerline.sh`` - (``powerline.py`` is much slower)). Fortunately this branch will be merged in - the future. +* Run ``powerline-daemon``. Powerline does not automatically start it for you. * Compile and install ``libzpython`` module that lives in https://bitbucket.org/ZyX_I/zpython. This variant is zsh-specific. diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 9ddc798a..f50940a6 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -149,6 +149,19 @@ hand: ``powerline`` is installed and run just like any other plugin using Shell prompts ------------- +.. note:: + It is advised that you run ``powerline-daemon`` before using any of the + below solutions. To do this add + + .. code-block:: bash + + powerline-daemon -q + + just before sourcing powerline bindings script or running + ``powerline-setup``. Use ``|| true`` or equivalent if you run your + configuration with ``set -e`` because ``powerline-daemon`` will exit with + ``1`` if daemon is already running. + Bash prompt ^^^^^^^^^^^ @@ -227,6 +240,14 @@ is the absolute path to your Powerline installation directory:: powerline support. You may specify location of this script via ``$POWERLINE_CONFIG_COMMAND`` environment variable. +.. note:: + It is advised that you run ``powerline-daemon`` before adding the above line + to tmux.conf. To do so add:: + + run-shell "powerline-daemon -q" + + to :file:`.tmux.conf`. + IPython prompt --------------