From 410dccd8703c7a326d6b3a4adf395bf04945a785 Mon Sep 17 00:00:00 2001 From: ZyX Date: Fri, 28 Nov 2014 20:25:07 +0300 Subject: [PATCH 1/3] Add warning about additional_escapes option --- docs/source/troubleshooting.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index 9583c713..d5304e49 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -35,6 +35,15 @@ I’m using tmux/screen and Powerline is colorless to ``"tmux"`` or ``"screen"``. Note that it is known to work perfectly in screen, but in tmux it may produce ugly spaces. + .. warning:: + Both tmux and screen are not resending sequences escaped in such a way. Thus + even though additional escaping will work for the last shown prompt, + highlighting will eventually go away when tmux or screen will redraw screen + for some reason. + + E.g. in screen it will go away when you used copy mode and prompt got out of + screen and in tmux it will go away immediately after you press ````. + After an update something stopped working ----------------------------------------- From f1399dc5d662a762bb4e596cb2f856711c0cb277 Mon Sep 17 00:00:00 2001 From: ZyX Date: Fri, 28 Nov 2014 20:31:24 +0300 Subject: [PATCH 2/3] Add information about tmux green bar --- docs/source/troubleshooting.rst | 79 +++++++++++++++++++-------------- 1 file changed, 45 insertions(+), 34 deletions(-) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index d5304e49..66563b04 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -13,38 +13,6 @@ System-specific issues Common issues ============= -I’m using tmux and Powerline looks like crap, what’s wrong? ------------------------------------------------------------ - -* You need to tell tmux that it has 256-color capabilities. Add this to your - :file:`.tmux.conf` to solve this issue:: - - set -g default-terminal "screen-256color" -* If you’re using iTerm2, make sure that you have enabled the setting - :guilabel:`Set locale variables automatically` in :menuselection:`Profiles --> - Terminal --> Environment`. -* Make sure tmux knows that terminal it is running in support 256 colors. You - may tell it tmux by using ``-2`` option when launching it. - -I’m using tmux/screen and Powerline is colorless ------------------------------------------------- - -* If the above advices do not help, then you need to disable - :ref:`term_truecolor `. -* Alternative: set :ref:`additional_escapes ` - to ``"tmux"`` or ``"screen"``. Note that it is known to work perfectly in - screen, but in tmux it may produce ugly spaces. - - .. warning:: - Both tmux and screen are not resending sequences escaped in such a way. Thus - even though additional escaping will work for the last shown prompt, - highlighting will eventually go away when tmux or screen will redraw screen - for some reason. - - E.g. in screen it will go away when you used copy mode and prompt got out of - screen and in tmux it will go away immediately after you press ````. - - After an update something stopped working ----------------------------------------- @@ -129,6 +97,49 @@ make powerline package importable anywhere: use pip install --user --editable path/to/powerline +Tmux/screen-related issues +========================== + +I’m using tmux and Powerline looks like crap, what’s wrong? +----------------------------------------------------------- + +* You need to tell tmux that it has 256-color capabilities. Add this to your + :file:`.tmux.conf` to solve this issue:: + + set -g default-terminal "screen-256color" +* If you’re using iTerm2, make sure that you have enabled the setting + :guilabel:`Set locale variables automatically` in :menuselection:`Profiles --> + Terminal --> Environment`. +* Make sure tmux knows that terminal it is running in support 256 colors. You + may tell it tmux by using ``-2`` option when launching it. + +I’m using tmux/screen and Powerline is colorless +------------------------------------------------ + +* If the above advices do not help, then you need to disable + :ref:`term_truecolor `. +* Alternative: set :ref:`additional_escapes ` + to ``"tmux"`` or ``"screen"``. Note that it is known to work perfectly in + screen, but in tmux it may produce ugly spaces. + + .. warning:: + Both tmux and screen are not resending sequences escaped in such a way. Thus + even though additional escaping will work for the last shown prompt, + highlighting will eventually go away when tmux or screen will redraw screen + for some reason. + + E.g. in screen it will go away when you used copy mode and prompt got out of + screen and in tmux it will go away immediately after you press ````. + +In tmux there is a green bar in place of powerline +-------------------------------------------------- + +In order for tmux bindings to work ``powerline-config`` script is required to be +present in ``$PATH``. Alternatively one may define ``$POWERLINE_CONFIG_COMMAND`` +environment variable pointing to the location of the script. *This variable must +be defined prior to launching tmux server and in the environment where server is +started from.* + Shell issues ============ @@ -180,8 +191,8 @@ My vim statusline has a lot of ``^`` or underline characters in it! ------------------------------------------------------------------- * You need to configure the ``fillchars`` setting to disable statusline - fillchars (see ``:h fillchars`` for details). Add this to your - :file:`vimrc` to solve this issue: + fillchars (see ``:h 'fillchars'`` for details). Add this to your :file:`vimrc` + to solve this issue: .. code-block:: vim From 774ec6dd42392593a313cf7c8387d6387e4b0616 Mon Sep 17 00:00:00 2001 From: ZyX Date: Fri, 28 Nov 2014 20:37:53 +0300 Subject: [PATCH 3/3] Add note about pip and $PATH Closes #1189 --- docs/source/troubleshooting.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index 66563b04..9cf5e923 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -143,6 +143,16 @@ started from.* Shell issues ============ +When sourcing shell bindings it complains about missing command or file +----------------------------------------------------------------------- + +If you are using ``pip`` based installation do not forget to add pip-specific +executable path to ``$PATH`` environment variable. This path usually looks +something like ``$HOME/.local/bin`` (linux) or +``$HOME/Library/Python/{python_version}/bin`` (OS X). One may check out where +``powerline-config`` script was installed by using ``pip show -f +powerline-status | grep powerline-config`` (does not always work). + I am suffering bad lags before displaying shell prompt ------------------------------------------------------