Skip to content

Commit be43cb3

Browse files
authored
Document conditions for suppress_history (#817)
Closes #804
1 parent aef137f commit be43cb3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/configuration/examples.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,13 @@ selected upon loading.
308308

309309
tmuxp allows `suppress_history: false` to override the default command /
310310
suppression when building the workspace.
311-
This will add the `shell_command` to the bash history in the pane.
311+
This will add the `shell_command` to the shell history in the pane.
312+
The suppression of the `shell_command` commands from the shell's history
313+
occurs by prefixing the commands with a space when `suppress_history: true`.
314+
Accordingly, this functionality depends on the shell being appropriately
315+
configured: bash requires the shell variable `HISTCONTROL` to be set and
316+
include either of the values `ignorespace` or `ignoreboth` (to also ignore
317+
sequential duplicate commands), and zsh requires `setopt HIST_IGNORE_SPACE`.
312318

313319
````{tab} YAML
314320

0 commit comments

Comments
 (0)