Update tmux Integration Best Practices authored by George Nachman's avatar George Nachman
......@@ -81,6 +81,14 @@ After changing the value of `set-titles` you must detach and reattach to tmux fo
The tmux option `set-titles-string` defines the contents of the title. The default value doesn't make much sense in tmux integration since it includes a bunch of information you might not care about, like the window number. See the tmux man page for more information on this.
## How do session names work?
The previous section described window names and window titles. Tmux has a concept of a "window pane" which maps onto an iTerm2 "split pane". In iTerm2, a split pane has a name. In tmux, a window pane has a name. You can edit the name of both in **Edit Session > Session Name**. In a tmux integration session this is surfaced in the per-pane titlebar, which is visible only when there are split panes (if the feature is enabled).
When you open **Edit Session** in tmux integration, you can choose to edit either the *Session Name* or the *Tab Title*. Editing the *Session Name* will not have an effect on the tab title.
Control sequences in tmux (like `\e]0;title\\\e`) modify the session name.
## I want to do something dangerous
Turn on **Prefs > Advanced > Allow variable window sizes in tmux integration**. Ensure you have the most recent version of tmux installed. This is kinda half-baked at the moment, but it works well enough to be useful for some people. I expect to finish polishing it up some time this year (2019).
\ No newline at end of file