Skip to content

Commit 2841ad9

Browse files
authored
docs(installation): update descriptions for Bash (#64)
The details are explained in the commit messages.
1 parent 0352239 commit 2841ad9

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/content/docs/guide/installation.mdx

+9-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ After installing, remember to restart your shell.
136136
<TabItem label="ble.sh">
137137
Atuin works best in bash when using [ble.sh](https://github.com/akinomyoga/ble.sh).
138138

139-
With ble.sh installed, just add atuin to your .bashrc
139+
With ble.sh installed and loaded in `~/.bashrc`, just add atuin to your `~/.bashrc`
140140

141141
```shell
142142
echo 'eval "$(atuin init bash)"' >> ~/.bashrc
@@ -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)