tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'update-documentation' into develop

This commit is contained in:
ZyX 2015-02-07 18:51:18 +03:00
parent e280313b0f 9e5bd5c1af
commit 04feda5922
2 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/commands/lint.rst
View File

@ -1,5 +1,7 @@
:orphan: :orphan:
.. _command-powerline-lint:
powerline-lint manual page powerline-lint manual page
========================== ==========================

30
docs/source/configuration.rst
View File

@ -33,6 +33,8 @@ corresponds to :file:`~/.config/powerline` on both platforms.
If per-instance configuration is needed please refer to :ref:`Local If per-instance configuration is needed please refer to :ref:`Local
configuration overrides <local-configuration-overrides>`. configuration overrides <local-configuration-overrides>`.
.. _configuration-merging:
.. note:: .. note::
Existing multiple configuration files that have the same name, but are placed Existing multiple configuration files that have the same name, but are placed
in different directories, will be merged. Merging happens in the following in different directories, will be merged. Merging happens in the following
@ -63,20 +65,21 @@ Quick setup guide
This guide will help you with the initial configuration of Powerline. This guide will help you with the initial configuration of Powerline.
Start by copying the entire set of default configuration files to the Look at configuration in :file:`{powerline_root}/powerline/config_files`. If you
corresponding path in your user config directory: want to modify some file you can create :file:`~/.config/powerline` directory
and put modifications there: all configuration files are :ref:`merged
.. code-block:: sh <configuration-merging>` with each other.
mkdir ~/.config/powerline
cp -R /path/to/powerline/config_files/* ~/.config/powerline
Each extension (vim, tmux, etc.) has its own theme, and they are located in Each extension (vim, tmux, etc.) has its own theme, and they are located in
:file:`{config directory}/themes/{extension}/default.json`. :file:`{config directory}/themes/{extension}/default.json`. Best way to modify
it is to copy this theme as a whole, remove ``segment_data`` key with
corresponding value if present (unless you need to modify it, in which case only
modifications must be left) and do necessary modifications in the list of
segments (lists are not subject to merging: this is why you need a copy).
If you want to move, remove or customize any of the provided segments, you If you want to move, remove or customize any of the provided segments in the
can do that by updating the segment dictionary in the theme you want to copy, you can do that by updating the segment dictionary in the theme you want
customize. A segment dictionary looks like this: to customize. A segment dictionary looks like this:
.. code-block:: javascript .. code-block:: javascript
@ -93,6 +96,11 @@ prompt or statusline.
is valid JSON! It’s strongly recommended that you run your configuration is valid JSON! It’s strongly recommended that you run your configuration
files through ``jsonlint`` after changing them. files through ``jsonlint`` after changing them.
.. note::
If your modifications appear not to work, run :ref:`powerline-lint script
<command-powerline-lint>`. This script should show you the location of the
error.
Some segments need a user configuration to work properly. Here’s a couple of Some segments need a user configuration to work properly. Here’s a couple of
segments that you may want to customize right away: segments that you may want to customize right away: