aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Albinus2012-11-08 08:50:43 +0100
committerMichael Albinus2012-11-08 08:50:43 +0100
commita43d02f01b7b6cc07f15a0a6ea677669ff079618 (patch)
tree60574cc36bc2946cf6744f8ebc91b332b9a1ccbf
parent6b064c16b1761605c87c0d3dbee91f6c3f6030d0 (diff)
downloademacs-a43d02f01b7b6cc07f15a0a6ea677669ff079618.tar.gz
emacs-a43d02f01b7b6cc07f15a0a6ea677669ff079618.zip
* os.texi (Notifications): Update descriptions of
notifications-notify, notifications-close-notification and notifications-get-capabilities according to latest code changes. Add notifications-get-server-information.
-rw-r--r--doc/lispref/ChangeLog7
-rw-r--r--doc/lispref/os.texi49
2 files changed, 50 insertions, 6 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 17bd43fc0d9..f5aad901d44 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,10 @@
12012-11-08 Michael Albinus <michael.albinus@gmx.de>
2
3 * os.texi (Notifications): Update descriptions of
4 notifications-notify, notifications-close-notification and
5 notifications-get-capabilities according to latest code changes.
6 Add notifications-get-server-information.
7
12012-11-03 Chong Yidong <cyd@gnu.org> 82012-11-03 Chong Yidong <cyd@gnu.org>
2 9
3 * objects.texi (General Escape Syntax): Clarify the explanation of 10 * objects.texi (General Escape Syntax): Clarify the explanation of
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 6c5f6e85683..2f06e207fc4 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2276,13 +2276,19 @@ These arguments should consist of alternating keyword and value pairs.
2276The supported keywords and values are as follows: 2276The supported keywords and values are as follows:
2277 2277
2278@table @code 2278@table @code
2279@item :bus @var{bus}
2280The D-Bus bus. This argument is needed only if a bus other than
2281@code{:session} shall be used.
2282
2279@item :title @var{title} 2283@item :title @var{title}
2280The notification title. 2284The notification title.
2281 2285
2282@item :body @var{text} 2286@item :body @var{text}
2283The notification body text. Depending on the implementation of the 2287The notification body text. Depending on the implementation of the
2284notification server, the text could contain HTML markups, like 2288notification server, the text could contain HTML markups, like
2285@samp{"<b>bold text</b>"}, hyperlinks, or images. 2289@samp{"<b>bold text</b>"}, hyperlinks, or images. Special HTML
2290characters must be encoded, as @samp{"Contact
2291&lt;postmaster@@localhost&gt;!"}.
2286 2292
2287@item :app-name @var{name} 2293@item :app-name @var{name}
2288The name of the application sending the notification. The default is 2294The name of the application sending the notification. The default is
@@ -2317,7 +2323,10 @@ When this keyword is given, the @var{title} string of the actions is
2317interpreted as icon name. 2323interpreted as icon name.
2318 2324
2319@item :category @var{category} 2325@item :category @var{category}
2320The type of notification this is, a string. 2326The type of notification this is, a string. See the
2327@uref{http://developer.gnome.org/notification-spec/#categories,
2328Desktop Notifications Specification} for a list of standard
2329categories.
2321 2330
2322@item :desktop-entry @var{filename} 2331@item :desktop-entry @var{filename}
2323This specifies the name of the desktop filename representing the 2332This specifies the name of the desktop filename representing the
@@ -2420,13 +2429,17 @@ A message window opens on the desktop. Press "I agree"
2420@end example 2429@end example
2421@end defun 2430@end defun
2422 2431
2423@defun notifications-close-notification id 2432@defun notifications-close-notification id &optional bus
2424This function closes a notification with identifier @var{id}. 2433This function closes a notification with identifier @var{id}.
2434@var{bus} can be a string denoting a D-Bus connection, the default is
2435@code{:session}.
2425@end defun 2436@end defun
2426 2437
2427@defun notifications-get-capabilities 2438@defun notifications-get-capabilities &optional bus
2428Returns the capabilities of the notification server, a list of strings. 2439Returns the capabilities of the notification server, a list of
2429The following capabilities can be expected: 2440symbols. @var{bus} can be a string denoting a D-Bus connection, the
2441default is @code{:session}. The following capabilities can be
2442expected:
2430 2443
2431@table @code 2444@table @code
2432@item :actions 2445@item :actions
@@ -2463,6 +2476,30 @@ Further vendor-specific caps start with @code{:x-vendor}, like
2463@code{:x-gnome-foo-cap}. 2476@code{:x-gnome-foo-cap}.
2464@end defun 2477@end defun
2465 2478
2479@defun notifications-get-server-information &optional bus
2480Return information on the notification server, a list of strings.
2481@var{bus} can be a string denoting a D-Bus connection, the default is
2482@code{:session}. The returned list is @code{(@var{name} @var{vendor}
2483@var{version} @var{spec-version})}.
2484
2485@table @var
2486@item name
2487The product name of the server.
2488
2489@item vendor
2490The vendor name. For example, @samp{"KDE"}, @samp{"GNOME"}.
2491
2492@item version
2493The server's version number.
2494
2495@item spec-version
2496The specification version the server is compliant with.
2497@end table
2498
2499If @var{SPEC_VERSION} is @code{nil}, the server supports a
2500specification prior to @samp{"1.0"}.
2501@end defun
2502
2466 2503
2467@node Dynamic Libraries 2504@node Dynamic Libraries
2468@section Dynamically Loaded Libraries 2505@section Dynamically Loaded Libraries