aboutsummaryrefslogtreecommitdiff
path: root/hooks/on_start
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-08-25 19:19:14 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-08-25 19:19:14 +0200
commitf8a687cbb855ed4e3aa54128624101a21ba5a8c3 (patch)
tree14f708cf389fa406d2d873997953fb8869d4e2b7 /hooks/on_start
parent168361ef112c61391a615d8b1f0048b79a2b7237 (diff)
downloadttym-f8a687cbb855ed4e3aa54128624101a21ba5a8c3.tar.gz
ttym-f8a687cbb855ed4e3aa54128624101a21ba5a8c3.zip
hooks: ship three commented examples, install them, document the contract
Add hooks/on_start, hooks/on_done and hooks/on_quit. They are named after the hooks themselves so copying one into ~/.config/ttym/hooks/ is the entire installation step, and each carries its argument contract in a header comment. on_start sets the terminal window title to what is running on_done desktop notification plus a sound, both backgrounded, with the first available of paplay/aplay/mpv/ffplay on_quit records abandoned sessions to a TSV under XDG_STATE_HOME and restores the terminal title make install places them in PREFIX/share/doc/ttym/hooks; make uninstall removes them and both directories; make dist ships hooks/ with the executable bits intact. The man page's HOOKS section now documents what the code actually does rather than what could be assumed from the call sites: - $2 differs per hook: requested duration on on_start, full duration on on_done, and time actually elapsed -- excluding time spent paused -- on on_quit. An abandoned 25m countdown reports what really ran. - $3 is always passed, so it is never unset. - hooks block: timer forks and waitpid()s, so on_done delays the completion bell and the alert loop. Background anything slow. - stdin, stdout and stderr all go to /dev/null, which is why printing is pointless and cannot corrupt the redrawn progress line. - execvp(3) means a script needs a #! line. README gains a Hooks section. All three examples pass sh -n and shellcheck, and were tested end to end through the documented flow: make install to a staging prefix, copy into a config dir, run. Claude-Session: https://claude.ai/code/session_01APLBs8RB1FcUaC4viVkzbP
Diffstat (limited to 'hooks/on_start')
-rwxr-xr-xhooks/on_start26
1 files changed, 26 insertions, 0 deletions
diff --git a/hooks/on_start b/hooks/on_start
new file mode 100755
index 0000000..441d6f1
--- /dev/null
+++ b/hooks/on_start
@@ -0,0 +1,26 @@
+#!/bin/sh
+# ttym on_start -- runs when a session begins.
+#
+# $1 mode countdown | stopwatch
+# $2 seconds requested duration for a countdown, 0 for a stopwatch
+# $3 comment the -c text, or an empty string
+#
+# stdin, stdout and stderr are /dev/null: printing here goes nowhere and
+# cannot corrupt the redrawn progress line. timer waits for this to exit,
+# so keep it quick or background the slow part with &.
+
+mode=$1 seconds=$2 comment=$3
+
+# Name the terminal window after what is running.
+case $TERM in
+xterm*|rxvt*|tmux*|screen*|alacritty|foot*)
+ if [ "$mode" = countdown ]; then
+ printf '\033]0;timer %sm %s\007' "$((seconds / 60))" "$comment" > /dev/tty
+ else
+ printf '\033]0;stopwatch %s\007' "$comment" > /dev/tty
+ fi
+ ;;
+esac
+
+# Pause music while a countdown runs (uncomment to use):
+# [ "$mode" = countdown ] && playerctl pause 2>/dev/null