90 lines
2.4 KiB
Groff
90 lines
2.4 KiB
Groff
.\" Automatically generated by Pandoc 3.9.0.2
|
|
.\"
|
|
.TH "WALLREEL" "1" "2026\-03\-24" "WallReel 2.0.2" "User Commands"
|
|
.SH NAME
|
|
wallreel \- Choose and set desktop wallpapers with customizable themes
|
|
and actions
|
|
.SH SYNOPSIS
|
|
\f[B]wallreel\f[R] [\f[I]options\f[R]]
|
|
.SH DESCRIPTION
|
|
\f[B]wallreel\f[R] is a Qt6 application for browsing wallpaper images,
|
|
previewing candidates, and applying a selected image.
|
|
.PP
|
|
Configuration is loaded from a JSON file.
|
|
CLI options are available for logging, one\-shot operations, and runtime
|
|
overrides.
|
|
.SH OPTIONS
|
|
\f[B]\-h, \-\-help\f[R] : Display help for command\-line options.
|
|
.PP
|
|
\f[B]\-v, \-\-version\f[R] : Display version information.
|
|
.PP
|
|
\f[B]\-V, \-\-verbose\f[R] : Set log level to DEBUG (default is INFO).
|
|
.PP
|
|
\f[B]\-C, \-\-clear\-cache\f[R] : Clear image cache and exit.
|
|
.PP
|
|
\f[B]\-q, \-\-quiet\f[R] : Suppress log output.
|
|
.PP
|
|
\f[B]\-d, \-\-append\-dir\f[R] \f[I]dir\f[R] : Append an additional
|
|
wallpaper search directory.
|
|
.PP
|
|
This option can be provided multiple times.
|
|
.PP
|
|
\f[B]\-c, \-\-config\-file\f[R] \f[I]file\f[R] : Use a custom
|
|
configuration file.
|
|
.PP
|
|
\f[B]\-D, \-\-disable\-actions\f[R] : Disable actions defined in the
|
|
configuration file.
|
|
.PP
|
|
\f[B]\-a, \-\-apply\f[R] \f[I]file\f[R] : Apply the specified image as
|
|
wallpaper and exit.
|
|
.PP
|
|
In this mode, the configuration is still parsed.
|
|
Action placeholders are resolved from the selected image and any
|
|
captured state values.
|
|
.SH BEHAVIOR NOTES
|
|
.IP \(bu 2
|
|
CLI options are generally optional; configuration is the preferred
|
|
customization path.
|
|
.IP \(bu 2
|
|
Some options are mutually exclusive (for example \f[CR]\-\-verbose\f[R]
|
|
and \f[CR]\-\-quiet\f[R]).
|
|
.IP \(bu 2
|
|
With \f[CR]\-\-apply\f[R], WallReel executes configured selection
|
|
actions without opening the UI.
|
|
.SH FILES
|
|
\f[CR]\(ti/.config/wallreel/config.json\f[R] : Default configuration
|
|
file location.
|
|
.PP
|
|
\f[CR]\(ti/.cache/wallreel/\f[R] : Runtime cache location.
|
|
.SH EXAMPLES
|
|
Run with default configuration:
|
|
.IP
|
|
.EX
|
|
wallreel
|
|
.EE
|
|
.PP
|
|
Use a custom configuration file:
|
|
.IP
|
|
.EX
|
|
wallreel \-\-config\-file \(ti/.config/wallreel/config.json
|
|
.EE
|
|
.PP
|
|
Append additional search directories:
|
|
.IP
|
|
.EX
|
|
wallreel \-\-append\-dir \(ti/Pictures/Wallpapers \-\-append\-dir \(ti/Art
|
|
.EE
|
|
.PP
|
|
Apply a wallpaper and exit:
|
|
.IP
|
|
.EX
|
|
wallreel \-\-apply \(ti/Pictures/wallpaper.jpg
|
|
.EE
|
|
.SH EXIT STATUS
|
|
Returns \f[CR]0\f[R] on success.
|
|
Returns a non\-zero value on failure.
|
|
.SH SEE ALSO
|
|
\f[B]wallreel\f[R](5)
|
|
.SH AUTHOR
|
|
Uyanide <github.com/Uyanide>
|