From eb24578b085066d5647121acfc3640063ffc0272 Mon Sep 17 00:00:00 2001 From: Bruno Sutic Date: Sat, 1 Aug 2015 02:20:18 +0200 Subject: [PATCH] Document new 'bin/install_plugins' script --- CHANGELOG.md | 1 + bin/install_plugins | 5 +++++ bindings/install_plugins | 3 +++ docs/installing_plugins_via_cmd_line.md | 22 +++++++++------------- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d65bb6c..5c0bb83 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/bin/install_plugins b/bin/install_plugins index 9c45152..c66b15b 100755 --- a/bin/install_plugins +++ b/bin/install_plugins @@ -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" diff --git a/bindings/install_plugins b/bindings/install_plugins index 3ae21b8..f92bbbc 100755 --- a/bindings/install_plugins +++ b/bindings/install_plugins @@ -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" diff --git a/docs/installing_plugins_via_cmd_line.md b/docs/installing_plugins_via_cmd_line.md index d2fdbf7..23de371 100644 --- a/docs/installing_plugins_via_cmd_line.md +++ b/docs/installing_plugins_via_cmd_line.md @@ -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