mirror of
https://github.com/powerline/powerline.git
synced 2025-05-09 01:00:49 +02:00
6ac9f0d602
The installation docs have been split into separate guides for OS X and Linux, with OS-specific troubleshooting as part of the installation guide. Terminal emulator support tables have been added to both guides. Closes #121.
130 lines
4.4 KiB
ReStructuredText
130 lines
4.4 KiB
ReStructuredText
:tocdepth: 2
|
|
|
|
.. _installation-osx:
|
|
|
|
********************
|
|
Installation on OS X
|
|
********************
|
|
|
|
Plugin installation
|
|
===================
|
|
|
|
Python package
|
|
--------------
|
|
|
|
1. Install a proper Python version (see `issue #39
|
|
<https://github.com/Lokaltog/powerline/issues/39>`_ for a discussion
|
|
regarding the required Python version on OS X)::
|
|
|
|
sudo port select python python27-apple
|
|
|
|
2. Install Powerline using the following command::
|
|
|
|
pip install --user git+git://github.com/Lokaltog/powerline
|
|
|
|
.. note:: You need to use the GitHub URI when installing Powerline! This
|
|
project is currently unavailable on the PyPI due to a naming conflict
|
|
with an unrelated project.
|
|
|
|
.. warning:: Installing Powerline with a vim plugin manager like Vundle is
|
|
not recommended and not officially supported.
|
|
|
|
Vim installation
|
|
----------------
|
|
|
|
Any terminal vim version with Python 3.3 or Python 2.7 support should work,
|
|
but if you're using MacVim you need to install it using the following
|
|
command::
|
|
|
|
brew install macvim --env-std --override-system-vim
|
|
|
|
Font installation
|
|
=================
|
|
|
|
================== =============================
|
|
Application/terminal emulator font support table
|
|
------------------------------------------------
|
|
Name Patched font support
|
|
================== =============================
|
|
iTerm2 |supp_yes|
|
|
Terminal.app |supp_yes|
|
|
================== =============================
|
|
|
|
.. |supp_yes| image:: ../_static/img/icons/tick.png
|
|
.. |supp_no| image:: ../_static/img/icons/cross.png
|
|
.. |supp_partial| image:: ../_static/img/icons/error.png
|
|
|
|
.. note:: You need a patched font for Powerline to work on OS X. Check out
|
|
the `powerline-fonts`_ repository on GitHub for patched versions of some
|
|
popular programming fonts.
|
|
|
|
1. Download the font of your choice and install it by double-clicking the
|
|
font file in Finder and then click :guilabel:`Install this font` in the
|
|
preview window.
|
|
|
|
If you can't find your preferred font in the `powerline-fonts`_ repo,
|
|
you'll have to patch your own font instead. See :ref:`font-patching` for
|
|
instructions.
|
|
2. Configure MacVim or your terminal emulator to use the patched font (the
|
|
correct font usually ends with *for Powerline*).
|
|
|
|
.. _powerline-fonts: https://github.com/Lokaltog/powerline-fonts
|
|
|
|
Troubleshooting
|
|
===============
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
I can't see any fancy symbols, what's wrong?
|
|
--------------------------------------------
|
|
|
|
* If you're using iTerm2, please update to `this revision
|
|
<https://github.com/gnachman/iTerm2/commit/8e3ad6dabf83c60b8cf4a3e3327c596401744af6>`_
|
|
or newer.
|
|
* You need to set your ``LANG`` and ``LC_*`` environment variables to
|
|
a UTF-8 locale (e.g. ``LANG=en_US.utf8``). Consult your Linux distro's
|
|
documentation for information about setting these variables correctly.
|
|
|
|
The colors look weird in the default OS X Terminal app!
|
|
-------------------------------------------------------
|
|
|
|
* The arrows may have the wrong colors if you have changed the "minimum
|
|
contrast" slider in the color tab of your OS X settings.
|
|
* The default OS X Terminal app is known to have some issues with the
|
|
Powerline colors. Please use another terminal emulator. iTerm2 should work
|
|
fine.
|
|
|
|
The colors look weird in iTerm2!
|
|
--------------------------------
|
|
|
|
* The arrows may have the wrong colors if you have changed the "minimum
|
|
contrast" slider in the color tab of your OS X settings.
|
|
* Please disable background transparency to resolve this issue.
|
|
|
|
I receive a ``NameError`` when trying to use Powerline with MacVim!
|
|
-------------------------------------------------------------------
|
|
|
|
* Please install MacVim using this command::
|
|
|
|
brew install macvim --env-std --override-system-vim
|
|
|
|
Then install Powerline locally with ``pip install --user``, or by
|
|
running these commands in the ``powerline`` directory::
|
|
|
|
./setup.py build
|
|
./setup.py install --user
|
|
|
|
I receive an ``ImportError`` when trying to use Powerline on OS X!
|
|
------------------------------------------------------------------
|
|
|
|
* This is caused by an invalid ``sys.path`` when using system vim and system
|
|
Python. Please try to select another Python distribution::
|
|
|
|
sudo port select python python27-apple
|
|
|
|
* See `issue #39 <https://github.com/Lokaltog/powerline/issues/39>`_ for
|
|
a discussion and other possible solutions for this issue.
|
|
|
|
.. include:: troubleshooting-common.rst
|