Document new 'bin/install_plugins' script

This commit is contained in:
Bruno Sutic 2015-08-01 02:20:18 +02:00
parent 40e6041512
commit eb24578b08
No known key found for this signature in database
GPG Key ID: 66D96E4F2F7EF26C
4 changed files with 18 additions and 13 deletions

View File

@ -3,6 +3,7 @@
### master
- refactor `shared_set_tpm_path_constant` function
- move all instructions to `docs/` dir
- add `bin/install_plugins` cli executable script
### v2.0.0, 2015-07-07
- enable overriding default key bindings

View File

@ -1,5 +1,10 @@
#!/usr/bin/env bash
# Script intended for use via the command line.
#
# `.tmux.conf` needs to be set for TPM. Tmux has to be installed on the system,
# but does not need to be started in order to run this script.
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
SCRIPTS_DIR="$CURRENT_DIR/../scripts"

View File

@ -1,5 +1,8 @@
#!/usr/bin/env bash
# Tmux key-binding script.
# Scripts intended to be used via the command line are in `bin/` directory.
CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
SCRIPTS_DIR="$CURRENT_DIR/../scripts"

View File

@ -1,20 +1,16 @@
# Installing plugins via the command line only
### From inside tmux
Run the following command to install plugins:
When you have `tmux` running, plugins can be installed with the following command:
~/.tmux/plugins/tpm/bin/install_plugins
~/.tmux/plugins/tpm/scripts/install_plugins.sh
Tmux does not need to be started in order to run the script (but it's okay if it
is).
This is the equivalent of pressing `prefix + I`.
If you [changed tpm install dir](docs/changing_plugins_install_dir.md) in
`.tmux.conf` that should work fine too.
### From outside tmux
Prerequisites:
To install the plugins when `tmux` is not even started (for example in a provisioning script):
# start tmux and create a session but don't attach to it
tmux new-session -d
# install the plugins
tmux run "~/.tmux/plugins/tpm/scripts/install_plugins.sh"
# killing the session is not required
tmux kill-session
- tmux installed on the system (doh)
- `.tmux.conf` set for TPM