summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJomar Milan <jomarm@pyrodax.com>2026-08-23 19:49:51 -0700
committerJomar Milan <jomarm@pyrodax.com>2026-08-23 19:49:51 -0700
commit2660542fb713d07c53738173510fbbf52f149cc6 (patch)
tree7cd119e33a235a8698c892c58eeb03cd6fdda8df
parent12bccdef008730a5f45438c18e492b0209c6745a (diff)
Update README to fit OSC 777 in existing sections
-rw-r--r--README.md24
1 files changed, 6 insertions, 18 deletions
diff --git a/README.md b/README.md
index 7ba1514..2b38411 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,12 @@
# osc-notify
This is a [Tabby](https://github.com/Eugeny/tabby) plugin. It creates a system
-notification when an OSC 9 escape code sequence is printed. OSC 9 is in this
-format:
+notification when certain OSC escape code sequences are printed. The following
+OSC escape codes are supported:
```sh
OSC 9 ; [message] ST
-```
-
-Clicking the notification brings Tabby to the front and switches to the exact
-tab/pane that emitted the sequence. The notification title reflects the tab's
-current title at the time the sequence is received.
-
-The OSC 9 title is cleaned up: it prefers a user-set custom tab name, and when
-the title looks like a filesystem path (e.g. a shell tab showing its cwd) only
-the last path segment is used instead of the full, often-truncated path.
-
-`OSC 777 ; notify ; title ; body` (the rxvt/urxvt notification form) is also
-supported, letting a program set an explicit title and body:
-
-```sh
-# creates a notification titled 'Build' with body 'Done'
-printf "\033]777;notify;Build;Done\a"
+OSC 777 ; notify ; [title] ; [body] ST
```
### Example commands
@@ -32,4 +17,7 @@ printf "\033]9;hello\a"
# for tmux, use the passthrough escape sequence. allow-passthrough should be
# enabled
printf "\033Ptmux;\033\x1b]9;hello\x07\033\\"
+
+# creates a notification titled 'Build' with body 'Done'
+printf "\033]777;notify;Build;Done\a"
```