Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.tmux.enable

Whether to enable tmux.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.tmux.package

The tmux package to use.

Type: null or package

Default:

pkgs.tmux

Declared by:

programs.tmux.aggressiveResize

Resize the window to the size of the smallest session for which it is the current window.

Type: boolean

Default:

false

Declared by:

programs.tmux.baseIndex

Base index for windows and panes.

Type: unsigned integer, meaning >=0

Default:

0

Example:

1

Declared by:

programs.tmux.clock24

Use 24 hour clock.

Type: boolean

Default:

false

Declared by:

programs.tmux.customPaneNavigationAndResize

Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode.

Type: boolean

Default:

false

Declared by:

programs.tmux.disableConfirmationPrompt

Disable confirmation prompt before killing a pane or window

Type: boolean

Default:

false

Declared by:

programs.tmux.escapeTime

Time in milliseconds for which tmux waits after an escape is input.

Type: unsigned integer, meaning >=0

Default:

10

Example:

0

Declared by:

programs.tmux.extraConfig

Additional configuration to add to tmux.conf.

Type: strings concatenated with “\n”

Default:

""

Declared by:

programs.tmux.focusEvents

On supported terminals, request focus events and pass them through to applications running in tmux.

Type: boolean

Default:

false

Declared by:

programs.tmux.historyLimit

Maximum number of lines held in window history.

Type: positive integer, meaning >0

Default:

2000

Example:

5000

Declared by:

programs.tmux.keyMode

VI or Emacs style shortcuts.

Type: one of “emacs”, “vi”

Default:

"emacs"

Example:

"vi"

Declared by:

programs.tmux.mouse

Whether to enable mouse support.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.tmux.newSession

Automatically spawn a session if trying to attach and none are running.

Type: boolean

Default:

false

Declared by:

programs.tmux.plugins

List of tmux plugins to be included at the end of your tmux configuration. The sensible plugin, however, is defaulted to run at the top of your configuration.

Type: list of plugin packages or submodules

Default:

[ ]

Example:

with pkgs; [
  tmuxPlugins.cpu
  {
    plugin = tmuxPlugins.resurrect;
    extraConfig = "set -g @resurrect-strategy-nvim 'session'";
  }
  {
    plugin = tmuxPlugins.continuum;
    extraConfig = ''
      set -g @continuum-restore 'on'
      set -g @continuum-save-interval '60' # minutes
    '';
  }
]

Declared by:

programs.tmux.plugins.*.extraConfig

Additional configuration for the associated plugin.

Type: strings concatenated with “\n”

Default:

""

programs.tmux.plugins.*.plugin

The plugin package to use. Path of the configuration file to include.

Type: package

Example:

pkgs.tmuxPlugins.sensible

programs.tmux.prefix

Set the prefix key. Overrules the “shortcut” option when set.

Type: null or string

Default:

null

Example:

"C-a"

Declared by:

programs.tmux.resizeAmount

Number of lines/columns when resizing.

Type: positive integer, meaning >0

Default:

5

Example:

10

Declared by:

programs.tmux.reverseSplit

Reverse the window split shortcuts.

Type: boolean

Default:

false

Declared by:

programs.tmux.secureSocket

Store tmux socket under /run, which is more secure than /tmp, but as a downside it doesn’t survive user logout.

Type: boolean

Default:

true

Declared by:

programs.tmux.sensibleOnTop

Run the sensible plugin at the top of the configuration. It is possible to override the sensible settings using the programs.tmux.extraConfig option.

Type: boolean

Default:

false

Declared by:

programs.tmux.shell

Set the default-shell tmux variable.

Type: null or string

Default:

null

Example:

${pkgs.zsh}/bin/zsh

Declared by:

programs.tmux.shortcut

CTRL following by this key is used as the main shortcut.

Type: string

Default:

"b"

Example:

"a"

Declared by:

programs.tmux.terminal

Set the $TERM variable.

Type: string

Default:

"screen"

Example:

"screen-256color"

Declared by:

programs.tmux.tmuxinator.enable

Whether to enable tmuxinator.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.tmux.tmuxinator.package

The tmuxinator package to use.

Type: null or package

Default:

pkgs.tmuxinator

Declared by:

programs.tmux.tmuxinator.projects

Tmuxinator projects to write to $HOME/.config/tmuxinator. One project configuration file is generated per attribute. See https://github.com/tmuxinator/tmuxinator for the project configuration format.

Type: attribute set of (YAML 1.1 value)

Default:

{ }

Example:

{
  myproject = {
    root = "~/code/myproject";
    windows = [
      {
        editor = {
          layout = "main-vertical";
          panes = [
            {
              editor = [
                "vim"
              ];
            }
            "guard"
          ];
        };
      }
      {
        server = "bundle exec rails s";
      }
      {
        logs = "tail -f log/development.log";
      }
    ];
  };
}

Declared by:

programs.tmux.tmuxp.enable

Whether to enable tmuxp.

Type: boolean

Default:

false

Example:

true

Declared by: