Skip to content

Minor (but IMO critical) language update in documentation #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
Features:

- continuous saving of tmux environment
- automatic tmux start when computer/server is turned on
- automatic tmux start when computer/server is turned on and the user logs in
- automatic restore when tmux is started

Together, these features enable uninterrupted tmux usage. No matter the computer
or server restarts, if the machine is on, tmux will be there how you left it off
the last time it was used.
the last time it was used once you log back in.

Tested and working on Linux, OSX and Cygwin.

Expand Down
14 changes: 8 additions & 6 deletions docs/automatic_start.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Automatic Tmux start

Tmux is automatically started after the computer/server is turned on.
Tmux is automatically started after the user logs in.

### 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:
Next time the computer is started and the user logs in:
- `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
Expand All @@ -28,10 +28,12 @@ Config options:
- `set -g @continuum-boot-options 'alacritty,fullscreen'` - start `alacritty`
in fullscreen

Note: The first time you reboot your machine and activate this feature you may be prompted about a script requiring
access to a system program (i.e. - System Events). If this happens tmux will not start automatically and you will need
to go to `System Preferences -> Security & Privacy -> Accessability` and add the script to the list of apps that are
allowed to control your computer.
Note: The first time you reboot your machine and activate this feature you may
be prompted about a script requiring access to a system program (i.e. - System
Events) upon first login. If this happens tmux will not start automatically and
you will need to go to `System Preferences -> Security & Privacy ->
Accessability` and add the script to the list of apps that are allowed to
control your computer. This may require administrative access.

### Linux

Expand Down