~~PAGEIMAGE::tools:tmux:media:20231026-170709.png~~

====== Tmux ======

{{template>:meta:template:pageinfo#tpl
|desc=Document common information about <wrap pkg>tmux</wrap>.}}

===== Hotkey =====
Tmux uses __hotkey twice__. The default first one is fixed to 
<wrap keys><wrap key>Ctrl</wrap><wrap key>b</wrap></wrap>, 
and some common second hotkeys((note:>A full list of supported hotkeys can be found 
[[http://man.openbsd.org/OpenBSD-current/man1/tmux.1#DEFAULT_KEY_BINDINGS|here]].)) are listed below.

<datatables>
^ Second Hotkey                            ^ Description                                                                                                       ^
| <wrap #cmd-input-mode /><wrap key>:</wrap>                       | Activate the command input mode, then you can use the commands listed in the [[#Commands]] section of this page.  |
| <wrap key>d</wrap>                       | Detach the current client.                                                                                        |
| <wrap key>"</wrap>                       | Split the current pane into two, top and bottom.                                                                  |
| <wrap key>%</wrap>                       | Split the current pane into two, left and right.                                                                  |
| <wrap key>0</wrap> - <wrap key>9</wrap>  | Select windows 0 to 9.                                                                                            |
| <wrap key>[</wrap>                       | Enter copy mode to copy text or view the history.                                                                 |
| <wrap key>]</wrap>                       | Paste the most recently copied buffer of text.                                                                    |
| <wrap key>c</wrap>                       | Create a new window.                                                                                              |
| <wrap key>x</wrap>                       | Kill the current pane.                                                                                            |
| <wrap key>&</wrap>                       | Kill the current window.                                                                                          |
| <wrap key>f</wrap>                       | Prompt to search for text in open windows.                                                                        |
| <wrap key>,</wrap>                       | Rename the current window.                                                                                        |
</datatables>

===== Commands =====
<datatables>
^ Command                                                             ^ Description                                                                                       ^
| <wrap cmd>set -g mouse on</wrap>                                    | Turn on mouse mode, in which you can switch the window grid or scroll the screen.                 |
| <wrap cmd>set -g default-terminal %%"%%screen-256color%%"%%</wrap>  | Change the color scheme to ''screen-256color'', which is the default scheme for the Linux shell.  |
| <wrap cmd>kill-session -t <wrap cmdp>id/name</wrap></wrap>          | Kill the session specified by <wrap cmdp>id</wrap> or <wrap cmdp>name</wrap>.                     |
| <wrap cmd>source <wrap cmdp>/path/to/tmux.conf</wrap></wrap>        | Apply <wrap file>/path/to/tmux.conf</wrap> to the current tmux server.                            |
</datatables>

===== Configuration File =====

When the tmux server is started, tmux runs a file called <wrap file>.tmux.conf</wrap> 
in the user's __home directory__. This file contains a list of tmux commands which are
executed in order.

<callout type="warning">
<wrap file>.tmux.conf</wrap> can only be applied when the tmux server is started or when running
<wrap cmd>source <wrap cmdp>path/to/.tmux.conf</wrap></wrap> manually in [[#cmd-input-mode|command input mode]],
not when a new session is created.((ref:>https://github.com/tmux/tmux/wiki/Getting-Started#the-configuration-file))
</callout>

For example, add the following commands ((note:>Run <wrap cmd>tmux -V</wrap>
to get the tmux version, then select the appropriate commands.)) to <wrap file>.tmux.conf</wrap>,
then reopen a new terminal and run <wrap cmd>tmux</wrap> to start tmux server.

  * Versions after (and including) 2.1 <codeprism lang=bash>
set -g mouse on
set -g default-terminal "screen-256color"
</codeprism>

  * Versions before 2.1 <codeprism lang=bash>
set -g mode-mouse on
set -g mouse-resize-pane on
set -g mouse-select-pane on
set -g mouse-select-window on
</codeprism>

{{template>meta:template:refnote#note}}
{{template>meta:template:refnote#ref}}

===== Further Reading =====

  * //[[https://github.com/tmux/tmux/wiki/Getting-Started#configuring-tmux]]//