add docs and docs link

This commit is contained in:
Jorge Morante 2017-04-02 19:51:19 +02:00
parent 2f0487280d
commit f41464ca71
2 changed files with 31 additions and 1 deletions

28
docs/health-check.md Normal file
View File

@ -0,0 +1,28 @@
# Health check troubleshooting
*tmux-fingers* performs a health check on startup to ensure that your system has all dependencies needed to run smoothly.
They are not much, and in most GNU/linux environments these are the defaults anyway.
## gawk not found
Install `gawk` package.
### OSX
`$ brew install gawk`
### Linux
* Ubuntu: `$ sudo aptitude install gawk`
* Arch linux: `$ sudo pacman -S install gawk`
## bash version is too old
This probably means you are running OSX, which ships with *bash 3*. In order to upgrade to *bash 4* you need need to run:
`$ brew install bash`
## tmux version is too old
You can install latest *tmux* from source, check https://github.com/tmux/tmux

View File

@ -68,7 +68,9 @@ function perform_health_check() {
: # waiting for-tmux
done
tmux run "echo -e 'tmux-fingers health-check:\\n\\n'; cat $health_tmp"
log_health "For more info check $HELP_LINK"
log_health "To skip this check add \"set -g @fingers-skip-health-check 1\" to your tmux conf"
tmux run "echo -e \"tmux-fingers health-check:\"; cat $health_tmp"
fi
rm -rf "$health_tmp"