diff --git a/plugins/bwana/README.md b/plugins/bwana/README.md index 8cbeaa32e..dd4fe9f9c 100644 --- a/plugins/bwana/README.md +++ b/plugins/bwana/README.md @@ -7,3 +7,6 @@ To use it add bwana to the plugins array in your zshrc file. ```bash plugins=(... bwana) ``` + +The `bwana` function opens the man page of the passed argument in the Bwana app. +For example: `bwana ln` opens the man page for `ln` in Bwana. diff --git a/plugins/bwana/bwana.plugin.zsh b/plugins/bwana/bwana.plugin.zsh index b9a04793f..71c9eb18d 100644 --- a/plugins/bwana/bwana.plugin.zsh +++ b/plugins/bwana/bwana.plugin.zsh @@ -4,10 +4,10 @@ if [[ -e /Applications/Bwana.app ]] || ( system_profiler -detailLevel mini SPApplicationsDataType | grep -q Bwana ) then - function man() { + function bwana() { open "man:$1" } else - echo "Bwana lets you read man files in Safari through a man: URI scheme" + echo "Bwana lets you read man files in Safari through a man: URI scheme" echo "To use it within Zsh, install it from https://www.bruji.com/bwana/" fi