master 37e1c896a0 2/3: ; * lisp/image/wallpaper.el: Minor doc fixes.

[Stefan Kangas]

branch: master
commit 37e1c896a02995c4a8ddc431bf14bf3fe5846390
Author: Stefan Kangas <stefankangas@gmail.com>
Commit: Stefan Kangas <stefankangas@gmail.com>

    ; * lisp/image/wallpaper.el: Minor doc fixes.
---
 etc/NEWS                | 28 ++++++++++++++--------------
 lisp/image/wallpaper.el | 27 +++++++++++++++++++--------
 2 files changed, 33 insertions(+), 22 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 5276a49d5c..0023d5e2eb 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1989,20 +1989,6 @@ and is bound to "s p" in Image mode.
 *** Users can now add special image conversion functions.
 This is done via 'image-converter-add-handler'.
 
----
-*** New library wallpaper.el.
-This library contains the command `wallpaper-set', which sets the
-desktop background.
-
-On GNU/Linux and other Unix-like systems, it uses an external command
-(such as "swaybg", "gm", "display" or "xloadimage").  A suitable
-command should be detected automatically in most cases, but can also
-be customized manually with the new user options 'wallpaper-command'
-and 'wallpaper-command-args' if needed.
-
-On Haiku, it uses the new function `haiku-set-wallpaper', which does
-not rely on any external command.
-
 ** Image-Dired
 
 +++
@@ -2457,6 +2443,20 @@ default 'convert' from ImageMagick, to do the actual 
cropping/eliding
 of the image file.  If the 'exiftool' program is available, it is used
 to optionally rotate images which have the :rotation property.
 
+---
+** New package 'wallpaper'.
+This package provides the command `wallpaper-set', which sets the
+desktop background.
+
+On GNU/Linux and other Unix-like systems, it uses an external command
+(such as "swaybg", "gm", "display" or "xloadimage").  A suitable
+command should be detected automatically in most cases, but can also
+be customized manually with the new user options 'wallpaper-command'
+and 'wallpaper-command-args' if needed.
+
+On Haiku, it uses the new function `haiku-set-wallpaper', which does
+not rely on any external command.
+
 +++
 ** New package 'oclosure'.
 Allows the creation of "functions with slots" or "function objects"
diff --git a/lisp/image/wallpaper.el b/lisp/image/wallpaper.el
index a3bf44a5c3..03b6afa4e0 100644
--- a/lisp/image/wallpaper.el
+++ b/lisp/image/wallpaper.el
@@ -1,4 +1,4 @@
-;;; wallpaper.el --- Set desktop wallpaper from Emacs  -*- lexical-binding: t; 
-*-
+;;; wallpaper.el --- Change desktop background from Emacs  -*- 
lexical-binding: t; -*-
 
 ;; Copyright (C) 2022 Free Software Foundation, Inc.
 
@@ -65,7 +65,7 @@
     ("xloadimage" "-onroot" "-fullscreen" "%f")
     ("xsetbg" " %f")
     )
-  "Executable used for setting the wallpaper.
+  "List of executables and options used for setting the wallpaper.
 This is used by `wallpaper--find-command' to automatically set
 `wallpaper-command', and by `wallpaper--find-command-args' to set
 `wallpaper-command-args'.  The commands will be tested in the
@@ -115,8 +115,9 @@ will be replaced as described in `wallpaper-command-args'.")
 
 (defvar wallpaper-command-args) ; silence byte-compiler
 (defun wallpaper--set-wallpaper-command (sym val)
-  "Set `wallpaper-command', and update `wallpaper-command-args'."
-  ;; Note: `command-args' is used by `wallpaper--find-command-arguments'.
+  "Set `wallpaper-command', and update `wallpaper-command-args'.
+Used to set `wallpaper-command'."
+  ;; Note: `wallpaper-command' is used by `wallpaper--find-command-arguments'.
   (prog1 (set-default sym val)
     (set-default 'wallpaper-command-args
                  (wallpaper--find-command-arguments))))
@@ -136,7 +137,10 @@ Note: If you find that you need to use a command in your
 environment that is not automatically detected, we would love to
 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]."
+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')."
   :type
   '(choice
     (radio
@@ -166,7 +170,13 @@ In each of the command line arguments, \"%f\" will be 
replaced
 with the full file name, \"%h\" with the height of the selected
 frame's display (as returned by `display-pixel-height'), and
 \"%w\" with the width of the selected frame's display (as
-returned by `display-pixel-width')."
+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')."
   :type '(repeat string)
   :group 'image
   :version "29.1")
@@ -207,8 +217,9 @@ See also `wallpaper-default-width'.")
   "Set the desktop background to FILE in a graphical environment.
 
 On GNU/Linux and other Unix-like systems, this relies on an
-external command.  Which command is being used depends on the
-user option `wallpaper-commands'.
+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."