[Emacs-diffs] /srv/bzr/emacs/trunk r110827: * os.texi (Notifications): Update descriptions of

[Michael Albinus]

------------------------------------------------------------
revno: 110827
committer: Michael Albinus <address@hidden
branch nick: trunk
timestamp: Thu 2012-11-08 08:50:43 +0100
message:
  * 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.
modified:
  doc/lispref/ChangeLog
  doc/lispref/os.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-11-03 11:02:43 +0000
+++ b/doc/lispref/ChangeLog     2012-11-08 07:50:43 +0000
@@ -1,3 +1,10 @@
+2012-11-08  Michael Albinus  <address@hidden>
+
+       * 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.
+
 2012-11-03  Chong Yidong  <address@hidden>
 
        * objects.texi (General Escape Syntax): Clarify the explanation of

=== modified file 'doc/lispref/os.texi'
--- a/doc/lispref/os.texi       2012-10-24 05:12:23 +0000
+++ b/doc/lispref/os.texi       2012-11-08 07:50:43 +0000
@@ -2276,13 +2276,19 @@
 The supported keywords and values are as follows:
 
 @table @code
address@hidden :bus @var{bus}
+The D-Bus bus.  This argument is needed only if a bus other than
address@hidden:session} shall be used.
+
 @item :title @var{title}
 The notification title.
 
 @item :body @var{text}
 The notification body text.  Depending on the implementation of the
 notification server, the text could contain HTML markups, like
address@hidden"<b>bold text</b>"}, hyperlinks, or images.
address@hidden"<b>bold text</b>"}, hyperlinks, or images.  Special HTML
+characters must be encoded, as @samp{"Contact
+&lt;postmaster@@localhost&gt;!"}.
 
 @item :app-name @var{name}
 The name of the application sending the notification.  The default is
@@ -2317,7 +2323,10 @@
 interpreted as icon name.
 
 @item :category @var{category}
-The type of notification this is, a string.
+The type of notification this is, a string.  See the
address@hidden://developer.gnome.org/notification-spec/#categories,
+Desktop Notifications Specification} for a list of standard
+categories.
 
 @item :desktop-entry @var{filename}
 This specifies the name of the desktop filename representing the
@@ -2420,13 +2429,17 @@
 @end example
 @end defun
 
address@hidden notifications-close-notification id
address@hidden notifications-close-notification id &optional bus
 This function closes a notification with identifier @var{id}.
address@hidden can be a string denoting a D-Bus connection, the default is
address@hidden:session}.
 @end defun
 
address@hidden notifications-get-capabilities
-Returns the capabilities of the notification server, a list of strings.
-The following capabilities can be expected:
address@hidden notifications-get-capabilities &optional bus
+Returns the capabilities of the notification server, a list of
+symbols.  @var{bus} can be a string denoting a D-Bus connection, the
+default is @code{:session}.  The following capabilities can be
+expected:
 
 @table @code
 @item :actions
@@ -2463,6 +2476,30 @@
 @code{:x-gnome-foo-cap}.
 @end defun
 
address@hidden notifications-get-server-information &optional bus
+Return information on the notification server, a list of strings.
address@hidden can be a string denoting a D-Bus connection, the default is
address@hidden:session}.  The returned list is @code{(@var{name} @var{vendor}
address@hidden @var{spec-version})}.
+
address@hidden @var
address@hidden name
+The product name of the server.
+
address@hidden vendor
+The vendor name.  For example, @samp{"KDE"}, @samp{"GNOME"}.
+
address@hidden version
+The server's version number.
+
address@hidden spec-version
+The specification version the server is compliant with.
address@hidden table
+
+If @var{SPEC_VERSION} is @code{nil}, the server supports a
+specification prior to @samp{"1.0"}.
address@hidden defun
+
 
 @node Dynamic Libraries
 @section Dynamically Loaded Libraries