-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathxwallpaper.1
114 lines (114 loc) · 4.35 KB
/
xwallpaper.1
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
.\" Copyright (c) 2017 Tobias Stoeckmann <[email protected]>
.\"
.\" 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.
.Dd April 2, 2017
.Dt XWALLPAPER 1
.Os xwallpaper 0.3.0
.Sh NAME
.Nm xwallpaper
.Nd wallpaper setting utility for X
.Sh SYNOPSIS
.Nm xwallpaper
.Op Fl Fl screen Ar screen
.Op Fl Fl no-randr
.Op Fl Fl output Ar output
.Op Fl Fl center Ar file
.Op Fl Fl maximize Ar file
.Op Fl Fl stretch Ar file
.Op Fl Fl tile Ar file
.Op Fl Fl zoom Ar file
.Op Fl Fl version
.Sh DESCRIPTION
The
.Nm xwallpaper
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
The various options are as follows:
.Bl -tag -width Ds
.It Fl Fl center Ar file
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.
.It Fl Fl maximize Ar file
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.
.It Fl Fl no-randr
Ignores individual outputs and uses the whole screen instead.
This is the area that spans across all different outputs (monitors).
.It Fl Fl output Ar output
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
.Xr xrandr 1 .
If no output is specified, all outputs will be modified individually.
The special keyword
.Cm all
will repeat subsequent actions on all displays.
.It Fl Fl screen Ar screen
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
.Fl Fl output
for such a use case above.
If the screen could not be found, nothing happens.
.It Fl Fl stretch Ar file
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.
.It Fl Fl tile Ar file
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.
.It Fl Fl version
Prints version and exits.
.It Fl Fl zoom Ar file
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.
.El
.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 reused.
.Sh EXAMPLES
Centers a PNG file as a wallpaper on LVDS-1:
.Dl $ xwallpaper --output LVDS-1 --center file.png
.Pp
Tiles a PNG file as a wallpaper across all outputs:
.Dl $ xwallpaper --no-randr --tile file.png
.Pp
Zooms into a JPEG file as a wallpaper on each output individually:
.Dl $ xwallpaper --zoom file.jpg
.Pp
Tiles a JPEG file as a wallpaper on VGA-1 and zooms into a PNG file on LVDS-1:
.Dl $ xwallpaper --output VGA-1 --tile file.jpg --output LVDS-1 --zoom file.png
.Sh BUGS
Use the GitHub issue tracker:
.Lk https://github.com/stoeckmann/xwallpaper/issues
.Sh AUTHOR
.An Tobias Stockmann Aq Mt [email protected]