1
1
# Tmux Plugin Manager
2
2
3
- [ ![ Build Status] ( https://travis-ci.org/tmux-plugins/tpm.png ?branch=master )] ( https://travis-ci.org/tmux-plugins/tpm )
3
+ [ ![ Build Status] ( https://travis-ci.org/tmux-plugins/tpm.svg ?branch=master )] ( https://travis-ci.org/tmux-plugins/tpm )
4
4
5
- Installs and loads TMUX plugins.
5
+ Installs and loads ` tmux ` plugins.
6
6
7
7
Tested and working on Linux, OSX, and Cygwin.
8
8
@@ -12,54 +12,60 @@ Requirements: `tmux` version 1.9 (or higher), `git`, `bash`.
12
12
13
13
Clone TPM:
14
14
15
- $ git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
15
+ ``` bash
16
+ $ git clone https://github.com/tmux-plugins/tpm ~ /.tmux/plugins/tpm
17
+ ```
16
18
17
19
Put this at the bottom of ` .tmux.conf ` :
18
20
19
- # List of plugins
20
- set -g @plugin 'tmux-plugins/tpm'
21
- set -g @plugin 'tmux-plugins/tmux-sensible'
21
+ ``` bash
22
+ # List of plugins
23
+ set -g @plugin ' tmux-plugins/tpm'
24
+ set -g @plugin ' tmux-plugins/tmux-sensible'
22
25
23
- # Other examples:
24
- # set -g @plugin 'github_username/plugin_name'
25
- # set -g @plugin '[email protected] /user/plugin'
26
- # set -g @plugin '[email protected] /user/plugin'
26
+ # Other examples:
27
+ # set -g @plugin 'github_username/plugin_name'
28
+ # set -g @plugin '[email protected] /user/plugin'
29
+ # set -g @plugin '[email protected] /user/plugin'
27
30
28
- # Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
29
- run '~/.tmux/plugins/tpm/tpm'
31
+ # Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
32
+ run ' ~/.tmux/plugins/tpm/tpm'
33
+ ```
30
34
31
35
Reload TMUX environment so TPM is sourced:
32
36
33
- # type this in terminal if tmux is already running
34
- $ tmux source ~/.tmux.conf
37
+ ``` bash
38
+ # type this in terminal if tmux is already running
39
+ $ tmux source ~ /.tmux.conf
40
+ ```
35
41
36
42
That's it!
37
43
38
44
### Installing plugins
39
45
40
46
1 . Add new plugin to ` ~/.tmux.conf ` with ` set -g @plugin '...' `
41
- 2 . Press ` prefix + I ` (capital I, as in ** I** nstall) to fetch the plugin.
47
+ 2 . Press ` prefix ` + < kbd >I</ kbd > (capital I, as in ** I** nstall) to fetch the plugin.
42
48
43
49
You're good to go! The plugin was cloned to ` ~/.tmux/plugins/ ` dir and sourced.
44
50
45
51
### Uninstalling plugins
46
52
47
53
1 . Remove (or comment out) plugin from the list.
48
- 2 . Press ` prefix + alt + u ` (lowercase u as in ** u** ninstall) to remove the plugin.
54
+ 2 . Press ` prefix ` + < kbd > alt</ kbd > + < kbd >u</ kbd > (lowercase u as in ** u** ninstall) to remove the plugin.
49
55
50
56
All the plugins are installed to ` ~/.tmux/plugins/ ` so alternatively you can
51
57
find plugin directory there and remove it.
52
58
53
59
### Key bindings
54
60
55
- ` prefix + I `
61
+ ` prefix ` + < kbd >I</ kbd >
56
62
- Installs new plugins from GitHub or any other git repository
57
63
- Refreshes TMUX environment
58
64
59
- ` prefix + U `
65
+ ` prefix ` + < kbd >U</ kbd >
60
66
- updates plugin(s)
61
67
62
- ` prefix + alt + u `
68
+ ` prefix ` + < kbd > alt</ kbd > + < kbd >u</ kbd >
63
69
- remove/uninstall plugins not on the plugin list
64
70
65
71
### More plugins
@@ -80,13 +86,15 @@ this:
80
86
81
87
### Tests
82
88
83
- Tests for this project run on [ travis ] ( https://travis-ci.org/tmux-plugins/tpm ) .
89
+ Tests for this project run on [ Travis CI ] ( https://travis-ci.org/tmux-plugins/tpm ) .
84
90
85
91
When run locally, [ vagrant] ( https://www.vagrantup.com/ ) is required.
86
92
Run tests with:
87
93
88
- # within project directory
89
- $ ./run_tests
94
+ ``` bash
95
+ # within project directory
96
+ $ ./run_tests
97
+ ```
90
98
91
99
### Other goodies
92
100
0 commit comments