diff options
| author | Michael Albinus | 2007-12-30 15:47:41 +0000 |
|---|---|---|
| committer | Michael Albinus | 2007-12-30 15:47:41 +0000 |
| commit | c9ecb5a74f473fbd2a2df68a92159d0d15e3e64f (patch) | |
| tree | 9f54372521f4b1323d2ad0f553413865a9a06c52 /doc/misc | |
| parent | 17bc8f9494e3166211fad1c6c044b1a2e00dd0e7 (diff) | |
| download | emacs-c9ecb5a74f473fbd2a2df68a92159d0d15e3e64f.tar.gz emacs-c9ecb5a74f473fbd2a2df68a92159d0d15e3e64f.zip | |
* dbus.texi (all): Replace "..." by @dots{}.
(Type Conversion): Precise the value range for :byte types.
(Signals): Rename dbus-unregister-signal to dbus-unregister-object.
Mention its return value.
(Errors and Events): There is no D-Bus error propagation during event
processing.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 9 | ||||
| -rw-r--r-- | doc/misc/dbus.texi | 34 |
2 files changed, 32 insertions, 11 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index a007f4da3a8..4db888d6e44 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,12 @@ | |||
| 1 | 2007-12-30 Michael Albinus <michael.albinus@gmx.de> | ||
| 2 | |||
| 3 | * dbus.texi (all): Replace "..." by @dots{}. | ||
| 4 | (Type Conversion): Precise the value range for :byte types. | ||
| 5 | (Signals): Rename dbus-unregister-signal to dbus-unregister-object. | ||
| 6 | Mention its return value. | ||
| 7 | (Errors and Events): There is no D-Bus error propagation during event | ||
| 8 | processing. | ||
| 9 | |||
| 1 | 2007-12-29 Jay Belanger <jay.p.belanger@gmail.com> | 10 | 2007-12-29 Jay Belanger <jay.p.belanger@gmail.com> |
| 2 | 11 | ||
| 3 | * calc.tex (Yacas Language, Maxima Language, Giac Language): | 12 | * calc.tex (Yacas Language, Maxima Language, Giac Language): |
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi index 352e57f0faa..d8f2f590360 100644 --- a/doc/misc/dbus.texi +++ b/doc/misc/dbus.texi | |||
| @@ -197,13 +197,13 @@ format. Example: | |||
| 197 | <method name=\"GetAllProperties\"> | 197 | <method name=\"GetAllProperties\"> |
| 198 | <arg name=\"properties\" direction=\"out\" type=\"a@{sv@}\"/> | 198 | <arg name=\"properties\" direction=\"out\" type=\"a@{sv@}\"/> |
| 199 | </method> | 199 | </method> |
| 200 | ... | 200 | @dots{} |
| 201 | <signal name=\"PropertyModified\"> | 201 | <signal name=\"PropertyModified\"> |
| 202 | <arg name=\"num_updates\" type=\"i\"/> | 202 | <arg name=\"num_updates\" type=\"i\"/> |
| 203 | <arg name=\"updates\" type=\"a(sbb)\"/> | 203 | <arg name=\"updates\" type=\"a(sbb)\"/> |
| 204 | </signal> | 204 | </signal> |
| 205 | </interface> | 205 | </interface> |
| 206 | ... | 206 | @dots{} |
| 207 | </node>" | 207 | </node>" |
| 208 | @end example | 208 | @end example |
| 209 | 209 | ||
| @@ -277,21 +277,27 @@ types are represented by the type symbols @code{:byte}, | |||
| 277 | Example: | 277 | Example: |
| 278 | 278 | ||
| 279 | @lisp | 279 | @lisp |
| 280 | (dbus-call-method ... @var{NUMBER} @var{STRING}) | 280 | (dbus-call-method @dots{} @var{NUMBER} @var{STRING}) |
| 281 | @end lisp | 281 | @end lisp |
| 282 | 282 | ||
| 283 | is equivalent to | 283 | is equivalent to |
| 284 | 284 | ||
| 285 | @lisp | 285 | @lisp |
| 286 | (dbus-call-method ... :uint32 @var{NUMBER} :string @var{STRING}) | 286 | (dbus-call-method @dots{} :uint32 @var{NUMBER} :string @var{STRING}) |
| 287 | @end lisp | 287 | @end lisp |
| 288 | 288 | ||
| 289 | but different to | 289 | but different to |
| 290 | 290 | ||
| 291 | @lisp | 291 | @lisp |
| 292 | (dbus-call-method ... :int32 @var{NUMBER} :signature @var{STRING}) | 292 | (dbus-call-method @dots{} :int32 @var{NUMBER} :signature @var{STRING}) |
| 293 | @end lisp | 293 | @end lisp |
| 294 | 294 | ||
| 295 | The value for a byte type can be any integer in the range 0 through | ||
| 296 | 255. If a character is used as argument, modifiers represented | ||
| 297 | outside this range are stripped of. For example, @code{:byte ?x} is | ||
| 298 | equal to @code{:byte ?\M-x}, but it is not equal to @code{:byte | ||
| 299 | ?\C-x} or @code{:byte ?\M-\C-x}. | ||
| 300 | |||
| 295 | A D-Bus compound type is always represented as list. The car of this | 301 | A D-Bus compound type is always represented as list. The car of this |
| 296 | list can be the type symbol @code{:array}, @code{:variant}, | 302 | list can be the type symbol @code{:array}, @code{:variant}, |
| 297 | @code{:struct} or @code{:dict-entry}, which would result in a | 303 | @code{:struct} or @code{:dict-entry}, which would result in a |
| @@ -313,7 +319,7 @@ contain only a key-value pair of two element, with a basic type key. | |||
| 313 | Example: | 319 | Example: |
| 314 | 320 | ||
| 315 | @lisp | 321 | @lisp |
| 316 | (dbus-send-signal ... | 322 | (dbus-send-signal @dots{} |
| 317 | :object-path STRING '(:variant :boolean BOOL) | 323 | :object-path STRING '(:variant :boolean BOOL) |
| 318 | '(:array NUMBER NUMBER) '(:array BOOL :boolean BOOL) | 324 | '(:array NUMBER NUMBER) '(:array BOOL :boolean BOOL) |
| 319 | '(:struct BOOL :boolean BOOL BOOL | 325 | '(:struct BOOL :boolean BOOL BOOL |
| @@ -365,7 +371,7 @@ The signal @code{PropertyModified}, discussed as example in | |||
| 365 | (@var{BOOL} stands here for either @code{nil} or @code{t}): | 371 | (@var{BOOL} stands here for either @code{nil} or @code{t}): |
| 366 | 372 | ||
| 367 | @lisp | 373 | @lisp |
| 368 | (@var{NUMBER} ((@var{STRING} @var{BOOL} @var{BOOL}) (@var{STRING} @var{BOOL} @var{BOOL}) ...)) | 374 | (@var{NUMBER} ((@var{STRING} @var{BOOL} @var{BOOL}) (@var{STRING} @var{BOOL} @var{BOOL}) @dots{})) |
| 369 | @end lisp | 375 | @end lisp |
| 370 | 376 | ||
| 371 | 377 | ||
| @@ -460,7 +466,7 @@ emulate the @code{lshal} command on GNU/Linux systems: | |||
| 460 | system.chassis.manufacturer = \"COMPAL\" | 466 | system.chassis.manufacturer = \"COMPAL\" |
| 461 | system.chassis.type = \"Notebook\" | 467 | system.chassis.type = \"Notebook\" |
| 462 | system.firmware.release_date = \"03/19/2005\" | 468 | system.firmware.release_date = \"03/19/2005\" |
| 463 | ..." | 469 | @dots{}" |
| 464 | @end example | 470 | @end example |
| 465 | @end defun | 471 | @end defun |
| 466 | 472 | ||
| @@ -548,13 +554,15 @@ machine, when registered for signal @code{DeviceAdded}, will show you | |||
| 548 | which objects the GNU/Linux @code{hal} daemon adds. | 554 | which objects the GNU/Linux @code{hal} daemon adds. |
| 549 | 555 | ||
| 550 | @code{dbus-register-signal} returns a Lisp symbol, which can be used | 556 | @code{dbus-register-signal} returns a Lisp symbol, which can be used |
| 551 | as argument in @code{dbus-unregister-signal} for removing the | 557 | as argument in @code{dbus-unregister-object} for removing the |
| 552 | registration for @var{signal}. | 558 | registration for @var{signal}. |
| 553 | @end defun | 559 | @end defun |
| 554 | 560 | ||
| 555 | @defun dbus-unregister-signal object | 561 | @defun dbus-unregister-object object |
| 556 | Unregister @var{object} from the the D-Bus. @var{object} must be the | 562 | Unregister @var{object} from the the D-Bus. @var{object} must be the |
| 557 | result of a preceding @code{dbus-register-signal} call. | 563 | result of a preceding @code{dbus-register-signal} or |
| 564 | @code{dbus-register-method} call. It returns @code{t} if @var{object} | ||
| 565 | has been unregistered, @code{nil} otherwise. | ||
| 558 | @end defun | 566 | @end defun |
| 559 | 567 | ||
| 560 | 568 | ||
| @@ -624,6 +632,10 @@ Returns the member name of of the D-Bus object @var{event} is coming | |||
| 624 | from. It is either a signal name or a method name. | 632 | from. It is either a signal name or a method name. |
| 625 | @end defun | 633 | @end defun |
| 626 | 634 | ||
| 635 | D-Bus errors are not propagated during event handling, because it is | ||
| 636 | usually not desired. D-Bus errors in events can be made visible by | ||
| 637 | setting the variable @code{dbus-debug} to @code{t}. | ||
| 638 | |||
| 627 | 639 | ||
| 628 | @node GNU Free Documentation License | 640 | @node GNU Free Documentation License |
| 629 | @appendix GNU Free Documentation License | 641 | @appendix GNU Free Documentation License |