tyler.durden/powerline
1
0
Fork 0
mirror of https://github.com/powerline/powerline.git synced 2025-07-23 13:55:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs and create a common terminal feature support matrix

Browse Source
This commit is contained in:
Kim Silkebækken 2013-01-25 10:48:44 +01:00
parent 16b82cf070
commit c06f8836b3
4 changed files with 58 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/source/configuration.rst
View File

@ -52,31 +52,12 @@ Common configuration
Common configuration is a subdictionary that is a value of ``common`` key in Common configuration is a subdictionary that is a value of ``common`` key in
:file:`powerline/config.json` file. :file:`powerline/config.json` file.
.. _config-term_24bit_colors:
``term_24bit_colors`` ``term_24bit_colors``
Defines whether to output a cterm index (8-bit) or RGB colors (24-bit) Defines whether to output cterm indices (8-bit) or RGB colors (24-bit)
to the terminal emulator. to the terminal emulator. See the :ref:`term-feature-support-matrix` for
information on whether your terminal emulator supports 24-bit colors.
.. table:: 24-bit color support table
:name: term-rgb-color-support
================== =====================
Terminal emulator 24-bit color support
================== =====================
Gnome Terminal |supp_no|
Gvim |supp_no|
Konsole |supp_yes|
lxterminal |supp_no|
rxvt-unicode |supp_no|
st |supp_no|
Xfce Terminal |supp_no|
xterm |supp_partial| [#]_
================== =====================
.. |supp_yes| image:: _static/img/icons/tick.png
.. |supp_no| image:: _static/img/icons/cross.png
.. |supp_partial| image:: _static/img/icons/error.png
.. [#] Uses nearest color from 8-bit palette.
``dividers`` ``dividers``
Defines the dividers used in all Powerline extensions. This option Defines the dividers used in all Powerline extensions. This option
@ -87,12 +68,12 @@ Common configuration is a subdictionary that is a value of ``common`` key in
background colors, while the ``soft`` dividers are used to divide background colors, while the ``soft`` dividers are used to divide
segments with the same background color. segments with the same background color.
``paths`` .. _config-common-paths:
.. _config-common-paths:
``paths``
Defines additional paths which will be searched for modules when using Defines additional paths which will be searched for modules when using
:ref:`module segment option <config-themes-seg-module>`. Paths defined here :ref:`module segment option <config-themes-seg-module>`. Paths defined
have priority when searching for modules. here have priority when searching for modules.
Extension-specific configuration Extension-specific configuration
-------------------------------- --------------------------------
@ -118,9 +99,9 @@ Colorschemes
``name`` ``name``
Name of the colorscheme. Name of the colorscheme.
``colors`` .. _config-colorscheme-colors:
.. _config-colorscheme-colors:
``colors``
Color definitions, consisting of a dict where the key is the name of the Color definitions, consisting of a dict where the key is the name of the
color, and the value is one of the following: color, and the value is one of the following:
@ -129,9 +110,9 @@ Colorschemes
"aabbcc"]``). This is useful for colorschemes that use colors that "aabbcc"]``). This is useful for colorschemes that use colors that
aren't available in color terminals. aren't available in color terminals.
``groups`` .. _config-colorscheme-groups:
.. _config-colorscheme-groups:
``groups``
Segment highlighting groups, consisting of a dict where the key is the Segment highlighting groups, consisting of a dict where the key is the
name of the highlighting group (usually the function name for function name of the highlighting group (usually the function name for function
segments), and the value is a dict that defines the foreground color, segments), and the value is a dict that defines the foreground color,
@ -173,9 +154,9 @@ Themes
``name`` ``name``
Name of the theme. Name of the theme.
``default_module`` .. _config-themes-default_module:
.. _config-themes-default_module:
``default_module``
Python module where segments will be looked by default. Python module where segments will be looked by default.
``segments`` ``segments``

25
docs/source/installation/linux.rst
View File

