[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 21b03fa: Merge from origin/emacs-27
|
From: |
Glenn Morris |
|
Subject: |
master 21b03fa: Merge from origin/emacs-27 |
|
Date: |
Wed, 17 Jun 2020 11:48:30 -0400 (EDT) |
branch: master
commit 21b03faed44913ba0b0e3d54d2ffdb0ac067fae8
Merge: 9682aa2 229995b
Author: Glenn Morris <rgm@gnu.org>
Commit: Glenn Morris <rgm@gnu.org>
Merge from origin/emacs-27
229995ba2c (origin/emacs-27) Fix some Texinfo markup
01e86b9fdf Fix recentf typo in Emacs manual
cd4f75bb86 Rename default function to next-error-buffer-unnavigated-c...
1dff0a8949 * lisp/image-mode.el (image-toggle-display-image): Fix fit...
a71d1787f1 * doc/misc/tramp.texi (Predefined connection information):...
079b0dc430 Delete, don't kill, dir dir fragments in icomplete-fido-ba...
6cdecc2659 Revert markup change in with-coding-priority docs
22f4fba8a9 * lisp/emulation/cua-rect.el (cua--rectangle-region-insert...
6b9eac6759 * lisp/simple.el (shell-command-on-region): Fix docstring.
43ad7dc1af Clean up D-Bus documentation (bug#41744)
c43e5ed60d * lisp/image-mode.el (image-transform-original): New comma...
6eb18a950d Move tab-bar and tab-line faces to faces.el (part of bug#4...
# Conflicts:
# etc/NEWS
# lisp/simple.el
---
doc/emacs/files.texi | 6 +-
doc/emacs/frames.texi | 21 +-
doc/emacs/misc.texi | 6 +-
doc/lispref/control.texi | 2 +-
doc/lispref/debugging.texi | 2 +-
doc/lispref/errors.texi | 5 +-
doc/lispref/files.texi | 2 +-
doc/lispref/frames.texi | 2 +-
doc/lispref/nonascii.texi | 6 +-
doc/lispref/os.texi | 2 +-
doc/lispref/text.texi | 2 +-
doc/misc/dbus.texi | 826 ++++++++++++++++++------------------
doc/misc/efaq-w32.texi | 14 +-
doc/misc/efaq.texi | 2 +-
doc/misc/emacs-gnutls.texi | 2 +-
doc/misc/gnus-faq.texi | 5 +-
doc/misc/message.texi | 4 +-
doc/misc/tramp.texi | 6 +
etc/NEWS.27 | 4 +-
lisp/emulation/cua-rect.el | 6 +-
lisp/faces.el | 27 ++
lisp/icomplete.el | 5 +-
lisp/image-mode.el | 32 +-
lisp/net/dbus.el | 228 +++++-----
lisp/simple.el | 16 +-
lisp/tab-bar.el | 15 +-
lisp/tab-line.el | 16 +-
test/manual/etags/tex-src/gzip.texi | 2 +-
28 files changed, 653 insertions(+), 613 deletions(-)
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index 56ce7fd..5998326 100644
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -1003,7 +1003,7 @@ variable @code{auto-revert-remote-files} to
non-@code{nil}.
@vindex auto-revert-use-notify
@vindex auto-revert-interval
By default, Auto Revert mode works using @dfn{file notifications},
-whereby changes in the filesystem are reported to Emacs by the OS.
+whereby changes in the filesystem are reported to Emacs by the OS@.
You can disable use of file notifications by customizing the variable
@code{auto-revert-use-notify} to a @code{nil} value, then Emacs will
check for file changes by polling every five seconds. You can change
@@ -2098,8 +2098,8 @@ recently-opened files, reading file names from a buffer.
If you enable Recentf mode, with @kbd{M-x recentf-mode}, the
@samp{File} menu includes a submenu containing a list of recently
opened files. @kbd{M-x recentf-save-list} saves the current
-@code{recent-file-list} to a file, and @kbd{M-x recentf-edit-list}
-edits it.
+@code{recentf-list} to a file, and @kbd{M-x recentf-edit-list} edits
+it.
@c FIXME partial-completion-mode (complete.el) is obsolete.
The @kbd{M-x ffap} command generalizes @code{find-file} with more
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 8f448e1..e0eabe3 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1362,15 +1362,16 @@ a recently used tab.
@findex tab-next
Switch to the next tab. If you repeat this command, it cycles through
all the tabs on the selected frame. With a positive numeric argument
-N, it switches to the next Nth tab; with a negative argument −N, it
-switches back to the previous Nth tab.
+@var{n}, it switches to the next @var{n}th tab; with a negative
+argument @minus{}@var{n}, it switches back to the previous @var{n}th
+tab.
@item S-C-@key{TAB}
@kindex S-C-TAB
@findex tab-previous
-Switch to the previous tab. With a positive numeric argument N, it
-switches to the previous Nth tab; with a negative argument −N, it
-switches back to the next Nth tab.
+Switch to the previous tab. With a positive numeric argument @var{n},
+it switches to the previous @var{n}th tab; with a negative argument
+@minus{}@var{n}, it switches back to the next @var{n}th tab.
@item C-x t @key{RET} @var{tabname} @key{RET}
Switch to the tab by its name, with completion on all tab names.
@@ -1392,7 +1393,7 @@ to select the tab by its number.
@findex tab-recent
Switch to the recent tab. The key combination is the modifier key
defined by @code{tab-bar-select-tab-modifiers} and the key @kbd{0}.
-With a numeric argument N, switch to the Nth recent tab.
+With a numeric argument @var{n}, switch to the @var{n}th recent tab.
@end table
The following commands can be used to operate on tabs:
@@ -1406,9 +1407,9 @@ variable @code{tab-bar-tab-name-function}.
@item C-x t m
@findex tab-move
-Move the current tab N positions to the right with a positive numeric
-argument N. With a negative argument −N, move the current tab
-N positions to the left.
+Move the current tab @var{n} positions to the right with a positive
+numeric argument @var{n}. With a negative argument @minus{}@var{n},
+move the current tab @var{n} positions to the left.
@end table
@findex tab-bar-history-mode
@@ -1621,7 +1622,7 @@ again.
enable mouse support. You must have the gpm server installed and
running on your system in order for this to work. Note that when
this mode is enabled, you cannot use the mouse to transfer text
-between Emacs and other programs which use GPM. This is due to
+between Emacs and other programs which use GPM@. This is due to
limitations in GPM and the Linux kernel.
@iftex
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index 1336da1..e7547eb 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -1968,12 +1968,12 @@ evaluate, @emph{not} as a list of files to visit.
@item -f @var{server-file}
@itemx --server-file=@var{server-file}
Specify a server file (@pxref{TCP Emacs server}) for connecting to an
-Emacs server via TCP. Alternatively, you can set the
+Emacs server via TCP@. Alternatively, you can set the
@env{EMACS_SERVER_FILE} environment variable to point to the server
file. (The command-line option overrides the environment variable.)
An Emacs server usually uses a local socket to listen for connections,
-but also supports connections over TCP. To connect to a TCP Emacs
+but also supports connections over TCP@. To connect to a TCP Emacs
server, @command{emacsclient} needs to read a @dfn{server file}
containing the connection details of the Emacs server. The name of
this file is specified with this option, either as a file name
@@ -2882,7 +2882,7 @@ widget. The URL normally defaults to the URL at or
before point, but
if there is an active region (@pxref{Mark}), the default URL comes
from the region instead, after removing any whitespace from it. The
command then creates a new buffer with the embedded browser showing
-the specified URL. The buffer is put in the Xwidget-WebKit mode
+the specified URL@. The buffer is put in the Xwidget-WebKit mode
(similar to Image mode, @pxref{Image Mode}), which provides
one-key commands for scrolling the widget, changing its size, and
reloading it. Type @w{@kbd{C-h b}} in that buffer to see the key
diff --git a/doc/lispref/control.texi b/doc/lispref/control.texi
index 58f9336..01ae94e 100644
--- a/doc/lispref/control.texi
+++ b/doc/lispref/control.texi
@@ -835,7 +835,7 @@ the second and subsequent occurrences do not expand to
re-binding,
but instead expand to an equality test using @code{eq}.
The following example features a @code{pcase} form
-with two clauses and two @var{seqpat}, A and B.
+with two clauses and two @var{seqpat}, A and B@.
Both A and B first check that @var{expval} is a
pair (using @code{pred}),
and then bind symbols to the @code{car} and @code{cdr}
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index 24ec656..29a0ab7 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -402,7 +402,7 @@ assumptions are false if the debugger is running
interpreted.
@cindex backtrace buffer
Debugger mode is derived from Backtrace mode, which is also used to
-show backtraces by Edebug and ERT. (@pxref{Edebug}, and @ref{Top,the
+show backtraces by Edebug and ERT@. (@pxref{Edebug}, and @ref{Top,the
ERT manual,, ert, ERT: Emacs Lisp Regression Testing}.)
@cindex stack frame
diff --git a/doc/lispref/errors.texi b/doc/lispref/errors.texi
index dc6877c..cd8694b 100644
--- a/doc/lispref/errors.texi
+++ b/doc/lispref/errors.texi
@@ -79,9 +79,8 @@ The message is @samp{Symbol's chain of variable indirections
contains
a loop}. @xref{Variable Aliases}.
@item dbus-error
-The message is @samp{D-Bus error}. This is only defined if Emacs was
-compiled with D-Bus support. @xref{Errors and Events,,, dbus, D-Bus
-integration in Emacs}.
+The message is @samp{D-Bus error}. @xref{Errors and Events,,, dbus,
+D-Bus integration in Emacs}.
@item end-of-buffer
The message is @samp{End of buffer}. @xref{Character Motion}.
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index 574c7e5..92cbc2a 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -1197,7 +1197,7 @@ inconclusive, the function returns @code{t} on Cygwin and
@code{nil}
on macOS.
Currently this function always returns @code{nil} on platforms other
-than MS-DOS, MS-Windows, Cygwin, and macOS. It does not detect
+than MS-DOS, MS-Windows, Cygwin, and macOS@. It does not detect
case-insensitivity of mounted filesystems, such as Samba shares or
NFS-mounted Windows volumes. On remote hosts, it assumes @code{t} for
the @samp{smb} method. For all other connection methods, runtime
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 966f620..a82b585 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -2173,7 +2173,7 @@ it on an undecorated frame.
@item override-redirect
@cindex override redirect frames
If non-@code{nil}, this means that this is an @dfn{override redirect}
-frame---a frame not handled by window managers under X. Override
+frame---a frame not handled by window managers under X@. Override
redirect frames have no window manager decorations, can be positioned
and resized only via Emacs' positioning and resizing functions and are
usually drawn on top of all other frames. Setting this parameter has
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi
index 51831a0..c6c78ec 100644
--- a/doc/lispref/nonascii.texi
+++ b/doc/lispref/nonascii.texi
@@ -1823,9 +1823,9 @@ than all the rest.
@defmac with-coding-priority coding-systems &rest body
This macro executes @var{body}, like @code{progn} does
-(@pxref{Sequencing}), with @var{coding-systems} at the front of the
-priority list for coding systems. @var{coding-systems} should be a
-list of coding systems to prefer during execution of @var{body}.
+(@pxref{Sequencing, progn}), with @var{coding-systems} at the front of
+the priority list for coding systems. @var{coding-systems} should be
+a list of coding systems to prefer during execution of @var{body}.
@end defmac
@node Explicit Encoding
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 67e4467..9189452 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -1989,7 +1989,7 @@ The result is @code{nil} if either argument is a NaN.
This returns the time difference @var{t1} @minus{} @var{t2} between
two time values, as a Lisp time value. The result is exact and its clock
resolution is no worse than the worse of its two arguments' resolutions.
-The result is floating-point only if it is infinite or a NaN.
+The result is floating-point only if it is infinite or a NaN@.
If you need the difference in units
of elapsed seconds, you can convert it with @code{time-convert} or
@code{float-time}. @xref{Time Conversion}.
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index d765c95..10e8246 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -5219,7 +5219,7 @@ Signaled when encountering invalid JSON syntax.
@end table
Only top-level values (arrays and objects) can be serialized to
-JSON. The subobjects within these top-level values can be of any
+JSON@. The subobjects within these top-level values can be of any
type. Likewise, the parsing functions will only return vectors,
hashtables, alists, and plists.
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi
index 9e5f1cc..167d2bd 100644
--- a/doc/misc/dbus.texi
+++ b/doc/misc/dbus.texi
@@ -167,7 +167,7 @@ default) or the symbol @code{:session}. An activatable
service is
described in a service registration file. Under GNU/Linux, such files
are located at @file{/usr/share/dbus-1/system-services/} (for the
@code{:system} bus) or @file{/usr/share/dbus-1/services/}. An
-activatable service is not necessarily registered at @var{bus} at already.
+activatable service is not necessarily registered at @var{bus} already.
The result is a list of strings, which is @code{nil} when there are no
activatable service names at all. Example:
@@ -180,8 +180,8 @@ activatable service names at all. Example:
@end defun
@defun dbus-list-names bus
-All service names, which are registered at D-Bus @var{bus}, are
-returned. The result is a list of strings, which is @code{nil} when
+This function returns all service names, which are registered at D-Bus
+@var{bus}. The result is a list of strings, which is @code{nil} when
there are no registered service names at all. Well known names are
strings like @samp{org.freedesktop.DBus}. Names starting with
@samp{:} are unique names for services.
@@ -191,10 +191,10 @@ strings like @samp{org.freedesktop.DBus}. Names starting
with
@end defun
@defun dbus-list-known-names bus
-Retrieves all registered services which correspond to a known name in
@var{bus}.
-A service has a known name if it doesn't start with @samp{:}. The
-result is a list of strings, which is @code{nil} when there are no
-known names at all.
+This function retrieves all registered services which correspond to a
+known name in @var{bus}. A service has a known name if it doesn't
+start with @samp{:}. The result is a list of strings, which is
+@code{nil} when there are no known names at all.
@var{bus} must be either the symbol @code{:system} or the symbol
@code{:session}.
@@ -202,9 +202,9 @@ known names at all.
@defun dbus-list-queued-owners bus service
For a given service, registered at D-Bus @var{bus} under the name
-@var{service}, all queued unique names are returned. The result is a
-list of strings, or @code{nil} when there are no queued names for
-@var{service} at all.
+@var{service}, this function returns all queued unique names. The
+result is a list of strings, or @code{nil} when there are no queued
+names for @var{service} at all.
@var{bus} must be either the symbol @code{:system} or the symbol
@code{:session}. @var{service} must be a known service name as
@@ -213,9 +213,9 @@ string.
@defun dbus-get-name-owner bus service
For a given service, registered at D-Bus @var{bus} under the name
-@var{service}, the unique name of the name owner is returned. The
-result is a string, or @code{nil} when there exist no name owner of
-@var{service}.
+@var{service}, this function returns the unique name of the name
+owner. The result is a string, or @code{nil} when there is no name
+owner of @var{service}.
@var{bus} must be either the symbol @code{:system} or the symbol
@code{:session}. @var{service} must be a known service name as
@@ -223,26 +223,28 @@ string.
@end defun
@defun dbus-ping bus service &optional timeout
-Check whether the service name @var{service} is registered at D-Bus
-@var{bus}. @var{service} might not have been started yet, it is
-autostarted if possible. The result is either @code{t} or @code{nil}.
+This function checks whether the service name @var{service} is
+registered at D-Bus @var{bus}. If @var{service} has not yet started,
+it is autostarted if possible. The result is either @code{t} or
+@code{nil}.
@var{bus} must be either the symbol @code{:system} or the symbol
@code{:session}. @var{service} must be a string. @var{timeout}, a
nonnegative integer, specifies the maximum number of milliseconds
-@code{dbus-ping} must return. The default value is 25,000. Example:
+before @code{dbus-ping} must return. The default value is 25,000.
+Example:
@lisp
(message
- "%s screensaver on board."
- (cond
- ((dbus-ping :session "org.gnome.ScreenSaver" 100) "Gnome")
- ((dbus-ping :session "org.freedesktop.ScreenSaver" 100) "KDE")
- (t "No")))
+ "%s screensaver on board."
+ (cond
+ ((dbus-ping :session "org.gnome.ScreenSaver" 100) "Gnome")
+ ((dbus-ping :session "org.freedesktop.ScreenSaver" 100) "KDE")
+ (t "No")))
@end lisp
-If it shall be checked whether @var{service} is already running
-without autostarting it, one shall apply
+To check whether @var{service} is already running without autostarting
+it, you can instead write:
@lisp
(member service (dbus-list-known-names bus))
@@ -250,8 +252,9 @@ without autostarting it, one shall apply
@end defun
@defun dbus-get-unique-name bus
-The unique name, under which Emacs is registered at D-Bus @var{bus},
-is returned as string.
+@anchor{dbus-get-unique-name}
+This function returns the unique name, under which Emacs is registered
+at D-Bus @var{bus}, as a string.
@var{bus} must be either the symbol @code{:system} or the symbol
@code{:session}.
@@ -380,8 +383,8 @@ format. Example:
@lisp
(dbus-introspect
- :system "org.freedesktop.Hal"
- "/org/freedesktop/Hal/devices/computer")
+ :system "org.freedesktop.Hal"
+ "/org/freedesktop/Hal/devices/computer")
@result{} "<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
@@ -420,46 +423,51 @@ the HAL specification}.}
@end defun
@defun dbus-introspect-xml bus service path
-This function has the same intention as function
+This function serves a similar purpose to the function
@code{dbus-introspect}. The returned value is a parsed XML tree,
which can be used for further analysis. Example:
@lisp
(dbus-introspect-xml
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main")
@result{} (node ((name . "/org/freedesktop/xesam/searcher/main"))
- (interface ((name . "org.freedesktop.xesam.Search"))
- (method ((name . "GetHitData"))
- (arg ((name . "search") (type . "s") (direction . "in")))
- (arg ((name . "hit_ids") (type . "au") (direction . "in")))
- (arg ((name . "fields") (type . "as") (direction . "in")))
- (arg ((name . "hit_data") (type . "aav") (direction . "out")))
- )
- @dots{}
- (signal ((name . "HitsAdded"))
- (arg ((name . "search") (type . "s")))
- (arg ((name . "count") (type . "u")))
- )
- )
- @dots{}
- )
+ (interface ((name . "org.freedesktop.xesam.Search"))
+ (method ((name . "GetHitData"))
+ (arg ((name . "search")
+ (type . "s")
+ (direction . "in")))
+ (arg ((name . "hit_ids")
+ (type . "au")
+ (direction . "in")))
+ (arg ((name . "fields")
+ (type . "as")
+ (direction . "in")))
+ (arg ((name . "hit_data")
+ (type . "aav")
+ (direction . "out"))))
+ @dots{}
+ (signal ((name . "HitsAdded"))
+ (arg ((name . "search") (type . "s")))
+ (arg ((name . "count") (type . "u")))))
+ @dots{})
@end lisp
@end defun
@defun dbus-introspect-get-attribute object attribute
-It returns the @var{attribute} value of a D-Bus introspection
-@var{object}. @var{object} can be every subtree of a parsed XML tree
-as retrieved with @code{dbus-introspect-xml}. @var{attribute} must be
-a string according to the attribute names in the D-Bus specification.
-Example:
+This function returns the @var{attribute} value of a D-Bus
+introspection @var{object}. The value of @var{object} can be any
+subtree of a parsed XML tree as retrieved with
+@code{dbus-introspect-xml}. @var{attribute} must be a string
+according to the attribute names in the D-Bus specification. Example:
@lisp
(dbus-introspect-get-attribute
- (dbus-introspect-xml :system "org.freedesktop.SystemToolsBackends"
- "/org/freedesktop/SystemToolsBackends/UsersConfig")
- "name")
+ (dbus-introspect-xml
+ :system "org.freedesktop.SystemToolsBackends"
+ "/org/freedesktop/SystemToolsBackends/UsersConfig")
+ "name")
@result{} "/org/freedesktop/SystemToolsBackends/UsersConfig"
@end lisp
@@ -476,12 +484,12 @@ The first elements, to be introspected for a D-Bus
object, are further
object paths and interfaces.
@defun dbus-introspect-get-node-names bus service path
-All node names of @var{service} in D-Bus @var{bus} at object path
-@var{path} are returned as list of strings. Example:
+This function returns all node names of @var{service} in D-Bus
+@var{bus} at object path @var{path} as a list of strings. Example:
@lisp
(dbus-introspect-get-node-names
- :session "org.gnome.seahorse" "/org/gnome/seahorse")
+ :session "org.gnome.seahorse" "/org/gnome/seahorse")
@result{} ("crypto" "keys")
@end lisp
@@ -512,9 +520,10 @@ Example:
@end defun
@defun dbus-introspect-get-interface-names bus service path
-There will be returned a list strings of all interface names of
+This function returns a list strings of all interface names of
@var{service} in D-Bus @var{bus} at object path @var{path}. This list
-will contain the default interface @samp{org.freedesktop.DBus.Introspectable}.
+will contain the default interface
+@samp{org.freedesktop.DBus.Introspectable}.
Another default interface is @samp{org.freedesktop.DBus.Properties}.
If present, @code{interface} elements can also have @code{property}
@@ -522,8 +531,8 @@ children. Example:
@lisp
(dbus-introspect-get-interface-names
- :system "org.freedesktop.Hal"
- "/org/freedesktop/Hal/devices/computer")
+ :system "org.freedesktop.Hal"
+ "/org/freedesktop/Hal/devices/computer")
@result{} ("org.freedesktop.DBus.Introspectable"
"org.freedesktop.Hal.Device"
@@ -533,30 +542,27 @@ children. Example:
@end defun
@defun dbus-introspect-get-interface bus service path interface
-Return @var{interface} of @var{service} in D-Bus @var{bus} at object
-path @var{path}. The return value is an XML element. @var{interface}
-must be a string, element of the list returned by
-@code{dbus-introspect-get-interface-names}. Example:
+This function returns @var{interface} of @var{service} in D-Bus
+@var{bus} at object path @var{path}. The return value is an XML
+element. @var{interface} must be a string and a member of the list
+returned by @code{dbus-introspect-get-interface-names}. Example:
@lisp
(dbus-introspect-get-interface
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search")
@result{} (interface ((name . "org.freedesktop.xesam.Search"))
(method ((name . "GetHitData"))
(arg ((name . "search") (type . "s") (direction . "in")))
(arg ((name . "hit_ids") (type . "au") (direction . "in")))
(arg ((name . "fields") (type . "as") (direction . "in")))
- (arg ((name . "hit_data") (type . "aav") (direction . "out")))
- )
+ (arg ((name . "hit_data") (type . "aav") (direction . "out"))))
@dots{}
(signal ((name . "HitsAdded"))
(arg ((name . "search") (type . "s")))
- (arg ((name . "count") (type . "u")))
- )
- )
+ (arg ((name . "count") (type . "u")))))
@end lisp
@end defun
@@ -565,7 +571,8 @@ With these functions, it is possible to retrieve all
introspection
data from a running system:
@lisp
-(with-current-buffer (switch-to-buffer "*introspect*")
+(progn
+ (pop-to-buffer "*introspect*")
(erase-buffer)
(dolist (service (dbus-list-known-names :session))
(dolist (path (dbus-introspect-get-all-nodes :session service "/"))
@@ -574,7 +581,7 @@ data from a running system:
(when (delete
"org.freedesktop.DBus.Introspectable"
(dbus-introspect-get-interface-names :session service path))
- (insert (message "\nservice: \"%s\" path: \"%s\"\n" service path)
+ (insert (format "\nservice: \"%s\" path: \"%s\"\n" service path)
(dbus-introspect :session service path))
(redisplay t)))))
@end lisp
@@ -587,14 +594,15 @@ Methods and signals are the communication means to D-Bus.
The
following functions return their specifications.
@defun dbus-introspect-get-method-names bus service path interface
-Return a list of strings of all method names of @var{interface} of
-@var{service} in D-Bus @var{bus} at object path @var{path}. Example:
+This function returns a list of strings of all method names of
+@var{interface} of @var{service} in D-Bus @var{bus} at object path
+@var{path}. Example:
@lisp
(dbus-introspect-get-method-names
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search")
@result{} ("GetState" "StartSearch" "GetHitCount" "GetHits" "NewSession"
"CloseSession" "GetHitData" "SetProperty" "NewSearch"
@@ -603,35 +611,36 @@ Return a list of strings of all method names of
@var{interface} of
@end defun
@defun dbus-introspect-get-method bus service path interface method
-This function returns @var{method} of @var{interface} as XML element.
-It must be located at @var{service} in D-Bus @var{bus} at object path
-@var{path}. @var{method} must be a string, element of the list
-returned by @code{dbus-introspect-get-method-names}. Example:
+This function returns @var{method} of @var{interface} as an XML
+element. It must be located at @var{service} in D-Bus @var{bus} at
+object path @var{path}. @var{method} must be a string and a member of
+the list returned by @code{dbus-introspect-get-method-names}.
+Example:
@lisp
(dbus-introspect-get-method
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "GetHitData")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "GetHitData")
@result{} (method ((name . "GetHitData"))
(arg ((name . "search") (type . "s") (direction . "in")))
(arg ((name . "hit_ids") (type . "au") (direction . "in")))
(arg ((name . "fields") (type . "as") (direction . "in")))
- (arg ((name . "hit_data") (type . "aav") (direction . "out")))
- )
+ (arg ((name . "hit_data") (type . "aav") (direction . "out"))))
@end lisp
@end defun
@defun dbus-introspect-get-signal-names bus service path interface
-Return a list of strings of all signal names of @var{interface} of
-@var{service} in D-Bus @var{bus} at object path @var{path}. Example:
+This function returns a list of strings of all signal names of
+@var{interface} of @var{service} in D-Bus @var{bus} at object path
+@var{path}. Example:
@lisp
(dbus-introspect-get-signal-names
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search")
@result{} ("StateChanged" "SearchDone" "HitsModified"
"HitsRemoved" "HitsAdded")
@@ -639,21 +648,21 @@ Return a list of strings of all signal names of
@var{interface} of
@end defun
@defun dbus-introspect-get-signal bus service path interface signal
-This function returns @var{signal} of @var{interface} as XML element.
-It must be located at @var{service} in D-Bus @var{bus} at object path
-@var{path}. @var{signal} must be a string, element of the list
-returned by @code{dbus-introspect-get-signal-names}. Example:
+This function returns @var{signal} of @var{interface} as an XML
+element. It must be located at @var{service} in D-Bus @var{bus} at
+object path @var{path}. @var{signal} must be a string and a member of
+the list returned by @code{dbus-introspect-get-signal-names}.
+Example:
@lisp
(dbus-introspect-get-signal
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "HitsAdded")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "HitsAdded")
@result{} (signal ((name . "HitsAdded"))
(arg ((name . "search") (type . "s")))
- (arg ((name . "count") (type . "u")))
- )
+ (arg ((name . "count") (type . "u"))))
@end lisp
@end defun
@@ -664,8 +673,8 @@ returned by @code{dbus-introspect-get-signal-names}.
Example:
Interfaces can have properties. These can be exposed via the
@samp{org.freedesktop.DBus.Properties} interface@footnote{See
@uref{https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties}}.
-That is, properties can be retrieved and changed during lifetime of an
-element.
+That is, properties can be retrieved and changed during the lifetime
+of an element.
A generalized interface is
@samp{org.freedesktop.DBus.Objectmanager}@footnote{See
@@ -678,13 +687,14 @@ Often, they are used to instruct generators, how to
generate code from
the interface for a given language binding.
@defun dbus-introspect-get-property-names bus service path interface
-Return a list of strings with all property names of @var{interface} of
-@var{service} in D-Bus @var{bus} at object path @var{path}. Example:
+This function returns a list of strings with all property names of
+@var{interface} of @var{service} in D-Bus @var{bus} at object path
+@var{path}. Example:
@lisp
(dbus-introspect-get-property-names
- :session "org.kde.kded" "/modules/networkstatus"
- "org.kde.Solid.Networking.Client")
+ :session "org.kde.kded" "/modules/networkstatus"
+ "org.kde.Solid.Networking.Client")
@result{} ("Status")
@end lisp
@@ -694,26 +704,26 @@ also the @samp{org.freedesktop.DBus.Properties} interface.
@end defun
@defun dbus-introspect-get-property bus service path interface property
-This function returns @var{property} of @var{interface} as XML element.
-It must be located at @var{service} in D-Bus @var{bus} at object path
-@var{path}. @var{property} must be a string, element of the list
-returned by @code{dbus-introspect-get-property-names}.
+This function returns @var{property} of @var{interface} as an XML
+element. It must be located at @var{service} in D-Bus @var{bus} at
+object path @var{path}. @var{property} must be a string and a member
+of the list returned by @code{dbus-introspect-get-property-names}.
A @var{property} value can be retrieved by the function
@code{dbus-introspect-get-attribute}. Example:
@lisp
(dbus-introspect-get-property
- :session "org.kde.kded" "/modules/networkstatus"
- "org.kde.Solid.Networking.Client" "Status")
+ :session "org.kde.kded" "/modules/networkstatus"
+ "org.kde.Solid.Networking.Client" "Status")
@result{} (property ((access . "read") (type . "u") (name . "Status")))
(dbus-introspect-get-attribute
- (dbus-introspect-get-property
- :session "org.kde.kded" "/modules/networkstatus"
- "org.kde.Solid.Networking.Client" "Status")
- "access")
+ (dbus-introspect-get-property
+ :session "org.kde.kded" "/modules/networkstatus"
+ "org.kde.Solid.Networking.Client" "Status")
+ "access")
@result{} "read"
@end lisp
@@ -727,23 +737,23 @@ result can be any valid D-Bus value, or @code{nil} if
there is no
@lisp
(dbus-get-property
- :session "org.kde.kded" "/modules/networkstatus"
- "org.kde.Solid.Networking.Client" "Status")
+ :session "org.kde.kded" "/modules/networkstatus"
+ "org.kde.Solid.Networking.Client" "Status")
@result{} 4
@end lisp
@end defun
@defun dbus-set-property bus service path interface property value
-Set value of @var{property} of @var{interface} to @var{value}. It
-will be checked at @var{bus}, @var{service}, @var{path}. When the
-value has been set successful, the result is @var{value}. Otherwise,
-@code{nil} is returned. Example:
+This function sets the value of @var{property} of @var{interface} to
+@var{value}. It will be checked at @var{bus}, @var{service},
+@var{path}. When the value is successfully set, this function returns
+@var{value}. Otherwise, it returns @code{nil}. Example:
@lisp
(dbus-set-property
- :session "org.kde.kaccess" "/MainApplication"
- "com.trolltech.Qt.QApplication" "doubleClickInterval" 500)
+ :session "org.kde.kaccess" "/MainApplication"
+ "com.trolltech.Qt.QApplication" "doubleClickInterval" 500)
@result{} 500
@end lisp
@@ -757,8 +767,8 @@ If there are no properties, @code{nil} is returned.
Example:
@lisp
(dbus-get-all-properties
- :session "org.kde.kaccess" "/MainApplication"
- "com.trolltech.Qt.QApplication")
+ :session "org.kde.kaccess" "/MainApplication"
+ "com.trolltech.Qt.QApplication")
@result{} (("cursorFlashTime" . 1000) ("doubleClickInterval" . 500)
("keyboardInputInterval" . 400) ("wheelScrollLines" . 3)
@@ -773,13 +783,13 @@ This function returns all objects at @var{bus},
@var{service},
@var{path}, and the children of @var{path}. The result is a list of
objects. Every object is a cons of an existing path name, and the
list of available interface objects. An interface object is another
-cons, which car is the interface name, and the cdr is the list of
+cons, whose car is the interface name and cdr is the list of
properties as returned by @code{dbus-get-all-properties} for that path
-and interface. Example:
+and interface. Example:
@lisp
(dbus-get-all-managed-objects
- :session "org.gnome.SettingsDaemon" "/")
+ :session "org.gnome.SettingsDaemon" "/")
@result{} (("/org/gnome/SettingsDaemon/MediaKeys"
("org.gnome.SettingsDaemon.MediaKeys")
@@ -809,31 +819,28 @@ An overview of all existing object paths, their
interfaces and
properties could be retrieved by the following code:
@lisp
-(with-current-buffer (switch-to-buffer "*objectmanager*")
+(let ((result (mapcar (lambda (service)
+ (cons service
+ (dbus-get-all-managed-objects
+ :session service "/")))
+ (dbus-list-known-names :session))))
+ (pop-to-buffer "*objectmanager*")
(erase-buffer)
- (let (result)
- (dolist (service (dbus-list-known-names :session) result)
- (message "%s" service)
- (add-to-list
- 'result
- (cons service
- (dbus-get-all-managed-objects :session service "/"))))
- (insert (message "%s" (pp result)))
- (redisplay t)))
+ (pp result (current-buffer)))
@end lisp
@end defun
@defun dbus-introspect-get-annotation-names bus service path interface
&optional name
-Return a list of all annotation names as list of strings. If
-@var{name} is @code{nil}, the annotations are children of
+This function returns a list of all annotation names as list of
+strings. If @var{name} is @code{nil}, the annotations are children of
@var{interface}, otherwise @var{name} must be a @code{method},
@code{signal}, or @code{property} XML element, where the annotations
belong to. Example:
@lisp
(dbus-introspect-get-annotation-names
- :session "de.berlios.Pinot" "/de/berlios/Pinot"
- "de.berlios.Pinot" "GetStatistics")
+ :session "de.berlios.Pinot" "/de/berlios/Pinot"
+ "de.berlios.Pinot" "GetStatistics")
@result{} ("de.berlios.Pinot.GetStatistics")
@end lisp
@@ -855,29 +862,30 @@ If set, don't expect a reply to the @code{method} call;
defaults to @code{nil}
@end defun
@defun dbus-introspect-get-annotation bus service path interface name
annotation
-Return annotation @var{ANNOTATION} as XML object. If @var{name} is
-@code{nil}, @var{ANNOTATION} is a child of @var{interface}, otherwise
-@var{name} must be the name of a @code{method}, @code{signal}, or
-@code{property} XML element, where the @var{ANNOTATION} belongs to.
+This function returns @var{annotation} as an XML object. If
+@var{name} is @code{nil}, @var{annotation} is a child of
+@var{interface}, otherwise @var{name} must be the name of a
+@code{method}, @code{signal}, or @code{property} XML element, where
+the @var{annotation} belongs to.
An attribute value can be retrieved by
@code{dbus-introspect-get-attribute}. Example:
@lisp
(dbus-introspect-get-annotation
- :session "de.berlios.Pinot" "/de/berlios/Pinot"
- "de.berlios.Pinot" "GetStatistics"
- "de.berlios.Pinot.GetStatistics")
+ :session "de.berlios.Pinot" "/de/berlios/Pinot"
+ "de.berlios.Pinot" "GetStatistics"
+ "de.berlios.Pinot.GetStatistics")
@result{} (annotation ((name . "de.berlios.Pinot.GetStatistics")
(value . "pinotDBus")))
(dbus-introspect-get-attribute
- (dbus-introspect-get-annotation
- :session "de.berlios.Pinot" "/de/berlios/Pinot"
- "de.berlios.Pinot" "GetStatistics"
- "de.berlios.Pinot.GetStatistics")
- "value")
+ (dbus-introspect-get-annotation
+ :session "de.berlios.Pinot" "/de/berlios/Pinot"
+ "de.berlios.Pinot" "GetStatistics"
+ "de.berlios.Pinot.GetStatistics")
+ "value")
@result{} "pinotDBus"
@end lisp
@@ -891,39 +899,41 @@ Methods and signals have arguments. They are described
in the
@code{arg} XML elements.
@defun dbus-introspect-get-argument-names bus service path interface name
-Return a list of all argument names as list of strings. @var{name}
-must be a @code{method} or @code{signal} XML element. Example:
+This function returns a list of all argument names as strings.
+@var{name} must be a @code{method} or @code{signal} XML element.
+Example:
@lisp
(dbus-introspect-get-argument-names
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "GetHitData")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "GetHitData")
@result{} ("search" "hit_ids" "fields" "hit_data")
@end lisp
-Argument names are optional; the function can return @code{nil}
-therefore, even if the method or signal has arguments.
+Argument names are optional; the function can therefore return
+@code{nil}, even if the method or signal has arguments.
@end defun
@defun dbus-introspect-get-argument bus service path interface name arg
-Return argument @var{ARG} as XML object. @var{name}
-must be a @code{method} or @code{signal} XML element. Example:
+This function returns the argument @var{arg} as an XML object.
+@var{name} must be a @code{method} or @code{signal} XML element.
+Example:
@lisp
(dbus-introspect-get-argument
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "GetHitData" "search")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "GetHitData" "search")
@result{} (arg ((name . "search") (type . "s") (direction . "in")))
@end lisp
@end defun
@defun dbus-introspect-get-signature bus service path interface name &optional
direction
-Return signature of a @code{method} or @code{signal}, represented by
-@var{name}, as string.
+This function returns the signature of a @code{method} or
+@code{signal}, represented by @var{name}, as a string.
If @var{name} is a @code{method}, @var{direction} can be either
@samp{in} or @samp{out}. If @var{direction} is @code{nil}, @samp{in}
@@ -934,16 +944,16 @@ non-@code{nil}, @var{direction} must be @samp{out}.
Example:
@lisp
(dbus-introspect-get-signature
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "GetHitData" "in")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "GetHitData" "in")
@result{} "sauas"
(dbus-introspect-get-signature
- :session "org.freedesktop.xesam.searcher"
- "/org/freedesktop/xesam/searcher/main"
- "org.freedesktop.xesam.Search" "HitsAdded")
+ :session "org.freedesktop.xesam.searcher"
+ "/org/freedesktop/xesam/searcher/main"
+ "org.freedesktop.xesam.Search" "HitsAdded")
@result{} "su"
@end lisp
@@ -998,30 +1008,27 @@ types are represented by the type symbols @code{:byte},
Example:
@lisp
-(dbus-call-method @dots{} @var{NAT-NUMBER} @var{STRING})
+(dbus-call-method @dots{} @var{nat-number} @var{string})
@end lisp
is equivalent to
@lisp
-(dbus-call-method @dots{} :uint32 @var{NAT-NUMBER} :string @var{STRING})
+(dbus-call-method @dots{} :uint32 @var{nat-number} :string @var{string})
@end lisp
but different to
@lisp
-(dbus-call-method @dots{} :int32 @var{NAT-NUMBER} :signature @var{STRING})
+(dbus-call-method @dots{} :int32 @var{nat-number} :signature @var{string})
@end lisp
The value for a byte D-Bus type can be any integer in the range 0
through 255. If a character is used as argument, modifiers
represented outside this range are stripped off. For example,
@code{:byte ?x} is equal to @code{:byte ?\M-x}, but it is not equal to
-@code{:byte ?\C-x} or @code{:byte ?\M-\C-x}.
-
-Signed and unsigned integer D-Bus types expect a corresponding integer
-value. If the value does not fit Emacs's integer range, it is also
-possible to use an equivalent floating point number.
+@code{:byte ?\C-x} or @code{:byte ?\M-\C-x}. Signed and unsigned
+integer D-Bus types expect a corresponding integer value.
A D-Bus compound type is always represented as a list. The @sc{car}
of this list can be the type symbol @code{:array}, @code{:variant},
@@ -1036,13 +1043,13 @@ D-Bus compound type rules.
@item An array must contain only elements of the same D-Bus type. It
can be empty.
-@item A variant must contain only one single element.
+@item A variant must contain only a single element.
-@item A dictionary entry must be element of an array, and it must
+@item A dictionary entry must be an element of an array, and it must
contain only a key-value pair of two elements, with a basic D-Bus type
key.
-@item There is no restriction for structs.
+@item There are no restrictions for structs.
@end itemize
If an empty array needs an element D-Bus type other than string, it
@@ -1052,27 +1059,27 @@ elements of this array. Example:
@lisp
(dbus-call-method
- :session "org.freedesktop.Notifications"
- "/org/freedesktop/Notifications"
- "org.freedesktop.Notifications" "Notify"
- "GNU Emacs" ;; Application name.
- 0 ;; No replacement of other notifications.
- "" ;; No icon.
- "Notification summary" ;; Summary.
- (format ;; Body.
- "This is a test notification, raised from\n%S" (emacs-version))
- '(:array) ;; No actions (empty array of strings).
- '(:array :signature "@{sv@}") ;; No hints
- ;; (empty array of dictionary entries).
- :int32 -1) ;; Default timeout.
+ :session "org.freedesktop.Notifications"
+ "/org/freedesktop/Notifications"
+ "org.freedesktop.Notifications" "Notify"
+ "GNU Emacs" ; Application name.
+ 0 ; No replacement of other notifications.
+ "" ; No icon.
+ "Notification summary" ; Summary.
+ (format ; Body.
+ "This is a test notification, raised from\n%S" (emacs-version))
+ '(:array) ; No actions (empty array of strings).
+ '(:array :signature "@{sv@}") ; No hints
+ ; (empty array of dictionary entries).
+ :int32 -1) ; Default timeout.
@result{} 3
@end lisp
@defun dbus-string-to-byte-array string
Sometimes, D-Bus methods require as input parameter an array of bytes,
-instead of a string. If it is guaranteed, that @var{string} is an
-UTF8 string, this function performs the conversion. Example:
+instead of a string. If it is guaranteed, that @var{string} is a
+UTF-8 string, this function performs the conversion. Example:
@lisp
(dbus-string-to-byte-array "/etc/hosts")
@@ -1083,10 +1090,10 @@ UTF8 string, this function performs the conversion.
Example:
@end defun
@defun dbus-escape-as-identifier string
-Escape an arbitrary @var{string} so it follows the rules for a C
-identifier. The escaped string can be used as object path component,
-interface element component, bus name component or member name in
-D-Bus.
+This function escapes an arbitrary @var{string} so it follows the
+rules for a C identifier. The escaped string can be used as object
+path component, interface element component, bus name component or
+member name in D-Bus.
The escaping consists of replacing all non-alphanumerics, and the
first character if it's a digit, with an underscore and two
@@ -1107,18 +1114,18 @@ Output parameters of D-Bus methods and signals are
mapped to Lisp
objects.
@example
-@multitable {DBUS_TYPE_OBJECT_PATH} {@expansion{}} {natural number or float}
+@multitable {DBUS_TYPE_OBJECT_PATH} {@expansion{}} {natural number}
@item D-Bus type @tab @tab Lisp type
@item
@item DBUS_TYPE_BOOLEAN @tab @expansion{} @tab @code{t} or @code{nil}
@item DBUS_TYPE_BYTE @tab @expansion{} @tab natural number
@item DBUS_TYPE_UINT16 @tab @expansion{} @tab natural number
@item DBUS_TYPE_INT16 @tab @expansion{} @tab integer
-@item DBUS_TYPE_UINT32 @tab @expansion{} @tab natural number or float
-@item DBUS_TYPE_UNIX_FD @tab @expansion{} @tab natural number or float
-@item DBUS_TYPE_INT32 @tab @expansion{} @tab integer or float
-@item DBUS_TYPE_UINT64 @tab @expansion{} @tab natural number or float
-@item DBUS_TYPE_INT64 @tab @expansion{} @tab integer or float
+@item DBUS_TYPE_UINT32 @tab @expansion{} @tab natural number
+@item DBUS_TYPE_UNIX_FD @tab @expansion{} @tab natural number
+@item DBUS_TYPE_INT32 @tab @expansion{} @tab integer
+@item DBUS_TYPE_UINT64 @tab @expansion{} @tab natural number
+@item DBUS_TYPE_INT64 @tab @expansion{} @tab integer
@item DBUS_TYPE_DOUBLE @tab @expansion{} @tab float
@item DBUS_TYPE_STRING @tab @expansion{} @tab string
@item DBUS_TYPE_OBJECT_PATH @tab @expansion{} @tab string
@@ -1130,26 +1137,21 @@ objects.
@end multitable
@end example
-A float object in case of @code{DBUS_TYPE_UINT32},
-@code{DBUS_TYPE_INT32}, @code{DBUS_TYPE_UINT64},
-@code{DBUS_TYPE_INT64} and @code{DBUS_TYPE_UNIX_FD} is returned, when
-the C value exceeds the Emacs number size range.
-
The resulting list of the last 4 D-Bus compound types contains as
elements the elements of the D-Bus container, mapped according to the
same rules.
-The signal @code{PropertyModified}, discussed as example in
+The signal @code{PropertyModified}, discussed as an example in
@ref{Inspection}, would offer as Lisp data the following object
-(@var{BOOL} stands here for either @code{nil} or @code{t}):
+(@var{bool} stands here for either @code{nil} or @code{t}):
@lisp
-(@var{INTEGER} ((@var{STRING} @var{BOOL} @var{BOOL}) (@var{STRING} @var{BOOL}
@var{BOOL}) @dots{}))
+(@var{integer} ((@var{string} @var{bool} @var{bool}) (@var{string} @var{bool}
@var{bool}) @dots{}))
@end lisp
@defun dbus-byte-array-to-string byte-array &optional multibyte
If a D-Bus method or signal returns an array of bytes, which are known
-to represent an UTF8 string, this function converts @var{byte-array}
+to represent a UTF-8 string, this function converts @var{byte-array}
to the corresponding string. The string is unibyte encoded, unless
@var{multibyte} is non-@code{nil}. Example:
@@ -1161,9 +1163,9 @@ to the corresponding string. The string is unibyte
encoded, unless
@end defun
@defun dbus-unescape-from-identifier string
-Retrieve the original string from the encoded @var{string} as unibyte
-string. @var{string} must have been encoded with
-@code{dbus-escape-as-identifier}. Example:
+This function retrieves the original string from the encoded
+@var{string} as a unibyte string. The value of @var{string} must have
+been encoded with @code{dbus-escape-as-identifier}. Example:
@lisp
(dbus-unescape-from-identifier "_30123abc_5fxyz_01_ff")
@@ -1177,9 +1179,9 @@ that string:
@lisp
(string-equal
- (dbus-unescape-from-identifier
- (dbus-escape-as-identifier "Grüß Göttin"))
- "Grüß Göttin")
+ (dbus-unescape-from-identifier
+ (dbus-escape-as-identifier "Grüß Göttin"))
+ "Grüß Göttin")
@result{} nil
@end lisp
@@ -1196,12 +1198,13 @@ that string:
Methods can be called synchronously (@dfn{blocking}) or asynchronously
(@dfn{non-blocking}).
-At D-Bus level, a method call consist of two messages: one message
+At the D-Bus level, a method call consist of two messages: one message
which carries the input parameters to the object owning the method to
be called, and a reply message returning the resulting output
parameters from the object.
@defun dbus-call-method bus service path interface method &optional :timeout
timeout &rest args
+@anchor{dbus-call-method}
This function calls @var{method} on the D-Bus @var{bus}. @var{bus} is
either the symbol @code{:system} or the symbol @code{:session}.
@@ -1210,14 +1213,14 @@ D-Bus object path, @var{service} is registered at.
@var{interface} is
an interface offered by @var{service}. It must provide @var{method}.
If the parameter @code{:timeout} is given, the following integer
-@var{timeout} specifies the maximum number of milliseconds the method
-call must return. The default value is 25,000. If the method call
-doesn't return in time, a D-Bus error is raised (@pxref{Errors and
-Events}).
+@var{timeout} specifies the maximum number of milliseconds before the
+method call must return. The default value is 25,000. If the method
+call doesn't return in time, a D-Bus error is raised (@pxref{Errors
+and Events}).
-All other arguments args are passed to @var{method} as arguments.
-They are converted into D-Bus types as described in @ref{Type
-Conversion}.
+The remaining arguments @var{args} are passed to @var{method} as
+arguments. They are converted into D-Bus types as described in
+@ref{Type Conversion}.
The function returns the resulting values of @var{method} as a list of
Lisp objects, according to the type conversion rules described in
@@ -1225,9 +1228,9 @@ Lisp objects, according to the type conversion rules
described in
@lisp
(dbus-call-method
- :session "org.gnome.seahorse" "/org/gnome/seahorse/keys/openpgp"
- "org.gnome.seahorse.Keys" "GetKeyField"
- "openpgp:657984B8C7A966DD" "simple-name")
+ :session "org.gnome.seahorse" "/org/gnome/seahorse/keys/openpgp"
+ "org.gnome.seahorse.Keys" "GetKeyField"
+ "openpgp:657984B8C7A966DD" "simple-name")
@result{} (t ("Philip R. Zimmermann"))
@end lisp
@@ -1238,10 +1241,10 @@ object. Example:
@lisp
(dbus-call-method
- :system "org.freedesktop.Hal"
- "/org/freedesktop/Hal/devices/computer"
- "org.freedesktop.Hal.Device" "GetPropertyString"
- "system.kernel.machine")
+ :system "org.freedesktop.Hal"
+ "/org/freedesktop/Hal/devices/computer"
+ "org.freedesktop.Hal.Device" "GetPropertyString"
+ "system.kernel.machine")
@result{} "i686"
@end lisp
@@ -1257,17 +1260,17 @@ emulate the @code{lshal} command on GNU/Linux systems:
@lisp
(dolist (device
- (dbus-call-method
- :system "org.freedesktop.Hal"
- "/org/freedesktop/Hal/Manager"
- "org.freedesktop.Hal.Manager" "GetAllDevices"))
+ (dbus-call-method
+ :system "org.freedesktop.Hal"
+ "/org/freedesktop/Hal/Manager"
+ "org.freedesktop.Hal.Manager" "GetAllDevices"))
(message "\nudi = %s" device)
(dolist (properties
- (dbus-call-method
- :system "org.freedesktop.Hal" device
- "org.freedesktop.Hal.Device" "GetAllProperties"))
+ (dbus-call-method
+ :system "org.freedesktop.Hal" device
+ "org.freedesktop.Hal.Device" "GetAllProperties"))
(message " %s = %S"
- (car properties) (or (caar (cdr properties)) ""))))
+ (car properties) (or (caadr properties) ""))))
@print{} "udi = /org/freedesktop/Hal/devices/computer
info.addons = (\"hald-addon-acpi\")
@@ -1304,34 +1307,35 @@ D-Bus object path, @var{service} is registered at.
@var{interface} is
an interface offered by @var{service}. It must provide @var{method}.
@var{handler} is a Lisp function, which is called when the
-corresponding return message has arrived. If @var{handler} is
-@code{nil}, no return message will be expected.
+corresponding return message arrives. If @var{handler} is @code{nil},
+no return message will be expected.
If the parameter @code{:timeout} is given, the following integer
-@var{timeout} specifies the maximum number of milliseconds a reply
-message must arrive. The default value is 25,000. If there is no
-reply message in time, a D-Bus error is raised (@pxref{Errors and
+@var{timeout} specifies the maximum number of milliseconds before a
+reply message must arrive. The default value is 25,000. If there is
+no reply message in time, a D-Bus error is raised (@pxref{Errors and
Events}).
-All other arguments args are passed to @var{method} as arguments.
-They are converted into D-Bus types as described in @ref{Type
-Conversion}.
+The remaining arguments @var{args} are passed to @var{method} as
+arguments. They are converted into D-Bus types as described in
+@ref{Type Conversion}.
If @var{handler} is a Lisp function, the function returns a key into
the hash table @code{dbus-registered-objects-table}. The
corresponding entry in the hash table is removed, when the return
-message has been arrived, and @var{handler} is called. Example:
+message arrives, and @var{handler} is called. Example:
@lisp
(dbus-call-method-asynchronously
- :system "org.freedesktop.Hal"
- "/org/freedesktop/Hal/devices/computer"
- "org.freedesktop.Hal.Device" "GetPropertyString" 'message
- "system.kernel.machine")
-
-@result{} (:serial :system 2)
+ :system "org.freedesktop.Hal"
+ "/org/freedesktop/Hal/devices/computer"
+ "org.freedesktop.Hal.Device" "GetPropertyString"
+ (lambda (msg) (message "%s" msg))
+ "system.kernel.machine")
@print{} i686
+
+@result{} (:serial :system 2)
@end lisp
@end defun
@@ -1347,7 +1351,8 @@ clients. Names on the D-Bus can be registered and
unregistered using
the following functions:
@defun dbus-register-service bus service &rest flags
-Register the known name @var{service} on D-Bus @var{bus}.
+This function registers the known name @var{service} on D-Bus
+@var{bus}.
@var{bus} is either the symbol @code{:system} or the symbol
@code{:session}.
@@ -1357,36 +1362,33 @@ must be a known name.
@var{flags} is a subset of the following keywords:
-@itemize
-@item @code{:allow-replacement}: Allow another service to become the primary
-owner if requested.
-
-@item @code{:replace-existing}: Request to replace the current primary owner.
-
-@item @code{:do-not-queue}: If we can not become the primary owner do not
-place us in the queue.
-@end itemize
+@table @code
+@item :allow-replacement
+Allow another service to become the primary owner if requested.
+@item :replace-existing
+Request to replace the current primary owner.
+@item :do-not-queue
+If we can not become the primary owner do not place us in the queue.
+@end table
One of the following keywords is returned:
-@itemize
-
-@item @code{:primary-owner}: We have become the primary owner of the name
-@var{service}.
-
-@item @code{:in-queue}: We could not become the primary owner and
-have been placed in the queue.
-
-@item @code{:exists}: We already are in the queue.
-
-@item @code{:already-owner}: We already are the primary
-owner.
-@end itemize
+@table @code
+@item :primary-owner
+We have become the primary owner of the name @var{service}.
+@item :in-queue
+We could not become the primary owner and have been placed in the
+queue.
+@item :exists
+We already are in the queue.
+@item :already-owner
+We already are the primary owner.
+@end table
@end defun
@defun dbus-unregister-service bus service
-Unregister all objects from D-Bus @var{bus}, registered by Emacs for
-@var{service}.
+This function unregisters all objects from D-Bus @var{bus}, that were
+registered by Emacs for @var{service}.
@var{bus} is either the symbol @code{:system} or the symbol
@code{:session}.
@@ -1397,24 +1399,27 @@ D-Bus.
One of the following keywords is returned:
-@itemize
-@item @code{:released}: We successfully released the name @var{service}.
-@item @code{:non-existent}: The name @var{service} does not exist on the bus.
-@item @code{:not-owner}: We are not an owner of the name @var{service}.
-@end itemize
+@table @code
+@item :released
+We successfully released the name @var{service}.
+@item :non-existent
+The name @var{service} does not exist on the bus.
+@item :not-owner
+We are not an owner of the name @var{service}.
+@end table
@end defun
-When a name has been chosen, Emacs can offer own methods, which can be
-called by other applications. These methods could be an
+When a name has been chosen, Emacs can offer its own methods, which
+can be called by other applications. These methods could be an
implementation of an interface of a well known service, like
@samp{org.freedesktop.TextEditor}.
-It could be also an implementation of an own interface. In this case,
-the service name must be @samp{org.gnu.Emacs}. The object path shall
-begin with @samp{/org/gnu/Emacs/@strong{Application}}, and the
-interface name shall be @code{org.gnu.Emacs.@strong{Application}}.
-@samp{@strong{Application}} is the name of the application which
-provides the interface.
+They could also be an implementation of its own interface. In this
+case, the service name must be @samp{org.gnu.Emacs}. The object path
+shall begin with @samp{/org/gnu/Emacs/@var{application}}, and the
+interface name shall be @code{org.gnu.Emacs.@var{application}}, where
+@var{application} is the name of the application which provides the
+interface.
@deffn Constant dbus-service-emacs
The well known service name @samp{org.gnu.Emacs} of Emacs.
@@ -1436,10 +1441,10 @@ With this function, an application registers
@var{method} on the D-Bus
@code{:session}.
@var{service} is the D-Bus service name of the D-Bus object
-@var{method} is registered for. It must be a known name (See
+@var{method} is registered for. It must be a known name (see
discussion of @var{dont-register-service} below).
-@var{path} is the D-Bus object path @var{service} is registered (See
+@var{path} is the D-Bus object path @var{service} is registered (see
discussion of @var{dont-register-service} below).
@var{interface} is the interface offered by @var{service}. It must
@@ -1456,8 +1461,8 @@ If @var{handler} wants to return just one Lisp object and
it is not a
cons cell, @var{handler} can return this object directly, instead of
returning a list containing the object.
-In case @var{handler} shall return a reply message with an empty
-argument list, @var{handler} must return the symbol @code{:ignore}.
+If @var{handler} returns a reply message with an empty argument list,
+@var{handler} must return the symbol @code{:ignore}.
When @var{dont-register-service} is non-@code{nil}, the known name
@var{service} is not registered. This means that other D-Bus clients
@@ -1468,7 +1473,7 @@ clients from discovering the still incomplete interface.
The default D-Bus timeout when waiting for a message reply is 25
seconds. This value could be even smaller, depending on the calling
-client. Therefore, @var{handler} shall not last longer than
+client. Therefore, @var{handler} should not last longer than
absolutely necessary.
@code{dbus-register-method} returns a Lisp object, which can be used
@@ -1477,18 +1482,14 @@ registration for @var{method}. Example:
@lisp
(defun my-dbus-method-handler (filename)
- (let (result)
- (if (find-file filename)
- (setq result '(:boolean t))
- (setq result '(:boolean nil)))
- result))
-
-@result{} my-dbus-method-handler
+ (if (find-file filename)
+ '(:boolean t)
+ '(:boolean nil)))
(dbus-register-method
- :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
- "org.freedesktop.TextEditor" "OpenFile"
- 'my-dbus-method-handler)
+ :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
+ "org.freedesktop.TextEditor" "OpenFile"
+ #'my-dbus-method-handler)
@result{} ((:method :session "org.freedesktop.TextEditor" "OpenFile")
("org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
@@ -1496,9 +1497,9 @@ registration for @var{method}. Example:
@end lisp
If you invoke the method @samp{org.freedesktop.TextEditor.OpenFile}
-from another D-Bus application with a filename as parameter, the file
+from another D-Bus application with a file name as parameter, the file
is opened in Emacs, and the method returns either @var{true} or
-@var{false}, indicating the success of the method. As test tool one
+@var{false}, indicating the success of the method. As a test tool one
could use the command line tool @code{dbus-send} in a shell:
@example
@@ -1522,11 +1523,9 @@ You can indicate an error by raising the Emacs signal
(find-file (car args))
(error (signal 'dbus-error (cdr err))))
t)
-
-@result{} my-dbus-method-handler
@end lisp
-The test runs then
+The test then runs
@example
# dbus-send --session --print-reply \
@@ -1550,7 +1549,7 @@ With this function, an application declares a
@var{property} on the D-Bus
@var{service} is the D-Bus service name of the D-Bus. It must be a
known name.
-@var{path} is the D-Bus object path @var{service} is registered (See
+@var{path} is the D-Bus object path @var{service} is registered (see
discussion of @var{dont-register-service} below).
@var{interface} is the name of the interface used at @var{path},
@@ -1559,7 +1558,7 @@ discussion of @var{dont-register-service} below).
@var{access} indicates, whether the property can be changed by other
services via D-Bus. It must be either the symbol @code{:read} or
@code{:readwrite}. @var{value} is the initial value of the property,
-it can be of any valid type (see @code{dbus-call-method} for details).
+it can be of any valid type (@xref{dbus-call-method}, for details).
If @var{property} already exists on @var{path}, it will be
overwritten. For properties with access type @code{:read} this is the
@@ -1584,15 +1583,15 @@ clients from discovering the still incomplete interface.
@lisp
(dbus-register-property
- :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
- "org.freedesktop.TextEditor" "name" :read "GNU Emacs")
+ :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
+ "org.freedesktop.TextEditor" "name" :read "GNU Emacs")
@result{} ((:property :session "org.freedesktop.TextEditor" "name")
("org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"))
(dbus-register-property
- :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
- "org.freedesktop.TextEditor" "version" :readwrite emacs-version t)
+ :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
+ "org.freedesktop.TextEditor" "version" :readwrite emacs-version t)
@result{} ((:property :session "org.freedesktop.TextEditor" "version")
("org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"))
@@ -1623,28 +1622,28 @@ possible via the command line tool @code{dbus-send} in
a shell:
]
@end example
-It is also possible, to apply the @code{dbus-get-property},
+It is also possible to apply the @code{dbus-get-property},
@code{dbus-get-all-properties} and @code{dbus-set-property} functions
(@pxref{Properties and Annotations}).
@lisp
(dbus-set-property
- :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
- "org.freedesktop.TextEditor" "version" "23.1.50")
+ :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
+ "org.freedesktop.TextEditor" "version" "23.1.50")
@result{} "23.1.50"
(dbus-get-property
- :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
- "org.freedesktop.TextEditor" "version")
+ :session "org.freedesktop.TextEditor" "/org/freedesktop/TextEditor"
+ "org.freedesktop.TextEditor" "version")
@result{} "23.1.50"
@end lisp
@end defun
@defun dbus-unregister-object object
-Unregister @var{object} from the D-Bus. @var{object} must be the
-result of a preceding @code{dbus-register-method},
+This function unregisters @var{object} from the D-Bus. @var{object}
+must be the result of a preceding @code{dbus-register-method},
@code{dbus-register-property} or @code{dbus-register-signal} call
(@pxref{Signals}). It returns @code{t} if @var{object} has been
unregistered, @code{nil} otherwise.
@@ -1672,22 +1671,22 @@ doesn't matter whether another object has registered
for @var{signal}.
Signals can be unicast or broadcast messages. For broadcast messages,
@var{service} must be @code{nil}. Otherwise, @var{service} is the
-D-Bus service name the signal is sent to as unicast
+D-Bus service name the signal is sent to as a unicast
message.@footnote{For backward compatibility, a broadcast message is
also emitted if @var{service} is the known or unique name Emacs is
registered at D-Bus @var{bus}.} @var{path} is the D-Bus object path
@var{signal} is sent from. @var{interface} is an interface available
at @var{path}. It must provide @var{signal}.
-All other arguments args are passed to @var{signal} as arguments.
-They are converted into D-Bus types as described in @ref{Type
-Conversion}. Example:
+The remaining arguments @var{args} are passed to @var{signal} as
+arguments. They are converted into D-Bus types as described in
+@ref{Type Conversion}. Example:
@lisp
(dbus-send-signal
- :session nil dbus-path-emacs
- (concat dbus-interface-emacs ".FileManager") "FileModified"
- "/home/albinus/.emacs")
+ :session nil dbus-path-emacs
+ (concat dbus-interface-emacs ".FileManager") "FileModified"
+ "/home/albinus/.emacs")
@end lisp
@end defun
@@ -1702,11 +1701,11 @@ With this function, an application registers for a
signal on the D-Bus
object. It can be either a known name or the unique name of the D-Bus
object sending the signal. A known name will be mapped onto the
unique name of the object, owning @var{service} at registration time.
-When the corresponding D-Bus object disappears, signals won't be
-received any longer.
+When the corresponding D-Bus object disappears, signals will no longer
+be received.
-@var{path} is the corresponding D-Bus object path, @var{service} is
-registered at. @var{interface} is an interface offered by
+@var{path} is the corresponding D-Bus object path that @var{service}
+is registered at. @var{interface} is an interface offered by
@var{service}. It must provide @var{signal}.
@var{service}, @var{path}, @var{interface} and @var{signal} can be
@@ -1721,30 +1720,31 @@ The remaining arguments @var{args} can be keywords or
keyword string
pairs.@footnote{For backward compatibility, the arguments @var{args}
can also be just strings. They stand for the respective arguments of
@var{signal} in their order, and are used for filtering as well. A
-@code{nil} argument might be used to preserve the order.} The meaning
-is as follows:
-
-@itemize
-@item @code{:argN} @var{string}:@*
-@code{:pathN} @var{string}:@*
-This stands for the Nth argument of the signal. @code{:pathN}
-arguments can be used for object path wildcard matches as specified by
-D-Bus, while an @code{:argN} argument requires an exact match.
-
-@item @code{:arg-namespace} @var{string}:@*
-Register for the signals, which first argument defines the service or
-interface namespace @var{string}.
-
-@item @code{:path-namespace} @var{string}:@*
+@code{nil} argument might be used to preserve the order.} Their
+meaning is as follows:
+
+@table @code
+@item :arg@var{n} @var{string}
+@item :path@var{n} @var{string}
+This stands for the @var{n}th argument of the signal.
+@code{:path@var{n}} arguments can be used for object path wildcard
+matches as specified by D-Bus, while an @code{:argN} argument requires
+an exact match.
+
+@item :arg-namespace @var{string}
+Register for those signals, whose first argument names a service or
+interface within the namespace @var{string}.
+
+@item :path-namespace @var{string}
Register for the object path namespace @var{string}. All signals sent
from an object path, which has @var{string} as the preceding string,
are matched. This requires @var{path} to be @code{nil}.
-@item @code{:eavesdrop}:@*
+@item :eavesdrop
Register for unicast signals which are not directed to the D-Bus
object Emacs is registered at D-Bus BUS, if the security policy of BUS
allows this. Otherwise, this argument is ignored.
-@end itemize
+@end table
@code{dbus-register-signal} returns a Lisp object, which can be used
as argument in @code{dbus-unregister-object} for removing the
@@ -1754,12 +1754,10 @@ registration for @var{signal}. Example:
(defun my-dbus-signal-handler (device)
(message "Device %s added" device))
-@result{} my-dbus-signal-handler
-
(dbus-register-signal
- :system "org.freedesktop.Hal" "/org/freedesktop/Hal/Manager"
- "org.freedesktop.Hal.Manager" "DeviceAdded"
- 'my-dbus-signal-handler)
+ :system "org.freedesktop.Hal" "/org/freedesktop/Hal/Manager"
+ "org.freedesktop.Hal.Manager" "DeviceAdded"
+ #'my-dbus-signal-handler)
@result{} ((:signal :system "org.freedesktop.Hal.Manager" "DeviceAdded")
("org.freedesktop.Hal" "/org/freedesktop/Hal/Manager"
@@ -1769,8 +1767,8 @@ registration for @var{signal}. Example:
As we know from the introspection data of interface
@samp{org.freedesktop.Hal.Manager}, the signal @samp{DeviceAdded}
provides one single parameter, which is mapped into a Lisp string.
-The callback function @code{my-dbus-signal-handler} must define one
-single string argument therefore. Plugging an USB device to your
+The callback function @code{my-dbus-signal-handler} must therefore
+define a single string argument. Plugging a USB device into your
machine, when registered for signal @samp{DeviceAdded}, will show you
which objects the GNU/Linux @code{hal} daemon adds.
@@ -1781,7 +1779,7 @@ for a dummy signal, and check the result:
@lisp
(dbus-ignore-errors
(dbus-register-signal
- :system nil nil nil nil 'ignore :path-namespace "/invalid/path"))
+ :system nil nil nil nil #'ignore :path-namespace "/invalid/path"))
@result{} nil
@end lisp
@@ -1796,14 +1794,14 @@ for a dummy signal, and check the result:
Until now, we have spoken about the system and the session buses,
which are the default buses to be connected to. However, it is
-possible to connect to any bus, from which the address is known. This
-is a UNIX domain or TCP/IP socket. Everywhere, where a @var{bus} is
-mentioned as argument of a function (the symbol @code{:system} or the
-symbol @code{:session}), this address can be used instead. The
-connection to this bus must be initialized first.
+possible to connect to any bus with a known address. This is a UNIX
+domain or TCP/IP socket. Everywhere, where a @var{bus} is mentioned
+as argument of a function (the symbol @code{:system} or the symbol
+@code{:session}), this address can be used instead. The connection to
+this bus must be initialized first.
@defun dbus-init-bus bus &optional private
-Establish the connection to D-Bus @var{bus}.
+This function establishes the connection to D-Bus @var{bus}.
@var{bus} can be either the symbol @code{:system} or the symbol
@code{:session}, or it can be a string denoting the address of the
@@ -1811,12 +1809,12 @@ corresponding bus. For the system and session buses,
this function
is called when loading @file{dbus.el}, there is no need to call it
again.
-The function returns a number, which counts the connections this Emacs
-session has established to the @var{bus} under the same unique name
-(see @code{dbus-get-unique-name}). It depends on the libraries Emacs
-is linked with, and on the environment Emacs is running. For example,
-if Emacs is linked with the GTK+ toolkit, and it runs in a GTK+-aware
-environment like Gnome, another connection might already be
+The function returns the number of connections this Emacs session has
+established to the @var{bus} under the same unique name
+(@pxref{dbus-get-unique-name}). It depends on the libraries Emacs is
+linked with, and on the environment Emacs is running. For example, if
+Emacs is linked with the GTK+ toolkit, and it runs in a GTK+-aware
+environment like GNOME, another connection might already be
established.
When @var{private} is non-@code{nil}, a new connection is established
@@ -1831,9 +1829,9 @@ Example: You initialize a connection to the AT-SPI bus on
your host:
@lisp
(setq my-bus
- (dbus-call-method
- :session "org.a11y.Bus" "/org/a11y/bus"
- "org.a11y.Bus" "GetAddress"))
+ (dbus-call-method
+ :session "org.a11y.Bus" "/org/a11y/bus"
+ "org.a11y.Bus" "GetAddress"))
@result{}
"unix:abstract=/tmp/dbus-2yzWHOCdSD,guid=a490dd26625870ca1298b6e10000fd7f"
@@ -1848,7 +1846,7 @@ Example: You initialize a connection to the AT-SPI bus on
your host:
@result{} ":1.19"
-;; Open a new connection to the same bus. This obsoletes the
+;; Open a new connection to the same bus. This supersedes the
;; previous one.
(dbus-init-bus my-bus 'private)
@@ -1859,14 +1857,14 @@ Example: You initialize a connection to the AT-SPI bus
on your host:
@result{} ":1.20"
@end lisp
-D-Bus addresses can specify different transport. A possible address
-could be based on TCP/IP sockets, see next example. However, it
-depends on the bus daemon configuration, which transport is supported.
+D-Bus addresses can specify a different transport. A possible address
+could be based on TCP/IP sockets, see next example. Which transport
+is supported depends on the bus daemon configuration, however.
@end defun
@defun dbus-setenv bus variable value
-Set the value of the @var{bus} environment variable @var{variable} to
-@var{value}.
+This function sets the value of the @var{bus} environment
+@var{variable} to @var{value}.
@var{bus} is either a Lisp symbol, @code{:system} or @code{:session},
or a string denoting the bus address. Both @var{variable} and
@@ -1877,7 +1875,7 @@ function adds to or modifies that environment when
activating services.
Some bus instances, such as @code{:system}, may disable setting the
environment. In such cases, or if this feature is not available in
-older D-Bus versions, a @code{dbus-error} error is raised.
+older D-Bus versions, this function signals a @code{dbus-error}.
As an example, it might be desirable to start X11 enabled services on
a remote host's bus on the same X11 server the local Emacs is
@@ -1916,7 +1914,7 @@ Input parameters of @code{dbus-call-method},
@code{dbus-register-method}, @code{dbus-register-property} and
@code{dbus-register-signal} are checked for correct D-Bus types. If
there is a type mismatch, the Lisp error @code{wrong-type-argument}
-@code{D-Bus ARG} is raised.
+@code{D-Bus @var{arg}} is raised.
All errors raised by D-Bus are signaled with the error symbol
@code{dbus-error}. If possible, error messages from D-Bus are
@@ -1967,35 +1965,39 @@ There exist convenience functions which could be called
inside a
callback function in order to retrieve the information from the event.
@defun dbus-event-bus-name event
-Returns the bus name @var{event} is coming from.
-The result is either the symbol @code{:system} or the symbol @code{:session}.
+This function returns the bus name @var{event} is coming from. The
+result is either the symbol @code{:system} or the symbol
+@code{:session}.
@end defun
@defun dbus-event-message-type event
-Returns the message type of the corresponding D-Bus message. The
-result is a natural number.
+This function returns the message type of the corresponding D-Bus
+message. The result is a natural number.
@end defun
@defun dbus-event-serial-number event
-Returns the serial number of the corresponding D-Bus message.
-The result is a natural number.
+This function returns the serial number of the corresponding D-Bus
+message. The result is a natural number.
@end defun
@defun dbus-event-service-name event
-Returns the unique name of the D-Bus object @var{event} is coming from.
+This function returns the unique name of the D-Bus object @var{event}
+is coming from.
@end defun
@defun dbus-event-path-name event
-Returns the object path of the D-Bus object @var{event} is coming from.
+This function returns the object path of the D-Bus object @var{event}
+is coming from.
@end defun
@defun dbus-event-interface-name event
-Returns the interface name of the D-Bus object @var{event} is coming from.
+This function returns the interface name of the D-Bus object
+@var{event} is coming from.
@end defun
@defun dbus-event-member-name event
-Returns the member name of the D-Bus object @var{event} is coming
-from. It is either a signal name or a method name.
+This function returns the member name of the D-Bus object @var{event}
+is coming from. It is either a signal name or a method name.
@end defun
D-Bus errors are not propagated during event handling, because it is
@@ -2009,7 +2011,7 @@ D-Bus error happens in the event handler. Every function
must accept
two arguments, the event and the error variable caught in
@code{condition-case} by @code{dbus-error}.
-Such functions can be used the adapt the error signal to be raised.
+Such functions can be used to adapt the error signal to be raised.
Example:
@lisp
@@ -2019,12 +2021,12 @@ Example:
(message "my-dbus-event-error-handler: %S %S" event error)
(signal 'file-error (cdr error))))
-(add-hook 'dbus-event-error-functions 'my-dbus-event-error-handler)
+(add-hook 'dbus-event-error-functions #'my-dbus-event-error-handler)
@end lisp
@end defvar
-Hook functions shall take into account, that there might be other
-D-Bus applications running. Therefore, they shall check carefully,
+Hook functions should take into account that there might be other
+D-Bus applications running. They should therefore check carefully,
whether a given D-Bus error is related to them.
diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi
index 83dd176..bbfc86b 100644
--- a/doc/misc/efaq-w32.texi
+++ b/doc/misc/efaq-w32.texi
@@ -143,7 +143,7 @@ executable, using the MinGW GCC compiler and development
tools.
@cindex DOS port
@cindex Windows 3.11 port
-Emacs can also be compiled for MSDOS. When run on recent MS Windows,
+Emacs can also be compiled for MSDOS@. When run on recent MS Windows,
it supports long file names, and uses the Windows clipboard.
See the @file{msdos} directory in the Emacs sources for building
instructions (requires DJGPP).
@@ -222,7 +222,7 @@ specific notes about debugging Emacs.
@cindex debugging Emacs with GDB
GDB is the GNU debugger, which can be used to debug Emacs when it has
-been compiled with MinGW GCC. The best results will be obtained if
+been compiled with MinGW GCC@. The best results will be obtained if
you start gdb from the @file{src} directory as @kbd{gdb ./emacs.exe}.
This will load the init file @file{.gdbinit}@footnote{
Latest versions of GDB might refuse to load the init file for security
@@ -592,7 +592,7 @@ Subject: Re: Re[2]: problem with caps/ctrl swap on NT 4.0
@end ignore
@smallexample
It's a binary value that lets you map keystrokes in the low-level keyboard
-drivers in NT. As a result you don't have to worry about applications
+drivers in NT@. As a result you don't have to worry about applications
bypassing mappings that you've done at a higher level (i.e., it just works).
Here's the format of the value:
@@ -1187,7 +1187,7 @@ A lot of effort has gone into making it easier to print
from Emacs on
MS Windows, but this has still been insufficient to keep up with
changes in printing technology from text and postscript based printers
connected via ports that can be accessed directly, to graphical
-printers that are only accessible via USB. For details, see
+printers that are only accessible via USB@. For details, see
@uref{http://www.emacswiki.org/emacs/PrintingFromEmacs, Emacs
Wiki}, @uref{http://www.emacswiki.org/emacs/PrintWithWebBrowser}, and
@uref{http://www.emacswiki.org/emacs/PrintFromWindowsExplorer}.
@@ -1398,7 +1398,7 @@ default shell in Emacs, you can place the following in
your init file:
@end example
WARNING: Some versions of bash set and use the environment variable
-PID. For some as yet unknown reason, if @env{PID} is set and Emacs
+PID@. For some as yet unknown reason, if @env{PID} is set and Emacs
passes it on to bash subshells, bash dies (Emacs can inherit the
@env{PID} variable if it's started from a bash shell). If you clear
the @env{PID} variable in your init file, you should be able to
@@ -1890,9 +1890,9 @@ need to use.
@node MSVC
@section How do I use Emacs with Microsoft Visual C++
-There are two ways you can use Emacs in conjunction with MSVC. You
+There are two ways you can use Emacs in conjunction with MSVC@. You
can use Emacs as the editor, and do everything else in the DevStudio
-IDE. Or you can use Emacs as an IDE, calling the MSVC command line
+IDE@. Or you can use Emacs as an IDE, calling the MSVC command line
tools to build your project.
@menu
diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi
index be1ffc0..0290e79 100644
--- a/doc/misc/efaq.texi
+++ b/doc/misc/efaq.texi
@@ -1125,7 +1125,7 @@ scanning of @code{#define}d symbols.
@cindex xref
@item
-New package Xref replaces Etags's front-end and UI. Xref provides a
+New package Xref replaces Etags's front-end and UI@. Xref provides a
generic framework and new commands to find and move to definitions of
functions, macros, data structures etc., as well as go back to the
location where you were before moving to a definition. It supersedes
diff --git a/doc/misc/emacs-gnutls.texi b/doc/misc/emacs-gnutls.texi
index c3e6917..bb13ebd 100644
--- a/doc/misc/emacs-gnutls.texi
+++ b/doc/misc/emacs-gnutls.texi
@@ -134,7 +134,7 @@ order: @file{/etc/ssl/certs/ca-certificates.crt} for
Debian, Ubuntu,
Gentoo and Arch Linux; @file{/etc/pki/tls/certs/ca-bundle.crt} for
Fedora and RHEL; @file{/etc/ssl/ca-bundle.pem} for Suse;
@file{/usr/ssl/certs/ca-bundle.crt} for Cygwin;
-@file{/usr/local/share/certs/ca-root-nss.crt} for FreeBSD. You can
+@file{/usr/local/share/certs/ca-root-nss.crt} for FreeBSD@. You can
easily customize @code{gnutls-trustfiles} to be something else, but
let us know if you do, so we can make the change to benefit the other
users of that platform.
diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi
index fd28539..9c1d2d0 100644
--- a/doc/misc/gnus-faq.texi
+++ b/doc/misc/gnus-faq.texi
@@ -689,8 +689,9 @@ retrieves via POP3?
@subsubheading Answer
Yes, if the POP3 server supports the UIDL control (maybe almost servers
-do it nowadays). To do that, add a @code{:leave VALUE} pair to each
-POP3 mail source. @xref{Mail Source Specifiers}, for details on VALUE.
+do it nowadays). To do that, add a @code{:leave @var{value}} pair to
+each POP3 mail source. @xref{Mail Source Specifiers}, for details on
+@var{value}.
@node FAQ 4 - Reading messages
@subsection Reading messages
diff --git a/doc/misc/message.texi b/doc/misc/message.texi
index f9527ee..bdd31b1 100644
--- a/doc/misc/message.texi
+++ b/doc/misc/message.texi
@@ -1116,7 +1116,7 @@ is used.
The choice between EasyPG and OpenSSL is controlled by the variable
@code{mml-smime-use}, which needs to be set to the value @code{epg}
-for EasyPG. Depending on your version of Emacs that value may be the
+for EasyPG@. Depending on your version of Emacs that value may be the
default; if not, you can either customize that variable or place the
following line in your @file{.emacs} file (that line needs to be
placed above other code related to message/gnus/encryption):
@@ -1232,7 +1232,7 @@ decryption/sign operation. @xref{Agent Options, , ,
gnupg, Using the
GNU Privacy Guard}.
How to use @command{gpg-agent} in Emacs depends on your version of
-GnuPG. With GnuPG version 2.1, @command{gpg-agent} is started
+GnuPG@. With GnuPG version 2.1, @command{gpg-agent} is started
automatically if necessary. With older versions you may need to run
the following command from the shell before starting Emacs.
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index eb0bf74..feead3d 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -2046,6 +2046,12 @@ reestablished. A value of @code{nil} disables this
feature. Most of
the methods do not set this property except the @option{sudo} and
@option{doas} methods, which use predefined values.
+@item @t{"tmpdir"}
+
+The temporary directory on the remote host. If not specified, the
+default value is @t{"/data/local/tmp"} for the @option{adb} method,
+@t{"/C$/Temp"} for the @option{smb} method, and @t{"/tmp"} otherwise.
+
@item @t{"posix"}
Connections using the @option{smb} method check, whether the remote
diff --git a/etc/NEWS.27 b/etc/NEWS.27
index 58bd491..10a6e39 100644
--- a/etc/NEWS.27
+++ b/etc/NEWS.27
@@ -956,8 +956,8 @@ displays the buffer from the next command in that window.
For example,
'S-M-right C-h i' displays the "*Info*" buffer in the right window,
creating the window if necessary. A special key can be customized to
display the buffer in the same window, for example, 'S-M-0 C-h e'
-displays the "*Messages*" buffer in the same window. 'S-M-t C-h C-n'
-displays NEWS in a new tab.
+displays the "*Messages*" buffer in the same window. 'S-M-t C-h r'
+displays the Emacs manual in a new tab.
+++
*** Windmove also supports directional window deletion.
diff --git a/lisp/emulation/cua-rect.el b/lisp/emulation/cua-rect.el
index e99bb33..663995a 100644
--- a/lisp/emulation/cua-rect.el
+++ b/lisp/emulation/cua-rect.el
@@ -1412,7 +1412,7 @@ With prefix arg, indent to that column."
(add-function :around region-extract-function
#'cua--rectangle-region-extract)
(add-function :around region-insert-function
- #'cua--insert-rectangle)
+ #'cua--rectangle-region-insert)
(add-function :around redisplay-highlight-region-function
#'cua--rectangle-highlight-for-redisplay)
@@ -1422,6 +1422,10 @@ With prefix arg, indent to that column."
;; already do it elsewhere.
(funcall redisplay-unhighlight-region-function (nth 3 args))))
+(defun cua--rectangle-region-insert (orig &rest args)
+ (if (not cua--rectangle) (apply orig args)
+ (funcall #'cua--insert-rectangle (car args))))
+
(defun cua--rectangle-region-extract (orig &optional delete)
(cond
((not cua--rectangle)
diff --git a/lisp/faces.el b/lisp/faces.el
index 8c3e464..f6b9593 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -2758,6 +2758,33 @@ Note: Other faces cannot inherit from the cursor face."
:version "21.1"
:group 'basic-faces)
+(defface tab-bar
+ '((((class color) (min-colors 88))
+ :inherit variable-pitch
+ :background "grey85"
+ :foreground "black")
+ (((class mono))
+ :background "grey")
+ (t
+ :inverse-video t))
+ "Tab bar face."
+ :version "27.1"
+ :group 'basic-faces)
+
+(defface tab-line
+ '((((class color) (min-colors 88))
+ :inherit variable-pitch
+ :height 0.9
+ :background "grey85"
+ :foreground "black")
+ (((class mono))
+ :background "grey")
+ (t
+ :inverse-video t))
+ "Tab line face."
+ :version "27.1"
+ :group 'basic-faces)
+
(defface menu
'((((type tty))
:inverse-video t)
diff --git a/lisp/icomplete.el b/lisp/icomplete.el
index 60ef024..3747ae3 100644
--- a/lisp/icomplete.el
+++ b/lisp/icomplete.el
@@ -300,7 +300,10 @@ if that doesn't produce a completion match."
(interactive)
(if (and (eq (char-before) ?/)
(eq (icomplete--category) 'file))
- (zap-up-to-char -1 ?/)
+ (save-excursion
+ (goto-char (1- (point)))
+ (when (search-backward "/" (point-min) t)
+ (delete-region (1+ (point)) (point-max))))
(call-interactively 'backward-delete-char)))
(defvar icomplete-fido-mode-map
diff --git a/lisp/image-mode.el b/lisp/image-mode.el
index 480b2e6..1bb213c 100644
--- a/lisp/image-mode.el
+++ b/lisp/image-mode.el
@@ -456,6 +456,7 @@ call."
(define-key map "sb" 'image-transform-fit-both)
(define-key map "ss" 'image-transform-set-scale)
(define-key map "sr" 'image-transform-set-rotation)
+ (define-key map "so" 'image-transform-original)
(define-key map "s0" 'image-transform-reset)
;; Multi-frame keys
@@ -521,8 +522,10 @@ call."
:help "Rotate the image"]
["Set Rotation..." image-transform-set-rotation
:help "Set rotation angle of the image"]
- ["Reset Transformations" image-transform-reset
- :help "Reset all image transformations"]
+ ["Original Size" image-transform-original
+ :help "Reset image to actual size"]
+ ["Reset to Default Size" image-transform-reset
+ :help "Reset all image transformations to initial size"]
"--"
["Show Thumbnails"
(lambda ()
@@ -807,8 +810,12 @@ was inserted."
filename))
;; If we have a `fit-width' or a `fit-height', don't limit
;; the size of the image to the window size.
- (edges (and (eq image-transform-resize t)
- (window-inside-pixel-edges (get-buffer-window))))
+ (edges (when (eq image-transform-resize t)
+ (window-inside-pixel-edges (get-buffer-window))))
+ (max-width (when edges
+ (- (nth 2 edges) (nth 0 edges))))
+ (max-height (when edges
+ (- (nth 3 edges) (nth 1 edges))))
(type (if (image--imagemagick-wanted-p filename)
'imagemagick
(image-type file-or-data nil data-p)))
@@ -824,14 +831,18 @@ was inserted."
(ignore-error exif-error
(exif-parse-buffer)))
0.0)))
+ ;; Swap width and height when changing orientation
+ ;; between portrait and landscape.
+ (when (and edges (zerop (mod (+ image-transform-rotation 90) 180)))
+ (setq max-width (prog1 max-height (setq max-height max-width))))
;; :scale 1: If we do not set this, create-image will apply
;; default scaling based on font size.
(setq image (if (not edges)
(create-image file-or-data type data-p :scale 1)
(create-image file-or-data type data-p :scale 1
- :max-width (- (nth 2 edges) (nth 0 edges))
- :max-height (- (nth 3 edges) (nth 1 edges)))))
+ :max-width max-width
+ :max-height max-height)))
;; Discard any stale image data before looking it up again.
(image-flush image)
@@ -1382,8 +1393,15 @@ ROTATION should be in degrees."
(setq image-transform-rotation (float (mod rotation 360)))
(image-toggle-display-image))
+(defun image-transform-original ()
+ "Display the current image with the original (actual) size and rotation."
+ (interactive)
+ (setq image-transform-resize nil
+ image-transform-scale 1)
+ (image-toggle-display-image))
+
(defun image-transform-reset ()
- "Display the current image with the default size and rotation."
+ "Display the current image with the default (initial) size and rotation."
(interactive)
(setq image-transform-resize image-auto-resize
image-transform-rotation 0.0
diff --git a/lisp/net/dbus.el b/lisp/net/dbus.el
index 4538399..06bd9e5 100644
--- a/lisp/net/dbus.el
+++ b/lisp/net/dbus.el
@@ -182,7 +182,7 @@ caught in `condition-case' by `dbus-error'.")
;;; Basic D-Bus message functions.
(defvar dbus-return-values-table (make-hash-table :test 'equal)
- "Hash table for temporary storing arguments of reply messages.
+ "Hash table for temporarily storing arguments of reply messages.
A key in this hash table is a list (:serial BUS SERIAL), like in
`dbus-registered-objects-table'. BUS is either a Lisp symbol,
`:system' or `:session', or a string denoting the bus address.
@@ -225,10 +225,10 @@ SERVICE is the D-Bus service name to be used. PATH is
the D-Bus
object path SERVICE is registered at. INTERFACE is an interface
offered by SERVICE. It must provide METHOD.
-If the parameter `:timeout' is given, the following integer TIMEOUT
-specifies the maximum number of milliseconds the method call must
-return. The default value is 25,000. If the method call doesn't
-return in time, a D-Bus error is raised.
+If the parameter `:timeout' is given, the following integer
+TIMEOUT specifies the maximum number of milliseconds before the
+method call must return. The default value is 25,000. If the
+method call doesn't return in time, a D-Bus error is raised.
All other arguments ARGS are passed to METHOD as arguments. They are
converted into D-Bus types via the following rules:
@@ -248,14 +248,14 @@ Lisp objects. The type conversion happens the other
direction as for
input arguments. It follows the mapping rules:
DBUS_TYPE_BOOLEAN => t or nil
- DBUS_TYPE_BYTE => number
- DBUS_TYPE_UINT16 => number
+ DBUS_TYPE_BYTE => natural number
+ DBUS_TYPE_UINT16 => natural number
DBUS_TYPE_INT16 => integer
- DBUS_TYPE_UINT32 => number or float
- DBUS_TYPE_UNIX_FD => number or float
- DBUS_TYPE_INT32 => integer or float
- DBUS_TYPE_UINT64 => number or float
- DBUS_TYPE_INT64 => integer or float
+ DBUS_TYPE_UINT32 => natural number
+ DBUS_TYPE_UNIX_FD => natural number
+ DBUS_TYPE_INT32 => integer
+ DBUS_TYPE_UINT64 => natural number
+ DBUS_TYPE_INT64 => integer
DBUS_TYPE_DOUBLE => float
DBUS_TYPE_STRING => string
DBUS_TYPE_OBJECT_PATH => string
@@ -268,9 +268,9 @@ input arguments. It follows the mapping rules:
Example:
\(dbus-call-method
- :session \"org.gnome.seahorse\" \"/org/gnome/seahorse/keys/openpgp\"
- \"org.gnome.seahorse.Keys\" \"GetKeyField\"
- \"openpgp:657984B8C7A966DD\" \"simple-name\")
+ :session \"org.gnome.seahorse\" \"/org/gnome/seahorse/keys/openpgp\"
+ \"org.gnome.seahorse.Keys\" \"GetKeyField\"
+ \"openpgp:657984B8C7A966DD\" \"simple-name\")
=> (t (\"Philip R. Zimmermann\"))
@@ -278,9 +278,9 @@ If the result of the METHOD call is just one value, the
converted Lisp
object is returned instead of a list containing this single Lisp object.
\(dbus-call-method
- :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/devices/computer\"
- \"org.freedesktop.Hal.Device\" \"GetPropertyString\"
- \"system.kernel.machine\")
+ :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/devices/computer\"
+ \"org.freedesktop.Hal.Device\" \"GetPropertyString\"
+ \"system.kernel.machine\")
=> \"i686\""
@@ -357,10 +357,10 @@ HANDLER is a Lisp function, which is called when the
corresponding
return message has arrived. If HANDLER is nil, no return message
will be expected.
-If the parameter `:timeout' is given, the following integer TIMEOUT
-specifies the maximum number of milliseconds the method call must
-return. The default value is 25,000. If the method call doesn't
-return in time, a D-Bus error is raised.
+If the parameter `:timeout' is given, the following integer
+TIMEOUT specifies the maximum number of milliseconds before the
+method call must return. The default value is 25,000. If the
+method call doesn't return in time, a D-Bus error is raised.
All other arguments ARGS are passed to METHOD as arguments. They are
converted into D-Bus types via the following rules:
@@ -377,19 +377,19 @@ type symbols, see Info node `(dbus)Type Conversion'.
If HANDLER is a Lisp function, the function returns a key into the
hash table `dbus-registered-objects-table'. The corresponding entry
-in the hash table is removed, when the return message has been arrived,
+in the hash table is removed, when the return message arrives,
and HANDLER is called.
Example:
\(dbus-call-method-asynchronously
- :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/devices/computer\"
- \"org.freedesktop.Hal.Device\" \"GetPropertyString\" \\='message
- \"system.kernel.machine\")
+ :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/devices/computer\"
+ \"org.freedesktop.Hal.Device\" \"GetPropertyString\" \\='message
+ \"system.kernel.machine\")
- => (:serial :system 2)
+ -| i686
- -| i686"
+ => (:serial :system 2)"
(or (featurep 'dbusbind)
(signal 'dbus-error (list "Emacs not compiled with dbus support")))
@@ -438,8 +438,8 @@ type symbols, see Info node `(dbus)Type Conversion'.
Example:
\(dbus-send-signal
- :session nil \"/org/gnu/Emacs\" \"org.gnu.Emacs.FileManager\"
- \"FileModified\" \"/home/albinus/.emacs\")"
+ :session nil \"/org/gnu/Emacs\" \"org.gnu.Emacs.FileManager\"
+ \"FileModified\" \"/home/albinus/.emacs\")"
(or (featurep 'dbusbind)
(signal 'dbus-error (list "Emacs not compiled with dbus support")))
@@ -625,17 +625,17 @@ SERVICE is the D-Bus service name used by the sending
D-Bus object.
It can be either a known name or the unique name of the D-Bus object
sending the signal.
-PATH is the D-Bus object path SERVICE is registered. INTERFACE
-is an interface offered by SERVICE. It must provide SIGNAL.
-HANDLER is a Lisp function to be called when the signal is
-received. It must accept as arguments the values SIGNAL is
+PATH is the D-Bus object path SERVICE is registered at.
+INTERFACE is an interface offered by SERVICE. It must provide
+SIGNAL. HANDLER is a Lisp function to be called when the signal
+is received. It must accept as arguments the values SIGNAL is
sending.
SERVICE, PATH, INTERFACE and SIGNAL can be nil. This is
interpreted as a wildcard for the respective argument.
The remaining arguments ARGS can be keywords or keyword string pairs.
-The meaning is as follows:
+Their meaning is as follows:
`:argN' STRING:
`:pathN' STRING: This stands for the Nth argument of the
@@ -643,8 +643,9 @@ signal. `:pathN' arguments can be used for object path
wildcard
matches as specified by D-Bus, while an `:argN' argument
requires an exact match.
-`:arg-namespace' STRING: Register for the signals, which first
-argument defines the service or interface namespace STRING.
+`:arg-namespace' STRING: Register for those signals, whose first
+argument names a service or interface within the namespace
+STRING.
`:path-namespace' STRING: Register for the object path namespace
STRING. All signals sent from an object path, which has STRING as
@@ -660,8 +661,8 @@ Example:
(message \"Device %s added\" device))
\(dbus-register-signal
- :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/Manager\"
- \"org.freedesktop.Hal.Manager\" \"DeviceAdded\" \\='my-signal-handler)
+ :system \"org.freedesktop.Hal\" \"/org/freedesktop/Hal/Manager\"
+ \"org.freedesktop.Hal.Manager\" \"DeviceAdded\" \\='my-signal-handler)
=> ((:signal :system \"org.freedesktop.Hal.Manager\" \"DeviceAdded\")
(\"org.freedesktop.Hal\" \"/org/freedesktop/Hal/Manager\"
my-signal-handler))
@@ -773,24 +774,24 @@ Example:
(defun dbus-register-method
(bus service path interface method handler &optional dont-register-service)
- "Register for method METHOD on the D-Bus BUS.
+ "Register METHOD on the D-Bus BUS.
BUS is either a Lisp symbol, `:system' or `:session', or a string
denoting the bus address.
SERVICE is the D-Bus service name of the D-Bus object METHOD is
-registered for. It must be a known name (See discussion of
+registered for. It must be a known name (see discussion of
DONT-REGISTER-SERVICE below).
-PATH is the D-Bus object path SERVICE is registered (See discussion of
-DONT-REGISTER-SERVICE below). INTERFACE is the interface offered by
-SERVICE. It must provide METHOD.
+PATH is the D-Bus object path SERVICE is registered at (see
+discussion of DONT-REGISTER-SERVICE below). INTERFACE is the
+interface offered by SERVICE. It must provide METHOD.
HANDLER is a Lisp function to be called when a method call is
received. It must accept the input arguments of METHOD. The return
value of HANDLER is used for composing the returning D-Bus message.
-In case HANDLER shall return a reply message with an empty argument
-list, HANDLER must return the symbol `:ignore'.
+If HANDLER returns a reply message with an empty argument list,
+HANDLER must return the symbol `:ignore'.
When DONT-REGISTER-SERVICE is non-nil, the known name SERVICE is not
registered. This means that other D-Bus clients have no way of
@@ -888,8 +889,8 @@ association to the service from D-Bus."
;;; D-Bus type conversion.
(defun dbus-string-to-byte-array (string)
- "Transform STRING to list (:array :byte c1 :byte c2 ...).
-STRING shall be UTF8 coded."
+ "Transform STRING to list (:array :byte C1 :byte C2 ...).
+STRING shall be UTF-8 coded."
(if (zerop (length string))
'(:array :signature "y")
(let (result)
@@ -897,7 +898,7 @@ STRING shall be UTF8 coded."
(setq result (append result (list :byte elt)))))))
(defun dbus-byte-array-to-string (byte-array &optional multibyte)
- "Transform BYTE-ARRAY into UTF8 coded string.
+ "Transform BYTE-ARRAY into UTF-8 coded string.
BYTE-ARRAY must be a list of structure (c1 c2 ...), or a byte
array as produced by `dbus-string-to-byte-array'. The resulting
string is unibyte encoded, unless MULTIBYTE is non-nil."
@@ -920,9 +921,9 @@ lower-case hex digits:
\"0123abc_xyz\\x01\\xff\" -> \"_30123abc_5fxyz_01_ff\"
-i.e. similar to URI encoding, but with \"_\" taking the role of \"%\",
-and a smaller allowed set. As a special case, \"\" is escaped to
-\"_\".
+i.e. similar to URI encoding, but with \"_\" taking the role of
+\"%\", and a smaller allowed set. As a special case, \"\" is
+escaped to \"_\".
Returns the escaped string. Algorithm taken from
telepathy-glib's `tp_escape_as_identifier'."
@@ -963,8 +964,8 @@ the function which has been registered for this message.
ARGS
are the arguments passed to HANDLER, when it is called during
event handling in `dbus-handle-event'.
-This function raises a `dbus-error' signal in case the event is
-not well formed."
+This function signals a `dbus-error' if the event is not well
+formed."
(when dbus-debug (message "DBus-Event %s" event))
(unless (and (listp event)
(eq (car event) 'dbus-event)
@@ -1038,16 +1039,16 @@ If the HANDLER returns a `dbus-error', it is propagated
as return message."
"Return the bus name the event is coming from.
The result is either a Lisp symbol, `:system' or `:session', or a
string denoting the bus address. EVENT is a D-Bus event, see
-`dbus-check-event'. This function raises a `dbus-error' signal
-in case the event is not well formed."
+`dbus-check-event'. This function signals a `dbus-error' if the
+event is not well formed."
(dbus-check-event event)
(nth 1 event))
(defun dbus-event-message-type (event)
"Return the message type of the corresponding D-Bus message.
The result is a number. EVENT is a D-Bus event, see
-`dbus-check-event'. This function raises a `dbus-error' signal
-in case the event is not well formed."
+`dbus-check-event'. This function signals a `dbus-error' if the
+event is not well formed."
(dbus-check-event event)
(nth 2 event))
@@ -1055,41 +1056,40 @@ in case the event is not well formed."
"Return the serial number of the corresponding D-Bus message.
The result is a number. The serial number is needed for
generating a reply message. EVENT is a D-Bus event, see
-`dbus-check-event'. This function raises a `dbus-error' signal
-in case the event is not well formed."
+`dbus-check-event'. This function signals a `dbus-error' if the
+event is not well formed."
(dbus-check-event event)
(nth 3 event))
(defun dbus-event-service-name (event)
"Return the name of the D-Bus object the event is coming from.
The result is a string. EVENT is a D-Bus event, see `dbus-check-event'.
-This function raises a `dbus-error' signal in case the event is
-not well formed."
+This function signals a `dbus-error' if the event is not well
+formed."
(dbus-check-event event)
(nth 4 event))
(defun dbus-event-path-name (event)
"Return the object path of the D-Bus object the event is coming from.
The result is a string. EVENT is a D-Bus event, see `dbus-check-event'.
-This function raises a `dbus-error' signal in case the event is
-not well formed."
+This function signals a `dbus-error' if the event is not well
+formed."
(dbus-check-event event)
(nth 5 event))
(defun dbus-event-interface-name (event)
"Return the interface name of the D-Bus object the event is coming from.
The result is a string. EVENT is a D-Bus event, see `dbus-check-event'.
-This function raises a `dbus-error' signal in case the event is
-not well formed."
+This function signals a `dbus-error' if the event is not well
+formed."
(dbus-check-event event)
(nth 6 event))
(defun dbus-event-member-name (event)
"Return the member name the event is coming from.
-It is either a signal name or a method name. The result is a
+It is either a signal name or a method name. The result is a
string. EVENT is a D-Bus event, see `dbus-check-event'. This
-function raises a `dbus-error' signal in case the event is not
-well formed."
+function signals a `dbus-error' if the event is not well formed."
(dbus-check-event event)
(nth 7 event))
@@ -1097,10 +1097,10 @@ well formed."
;;; D-Bus registered names.
(defun dbus-list-activatable-names (&optional bus)
- "Return the D-Bus service names which can be activated as list.
-If BUS is left nil, `:system' is assumed. The result is a list
-of strings, which is nil when there are no activatable service
-names at all."
+ "Return a list of the D-Bus service names which can be activated.
+BUS defaults to `:system' when nil or omitted. The result is a
+list of strings, which is nil when there are no activatable
+service names at all."
(dbus-ignore-errors
(dbus-call-method
(or bus :system) dbus-service-dbus
@@ -1126,8 +1126,8 @@ A service has a known name if it doesn't start with
\":\"."
(defun dbus-list-queued-owners (bus service)
"Return the unique names registered at D-Bus BUS and queued for SERVICE.
-The result is a list of strings, or nil when there are no
-queued name owners service names at all."
+The result is a list of strings, or nil when there are no queued
+name owner service names at all."
(dbus-ignore-errors
(dbus-call-method
bus dbus-service-dbus dbus-path-dbus
@@ -1144,13 +1144,13 @@ The result is either a string, or nil if there is no
name owner."
(defun dbus-ping (bus service &optional timeout)
"Check whether SERVICE is registered for D-Bus BUS.
TIMEOUT, a nonnegative integer, specifies the maximum number of
-milliseconds `dbus-ping' must return. The default value is 25,000.
+milliseconds before `dbus-ping' must return. The default value
+is 25,000.
-Note, that this autoloads SERVICE if it is not running yet. If
-it shall be checked whether SERVICE is already running, one shall
-apply
+Note, that this autoloads SERVICE if it is not running yet. To
+check whether SERVICE is already running, you can instead write
- (member service \(dbus-list-known-names bus))"
+ (member service (dbus-list-known-names bus))"
;; "Ping" raises a D-Bus error if SERVICE does not exist.
;; Otherwise, it returns silently with nil.
(condition-case nil
@@ -1239,11 +1239,11 @@ It returns a list of strings, which are further object
paths of SERVICE."
"Return all interface names of SERVICE in D-Bus BUS at object path PATH.
It returns a list of strings.
-There will be always the default interface
-\"org.freedesktop.DBus.Introspectable\". Another default
-interface is \"org.freedesktop.DBus.Properties\". If present,
-\"interface\" objects can also have \"property\" objects as
-children, beside \"method\" and \"signal\" objects."
+The default interface \"org.freedesktop.DBus.Introspectable\" is
+always present. Another default interface is
+\"org.freedesktop.DBus.Properties\". If present, \"interface\"
+objects can also have \"property\" objects as children, beside
+\"method\" and \"signal\" objects."
(let ((object (dbus-introspect-xml bus service path))
result)
(dolist (elt (xml-get-children object 'interface) (nreverse result))
@@ -1251,9 +1251,10 @@ children, beside \"method\" and \"signal\" objects."
(defun dbus-introspect-get-interface (bus service path interface)
"Return the INTERFACE of SERVICE in D-Bus BUS at object path PATH.
-The return value is an XML object. INTERFACE must be a string,
-element of the list returned by `dbus-introspect-get-interface-names'.
-The resulting \"interface\" object can contain \"method\", \"signal\",
+The return value is an XML object. INTERFACE must be a string
+and a member of the list returned by
+`dbus-introspect-get-interface-names'. The resulting
+\"interface\" object can contain \"method\", \"signal\",
\"property\" and \"annotation\" children."
(let ((elt (xml-get-children
(dbus-introspect-xml bus service path) 'interface)))
@@ -1273,9 +1274,9 @@ SERVICE is a service of D-Bus BUS at object path PATH."
(push (dbus-introspect-get-attribute elt "name") result))))
(defun dbus-introspect-get-method (bus service path interface method)
- "Return method METHOD of interface INTERFACE as XML object.
+ "Return method METHOD of interface INTERFACE as an XML object.
It must be located at SERVICE in D-Bus BUS at object path PATH.
-METHOD must be a string, element of the list returned by
+METHOD must be a string and a member of the list returned by
`dbus-introspect-get-method-names'. The resulting \"method\"
object can contain \"arg\" and \"annotation\" children."
(let ((elt (xml-get-children
@@ -1296,7 +1297,7 @@ SERVICE is a service of D-Bus BUS at object path PATH."
(push (dbus-introspect-get-attribute elt "name") result))))
(defun dbus-introspect-get-signal (bus service path interface signal)
- "Return signal SIGNAL of interface INTERFACE as XML object.
+ "Return signal SIGNAL of interface INTERFACE as an XML object.
It must be located at SERVICE in D-Bus BUS at object path PATH.
SIGNAL must be a string, element of the list returned by
`dbus-introspect-get-signal-names'. The resulting \"signal\"
@@ -1319,9 +1320,9 @@ SERVICE is a service of D-Bus BUS at object path PATH."
(push (dbus-introspect-get-attribute elt "name") result))))
(defun dbus-introspect-get-property (bus service path interface property)
- "Return PROPERTY of INTERFACE as XML object.
+ "Return PROPERTY of INTERFACE as an XML object.
It must be located at SERVICE in D-Bus BUS at object path PATH.
-PROPERTY must be a string, element of the list returned by
+PROPERTY must be a string and a member of the list returned by
`dbus-introspect-get-property-names'. The resulting PROPERTY
object can contain \"annotation\" children."
(let ((elt (xml-get-children
@@ -1336,7 +1337,7 @@ object can contain \"annotation\" children."
(defun dbus-introspect-get-annotation-names
(bus service path interface &optional name)
- "Return all annotation names as list of strings.
+ "Return all annotation names as a list of strings.
If NAME is nil, the annotations are children of INTERFACE,
otherwise NAME must be a \"method\", \"signal\", or \"property\"
object, where the annotations belong to."
@@ -1352,7 +1353,7 @@ object, where the annotations belong to."
(defun dbus-introspect-get-annotation
(bus service path interface name annotation)
- "Return ANNOTATION as XML object.
+ "Return ANNOTATION as an XML object.
If NAME is nil, ANNOTATION is a child of INTERFACE, otherwise
NAME must be the name of a \"method\", \"signal\", or
\"property\" object, where the ANNOTATION belongs to."
@@ -1374,7 +1375,7 @@ NAME must be the name of a \"method\", \"signal\", or
(car elt)))
(defun dbus-introspect-get-argument-names (bus service path interface name)
- "Return a list of all argument names as list of strings.
+ "Return a list of all argument names as a list of strings.
NAME must be a \"method\" or \"signal\" object.
Argument names are optional, the function can return nil
@@ -1388,8 +1389,9 @@ therefore, even if the method or signal has arguments."
(defun dbus-introspect-get-argument (bus service path interface name arg)
"Return argument ARG as XML object.
-NAME must be a \"method\" or \"signal\" object. ARG must be a string,
-element of the list returned by `dbus-introspect-get-argument-names'."
+NAME must be a \"method\" or \"signal\" object. ARG must be a
+string and a member of the list returned by
+`dbus-introspect-get-argument-names'."
(let ((elt (xml-get-children
(or (dbus-introspect-get-method bus service path interface name)
(dbus-introspect-get-signal bus service path interface name))
@@ -1402,7 +1404,7 @@ element of the list returned by
`dbus-introspect-get-argument-names'."
(defun dbus-introspect-get-signature
(bus service path interface name &optional direction)
- "Return signature of a `method' or `signal', represented by NAME, as string.
+ "Return signature of a `method' or `signal' represented by NAME as a string.
If NAME is a `method', DIRECTION can be either \"in\" or \"out\".
If DIRECTION is nil, \"in\" is assumed.
@@ -1450,9 +1452,8 @@ valid D-Bus value, or nil if there is no PROPERTY."
(defun dbus-set-property (bus service path interface property value)
"Set value of PROPERTY of INTERFACE to VALUE.
-It will be checked at BUS, SERVICE, PATH. When the value has
-been set successful, the result is VALUE. Otherwise, nil is
-returned."
+It will be checked at BUS, SERVICE, PATH. When the value is
+successfully set return VALUE. Otherwise, return nil."
(dbus-ignore-errors
;; "Set" requires a variant.
(dbus-call-method
@@ -1479,15 +1480,15 @@ nil is returned."
(defun dbus-register-property
(bus service path interface property access value
&optional emits-signal dont-register-service)
- "Register property PROPERTY on the D-Bus BUS.
+ "Register PROPERTY on the D-Bus BUS.
BUS is either a Lisp symbol, `:system' or `:session', or a string
denoting the bus address.
SERVICE is the D-Bus service name of the D-Bus. It must be a
-known name (See discussion of DONT-REGISTER-SERVICE below).
+known name (see discussion of DONT-REGISTER-SERVICE below).
-PATH is the D-Bus object path SERVICE is registered (See
+PATH is the D-Bus object path SERVICE is registered at (see
discussion of DONT-REGISTER-SERVICE below). INTERFACE is the
name of the interface used at PATH, PROPERTY is the name of the
property of INTERFACE. ACCESS indicates, whether the property
@@ -1625,8 +1626,8 @@ It will be registered for all objects created by
`dbus-register-property'."
"Return all objects at BUS, SERVICE, PATH, and the children of PATH.
The result is a list of objects. Every object is a cons of an
existing path name, and the list of available interface objects.
-An interface object is another cons, which car is the interface
-name, and the cdr is the list of properties as returned by
+An interface object is another cons, whose car is the interface
+name and cdr is the list of properties as returned by
`dbus-get-all-properties' for that path and interface. Example:
\(dbus-get-all-managed-objects :session \"org.gnome.SettingsDaemon\" \"/\")
@@ -1782,12 +1783,13 @@ can be a string denoting the address of the
corresponding bus. For
the system and session buses, this function is called when loading
`dbus.el', there is no need to call it again.
-The function returns a number, which counts the connections this Emacs
-session has established to the BUS under the same unique name (see
-`dbus-get-unique-name'). It depends on the libraries Emacs is linked
-with, and on the environment Emacs is running. For example, if Emacs
-is linked with the gtk toolkit, and it runs in a GTK-aware environment
-like Gnome, another connection might already be established.
+The function returns the number of connections this Emacs session
+has established to the BUS under the same unique name (see
+`dbus-get-unique-name'). It depends on the libraries Emacs is
+linked with, and on the environment Emacs is running. For
+example, if Emacs is linked with the GTK+ toolkit, and it runs in
+a GTK+-aware environment like GNOME, another connection might
+already be established.
When PRIVATE is non-nil, a new connection is established instead of
reusing an existing one. It results in a new unique name at the bus.
diff --git a/lisp/simple.el b/lisp/simple.el
index 0fe8a10..a28d10f 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -212,7 +212,7 @@ all other buffers."
(const :tag "Single next-error capable buffer on selected
frame"
next-error-buffer-on-selected-frame)
(const :tag "Current buffer if next-error capable and outside
navigation"
- next-error-no-navigation-try-current)
+ next-error-buffer-unnavigated-current)
(function :tag "Other function"))
:group 'next-error
:version "28.1")
@@ -242,10 +242,9 @@ from which next-error navigated, and a target buffer
TO-BUFFER."
(if (eq (length window-buffers) 1)
(car window-buffers))))
-(defun next-error-no-navigation-try-current (&optional
- avoid-current
- extra-test-inclusive
- extra-test-exclusive)
+(defun next-error-buffer-unnavigated-current (&optional avoid-current
+ extra-test-inclusive
+ extra-test-exclusive)
"Try the current buffer when outside navigation.
But return nil if we navigated to the current buffer by the means
of `next-error' command. Othewise, return it if it's next-error
@@ -3951,7 +3950,12 @@ is used for ERROR-BUFFER.
Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
display the error buffer if there were any errors. When called
-interactively, this is t."
+interactively, this is t.
+
+Non-nil REGION-NONCONTIGUOUS-P means that the region is composed of
+noncontiguous pieces. The most common example of this is a
+rectangular region, where the pieces are separated by newline
+characters."
(interactive (let (string)
(unless (mark)
(user-error "The mark is not set now, so there is no
region"))
diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el
index eb3ad72..b54258a 100644
--- a/lisp/tab-bar.el
+++ b/lisp/tab-bar.el
@@ -44,25 +44,12 @@
:group 'convenience
:version "27.1")
-(defgroup tab-bar-faces nil
+(defgroup tab-bar-faces '((tab-bar custom-face)) ; tab-bar is defined in
faces.el
"Faces used in the tab bar."
:group 'tab-bar
:group 'faces
:version "27.1")
-(defface tab-bar
- '((((class color) (min-colors 88))
- :inherit variable-pitch
- :background "grey85"
- :foreground "black")
- (((class mono))
- :background "grey")
- (t
- :inverse-video t))
- "Tab bar face."
- :version "27.1"
- :group 'tab-bar-faces)
-
(defface tab-bar-tab
'((default
:inherit tab-bar)
diff --git a/lisp/tab-line.el b/lisp/tab-line.el
index 7a2bdc0..e8c4dc4 100644
--- a/lisp/tab-line.el
+++ b/lisp/tab-line.el
@@ -35,26 +35,12 @@
:group 'convenience
:version "27.1")
-(defgroup tab-line-faces nil
+(defgroup tab-line-faces '((tab-line custom-face)) ; tab-line is defined in
faces.el
"Faces used in the tab line."
:group 'tab-line
:group 'faces
:version "27.1")
-(defface tab-line
- '((((class color) (min-colors 88))
- :inherit variable-pitch
- :height 0.9
- :background "grey85"
- :foreground "black")
- (((class mono))
- :background "grey")
- (t
- :inverse-video t))
- "Tab line face."
- :version "27.1"
- :group 'tab-line-faces)
-
(defface tab-line-tab
'((default
:inherit tab-line)
diff --git a/test/manual/etags/tex-src/gzip.texi
b/test/manual/etags/tex-src/gzip.texi
index ea5f7f5..72c5c7e 100644
--- a/test/manual/etags/tex-src/gzip.texi
+++ b/test/manual/etags/tex-src/gzip.texi
@@ -148,7 +148,7 @@ input and writes the uncompressed data on standard output.
@code{zcat}
will uncompress files that have the correct magic number whether they
have a @samp{.gz} suffix or not.
-@code{gzip} uses the Lempel-Ziv algorithm used in @code{zip} and PKZIP.
+@code{gzip} uses the Lempel-Ziv algorithm used in @code{zip} and PKZIP@.
The amount of compression obtained depends on the size of the input and
the distribution of common substrings. Typically, text such as source
code or English is reduced by 60-70%. Compression is generally much