tmuxtmuxOptions, hooks and formats

Choose documentation 1

latest

tmux catalog version

Latest (3.7c) 3.7c 3.2a

English

tmux 3.7c options, hooks and formats

option tmux3.7c

`lock-command`

Command to run when locking each client.

Scope: session
Type: Text
Default: lock -np
Set: set-option lock-command value
Read: show-options lock-command

Description#

Command to run when locking each client. The default is to run lock(1) with -np.

Releases#

tmux 3.7c : present
tmux 3.2a : present

Source#

Defined in: options-table.c:719
C source reference: options_table
CLI Manual: Original manual entry

Used by#

Library documentation that names this option.

Rust: client.Client.lock, error.Error.ClientSuspended, options.generated.LOCK_COMMAND, server.Server.lock_all, session.Session.lock
Go: tmux.GlobalSessionScope.SetLockCommand, tmux.Session.SetLockCommand, tmux.SessionOptionValues.LockCommand

Reference preview Open reference