Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 11:48:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Better doc on desktop notifications

Browse Source
This commit is contained in:
Marcin Kulik
2021-10-02 21:12:35 +02:00
parent 6fefeec585
commit a97117f3c4
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -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 <kbd>Ctrl+\</kbd>. You can temporarily pause recording of terminal by pressing <kbd>Ctrl+\</kbd>.
This is useful when you want to execute some commands during the recording 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 session that should not be captured (e.g. pasting secrets). Resume by pressing
<kbd>Ctrl+\</kbd> again. <kbd>Ctrl+\</kbd> 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 <kbd>Ctrl+D</kbd> or type Recording finishes when you exit the shell (hit <kbd>Ctrl+D</kbd> or type
`exit`). If the recorded process is not a shell then recording finishes when `exit`). If the recorded process is not a shell then recording finishes when
@@ -357,12 +358,18 @@ pause_key = p
step_key = ] step_key = ]
[notifications] [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 ; Should desktop notifications be enabled, default: yes
enabled = no enabled = no
; Custom notification command ; 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" command = tmux display-message "$TEXT"
``` ```