41 lines
1.5 KiB
Markdown
Raw Normal View History

2021-12-23 22:35:00 -05:00
# tmux-autoattach.plugin
2021-12-23 22:35:00 -05:00
This tmux plugin will automatically attach a tmux session to your shell session.
2021-12-23 22:35:00 -05:00
## Variables
2021-12-23 22:35:00 -05:00
#### OSH_PLUGIN_TMUX_AUTOATTACH_BEHAVIOR
| Setting | Description |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `detach` (default) | This will allow you to detach from the tmux screen without closing the terminal or shell session. |
| `exit` | This will completely close out your shell session, including your terminal, but keep your tmux sessions intact. This will also close your session if you detach. |
## Common Enable Conditions
*Note* If you prefer to manually start your desktop session using tools like `startx`, you may run into problems starting your desktop session inside of a tmux terminal. You can employ conditionals to control when this plugin should be enabled.
**SSH**
```bash
[ "$SSH_TTY" ] && plugins+=(tmux-autoattach)
```
**Wayland**
```bash
[ "$DISPLAY_WAYLAND" ] && plugins+=(tmux-autoattach)
```
**X11**
```bash
[ "$DISPLAY" ] && plugins+=(tmux-autoattach)
```
**Multiple**
```bash
{ [ "$DISPLAY" ] || [ "$SSH" ]; } && plugins+=(tmux-autoattach)
```