[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[c4ee35e] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[4a86f18a] | 7 | <!ENTITY libnotify-download-http "&gnome-download-http;/libnotify/0.8/libnotify-&libnotify-version;.tar.xz">
|
---|
[e1e58be] | 8 | <!ENTITY libnotify-download-ftp " ">
|
---|
[f2b7761] | 9 | <!ENTITY libnotify-md5sum "952e55f45067b6a5b9eab4310c9cd658">
|
---|
[4a86f18a] | 10 | <!ENTITY libnotify-size "104 KB">
|
---|
[504e5ce] | 11 | <!ENTITY libnotify-buildsize "2.3 MB">
|
---|
[4a86f18a] | 12 | <!ENTITY libnotify-time "0.1 SBU">
|
---|
[c4ee35e] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libnotify" xreflabel="libnotify-&libnotify-version;">
|
---|
| 16 | <?dbhtml filename="libnotify.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libnotify-&libnotify-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libnotify">
|
---|
| 22 | <primary sortas="a-libnotify">libnotify</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libnotify</title>
|
---|
| 27 |
|
---|
[a2912ff] | 28 | <para>
|
---|
| 29 | The <application>libnotify</application> library is used to send desktop
|
---|
| 30 | notifications to a notification daemon, as defined in the Desktop
|
---|
| 31 | Notifications spec. These notifications can be used to inform the user about
|
---|
| 32 | an event or display some form of information without getting in the user's
|
---|
| 33 | way.
|
---|
| 34 | </para>
|
---|
[c4ee35e] | 35 |
|
---|
[42f164e] | 36 | &lfs122_checked;
|
---|
[4f51961] | 37 |
|
---|
[c4ee35e] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[a2912ff] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&libnotify-download-http;"/>
|
---|
| 43 | </para>
|
---|
[c4ee35e] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[a2912ff] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&libnotify-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[c4ee35e] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[a2912ff] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &libnotify-md5sum;
|
---|
| 53 | </para>
|
---|
[c4ee35e] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[a2912ff] | 56 | <para>
|
---|
| 57 | Download size: &libnotify-size;
|
---|
| 58 | </para>
|
---|
[c4ee35e] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[a2912ff] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &libnotify-buildsize;
|
---|
| 63 | </para>
|
---|
[c4ee35e] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[a2912ff] | 66 | <para>
|
---|
| 67 | Estimated build time: &libnotify-time;
|
---|
| 68 | </para>
|
---|
[c4ee35e] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">libnotify Dependencies</bridgehead>
|
---|
| 73 |
|
---|
[d0b1879] | 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
| 76 | <xref linkend="gtk3"/>
|
---|
| 77 | </para>
|
---|
| 78 |
|
---|
[4c2be438] | 79 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
| 80 | <para role="optional">
|
---|
[c0bc0a9] | 81 | &gobject-introspection;
|
---|
[4c2be438] | 82 | </para>
|
---|
| 83 |
|
---|
[4f51961] | 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[41d905b4] | 85 | <para role="optional">
|
---|
[26c597d] | 86 | <xref linkend="gi-docgen"/> and
|
---|
[a6852d6] | 87 | <xref linkend="xmlto"/>
|
---|
[41d905b4] | 88 | </para>
|
---|
[c4ee35e] | 89 |
|
---|
[28da91b1] | 90 | <bridgehead renderas="sect4">Required (runtime)</bridgehead>
|
---|
[1051f94e] | 91 | <para role="required">
|
---|
[99ffe6e5] | 92 | <xref role="runtime" linkend="notification-daemon"/>,
|
---|
| 93 | <xref role="nodep" linkend="xfce4-notifyd"/>, or
|
---|
| 94 | <xref role="nodep" linkend="lxqt-notificationd"/>
|
---|
[28da91b1] | 95 | </para>
|
---|
| 96 |
|
---|
| 97 | <note>
|
---|
| 98 | <para>
|
---|
[99ffe6e5] | 99 | <application>GNOME Shell</application> and
|
---|
| 100 | <application>KDE KWin</application>
|
---|
[28da91b1] | 101 | provide their own notification daemons.
|
---|
| 102 | </para>
|
---|
| 103 | </note>
|
---|
| 104 |
|
---|
[c4ee35e] | 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
| 108 | <title>Installation of libnotify</title>
|
---|
| 109 |
|
---|
[a2912ff] | 110 | <para>
|
---|
| 111 | Install <application>libnotify</application> by running the following
|
---|
| 112 | commands:
|
---|
| 113 | </para>
|
---|
[c4ee35e] | 114 |
|
---|
[e363635] | 115 | <screen><userinput>mkdir build &&
|
---|
[6a720e7] | 116 | cd build &&
|
---|
[e363635] | 117 |
|
---|
[91318eb] | 118 | meson setup --prefix=/usr \
|
---|
| 119 | --buildtype=release \
|
---|
[6d6005b0] | 120 | -D gtk_doc=false \
|
---|
| 121 | -D man=false \
|
---|
[91318eb] | 122 | .. &&
|
---|
[e363635] | 123 | ninja</userinput></screen>
|
---|
[c4ee35e] | 124 |
|
---|
[a2912ff] | 125 | <para>
|
---|
| 126 | This package does not come with a test suite.
|
---|
| 127 | </para>
|
---|
[c4ee35e] | 128 |
|
---|
[26c597d] | 129 | <para>
|
---|
| 130 | If you have <xref linkend='gi-docgen'/> installed and wish to build
|
---|
| 131 | the API documentation for this package, issue:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <!-- No &libnotify-version; here because we'll mv the doc dir anyway -->
|
---|
| 135 | <screen remap='doc'><userinput>sed "/docs_dir =/s@\$@ / 'libnotify'@" \
|
---|
| 136 | -i ../docs/reference/meson.build &&
|
---|
[6d6005b0] | 137 | meson configure -D gtk_doc=true &&
|
---|
[26c597d] | 138 | ninja</userinput></screen>
|
---|
| 139 |
|
---|
[a2912ff] | 140 | <para>
|
---|
| 141 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 142 | </para>
|
---|
[c4ee35e] | 143 |
|
---|
[38f90cf] | 144 | <screen role="root"><userinput>ninja install &&
|
---|
[e5c8c6d5] | 145 | if [ -e /usr/share/doc/libnotify ]; then
|
---|
| 146 | rm -rf /usr/share/doc/libnotify-&libnotify-version;
|
---|
| 147 | mv -v /usr/share/doc/libnotify{,-&libnotify-version;}
|
---|
| 148 | fi</userinput></screen>
|
---|
[c4ee35e] | 149 |
|
---|
| 150 | </sect2>
|
---|
| 151 |
|
---|
[4f51961] | 152 | <sect2 role="commands">
|
---|
| 153 | <title>Command Explanations</title>
|
---|
| 154 |
|
---|
[adf17153] | 155 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 156 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[4f51961] | 157 | </sect2>
|
---|
| 158 |
|
---|
[c4ee35e] | 159 | <sect2 role="content">
|
---|
| 160 | <title>Contents</title>
|
---|
| 161 |
|
---|
| 162 | <segmentedlist>
|
---|
| 163 | <segtitle>Installed Program</segtitle>
|
---|
| 164 | <segtitle>Installed Library</segtitle>
|
---|
[4f51961] | 165 | <segtitle>Installed Directories</segtitle>
|
---|
[c4ee35e] | 166 |
|
---|
| 167 | <seglistitem>
|
---|
[41d905b4] | 168 | <seg>
|
---|
| 169 | notify-send
|
---|
| 170 | </seg>
|
---|
| 171 | <seg>
|
---|
| 172 | libnotify.so
|
---|
| 173 | </seg>
|
---|
| 174 | <seg>
|
---|
[a2912ff] | 175 | /usr/include/libnotify and
|
---|
| 176 | /usr/share/gtk-doc/html/libnotify
|
---|
[41d905b4] | 177 | </seg>
|
---|
[c4ee35e] | 178 | </seglistitem>
|
---|
| 179 | </segmentedlist>
|
---|
| 180 |
|
---|
| 181 | <variablelist>
|
---|
| 182 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 183 | <?dbfo list-presentation="list"?>
|
---|
| 184 | <?dbhtml list-presentation="table"?>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="notify-send">
|
---|
| 187 | <term><command>notify-send</command></term>
|
---|
| 188 | <listitem>
|
---|
[a2912ff] | 189 | <para>
|
---|
[4c24eb0a] | 190 | is a command used to send notifications
|
---|
[a2912ff] | 191 | </para>
|
---|
[c4ee35e] | 192 | <indexterm zone="libnotify notify-send">
|
---|
| 193 | <primary sortas="b-notify-send">notify-send</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="libnotify-lib">
|
---|
[4c24eb0a] | 199 | <term><filename class="libraryfile">libnotify.so</filename></term>
|
---|
[c4ee35e] | 200 | <listitem>
|
---|
[a2912ff] | 201 | <para>
|
---|
[4c24eb0a] | 202 | contains the <application>libnotify</application> API functions
|
---|
[a2912ff] | 203 | </para>
|
---|
[c4ee35e] | 204 | <indexterm zone="libnotify libnotify">
|
---|
[41d905b4] | 205 | <primary sortas="c-libnotify">libnotify.so</primary>
|
---|
[c4ee35e] | 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
| 210 | </variablelist>
|
---|
| 211 |
|
---|
| 212 | </sect2>
|
---|
| 213 |
|
---|
| 214 | </sect1>
|
---|