File: notify.rst

package info (click to toggle)
kitty 0.42.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 28,564 kB
  • sloc: ansic: 82,787; python: 55,191; objc: 5,122; sh: 1,295; xml: 364; makefile: 143; javascript: 78
file content (43 lines) | stat: -rw-r--r-- 1,296 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
notify
==================================================

.. only:: man

    Overview
    --------------

Show pop-up system notifications.

.. highlight:: sh

.. versionadded:: 0.36.0
   The notify kitten

The ``notify`` kitten can be used to show pop-up system notifications
from the shell. It even works over SSH. Using it is as simple as::

    kitten notify "Good morning" Hello world, it is a nice day!

To add an icon, use::

    kitten notify --icon-path /path/to/some/image.png "Good morning" Hello world, it is a nice day!
    kitten notify --icon firefox "Good morning" Hello world, it is a nice day!


To be informed when the notification is activated::

    kitten notify --wait-for-completion "Good morning" Hello world, it is a nice day!

Then, the kitten will wait till the notification is either closed or activated.
If activated, a ``0`` is printed to :file:`STDOUT`. You can press the
:kbd:`Esc` or :kbd:`Ctrl+c` keys to abort, closing the notification.

To add buttons to the notification::

    kitten notify --wait-for-completion --button One --button Two "Good morning" Hello world, it is a nice day!

.. program:: kitty +kitten notify

.. tip:: Learn about the underlying :doc:`/desktop-notifications` escape code protocol.

.. include:: /generated/cli-kitten-notify.rst