Skip to content

Commit 186c2b9

Browse files
author
Bruno Sutic
committed
Move all docs to 'docs/' dir
1 parent 4ca5893 commit 186c2b9

File tree

3 files changed

+30
-28
lines changed

3 files changed

+30
-28
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ This action starts automatically when the plugin is installed.
2121

2222
Tmux is automatically started after the computer/server is turned on.
2323

24-
See the [instructions](scripts/handle_tmux_automatic_start/README.md) how to
25-
enable this for your system.
24+
See the [instructions](docs/automatic_start.md) how to enable this for your
25+
system.
2626

2727
#### Automatic restore
2828

@@ -75,6 +75,7 @@ required.
7575
- [behavior when running multiple tmux servers](docs/multiple_tmux_servers.md) -
7676
this doc is safe to skip, but you might want to read it if you're using tmux
7777
with `-L` or `-S` flags
78+
- [automatically start tmux after the computer is turned on](docs/automatic_start.md)
7879

7980
### Other goodies
8081

docs/automatic_start.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Automatic Tmux start
2+
3+
Tmux is automatically started after the computer/server is turned on.
4+
5+
### OS X
6+
7+
To enable this feature:
8+
- put `set -g @continuum-boot 'on'` in `tmux.conf`
9+
- reload tmux config with this shell command: `$ tmux source-file ~/.tmux.conf`
10+
11+
Next time the computer is started:
12+
- `Terminal.app` window will open and resize to maximum size
13+
- `tmux` command will be executed in the terminal window
14+
- if "auto restore" feature is enabled, tmux will start restoring previous env
15+
16+
Config options:
17+
- `set -g @continuum-boot-options 'fullscreen'` - terminal window
18+
will go fullscreen
19+
- `set -g @continuum-boot-options 'iterm'` - start `iTerm` instead
20+
of `Terminal.app`
21+
- `set -g @continuum-boot-options 'iterm,fullscreen'` - start `iTerm`
22+
in fullscreen
23+
24+
### Linux
25+
26+
Help with this would be greatly appreciated. Please get in touch.

scripts/handle_tmux_automatic_start/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/automatic_start.md

0 commit comments

Comments
 (0)