summaryrefslogtreecommitdiff
path: root/docs/notify-send.xml
blob: 5659794f1e0f9da9640e1ba687211b93d0d13453 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <info>
    <date>November 2005</date>
    <productname>libnotify</productname>
    <authorgroup>
      <author>
        <personname>Andre Filipe de Assuncao e Brito</personname>
        <email>decko@noisemakers.org</email>
        <contrib>Original author</contrib>
      </author>
      <author>
        <personname>Paul van Tilburg</personname>
        <email>paulvt@debian.org</email>
        <contrib>Original author</contrib>
      </author>
      <author>
        <personname>Riccardo Setti</personname>
        <email>giskard@debian.org</email>
        <contrib>Original author</contrib>
      </author>
    </authorgroup>
  </info>
  <refmeta>
    <refentrytitle>notify-send</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="manual">User Commands</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>notify-send</refname>
    <refpurpose>a program to send desktop notifications</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>notify-send</command>
      <arg choice="opt">
        <replaceable>OPTIONS</replaceable>
      </arg>
      <arg choice="req">
        <replaceable>summary</replaceable>
      </arg>
      <arg choice="opt">
        <replaceable>body</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsection>
    <info><title>Description</title></info>

    <para>With <command>notify-send</command> you can send desktop notifications to the user via a notification daemon from the command line. These notifications can be used to inform the user about an event or display some form of information without getting in the user’s way.</para>
  </refsection>
  <refsection>
    <info><title>Options</title></info>

    <variablelist>
      <varlistentry>
        <term><option>-?</option>, <option>--help</option></term>
        <listitem>
          <para>Show help and exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a</option>, <option>--app-name</option>=<replaceable>APP_NAME</replaceable></term>
        <listitem>
          <para>Specifies the app name for the notification.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-A</option>, <option>--action</option>=[<replaceable>NAME</replaceable>=]<replaceable>Text...</replaceable></term>
        <listitem>
          <para>Specifies the actions to display to the user. Implies <option>--wait</option> to wait for user input. May be set multiple times. The <replaceable>NAME</replaceable> of the action is output to <literal>stdout</literal>. If <replaceable>NAME</replaceable> is not specified, the numerical index of the option is used (starting with <literal>1</literal>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-u</option>, <option>--urgency</option>=<replaceable>LEVEL</replaceable></term>
        <listitem>
          <para>Specifies the urgency level (<literal>low</literal>, <literal>normal</literal>, <literal>critical</literal>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option>, <option>--expire-time</option>=<replaceable>TIME</replaceable>
        </term>
        <listitem>
          <para>The duration, in milliseconds, for the notification to appear on screen.</para>
          <para>Not all implementations use this parameter. GNOME Shell and Notify OSD always ignore it, while Plasma ignores it for notifications with the critical urgency level.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option>, <option>--icon</option>=<replaceable>ICON</replaceable>
        </term>
        <listitem>
          <para>Specifies an icon filename or stock icon to display.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option>, <option>--category</option>=<replaceable>TYPE</replaceable>[,<replaceable>TYPE</replaceable>…]
        </term>
        <listitem>
          <para>Specifies the notification category.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>, <option>--hint</option>=<replaceable>TYPE</replaceable>:<replaceable>NAME</replaceable>:<replaceable>VALUE</replaceable> </term>
        <listitem>
          <para>Specifies basic extra data to pass. Valid types are <literal>BOOLEAN</literal>, <literal>INT</literal>, <literal>DOUBLE</literal>, <literal>STRING</literal>, <literal>BYTE</literal> and <literal>VARIANT</literal>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option>, <option>--print-id</option></term>
        <listitem>
          <para>Print the notification ID.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r</option>, <option>--replace-id</option>=<replaceable>REPLACE_ID</replaceable></term>
        <listitem>
          <para>The ID of the notification to replace.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option>, <option>--wait</option></term>
          <listitem>
            <para>Wait for the notification to be closed before exiting. If the <option>expire-time</option> is set, it will be used as the maximum waiting time.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-e</option>, <option>--transient</option></term>
          <listitem>
            <para>Show a transient notification. Transient notifications by-pass the server's persistence capability, if any. And so it won't be preserved until the user acknowledges it.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>
  <refsection>
    <info><title>See also</title></info>

    <para>The Desktop Notification Spec on <link xlink:href="https://specifications.freedesktop.org/notification-spec/">https://specifications.freedesktop.org/notification-spec/</link>.</para>
  </refsection>
</refentry>