summaryrefslogtreecommitdiff
path: root/plugins/bwana
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/bwana')
-rw-r--r--plugins/bwana/README.md12
-rw-r--r--plugins/bwana/bwana.plugin.zsh8
2 files changed, 16 insertions, 4 deletions
diff --git a/plugins/bwana/README.md b/plugins/bwana/README.md
new file mode 100644
index 000000000..dd4fe9f9c
--- /dev/null
+++ b/plugins/bwana/README.md
@@ -0,0 +1,12 @@
+# Bwana
+
+This plugin provides a function to open `man` pages directly with [Bwana](https://www.bruji.com/bwana/).
+
+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 455da8621..71c9eb18d 100644
--- a/plugins/bwana/bwana.plugin.zsh
+++ b/plugins/bwana/bwana.plugin.zsh
@@ -1,13 +1,13 @@
#
-# Requires http://www.bruji.com/bwana/
+# Requires https://www.bruji.com/bwana/
#
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 "To use it within Zsh, install it from http://www.bruji.com/bwana/"
+ 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