]> git.eshelyaron.com Git - emacs.git/commitdiff
Document MS-Windows support in wallpaper.el
authorStefan Kangas <stefankangas@gmail.com>
Thu, 15 Sep 2022 17:12:10 +0000 (19:12 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Thu, 15 Sep 2022 17:14:38 +0000 (19:14 +0200)
* lisp/image/wallpaper.el: Add MS-Windows to Commentary.
(wallpaper-command, wallpaper-command-args, wallpaper-set):
Document MS-Windows support.

etc/NEWS
lisp/image/wallpaper.el

index cc68cd82b8669b7b818cef6742689e24b6a89f97..72c330f5f77ad8e902292d22c3cbc514dcd430f5 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2467,8 +2467,8 @@ This package provides the command 'wallpaper-set', which sets the
 desktop background image.  Depending on the system and the desktop,
 this may require an external program (such as 'swaybg', 'gm',
 'display' or 'xloadimage').  If so, a suitable command should be
-detected automatically in most cases, and can also be customized
-manually if needed using the new user options 'wallpaper-command' and
+detected automatically in most cases.  It can also be customized
+manually if needed, using the new user options 'wallpaper-command' and
 'wallpaper-command-args'.
 
 +++
index fe6882a5880d80bb919056c38138a9ef5f668e25..5622f9b8e8a8e1434c6e5d125841869274868f8a 100644 (file)
 ;; On GNU/Linux and other Unix-like systems, it uses an external
 ;; command to set the desktop background.
 ;;
-;; On Haiku, it uses the `haiku-set-wallpaper' function, which does
-;; not rely on any external commands.
-;;
-;; On macOS, the "osascript" command is used.  You might need to
-;; disable the option "Change picture" in the "Desktop & Screensaver"
-;; preferences for this to work (this was seen with macOS 10.13).
-;;
 ;; Finding an external command to use is obviously a bit tricky to get
 ;; right, as there is no lack of platforms, window managers, desktop
 ;; environments and tools.  However, it should be detected
 ;; automatically in most cases.  If it doesn't work in your
 ;; environment, customize the user options `wallpaper-command' and
 ;; `wallpaper-command-args'.
+;;
+;; On MS-Windows, it uses the `w32-set-wallpaper' function, and on
+;; Haiku the `haiku-set-wallpaper' function, neither of which relies
+;; on any external commands.  The value of `wallpaper-command' and
+;; `wallpaper-command-args' are ignored on such systems.
+;;
+;; On macOS, the "osascript" command is used.  You might need to
+;; disable the option "Change picture" in the "Desktop & Screensaver"
+;; preferences for this to work (this was seen with macOS 10.13).
 
 ;;; Code:
 
@@ -131,7 +133,7 @@ Used to set `wallpaper-command'."
                  (wallpaper--find-command-arguments))))
 
 (defcustom wallpaper-command (wallpaper--find-command)
-  "Executable used for setting the wallpaper.
+  "Executable used by `wallpaper-set' for setting the wallpaper.
 A suitable command for your environment should be detected
 automatically, so there is usually no need to customize this.
 
@@ -147,8 +149,8 @@ hear about it!  Please send an email to bug-gnu-emacs@gnu.org and
 tell us the command (and all options) that worked for you.  You
 can also use \\[report-emacs-bug].
 
-The value of this variable is ignored on Haiku systems, where a
-native API will be used instead (see `haiku-set-wallpaper')."
+The value of this variable is ignored on MS-Windows and Haiku
+systems, where a native API is used instead."
   :type
   '(choice
     (radio
@@ -186,8 +188,8 @@ returned by `display-pixel-width').
 If `wallpaper-set' is run from a TTY frame, it will prompt for a
 height and width for \"%h\" and \"%w\" instead.
 
-The value of this variable is ignored on Haiku systems, where a
-native API will be used instead (see `haiku-set-wallpaper')."
+The value of this variable is ignored on MS-Windows and Haiku
+systems, where a native API is used instead."
   :type '(repeat string)
   :group 'image
   :version "29.1")
@@ -233,8 +235,8 @@ external command.  Which command to use is automatically detected
 in most cases, but can be manually customized with the user
 options `wallpaper-command' and `wallpaper-command-args'.
 
-On Haiku, no external command is needed, so the value of
-`wallpaper-commands' is ignored."
+On MS-Windows and Haiku systems, no external command is needed,
+so the value of `wallpaper-commands' is ignored."
   (interactive (list (and
                       (display-graphic-p)
                       (read-file-name "Set desktop background to: "