dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 23:08:00 +00:00
Code Issues Releases Wiki Activity
e7a12fdf06
prezto/modules/tmux/README.md

96 lines
2.7 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Tmux
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
Defines [_tmux_][1] aliases and provides for auto launching it at start-up.
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Settings
Add documentation for tmux
2012-03-29 20:31:55 +00:00
Correct title casing in screen and tmux READMEs
2012-06-14 22:01:01 +00:00
### Auto-Start
Add documentation for tmux
2012-03-29 20:31:55 +00:00
Improve diction in documentation
2012-06-02 21:17:12 +00:00
Starts a tmux session automatically when Zsh is launched.
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
To enable this feature when launching Zsh in a local terminal, add the following
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
Add documentation for tmux
2012-03-29 20:31:55 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:tmux:auto-start' local 'yes'
```
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
To enable this feature when launching Zsh in a SSH connection, add the following
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
Increase control over multiplexer auto-start Setting the auto-start 'remote' and 'local' zstyles for the screen and tmux modules to 'true' automatically starts a session in SSH connections and in local terminals respectively. Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2013-01-24 13:54:55 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:tmux:auto-start' remote 'yes'
```
Increase control over multiplexer auto-start Setting the auto-start 'remote' and 'local' zstyles for the screen and tmux modules to 'true' automatically starts a session in SSH connections and in local terminals respectively. Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2013-01-24 13:54:55 +00:00
[Fix #543] Do not set tmux destroy-unattached Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-02-21 19:13:21 +00:00
In both cases, it will create a background session named _prezto_ if the tmux
server is not started.
Add documentation for tmux
2012-03-29 20:31:55 +00:00
Add the ability to specify tmux session name
2017-05-03 00:57:00 +00:00
You can change the default session name with:
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:tmux:session' name '<YOUR DEFAULT SESSION NAME>'
```
Add the ability to specify tmux session name
2017-05-03 00:57:00 +00:00
[Fix #543] Do not set tmux destroy-unattached Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-02-21 19:13:21 +00:00
With `auto-start` enabled, you may want to control how multiple sessions are
managed. The `destroy-unattached` option of tmux controls if the unattached
sessions must be kept alive, making sessions available for later use, configured
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
in _tmux.conf_:
[Fix #543] Do not set tmux destroy-unattached Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-02-21 19:13:21 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```conf
set-option -g destroy-unattached [on | off]
```
Add documentation for tmux
2012-03-29 20:31:55 +00:00
Enable iTerm2 tmux integration Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-11-06 23:15:23 +00:00
#### iTerm2 Integration
[iTerm2][6] offers significant integration with tmux. This can be enabled by
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
adding the following line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
Enable iTerm2 tmux integration Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-11-06 23:15:23 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:tmux:iterm' integrate 'yes'
```
Enable iTerm2 tmux integration Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-11-06 23:15:23 +00:00
Read [iTerm2 and tmux Integration][7] for more information.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Aliases
Move settings right bellow module description
2012-06-10 23:49:33 +00:00
general: Documentation update for zstyle based alias skipping support Add documentation to surface the `zstyle` based alias skipping.
2023-05-05 03:21:48 +00:00
Aliases are enabled by default. To disable them, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
```sh
zstyle ':prezto:module:tmux:alias' skip 'yes'
```
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `tmuxa` attaches or switches to a tmux session.
- `tmuxl` lists sessions managed by the tmux server.
Move settings right bellow module description
2012-06-10 23:49:33 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Caveats
Add documentation for tmux
2012-03-29 20:31:55 +00:00
Rename "Mac OS X" to "macOS" in comments This only changes references in text for human consumption. It leaves out renaming paths because that can cause breaking changes. Related issue https://github.com/sorin-ionescu/prezto/issues/1449.
2018-04-16 22:51:57 +00:00
On macOS, launching tmux can cause the error **launch_msg(...): Socket is not
[Fix #139] Document a startup error in tmux module
2012-04-13 12:28:15 +00:00
connected** to be displayed, which can be fixed by installing
[reattach-to-user-namespace][3], available in [Homebrew][4], and adding the
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
following to _tmux.conf_:
[Fix #139] Document a startup error in tmux module
2012-04-13 12:28:15 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```conf
set-option -g default-command "reattach-to-user-namespace -l $SHELL -l"
```
[Fix #139] Document a startup error in tmux module
2012-04-13 12:28:15 +00:00
Rename "Mac OS X" to "macOS" in comments This only changes references in text for human consumption. It leaves out renaming paths because that can cause breaking changes. Related issue https://github.com/sorin-ionescu/prezto/issues/1449.
2018-04-16 22:51:57 +00:00
Furthermore, tmux is known to cause **kernel panics** on macOS. A discussion
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
about this and Prezto has already been [opened][2].
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Authors
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_The authors of this module should be contacted via the [issue tracker][5]._
Add documentation for tmux
2012-03-29 20:31:55 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- [Sorin Ionescu](https://github.com/sorin-ionescu)
- [Colin Hebert](https://github.com/ColinHebert)
- [Georges Discry](https://github.com/gdiscry)
- [Xavier Cambar](https://github.com/xcambar)
Update documentation for tmux
2012-04-04 13:22:02 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[1]: https://tmux.github.io/
Fix URLs in tmux documentation Use full URLs instead of relative urls. Fix link about kernel issues with tmux on Mac OS X.
2012-09-12 08:00:10 +00:00
[2]: https://github.com/sorin-ionescu/prezto/issues/62
[3]: https://github.com/ChrisJohnsen/tmux-MacOSX-pasteboard
[4]: https://github.com/mxcl/homebrew
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
[5]: https://github.com/sorin-ionescu/prezto/issues
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[6]: https://iterm2.com
Update the link to iTerm2 and tmux integration Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2015-05-01 13:35:59 +00:00
[7]: https://gitlab.com/gnachman/iterm2/wikis/TmuxIntegration
Reference in New Issue Copy Permalink