tyler.durden/powerline
1
0
Fork 0
mirror of https://github.com/powerline/powerline.git synced 2025-05-28 02:20:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update terminal prompt usage instructions

Browse Source 
Closes #56.
This commit is contained in:
Kim Silkebækken 2013-01-17 17:06:45 +01:00
parent 8a5b8719cd
commit 1a99fbd36a
1 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/source/overview.rst
View File

@ -51,6 +51,11 @@ they provide an easy way of installing and upgrading Powerline:
Usage Usage
----- -----
.. note:: If Powerline is installed somewhere other than Python's
site-packages directories (e.g. by having the git repo in your dotfiles
directory) you'll have to use the absolute path to the scripts in the
examples below.
Vim statusline Vim statusline
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
@ -60,27 +65,37 @@ by adding the following line to your ``vimrc``::
python from powerline.ext.vim import source_plugin; source_plugin() python from powerline.ext.vim import source_plugin; source_plugin()
If Powerline is installed somewhere other than Python's site-packages If Powerline is installed somewhere other than Python's site-packages
directories (e.g. by having the git repo in your dotfiles directory) you'll directories you'll have to source the vim plugin file with an absolute path
have to source the vim plugin file with an absolute path to the plugin to the plugin location.
location.
Add the following line to your ``vimrc``, where ``{path}`` is the path to Add the following line to your ``vimrc``, where ``{path}`` is the path to
the main Powerline project directory:: the main Powerline project directory::
source {path}/powerline/ext/vim/source_plugin.vim source {path}/powerline/ext/vim/source_plugin.vim
Terminal prompt Terminal prompts
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
Add the following to your ``.bashrc``/``.zshrc``:: Bash prompt
***********
Add the following to your ``.bashrc``::
function _update_ps1() {
export PS1="$(powerline-prompt)"
}
export PROMPT_COMMAND="_update_ps1"
Zsh prompt
**********
Add the following to your ``.zshrc``::
setopt prompt_subst
export PS1=\`powerline-prompt\` export PS1=\`powerline-prompt\`
If Powerline is installed somewhere other than Python's site-packages you'll
have to specify the full path to the script::
export PS1=\`/path/to/powerline/scripts/powerline-prompt\`
Tmux statusline Tmux statusline
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
@ -96,7 +111,3 @@ Add the following to your ``tmux.conf``::
set-option -g status-justify "centre" set-option -g status-justify "centre"
set-option -g status-bg "colour235" set-option -g status-bg "colour235"
set-option -g status-fg "colour249" set-option -g status-fg "colour249"
If Powerline is installed somewhere other than Python's site-packages you'll
have to specify the full path to the script in the ``status-left`` and
``status-right`` options.