Arguments

XAWP supports both configuration files and commands. Using commands can reduce the time for testing features and tweaking.

Help

xawp --help or xawp -h can be used to list the following list of commands:

XAWP - X11 Animated Wallpaper Player
Play animated wallpapers in X11 by passing XAWP a directory containing the
pictures frames wanted to be displayed.

Usage: xawp [options]

Options:
-h, --help			Output this help list and exit
-t, --time			Set the time XAWP needs to wait between the
				change of images: --time seconds.milliseconds

-v, --version			Output version information and license and exit
-D, --debug			Output the debug log
-d, --directory			Set directory containing animation frames:
				--directory /home/foo/wallgif/

-c, --config			Set another configuration file than the default
				/home/foo/.config/xawp/xawp.conf configuration file

-S, --set-static-wallpaper	Set a static wallpaper and exit

Note that XAWP uses a lot of system resources like RAM and CPU!

Time

xawp --time 1.3 or xawp -t 1.3 are 2 examples of how to set the time interval between frames. It accepts a floating number, the integer representing the seconds and the float representing 10^2 of a millisecond. Basically the example sets the time interval to 1 second and 300 milliseconds, or 1300 milliseconds. Of course, it can be set a lower interval than 1.0.

The time set in the argument takes over the time set in the configuration file.

Version

xawp --version or xawp -v prints the version of XAWP and a copyright license of GNU GPL v3+:

XAWP version <ver_string>

Copyright (C) 2022 TheRealOne78
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Debug

xawp --debug or xawp -D triggers the debug info when XAWP is running. It's useful when catching a bug.

Directory

xawp --directory /home/foo/wallgif/ or xawp -d /home/foo/wallgif/ is used when the user wants to set a specific directory of frames. Notice that the other paramenters from the configuration file will still be used.

Config

xawp --config or xawp -c can be used to set another configuration file than $HOME/.config/xawp/xawp.conf. Best when tweaking or using random configuration files each time the user logins.

Set static wallpaper

xawp --set-static-wallpaper /home/foo/wallpaper.png or xawp -S /home/foo/wallpaper.png is used when the user decides to set a simple background image. The principle is to set the background image and exit. This isn't very resource demanding.

To see how to configure XAWP, check out the configuring wiki page.