@ -36,31 +36,10 @@ Plugin installation
Font installation Font installation
================= =================
================== ============================= ======================
Application/terminal emulator font support table
-----------------------------------------------------------------------
Name Patched font support Fontconfig support
================== ============================= ======================
Gnome Terminal |supp_yes| |supp_yes|
Gvim |supp_yes| |supp_no|
Konsole |supp_yes| |supp_yes|
lxterminal |supp_yes| |supp_yes|
rxvt-unicode |supp_partial| [#]_ |supp_no|
st |supp_yes| |supp_yes|
Xfce Terminal |supp_yes| |supp_yes|
xterm |supp_yes| |supp_no|
================== ============================= ======================
.. |supp_yes| image:: ../_static/img/icons/tick.png
.. |supp_no| image:: ../_static/img/icons/cross.png
.. |supp_partial| image:: ../_static/img/icons/error.png
.. [#] Must be compiled with ``--enable-unicode3`` for the
patched font to work.
Powerline provides two ways of installing the required fonts on Linux. The Powerline provides two ways of installing the required fonts on Linux. The
recommended method is using ``fontconfig`` if your terminal emulator recommended method is using ``fontconfig`` if your terminal emulator
supports it (see the table above). supports it. See the :ref:`term-feature-support-matrix` for details about
what features your terminal emulator supports.
Fontconfig Fontconfig
---------- ----------

19
docs/source/installation/osx.rst
View File

@ -41,22 +41,9 @@ command::
Font installation Font installation
================= =================
================== ============================= You need a patched font for Powerline to work on OS X. Check out the
Application/terminal emulator font support table `powerline-fonts`_ repository on GitHub for patched versions of some popular
------------------------------------------------ programming fonts.
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 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 font file in Finder and then click :guilabel:`Install this font` in the

43
docs/source/overview.rst
View File

@ -7,11 +7,6 @@ Requirements
Powerline requires Python 3.3 or Python 2.7 to work. Powerline requires Python 3.3 or Python 2.7 to work.
Powerline uses several special glyphs to get the arrow effect and some
custom symbols for developers. This requires that you either have the symbol
font or a patched font on your system (details in installation
instructions).
Vim plugin requirements Vim plugin requirements
----------------------- -----------------------
@ -28,6 +23,44 @@ packages.
Vim version 7.3.661 or newer is recommended for performance reasons. Vim version 7.3.661 or newer is recommended for performance reasons.
Terminal emulator requirements
------------------------------
Powerline uses several special glyphs to get the arrow effect and some
custom symbols for developers. This requires that you either have a symbol
font or a patched font on your system. Your terminal emulator must also
support either patched fonts or fontconfig for Powerline to work properly.
You can also enable :ref:`24-bit color support <config-term_24bit_colors>`
if your terminal emulator supports it.
.. table:: Application/terminal emulator feature support matrix
:name: term-feature-support-matrix
===================== ======= ===================== ===================== =====================
Name OS Patched font support Fontconfig support 24-bit color support
===================== ======= ===================== ===================== =====================
Gnome Terminal Linux |i_yes| |i_yes| |i_no|
Gvim Linux |i_yes| |i_no| |i_yes|
iTerm2 OS X |i_yes| |i_no| |i_no|
Konsole Linux |i_yes| |i_yes| |i_yes|
lxterminal Linux |i_yes| |i_yes| |i_no|
MacVim OS X |i_yes| |i_no| |i_yes|
rxvt-unicode Linux |i_partial| [#]_ |i_no| |i_no|
st Linux |i_yes| |i_yes| |i_no|
Terminal.app OS X |i_yes| |i_no| |i_no|
Xfce Terminal Linux |i_yes| |i_yes| |i_no|
xterm Linux |i_yes| |i_no| |i_partial| [#]_
===================== ======= ===================== ===================== =====================
.. |i_yes| image:: _static/img/icons/tick.png
.. |i_no| image:: _static/img/icons/cross.png
.. |i_partial| image:: _static/img/icons/error.png
.. [#] Must be compiled with ``--enable-unicode3`` for the
patched font to work.
.. [#] Uses nearest color from 8-bit palette.
Optional dependencies Optional dependencies
--------------------- ---------------------