File: wallpaper.el.html

This library provides the command wallpaper-set, which sets the desktop background.

On GNU/Linux and other Unix-like systems, it uses an external command to set the desktop background. This should work seamlessly on both X and Wayland.

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). You might also have to tweak some permissions.

Note: If you find that you need to use a command in your environment that was 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 M-x report-emacs-bug.

Defined variables (8)

wallpaper--default-settersList of setters used for setting the wallpaper.
wallpaper-commandExecutable used by ‘wallpaper-set’ for setting the wallpaper.
wallpaper-command-argsCommand line arguments for ‘wallpaper-command’.
wallpaper-debugIf non-nil, display debug messages.
wallpaper-default-heightDefault height used by ‘wallpaper-set’.
wallpaper-default-widthDefault width used by ‘wallpaper-set’.
wallpaper-image-file-extensionsList of file extensions that ‘wallpaper-set’ will consider for completion.
wallpaper-set-functionFunction used by ‘wallpaper-set’ to set the wallpaper.

Defined functions (27)

wallpaper--default-methods-create(&rest ITEMS)
wallpaper--find-command()
wallpaper--find-command-args()
wallpaper--format-arg(FORMAT FILE)
wallpaper--get-height-or-width(DESC FUN DEFAULT)
wallpaper--init-action-kill(PROCESS-NAME)
wallpaper--set-wallpaper-command(SYM VAL)
wallpaper--x-monitor-name()
wallpaper-debug(&rest ARGS)
wallpaper-default-set-function(FILE)
wallpaper-set(FILE)
wallpaper-setter-args(wallpaper-setter-args X)
wallpaper-setter-args--inliner(INLINE--FORM X)
wallpaper-setter-command(wallpaper-setter-command X)
wallpaper-setter-command--inliner(INLINE--FORM X)
wallpaper-setter-copy(ARG)
wallpaper-setter-create(NAME COMMAND ARGS-RAW &rest REST-PLIST)
wallpaper-setter-detach(wallpaper-setter-detach X)
wallpaper-setter-detach--inliner(INLINE--FORM X)
wallpaper-setter-init-action(wallpaper-setter-init-action X)
wallpaper-setter-init-action--inliner(INLINE--FORM X)
wallpaper-setter-name(wallpaper-setter-name X)
wallpaper-setter-name--inliner(INLINE--FORM X)
wallpaper-setter-p(X)
wallpaper-setter-p--inliner(INLINE--FORM X)
wallpaper-setter-predicate(wallpaper-setter-predicate X)
wallpaper-setter-predicate--inliner(INLINE--FORM X)

Defined faces (0)