xsetwallpaper/xsetwallpaper.1 at master · mherrb/xsetwallpaper · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
.\" Copyright (c) 2017 Tobias Stoeckmann <tobias@stoeckmann.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.TH XSETWALLPAPER 1 "xsetwallpaper 0.2.0" "XSETWALLPAPER"
.SH NAME
xsetwallpaper \- wallpaper setting utility for X
.SH SYNOPSIS
.B xsetwallpaper [--screen <screen>] [--output <output>] [--center <file>] [--maximize <file>] [--stretch <file>] [--tile <file>] [--zoom <file>] [--version]
.SH DESCRIPTION
The
.I xsetwallpaper
program allows you to set image files as your X wallpaper. PNG file format
is supported by default and preferred, but optional JPEG support exists as well.
.PP
The wallpaper is also advertised to programs which support semi-transparent
backgrounds.
.SH OPTIONS
.PP
The various options are as follows:
.IP "\fB--center \fP \fIfile\fP
Centers the input file on the screen. If the dimensions of the input file are
smaller than the screen dimensions, the remaining area is filled black. If the
input file dimensions are too large, parts of the image will be cropped.
.IP "\fB--maximize \fP \fIfile\fP
Maximizes input file to fit screen without cropping. This could mean zooming in
or out, depending on the dimensions of the input file and the screen. This
option guarantees that the whole image is seen. If the ratio does not fit the
screen, the remaining area is filled black. The image itself will be centered
on screen.
.IP "\fB--output \fP \fIoutput\fP
Specifies the output on which a subsequently supplied file shall be set as
wallpaper. You can retrieve a list of outputs on your system by executing
\fIxrandr(1)\fP. If no output is specified, the virtual desktop will be used,
which is the maximum area spaning across the different outputs (monitors).
The special keyword \fIall\fP will repeat subsequent actions on all displays.
.IP "\fB--screen \fP \fIscreen\fP
Specifies a screen by its screen number. Normally all screens of an X display
are processed. Please note that a screen is not a single monitor. See
\fI\-\-output\fP for such a use case above. If the screen could not be found,
nothing happens.
.IP "\fB--stretch \fP \fIfile\fP
Stretches input file to fully cover the screen. If the aspect ratio of the
input file does not match the screen, then the ratio of the input file is
adjusted.
.IP "\fB--tile \fP \fIfile\fP
Uses tiling mode. Draws the input file at the upper left corner of the screen
and repeats the image until the remaining area of the screen is covered.
.IP "\fB--version\fP
Prints version and exits.
.IP "\fB--zoom \fP \fIfile\fP
Zooms input file to fit screen with cropping. This could mean zooming in or out,
depending on the dimensions of the input file and the screen. If the ratio
does not fit the screen, parts of the input file will not be shown. The image
itself will be centered on screen. Default behaviour if no option was selected.
.PP
If multiple contradicting options were given, the last supplied option wins.
It is also possible to repeat output arguments without any subsequent files.
In that case, the last mode and file will be re-used.
.SH EXAMPLES
Centers a PNG file as a wallpaper on LVDS1:
.RS
xsetwallpaper --output LVDS1 --center file.png
.RE
.PP
Tiles a PNG file as a wallpaper across all outputs:
.RS
xsetwallpaper --tile file.png
.RE
.PP
Zooms into a JPEG file as a wallpaper on each output individually:
.RS
xsetwallpaper --zoom all --tile file.jpg
.RE
.PP
Tiles a JPEG file as a wallpaper on VGA1 and zooms into a PNG file on LVDS1:
.RS
xsetwallpaper --output VGA1 --tile file.jpg --output LVDS1 --zoom file.png
.RE
.SH BUGS
Use the GitHub issue tracker: https://github.com/stoeckmann/xsetwallpaper/issues
.SH AUTHOR
Tobias Stoeckmann <tobias@stoeckmann.org>