Add troubleshooting docs

This commit is contained in:
Bruno Sutic 2015-08-10 20:18:32 +02:00
parent bfc7a2c2cb
commit 5de37f98bb
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
3 changed files with 31 additions and 0 deletions

View File

@ -4,6 +4,7 @@
- upgrade to new version of `tmux-test` - upgrade to new version of `tmux-test`
- bug: when using `emacs` copy mode, Enter does not quit screen after tpm - bug: when using `emacs` copy mode, Enter does not quit screen after tpm
installation/update. Fix by making `Escape` the key for emacs mode. installation/update. Fix by making `Escape` the key for emacs mode.
- add a doc with troubleshooting instructions
### v3.0.0, 2015-08-03 ### v3.0.0, 2015-08-03
- refactor `shared_set_tpm_path_constant` function - refactor `shared_set_tpm_path_constant` function

View File

@ -69,6 +69,8 @@ For more plugins, check [here](https://github.com/tmux-plugins).
### Docs ### Docs
- [Help, tpm not working](docs/tpm_not_working.md) - problem solutions
More advanced features and instructions, regular users probably do not need More advanced features and instructions, regular users probably do not need
this: this:

28
docs/tpm_not_working.md Normal file
View File

@ -0,0 +1,28 @@
# Help, tpm not working!
Here's the list of issues users had with `tpm`:
> Nothing works. `tpm` key bindings `prefix + I`, `prefix + U` not even
defined.
[Issue #22](https://github.com/tmux-plugins/tpm/issues/22)
- Do you have required `tmux` version to run `tpm`?<br/>
Check `tmux` version with `$ tmux -V` command and make sure it's higher or
equal to the required version for `tpm` as stated in the readme.
- ZSH tmux plugin might be causing issues.<br/>
If you have it installed, try disabling it and see if `tpm` works then.
> Weird sequence of characters show up when installing or updating plugins
[Issue #25](https://github.com/tmux-plugins/tpm/issues/25)
- This could be caused by [tmuxline.vim](https://github.com/edkolev/tmuxline.vim)
plugin. Uninstall it and see if things work.
> "failed to connect to server" error when sourcing .tmux.conf
[Issue #48](https://github.com/tmux-plugins/tpm/issues/48)
- Make sure `tmux source ~/.tmux.conf` command is ran from inside `tmux`.