From 620f06c524cc6ea2761c7cbc4640ac0a3fc3e7b4 Mon Sep 17 00:00:00 2001 From: Bruno Sutic Date: Mon, 14 Dec 2015 01:21:47 +0100 Subject: [PATCH 1/2] Undeprecate 'set -g @tpm_plugins' --- CHANGELOG.md | 1 + README.md | 3 --- docs/tpm_not_working.md | 26 ++++++++++++++++++++++++++ scripts/helpers/plugin_functions.sh | 2 +- 4 files changed, 28 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d83ca0..672d3e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ - add `.gitattributes` file that forces linefeed characters (classic `\n`) as line endings - helps with misconfigured git on windows/cygwin - readme update: announce Cygwin support +- un-deprecate old plugin definition syntax: `set -g @tpm_plugins` ### v3.0.0, 2015-08-03 - refactor `shared_set_tpm_path_constant` function diff --git a/README.md b/README.md index 14765b7..3ba4330 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,6 @@ Reload TMUX environment so TPM is sourced: That's it! -(**Note:** using `set -g @tpm_plugins` is deprecated, but still works alongside -new syntax.) - ### Installing plugins 1. Add new plugin to `~/.tmux.conf` with `set -g @plugin '...'` diff --git a/docs/tpm_not_working.md b/docs/tpm_not_working.md index 95e3ba7..5c84e7e 100644 --- a/docs/tpm_not_working.md +++ b/docs/tpm_not_working.md @@ -14,6 +14,32 @@ Here's the list of issues users had with `tpm`: - ZSH tmux plugin might be causing issues.
If you have it installed, try disabling it and see if `tpm` works then. +> Help, I'm using `tmux -f /path/to/my_tmux.conf` option to start Tmux and for +some reason plugins aren't loaded!? + +[Issue #57](https://github.com/tmux-plugins/tpm/issues/57) + +`tpm` has a known issue when using alternative config file with `-f` option. +The solution is to use alternative plugin definition. Here are the steps to +make it work: + +1. remove all `set -g @plugin` lines from tmux config file +2. in the config file define the plugins in the following way: + + # List of plugins + set -g @tpm_plugins ' \ + tmux-plugins/tpm \ + tmux-plugins/tmux-sensible \ + tmux-plugins/tmux-resurrect \ + ' + + # Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf) + run '~/.tmux/plugins/tpm/tpm' + +3. Reload TMUX environment so TPM is sourced: `$ tmux source /path/to/my_tmux.conf` + +The plugins should now be working. + > Weird sequence of characters show up when installing or updating plugins [Issue #25](https://github.com/tmux-plugins/tpm/issues/25) diff --git a/scripts/helpers/plugin_functions.sh b/scripts/helpers/plugin_functions.sh index 124c40f..6ee7a5d 100644 --- a/scripts/helpers/plugin_functions.sh +++ b/scripts/helpers/plugin_functions.sh @@ -38,7 +38,7 @@ tpm_path() { } tpm_plugins_list_helper() { - # DEPRECATED: lists plugins from @tpm_plugins option + # lists plugins from @tpm_plugins option echo "$(tmux start-server\; show-option -gqv "$tpm_plugins_variable_name")" # read set -g @plugin "tmux-plugins/tmux-example-plugin" entries From 51ff07a729b4b67f692936ad75cb0650149afbb4 Mon Sep 17 00:00:00 2001 From: Bruno Sutic Date: Mon, 14 Dec 2015 01:26:16 +0100 Subject: [PATCH 2/2] Docs wording change --- docs/tpm_not_working.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/tpm_not_working.md b/docs/tpm_not_working.md index 5c84e7e..459ab01 100644 --- a/docs/tpm_not_working.md +++ b/docs/tpm_not_working.md @@ -14,14 +14,14 @@ Here's the list of issues users had with `tpm`: - ZSH tmux plugin might be causing issues.
If you have it installed, try disabling it and see if `tpm` works then. -> Help, I'm using `tmux -f /path/to/my_tmux.conf` option to start Tmux and for -some reason plugins aren't loaded!? +> Help, I'm using custom config file with `tmux -f /path/to/my_tmux.conf` +to start Tmux and for some reason plugins aren't loaded!? [Issue #57](https://github.com/tmux-plugins/tpm/issues/57) -`tpm` has a known issue when using alternative config file with `-f` option. -The solution is to use alternative plugin definition. Here are the steps to -make it work: +`tpm` has a known issue when using custom config file with `-f` option. +The solution is to use alternative plugin definition syntax. Here are the steps +to make it work: 1. remove all `set -g @plugin` lines from tmux config file 2. in the config file define the plugins in the following way: