diff options
| author | Glenn Morris | 2012-04-04 00:38:30 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-04-04 00:38:30 -0700 |
| commit | 97f4a299ee49ed580beb079752bd4d0c9dee0ce7 (patch) | |
| tree | 26e5a4c6614765a4bca54bc85b61470fa3cc4bd9 /doc | |
| parent | 251c2719e6e5ad5b54285fef31de14cd0773808c (diff) | |
| download | emacs-97f4a299ee49ed580beb079752bd4d0c9dee0ce7.tar.gz emacs-97f4a299ee49ed580beb079752bd4d0c9dee0ce7.zip | |
* doc/lispref/os.texi (Notifications): Copyedits.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 25 |
2 files changed, 16 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index c392cb6cf96..9a0730d82a7 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2012-04-04 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * os.texi (Notifications): Copyedits. | ||
| 4 | |||
| 1 | 2012-04-03 Michael Albinus <michael.albinus@gmx.de> | 5 | 2012-04-03 Michael Albinus <michael.albinus@gmx.de> |
| 2 | 6 | ||
| 3 | * os.texi (Terminal-Specific): Fix typo. | 7 | * os.texi (Terminal-Specific): Fix typo. |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 96221f328d6..c371c5f4d51 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -2254,9 +2254,10 @@ Emacs is restarted by the session manager. | |||
| 2254 | @section Desktop Notifications | 2254 | @section Desktop Notifications |
| 2255 | @cindex desktop notifications | 2255 | @cindex desktop notifications |
| 2256 | 2256 | ||
| 2257 | Emacs is able to send notifications on systems which support the | 2257 | Emacs is able to send @dfn{notifications} on systems that support the |
| 2258 | desktop notification specification of freedesktop.org. In order to | 2258 | desktop notification specification of freedesktop.org. In order to |
| 2259 | use this functionality, the package @code{notifications} must be loaded. | 2259 | use this functionality, Emacs must have been compiled with D-Bus |
| 2260 | support, and the @code{notifications} library must be loaded. | ||
| 2260 | 2261 | ||
| 2261 | @defun notifications-notify &rest params | 2262 | @defun notifications-notify &rest params |
| 2262 | This function sends a notification to the desktop via D-Bus. | 2263 | This function sends a notification to the desktop via D-Bus. |
| @@ -2272,7 +2273,7 @@ notification server, the text could contain HTML markups, like | |||
| 2272 | @samp{"<b>bold text</b>"}, or hyperlinks. | 2273 | @samp{"<b>bold text</b>"}, or hyperlinks. |
| 2273 | 2274 | ||
| 2274 | @item :app-name @var{name} | 2275 | @item :app-name @var{name} |
| 2275 | The name of the application sending the notification. Default is | 2276 | The name of the application sending the notification. The default is |
| 2276 | @code{notifications-application-name}. | 2277 | @code{notifications-application-name}. |
| 2277 | 2278 | ||
| 2278 | @item :replaces-id @var{id} | 2279 | @item :replaces-id @var{id} |
| @@ -2281,7 +2282,7 @@ must be the result of a previous @code{notifications-notify} call. | |||
| 2281 | 2282 | ||
| 2282 | @item :app-icon @var{icon-file} | 2283 | @item :app-icon @var{icon-file} |
| 2283 | The file name of the notification icon. If set to @code{nil}, no icon | 2284 | The file name of the notification icon. If set to @code{nil}, no icon |
| 2284 | is displayed. Default is @code{notifications-application-icon}. | 2285 | is displayed. The default is @code{notifications-application-icon}. |
| 2285 | 2286 | ||
| 2286 | @item :actions (@var{key} @var{title} @var{key} @var{title} ...) | 2287 | @item :actions (@var{key} @var{title} @var{key} @var{title} ...) |
| 2287 | A list of actions to be applied. @var{key} and @var{title} are both | 2288 | A list of actions to be applied. @var{key} and @var{title} are both |
| @@ -2297,7 +2298,7 @@ server's settings, and may vary for the type of notification. If 0, | |||
| 2297 | the notification never expires. Default value is -1. | 2298 | the notification never expires. Default value is -1. |
| 2298 | 2299 | ||
| 2299 | @item :urgency @var{urgency} | 2300 | @item :urgency @var{urgency} |
| 2300 | The urgency level. It can be @code{low}, @code{normal} or @code{critical}. | 2301 | The urgency level. It can be @code{low}, @code{normal}, or @code{critical}. |
| 2301 | 2302 | ||
| 2302 | @item :category @var{category} | 2303 | @item :category @var{category} |
| 2303 | The type of notification this is, a string. | 2304 | The type of notification this is, a string. |
| @@ -2307,9 +2308,9 @@ This specifies the name of the desktop filename representing the | |||
| 2307 | calling program, like @samp{"emacs"}. | 2308 | calling program, like @samp{"emacs"}. |
| 2308 | 2309 | ||
| 2309 | @item :image-data (@var{width} @var{height} @var{rowstride} @var{has-alpha} @var{bits} @var{channels} @var{data}) | 2310 | @item :image-data (@var{width} @var{height} @var{rowstride} @var{has-alpha} @var{bits} @var{channels} @var{data}) |
| 2310 | This is a raw data image format which describes the width, height, | 2311 | This is a raw data image format that describes the width, height, |
| 2311 | rowstride, has alpha, bits per sample, channels and image data | 2312 | rowstride, whether there is an alpha channel, bits per sample, |
| 2312 | respectively. | 2313 | channels and image data, respectively. |
| 2313 | 2314 | ||
| 2314 | @item :image-path @var{path} | 2315 | @item :image-path @var{path} |
| 2315 | This is represented either as a URI (@samp{file://} is the only URI | 2316 | This is represented either as a URI (@samp{file://} is the only URI |
| @@ -2331,7 +2332,7 @@ ability. | |||
| 2331 | 2332 | ||
| 2332 | @item :x @var{position} | 2333 | @item :x @var{position} |
| 2333 | @itemx :y @var{position} | 2334 | @itemx :y @var{position} |
| 2334 | Specifies the X respectively Y location on the screen that the | 2335 | Specifies the X, Y location on the screen that the |
| 2335 | notification should point to. Both arguments must be used together. | 2336 | notification should point to. Both arguments must be used together. |
| 2336 | 2337 | ||
| 2337 | @item :on-action @var{function} | 2338 | @item :on-action @var{function} |
| @@ -2356,9 +2357,7 @@ by the user. The function receive the notification @var{id} and the closing | |||
| 2356 | This function returns a notification id, an integer, which can be used | 2357 | This function returns a notification id, an integer, which can be used |
| 2357 | to manipulate the notification item with | 2358 | to manipulate the notification item with |
| 2358 | @code{notifications-close-notification} or the @code{:replaces-id} | 2359 | @code{notifications-close-notification} or the @code{:replaces-id} |
| 2359 | argument of another @code{notifications-notify} call. | 2360 | argument of another @code{notifications-notify} call. For example: |
| 2360 | |||
| 2361 | Example: | ||
| 2362 | 2361 | ||
| 2363 | @example | 2362 | @example |
| 2364 | @group | 2363 | @group |
| @@ -2392,7 +2391,7 @@ A message window opens on the desktop. Press "I agree" | |||
| 2392 | @end defun | 2391 | @end defun |
| 2393 | 2392 | ||
| 2394 | @defun notifications-close-notification id | 2393 | @defun notifications-close-notification id |
| 2395 | This function closes a notification with identifier ID. | 2394 | This function closes a notification with identifier @var{id}. |
| 2396 | @end defun | 2395 | @end defun |
| 2397 | 2396 | ||
| 2398 | @node Dynamic Libraries | 2397 | @node Dynamic Libraries |