Move all docs to 'docs/' dir

This commit is contained in:
Bruno Sutic 2015-10-08 18:44:32 +02:00
parent 4ca58931cc
commit 186c2b9e9b
No known key found for this signature in database
GPG Key ID: CAFA7B1B2914ED81
3 changed files with 30 additions and 28 deletions

View File

@ -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

26
docs/automatic_start.md Normal file
View File

@ -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.

View File

@ -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.

View File

@ -0,0 +1 @@
docs/automatic_start.md