From a97117f3c44d8ed9f27e1680b0ffb5c34c4d95eb Mon Sep 17 00:00:00 2001 From: Marcin Kulik Date: Sat, 2 Oct 2021 21:12:35 +0200 Subject: [PATCH] Better doc on desktop notifications --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5808219..84a8e65 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,8 @@ below), and defaults to `$SHELL` which is what you want in most cases. You can temporarily pause recording of terminal by pressing Ctrl+\. This is useful when you want to execute some commands during the recording session that should not be captured (e.g. pasting secrets). Resume by pressing -Ctrl+\ again. +Ctrl+\ again. When pausing desktop notification is displayed so +you're sure the sensitive output is not captured in the recording. Recording finishes when you exit the shell (hit Ctrl+D or type `exit`). If the recorded process is not a shell then recording finishes when @@ -357,12 +358,18 @@ pause_key = p step_key = ] [notifications] +; Desktop notifications are displayed on certain occasions, e.g. when +; pausing/resuming the capture of terminal with C-\ keyboard shortcut. ; Should desktop notifications be enabled, default: yes enabled = no ; Custom notification command -; Environment variable $TEXT contains notification text +; asciinema automatically detects available desktop notification system +; (notify-send on GNU/Linux, osacript/terminal-notifier on macOS). Custom +; command can be used if needed. +; When invoked, environment variable $TEXT contains notification text, while +; $ICON_PATH contains path to the asciinema logo image. command = tmux display-message "$TEXT" ```