Skip to content

Commit 5337a53

Browse files
committed
docs(installation): add missing cautions for bash-preexec
This is also the descriptions in README.md (@atuinsh/atuin) removed by [1] and not reflected in atuinsh/docs. [1] atuinsh/atuin#2203
1 parent 0b895ce commit 5337a53

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/content/docs/guide/installation.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,14 @@ After installing, remember to restart your shell.
150150
bash-preexec currently has an issue where it will stop honoring `ignorespace`.
151151
While Atuin will ignore commands prefixed with whitespace, they may still end up in your bash history.
152152
Please check your configuration! All other shells do not have this issue.
153+
154+
To use Atuin in `bash < 4` with bash-preexec, the option `enter_accept` needs
155+
to be turned on (which is so by default).
156+
157+
bash-preexec cannot properly invoke the `preexec` hook for subshell commands
158+
`(...)`, function definitions `func() { ...; }`, empty for-in-statements `for
159+
i in; do ...; done`, etc., so those commands and duration may not be recorded
160+
in the Atuin's history correctly.
153161
</Aside>
154162

155163
To use bash-preexec, download and initialize it

0 commit comments

Comments
 (0)