mirror of
https://github.com/powerline/powerline.git
synced 2025-04-08 19:25:04 +02:00
Replace all ASCII apostrophs with Unicode ones in documentation
This commit is contained in:
parent
32cc0c7711
commit
b94cfd98a4
10
README.rst
10
README.rst
@ -34,11 +34,11 @@ Features
|
|||||||
* **Support for prompts and statuslines in many applications.** Originally
|
* **Support for prompts and statuslines in many applications.** Originally
|
||||||
created exclusively for vim statuslines, the project has evolved to
|
created exclusively for vim statuslines, the project has evolved to
|
||||||
provide statuslines in tmux and several WMs, and prompts for shells like
|
provide statuslines in tmux and several WMs, and prompts for shells like
|
||||||
bash/zsh and other applications. It's simple to write renderers for any
|
bash/zsh and other applications. It’s simple to write renderers for any
|
||||||
other applications that Powerline doesn't yet support.
|
other applications that Powerline doesn’t yet support.
|
||||||
* **Configuration and colorschemes written in JSON.** JSON is
|
* **Configuration and colorschemes written in JSON.** JSON is
|
||||||
a standardized, simple and easy to use file format that allows for easy
|
a standardized, simple and easy to use file format that allows for easy
|
||||||
user configuration across all of Powerline's supported applications.
|
user configuration across all of Powerline’s supported applications.
|
||||||
* **Fast and lightweight, with daemon support for even better performance.**
|
* **Fast and lightweight, with daemon support for even better performance.**
|
||||||
Although the code base spans a couple of thousand lines of code with no
|
Although the code base spans a couple of thousand lines of code with no
|
||||||
goal of "less than X lines of code", the main focus is on good performance
|
goal of "less than X lines of code", the main focus is on good performance
|
||||||
@ -47,11 +47,11 @@ Features
|
|||||||
launched for prompts and statuslines, which provides excellent
|
launched for prompts and statuslines, which provides excellent
|
||||||
performance.
|
performance.
|
||||||
|
|
||||||
*But I hate Python / I don't need shell prompts / this is just too much
|
*But I hate Python / I don’t need shell prompts / this is just too much
|
||||||
hassle for me / what happened to the original vim-powerline project / …*
|
hassle for me / what happened to the original vim-powerline project / …*
|
||||||
|
|
||||||
You should check out some of the Powerline derivatives. The most lightweight
|
You should check out some of the Powerline derivatives. The most lightweight
|
||||||
and feature-rich alternative is currently Bailey Ling's `vim-airline
|
and feature-rich alternative is currently Bailey Ling’s `vim-airline
|
||||||
<https://github.com/bling/vim-airline>`_ project.
|
<https://github.com/bling/vim-airline>`_ project.
|
||||||
|
|
||||||
------
|
------
|
||||||
|
@ -87,29 +87,29 @@ You can move the segment dictionaries around to change the segment
|
|||||||
positions, or remove the entire dictionary to remove the segment from the
|
positions, or remove the entire dictionary to remove the segment from the
|
||||||
prompt or statusline.
|
prompt or statusline.
|
||||||
|
|
||||||
.. note:: It's essential that the contents of all your configuration files
|
.. note:: It’s essential that the contents of all your configuration files
|
||||||
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.
|
||||||
|
|
||||||
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:
|
||||||
|
|
||||||
**E-mail alert segment**
|
**E-mail alert segment**
|
||||||
You have to set your username and password (and possibly server/port)
|
You have to set your username and password (and possibly server/port)
|
||||||
for the e-mail alert segment. If you're using GMail it's recommended
|
for the e-mail alert segment. If you’re using GMail it’s recommended
|
||||||
that you `generate an application-specific password
|
that you `generate an application-specific password
|
||||||
<https://accounts.google.com/IssuedAuthSubTokens>`_ for this purpose.
|
<https://accounts.google.com/IssuedAuthSubTokens>`_ for this purpose.
|
||||||
|
|
||||||
Open a theme file, scroll down to the ``email_imap_alert`` segment and
|
Open a theme file, scroll down to the ``email_imap_alert`` segment and
|
||||||
set your ``username`` and ``password``. The server defaults to GMail's
|
set your ``username`` and ``password``. The server defaults to GMail’s
|
||||||
IMAP server, but you can set the server/port by adding a ``server`` and
|
IMAP server, but you can set the server/port by adding a ``server`` and
|
||||||
a ``port`` argument.
|
a ``port`` argument.
|
||||||
**Weather segment**
|
**Weather segment**
|
||||||
The weather segment will try to find your location using a GeoIP lookup,
|
The weather segment will try to find your location using a GeoIP lookup,
|
||||||
so unless you're on a VPN you probably won't have to change the location
|
so unless you’re on a VPN you probably won’t have to change the location
|
||||||
query.
|
query.
|
||||||
|
|
||||||
If you want to change the location query or the temperature unit you'll
|
If you want to change the location query or the temperature unit you’ll
|
||||||
have to update the segment arguments. Open a theme file, scroll down to
|
have to update the segment arguments. Open a theme file, scroll down to
|
||||||
the weather segment and update it to include unit/location query
|
the weather segment and update it to include unit/location query
|
||||||
arguments:
|
arguments:
|
||||||
|
@ -177,7 +177,7 @@ Color definitions
|
|||||||
* A cterm color index.
|
* A cterm color index.
|
||||||
* A list with a cterm color index and a hex color string (e.g. ``[123,
|
* A list with a cterm color index and a hex color string (e.g. ``[123,
|
||||||
"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.
|
||||||
|
|
||||||
``gradients``
|
``gradients``
|
||||||
Gradient definitions, consisting of a dict where the key is the name of the
|
Gradient definitions, consisting of a dict where the key is the name of the
|
||||||
@ -236,7 +236,7 @@ override those from each previous file. It is required that either
|
|||||||
|
|
||||||
``mode_translations``
|
``mode_translations``
|
||||||
Mode-specific highlighting for extensions that support it (e.g. the vim
|
Mode-specific highlighting for extensions that support it (e.g. the vim
|
||||||
extension). It's an easy way of changing a color in a specific mode.
|
extension). It’s an easy way of changing a color in a specific mode.
|
||||||
Consists of a dict where the key is the mode and the value is a dict
|
Consists of a dict where the key is the mode and the value is a dict
|
||||||
with the following options:
|
with the following options:
|
||||||
|
|
||||||
@ -308,7 +308,7 @@ ascii Theme without any unicode characters at all
|
|||||||
|
|
||||||
``dividers``
|
``dividers``
|
||||||
Defines the dividers used in all Powerline extensions. This option
|
Defines the dividers used in all Powerline extensions. This option
|
||||||
should usually only be changed if you don't have a patched font, or if
|
should usually only be changed if you don’t have a patched font, or if
|
||||||
you use a font patched with the legacy font patcher.
|
you use a font patched with the legacy font patcher.
|
||||||
|
|
||||||
The ``hard`` dividers are used to divide segments with different
|
The ``hard`` dividers are used to divide segments with different
|
||||||
|
@ -15,7 +15,7 @@ always absolute.
|
|||||||
|
|
||||||
Segments are regular Python functions, and they may accept arguments. All
|
Segments are regular Python functions, and they may accept arguments. All
|
||||||
arguments should have a default value which will be used for themes that
|
arguments should have a default value which will be used for themes that
|
||||||
don't provide an ``args`` dict.
|
don’t provide an ``args`` dict.
|
||||||
|
|
||||||
More information is available in :ref:`Writing segments <dev-segments>` section.
|
More information is available in :ref:`Writing segments <dev-segments>` section.
|
||||||
|
|
||||||
|
@ -90,8 +90,8 @@ Patched fonts
|
|||||||
This method is the fallback method and works for every terminal, with the
|
This method is the fallback method and works for every terminal, with the
|
||||||
exception of :ref:`rxvt-unicode <tips-and-tricks-urxvt>`.
|
exception of :ref:`rxvt-unicode <tips-and-tricks-urxvt>`.
|
||||||
|
|
||||||
Download the font of your choice from `powerline-fonts`_. If you can't find
|
Download the font of your choice from `powerline-fonts`_. If you can’t find
|
||||||
your preferred font in the `powerline-fonts`_ repo, you'll have to patch your
|
your preferred font in the `powerline-fonts`_ repo, you’ll have to patch your
|
||||||
own font instead.
|
own font instead.
|
||||||
|
|
||||||
.. _powerline-fonts: https://github.com/Lokaltog/powerline-fonts
|
.. _powerline-fonts: https://github.com/Lokaltog/powerline-fonts
|
||||||
|
@ -10,7 +10,7 @@ automatically do most of the configuration for you.
|
|||||||
* `Arch Linux (AUR), Python 3 version <https://aur.archlinux.org/packages/python-powerline-git/>`_
|
* `Arch Linux (AUR), Python 3 version <https://aur.archlinux.org/packages/python-powerline-git/>`_
|
||||||
* Gentoo Live ebuild in `raiagent <https://github.com/leycec/raiagent>`_ overlay
|
* Gentoo Live ebuild in `raiagent <https://github.com/leycec/raiagent>`_ overlay
|
||||||
|
|
||||||
If you're running a distribution without an official package you'll have to
|
If you’re running a distribution without an official package you’ll have to
|
||||||
follow the installation guide below:
|
follow the installation guide below:
|
||||||
|
|
||||||
1. Install Python 3.2+ or Python 2.6+ with ``pip``. This step is
|
1. Install Python 3.2+ or Python 2.6+ with ``pip``. This step is
|
||||||
@ -34,8 +34,8 @@ Fonts installation
|
|||||||
Fontconfig
|
Fontconfig
|
||||||
----------
|
----------
|
||||||
|
|
||||||
This method only works on Linux. It's the recommended method if your
|
This method only works on Linux. It’s the recommended method if your
|
||||||
terminal emulator supports it as you don't have to patch any fonts, and it
|
terminal emulator supports it as you don’t have to patch any fonts, and it
|
||||||
generally works well with any coding font.
|
generally works well with any coding font.
|
||||||
|
|
||||||
#. Download the latest version of the symbol font and fontconfig file::
|
#. Download the latest version of the symbol font and fontconfig file::
|
||||||
@ -54,16 +54,16 @@ generally works well with any coding font.
|
|||||||
fc-cache -vf ~/.fonts/
|
fc-cache -vf ~/.fonts/
|
||||||
|
|
||||||
#. Install the fontconfig file. For newer versions of fontconfig the config
|
#. Install the fontconfig file. For newer versions of fontconfig the config
|
||||||
path is ``~/.config/fontconfig/conf.d/``, for older versions it's
|
path is ``~/.config/fontconfig/conf.d/``, for older versions it’s
|
||||||
``~/.fonts.conf.d/``::
|
``~/.fonts.conf.d/``::
|
||||||
|
|
||||||
mv 10-powerline-symbols.conf ~/.config/fontconfig/conf.d/
|
mv 10-powerline-symbols.conf ~/.config/fontconfig/conf.d/
|
||||||
|
|
||||||
If you can't see the custom symbols, please close all instances of your
|
If you can’t see the custom symbols, please close all instances of your
|
||||||
terminal emulator. You may need to restart X for the changes to take
|
terminal emulator. You may need to restart X for the changes to take
|
||||||
effect.
|
effect.
|
||||||
|
|
||||||
If you *still* can't see the custom symbols, double-check that you have
|
If you *still* can’t see the custom symbols, double-check that you have
|
||||||
installed the font to a valid X font path, and that you have installed the
|
installed the font to a valid X font path, and that you have installed the
|
||||||
fontconfig file to a valid fontconfig path. Alternatively try to install
|
fontconfig file to a valid fontconfig path. Alternatively try to install
|
||||||
a :ref:`patched font <installation-patched-fonts>`.
|
a :ref:`patched font <installation-patched-fonts>`.
|
||||||
@ -87,9 +87,9 @@ After installing the patched font you need to update Gvim or your terminal
|
|||||||
emulator to use the patched font. The correct font usually ends with *for
|
emulator to use the patched font. The correct font usually ends with *for
|
||||||
Powerline*.
|
Powerline*.
|
||||||
|
|
||||||
If you can't see the custom symbols, please close all instances of your
|
If you can’t see the custom symbols, please close all instances of your
|
||||||
terminal emulator. You may need to restart X for the changes to take
|
terminal emulator. You may need to restart X for the changes to take
|
||||||
effect.
|
effect.
|
||||||
|
|
||||||
If you *still* can't see the custom symbols, double-check that you have
|
If you *still* can’t see the custom symbols, double-check that you have
|
||||||
installed the font to a valid X font path.
|
installed the font to a valid X font path.
|
||||||
|
@ -45,7 +45,7 @@ Vim installation
|
|||||||
================
|
================
|
||||||
|
|
||||||
Any terminal vim version with Python 3.2+ or Python 2.6+ support should work,
|
Any terminal vim version with Python 3.2+ or Python 2.6+ support should work,
|
||||||
but if you're using MacVim you need to install it using the following command::
|
but if you’re using MacVim you need to install it using the following command::
|
||||||
|
|
||||||
brew install macvim --env-std --override-system-vim
|
brew install macvim --env-std --override-system-vim
|
||||||
|
|
||||||
|
@ -20,11 +20,11 @@ Features
|
|||||||
* **Support for prompts and statuslines in many applications.** Originally
|
* **Support for prompts and statuslines in many applications.** Originally
|
||||||
created exclusively for vim statuslines, the project has evolved to
|
created exclusively for vim statuslines, the project has evolved to
|
||||||
provide statuslines in tmux and several WMs, and prompts for shells like
|
provide statuslines in tmux and several WMs, and prompts for shells like
|
||||||
bash/zsh and other applications. It's simple to write renderers for any
|
bash/zsh and other applications. It’s simple to write renderers for any
|
||||||
other applications that Powerline doesn't yet support.
|
other applications that Powerline doesn’t yet support.
|
||||||
* **Configuration and colorschemes written in JSON.** JSON is
|
* **Configuration and colorschemes written in JSON.** JSON is
|
||||||
a standardized, simple and easy to use file format that allows for easy
|
a standardized, simple and easy to use file format that allows for easy
|
||||||
user configuration across all of Powerline's supported applications.
|
user configuration across all of Powerline’s supported applications.
|
||||||
* **Fast and lightweight, with daemon support for even better performance.**
|
* **Fast and lightweight, with daemon support for even better performance.**
|
||||||
Although the code base spans a couple of thousand lines of code with no
|
Although the code base spans a couple of thousand lines of code with no
|
||||||
goal of "less than X lines of code", the main focus is on good performance
|
goal of "less than X lines of code", the main focus is on good performance
|
||||||
@ -33,11 +33,11 @@ Features
|
|||||||
launched for prompts and statuslines, which provides excellent
|
launched for prompts and statuslines, which provides excellent
|
||||||
performance.
|
performance.
|
||||||
|
|
||||||
*But I hate Python / I don't need shell prompts / this is just too much
|
*But I hate Python / I don’t need shell prompts / this is just too much
|
||||||
hassle for me / what happened to the original vim-powerline project / …*
|
hassle for me / what happened to the original vim-powerline project / …*
|
||||||
|
|
||||||
You should check out some of the Powerline derivatives. The most lightweight
|
You should check out some of the Powerline derivatives. The most lightweight
|
||||||
and feature-rich alternative is currently Bailey Ling's `vim-airline
|
and feature-rich alternative is currently Bailey Ling’s `vim-airline
|
||||||
<https://github.com/bling/vim-airline>`_ project.
|
<https://github.com/bling/vim-airline>`_ project.
|
||||||
|
|
||||||
Screenshots
|
Screenshots
|
||||||
|
@ -47,7 +47,7 @@ In the ``~/.Xdefaults`` add the following::
|
|||||||
I noticed that Source Code Pro has the glyphs there already, but the pixel size
|
I noticed that Source Code Pro has the glyphs there already, but the pixel size
|
||||||
of the fonts play a role in whether or not the > or the < separators showing up
|
of the fonts play a role in whether or not the > or the < separators showing up
|
||||||
or not. Using font size 12, glyphs on the right hand side of the powerline are
|
or not. Using font size 12, glyphs on the right hand side of the powerline are
|
||||||
present, but the ones on the left don't. Pixel size 14, brings the reverse
|
present, but the ones on the left don’t. Pixel size 14, brings the reverse
|
||||||
problem. Font size 13 seems to work just fine.
|
problem. Font size 13 seems to work just fine.
|
||||||
|
|
||||||
Reloading powerline after update
|
Reloading powerline after update
|
||||||
|
@ -13,14 +13,14 @@ System-specific issues
|
|||||||
Common issues
|
Common issues
|
||||||
=============
|
=============
|
||||||
|
|
||||||
I'm using tmux and Powerline looks like crap, what's wrong?
|
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
|
* You need to tell tmux that it has 256-color capabilities. Add this to your
|
||||||
:file:`.tmux.conf` to solve this issue::
|
:file:`.tmux.conf` to solve this issue::
|
||||||
|
|
||||||
set -g default-terminal "screen-256color"
|
set -g default-terminal "screen-256color"
|
||||||
* If you're using iTerm2, make sure that you have enabled the setting
|
* If you’re using iTerm2, make sure that you have enabled the setting
|
||||||
:guilabel:`Set locale variables automatically` in :menuselection:`Profiles -->
|
:guilabel:`Set locale variables automatically` in :menuselection:`Profiles -->
|
||||||
Terminal --> Environment`.
|
Terminal --> Environment`.
|
||||||
* Make sure tmux knows that terminal it is running in support 256 colors. You
|
* Make sure tmux knows that terminal it is running in support 256 colors. You
|
||||||
|
@ -2,16 +2,16 @@
|
|||||||
Troubleshooting on Linux
|
Troubleshooting on Linux
|
||||||
************************
|
************************
|
||||||
|
|
||||||
I can't see any fancy symbols, what's wrong?
|
I can’t see any fancy symbols, what’s wrong?
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
* Make sure that you've configured gvim or your terminal emulator to use
|
* Make sure that you’ve configured gvim or your terminal emulator to use
|
||||||
a patched font.
|
a patched font.
|
||||||
* You need to set your ``LANG`` and ``LC_*`` environment variables to
|
* 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
|
a UTF-8 locale (e.g. ``LANG=en_US.utf8``). Consult your Linux distro’s
|
||||||
documentation for information about setting these variables correctly.
|
documentation for information about setting these variables correctly.
|
||||||
* Make sure that vim is compiled with the ``--with-features=big`` flag.
|
* Make sure that vim is compiled with the ``--with-features=big`` flag.
|
||||||
* If you're using rxvt-unicode, make sure that it's compiled with the
|
* If you’re using rxvt-unicode, make sure that it’s compiled with the
|
||||||
``--enable-unicode3`` flag.
|
``--enable-unicode3`` flag.
|
||||||
|
|
||||||
The fancy symbols look a bit blurry or "off"!
|
The fancy symbols look a bit blurry or "off"!
|
||||||
|
@ -2,14 +2,14 @@
|
|||||||
Troubleshooting on OS X
|
Troubleshooting on OS X
|
||||||
***********************
|
***********************
|
||||||
|
|
||||||
I can't see any fancy symbols, what's wrong?
|
I can’t see any fancy symbols, what’s wrong?
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
* If you're using iTerm2, please update to `this revision
|
* If you’re using iTerm2, please update to `this revision
|
||||||
<https://github.com/gnachman/iTerm2/commit/8e3ad6dabf83c60b8cf4a3e3327c596401744af6>`_
|
<https://github.com/gnachman/iTerm2/commit/8e3ad6dabf83c60b8cf4a3e3327c596401744af6>`_
|
||||||
or newer.
|
or newer.
|
||||||
* You need to set your ``LANG`` and ``LC_*`` environment variables to
|
* 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
|
a UTF-8 locale (e.g. ``LANG=en_US.utf8``). Consult your Linux distro’s
|
||||||
documentation for information about setting these variables correctly.
|
documentation for information about setting these variables correctly.
|
||||||
|
|
||||||
The colors look weird in the default OS X Terminal app!
|
The colors look weird in the default OS X Terminal app!
|
||||||
|
@ -12,11 +12,11 @@ The vim plugin requires a vim version with Python support compiled in. You
|
|||||||
can check if your vim supports Python by running ``vim --version | grep
|
can check if your vim supports Python by running ``vim --version | grep
|
||||||
+python``.
|
+python``.
|
||||||
|
|
||||||
If your vim version doesn't have support for Python, you'll have to compile
|
If your vim version doesn’t have support for Python, you’ll have to compile
|
||||||
it with the ``--enable-pythoninterp`` flag (``--enable-python3interp`` if
|
it with the ``--enable-pythoninterp`` flag (``--enable-python3interp`` if
|
||||||
you want Python 3 support instead). Note that this also requires the related
|
you want Python 3 support instead). Note that this also requires the related
|
||||||
Python headers to be installed on your system. Please consult your
|
Python headers to be installed on your system. Please consult your
|
||||||
distribution's documentation for details on how to compile and install
|
distribution’s documentation for details on how to compile and install
|
||||||
packages.
|
packages.
|
||||||
|
|
||||||
Vim version 7.4 or newer is recommended for performance reasons, but Powerline
|
Vim version 7.4 or newer is recommended for performance reasons, but Powerline
|
||||||
|
@ -25,7 +25,7 @@ directory:
|
|||||||
|
|
||||||
set rtp+={repository_root}/powerline/bindings/vim
|
set rtp+={repository_root}/powerline/bindings/vim
|
||||||
|
|
||||||
If you're using pathogen and don't want Powerline functionality in any other
|
If you’re using pathogen and don’t want Powerline functionality in any other
|
||||||
applications, simply add Powerline as a bundle and point the path above to the
|
applications, simply add Powerline as a bundle and point the path above to the
|
||||||
Powerline bundle directory, e.g.
|
Powerline bundle directory, e.g.
|
||||||
``~/.vim/bundle/powerline/powerline/bindings/vim``.
|
``~/.vim/bundle/powerline/powerline/bindings/vim``.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user