tmux-plugins/tpm
1
0
Fork 0
mirror of https://github.com/tmux-plugins/tpm.git synced 2025-11-04 08:36:05 +00:00
Code Issues Projects Releases Wiki Activity

Update readme with new plugin syntax

Browse Source
This commit is contained in:
Bruno Sutic
2015-07-07 01:46:53 +02:00
parent 7ce0326916
commit 343ae423dd
1 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -12,44 +12,43 @@ Clone TPM:
$ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm $ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
Put this at the bottom of your `.tmux.conf` (backslashes at the end of the lines Put this at the bottom of `.tmux.conf`:
are required):
# List of plugins # List of plugins
# Supports `github_username/repo` or full git repo URLs set -g @plugin 'tmux-plugins/tpm'
set -g @tpm_plugins ' \ set -g @plugin 'tmux-plugins/tmux-sensible'
tmux-plugins/tpm \
tmux-plugins/tmux-sensible \
'
# Other examples:
# github_username/plugin_name \
# git@github.com/user/plugin \
# git@bitbucket.com/user/plugin \
# Initializes TMUX plugin manager. # Other examples:
# Keep this line at the very bottom of tmux.conf. # set -g @plugin 'github_username/plugin_name'
run-shell '~/.tmux/plugins/tpm/tpm' # set -g @plugin 'git@github.com/user/plugin'
# set -g @plugin 'git@bitbucket.com/user/plugin'
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
run '~/.tmux/plugins/tpm/tpm'
Reload TMUX environment so TPM is sourced: Reload TMUX environment so TPM is sourced:
# type this in terminal # type this in terminal
$ tmux source-file ~/.tmux.conf $ tmux source ~/.tmux.conf
That's it! That's it!
(**Note:** using `set -g @tpm_plugins` is deprecated, but still works alongside
new syntax)
### Installing plugins ### Installing plugins
1. add a new plugin to the `@tpm_plugins` list 1. add new plugin to `.tmux.conf` with `set -g @plugin '...'`
2. hit `prefix + I` (I as in *I*nstall) to fetch the plugin 2. hit `prefix + I` (I as in **I**nstall) to fetch the plugin
You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced. You're good to go! The plugin was cloned to `~/.tmux/plugins/` dir and sourced.
### Uninstalling plugins ### Uninstalling plugins
1. remove plugin from `@tpm_plugins` list 1. remove (or comment out) plugin from the list
2. hit `prefix + alt + u` (u as in *u*install) to remove the plugin 2. hit `prefix + alt + u` (u as in **u**install) to remove the plugin
All the plugins are installed to `~/.tmux/plugins/` so if you want you can just All the plugins are installed to `~/.tmux/plugins/` so alternatively you can
find plugin directory there and remove it. find plugin directory there and remove it.
### Key bindings ### Key bindings
@@ -62,9 +61,9 @@ find plugin directory there and remove it.
- updates plugin(s) - updates plugin(s)
`prefix + alt + u` `prefix + alt + u`
- uninstall unused plugin(s) - uninstall plugins that are not on the plugin list
### List of plugins ### More plugins
For more plugins, check [here](https://github.com/tmux-plugins). For more plugins, check [here](https://github.com/tmux-plugins).
@@ -81,7 +80,7 @@ More advanced features, regular users probably do not need this:
### Tests ### Tests
Tests run on [travis](https://travis-ci.org/tmux-plugins/tpm). Tests for this project run on [travis](https://travis-ci.org/tmux-plugins/tpm).
When run locally, [vagrant](https://www.vagrantup.com/) is required. When run locally, [vagrant](https://www.vagrantup.com/) is required.
Run tests with: Run tests with: