summaryrefslogtreecommitdiff
path: root/help/C/notification.page
blob: f6dfd41fd7784144b87234d5028abd3e47813366 (plain)
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<page xmlns="http://projectmallard.org/1.0/"
      type="topic"
      id="notification">
  <info>
    <link type="guide" xref="index#dialogs"/>
    <desc>Use the <cmd>--notification</cmd> option.</desc>
  </info>
  <title>Notification Icon</title>
    <p>
	Use the <cmd>--notification</cmd> option to create a notification icon.
    </p>

    <terms>

      <item>
        <title><cmd>--text</cmd>=<var>text</var></title>
	  <p>Specifies the text that is displayed in the notification area.</p>
      </item>
      <item>
        <title><cmd>--listen</cmd>=icon: '<var>text</var>', message: '<var>text</var>', tooltip: '<var>text</var>', visible: '<var>text</var>',</title>
          <p>Listens for commands at standard input. At least one command must be specified. Commands are comma seperated. A command must be followed by a colon and a value. </p>
          <note style="tip">
            <p>The <cmd>icon</cmd> command also accepts four stock icon values such as <var>error</var>, <var>info</var>, <var>question</var> and <var>warning</var>.</p>
          </note>
      </item>
    </terms>

    <p>
      The following example script shows how to create a notification icon:
    </p>
<code>
#!/bin/sh

zenity --notification\
  --window-icon="info" \
  --text="There are system updates necessary!"
</code>

    <figure id="zenity-notification-screenshot">
      <title>Notification Icon Example</title>
      <desc><app>Zenity</app> notification icon example</desc>
      <media type="image" mime="image/png" src="figures/zenity-notification-screenshot.png"/>
   </figure>

    <p>
      The following example script shows how to create a notification icon along with <cmd>--listen</cmd>:
    </p>

<code>
#!/bin/sh

cat &#60;&#60;EOH| zenity --notification --listen
message: this is the message text
EOH
</code>

    <figure id="zenity-notification-listen-screenshot">
      <title>Notification Icon with <cmd>--listen</cmd> Example</title>
      <desc><app>Zenity</app> notification with <cmd>--listen</cmd> example</desc>
      <media type="image" mime="image/png" src="figures/zenity-notification-listen-screenshot.png"/>
   </figure>

</page>
bgstack15