diff --git a/README.md b/README.md index e65a471..2bad295 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ This action starts automatically when the plugin is installed. Tmux is automatically started after the computer/server is turned on. -See the [instructions](scripts/handle_tmux_automatic_start/README.md) how to -enable this for your system. +See the [instructions](docs/automatic_start.md) how to enable this for your +system. #### Automatic restore @@ -75,6 +75,7 @@ required. - [behavior when running multiple tmux servers](docs/multiple_tmux_servers.md) - this doc is safe to skip, but you might want to read it if you're using tmux with `-L` or `-S` flags +- [automatically start tmux after the computer is turned on](docs/automatic_start.md) ### Other goodies diff --git a/docs/automatic_start.md b/docs/automatic_start.md new file mode 100644 index 0000000..efff29c --- /dev/null +++ b/docs/automatic_start.md @@ -0,0 +1,26 @@ +# Automatic Tmux start + +Tmux is automatically started after the computer/server is turned on. + +### OS X + +To enable this feature: +- put `set -g @continuum-boot 'on'` in `tmux.conf` +- reload tmux config with this shell command: `$ tmux source-file ~/.tmux.conf` + +Next time the computer is started: +- `Terminal.app` window will open and resize to maximum size +- `tmux` command will be executed in the terminal window +- if "auto restore" feature is enabled, tmux will start restoring previous env + +Config options: +- `set -g @continuum-boot-options 'fullscreen'` - terminal window + will go fullscreen +- `set -g @continuum-boot-options 'iterm'` - start `iTerm` instead + of `Terminal.app` +- `set -g @continuum-boot-options 'iterm,fullscreen'` - start `iTerm` + in fullscreen + +### Linux + +Help with this would be greatly appreciated. Please get in touch. diff --git a/scripts/handle_tmux_automatic_start/README.md b/scripts/handle_tmux_automatic_start/README.md deleted file mode 100644 index efff29c..0000000 --- a/scripts/handle_tmux_automatic_start/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Automatic Tmux start - -Tmux is automatically started after the computer/server is turned on. - -### OS X - -To enable this feature: -- put `set -g @continuum-boot 'on'` in `tmux.conf` -- reload tmux config with this shell command: `$ tmux source-file ~/.tmux.conf` - -Next time the computer is started: -- `Terminal.app` window will open and resize to maximum size -- `tmux` command will be executed in the terminal window -- if "auto restore" feature is enabled, tmux will start restoring previous env - -Config options: -- `set -g @continuum-boot-options 'fullscreen'` - terminal window - will go fullscreen -- `set -g @continuum-boot-options 'iterm'` - start `iTerm` instead - of `Terminal.app` -- `set -g @continuum-boot-options 'iterm,fullscreen'` - start `iTerm` - in fullscreen - -### Linux - -Help with this would be greatly appreciated. Please get in touch. diff --git a/scripts/handle_tmux_automatic_start/README.md b/scripts/handle_tmux_automatic_start/README.md new file mode 120000 index 0000000..c0cc077 --- /dev/null +++ b/scripts/handle_tmux_automatic_start/README.md @@ -0,0 +1 @@ +docs/automatic_start.md \ No newline at end of file