aboutsummaryrefslogtreecommitdiffstats
path: root/doc/yawa.rst
blob: 95da79c2136be095af212f89b60d55cd3f62e06c (plain)
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
yawa
====

Synopsis
--------

**yawa** [*options*]

Description
-----------

:program:`yawa` is Yet Another Wallpaper Application, and a cleaned up fork of hsetroot

Options
-------

Gradients:
~~~~~~~~~~

-a COLOR, --add=COLOR
        Add the specified hex color to range

-d DISTANCE, --distance=DISTANCE
        Distance to use for adding color to range (Specify multiple times for
        successive distances). Defaults to 1 for each color.

-c, --clear
        Clear the color range

-g ANGLE, --gradient=ANGLE
        Render gradient using the specified angle

Solid:
~~~~~~

-s COLOR, --solid=COLOR
        Render a solid background using the specified color

Image files:
~~~~~~~~~~~~

-C IMAGE, --center=IMAGE
        Render the specified image centered on the screen

-f IMAGE, --full=IMAGE
        Render the specified image using the maximum aspect ratio

-F IMAGE, --fill=IMAGE
        Render the specified image stretched out

-t IMAGE, --tile=IMAGE
        Render the specified image tiled

Manipulations:
~~~~~~~~~~~~~~

-b RADIUS, --blur=RADIUS
        Blur the current image using the specified radius

-B AMOUNT, --brightness=AMOUNT
        Adjust the brightness of the current image with the specified amount of
        brightness

-G AMOUNT, --gamma=AMOUNT
        Adjust the gamma level of the current image with the specifed amount

-o AMOUNT, --contrast=AMOUNT
        Adjust the constrast of the current image with the specified amount

-S RADIUS, --sharpen=RADIUS
        Sharpen the current image

-T COLOR, --tint=COLOR
        Tint the current image using the specified hex color

--fliph
        Flip the current image horizontally

--flipv
        Flip the current image vertically

--flipd
        Flip the current image diagonally

Misc:
~~~~~

-A AMOUNT, --alpha=AMOUNT
        Adjust the alpha level for colors and images

-w FILENAME, --write=FILENAME
        Write the current image to the specified file. The filename specifies
        the out-format

-h, --help
        Show this help message and exit

--usage
        Print a short usage message

-?, --version
        Print program version

Examples
--------

Set the background to a nice blue to yellow horizontal gradient

        :program:`yawa --add '#ffb301' --add '#00ffff' --gradient 100`