1XSNOW(6)                         User Commands                        XSNOW(6)
2
3
4

NAME

6       xsnow - Snow and Santa on your desktop
7

SYNOPSIS

9       xsnow [OPTION]...
10

DESCRIPTION

12       Xsnow  shows an animation of Santa and snow on your desktop.  Xsnow can
13       also run in one or more windows, see options -xwininfo, -id  .   (These
14       options only work satisfactorily in an X11 environment.)  Xsnow depends
15       on an X11 environment.  This  is  forced  by  setting  the  environment
16       variable  GDK_BACKEND=x11 before initializing the GTK.  Hopefully, this
17       will ensure that xsnow also runs in  a  Wayland  environment  for  some
18       time.
19
20   General options:
21       Below: <n> denotes an unsigned decimal (e.g 123) or octal (e.g. 017) or
22       hex (e.g. 0x50009) number.  <c> denotes a  color  name  like  "red"  or
23       "#123456".
24
25
26       -h, -help
27              print this text.
28
29       -H, -manpage
30              print man page.
31
32       -v, -version
33              prints version of xsnow.
34
35       -display name
36              Drop the snowflakes on the given display.  Make sure the display
37              is nearby, so you can hear them enjoy...
38
39       -vintage
40              Run xsnow in vintage settings.
41
42       -defaults
43              Do not read config file (see FILES).
44
45       -noconfig
46              Do not read or write config file (see FILES).
47
48       -nomenu
49              Do not how interactive menu.
50
51       -id <n>
52              Snow in window with id (for example from xwininfo).
53
54       -desktop
55              Act as if window is a desktop.
56
57       -allworkspaces <n>
58              0: use one desktop for snow, 1: use all desktops (default: 1).
59
60       -fullscreen
61              Snow on full screen window: panels, task bars etc. will  be  not
62              accessible.
63
64       -above Snow above your windows. Default is to snow below your windows.
65
66       -xwininfo
67              Use  a  cursor  to  point  at the window you want the snow to be
68              fallen in.
69
70       -bg <c>
71              Use color <c> to erase obsolete  drawings  (snow,  santa,  ...).
72              Useful  in  for example KDE: create mono colored background, and
73              specify the  same  color  here,  e.g:  -bg  "#123456"  (default:
74              "#000000".)
75
76       -kdebg sets  the  KDE  desktop  background  color to the value given at
77              '-bg'.
78
79       -exposures
80              Force XClearArea(...,exposures=True) when erasing.
81
82       -noexposures
83              Force XClearArea(...,exposures=False) when  erasing.   Exposures
84              have effect with '-alpha 0' or '-xwininfo'.
85
86       -alpha <n>
87              0: do not use alpha channel; 1: use alpha channel.
88
89       -fvwm  prepare  for  FVWM  and  the  like:  no  background,  -alpha  0,
90              -noexposures .
91
92       -gnome prepare for GNOME, KDE and the like: no  background,  -alpha  1,
93              -noexposures .
94
95       -stopafter <n>
96              Stop xsnow after so many seconds.
97
98       -showstats
99              Print  some  statistics  about the various things that happen in
100              xsnow.
101
102       -noquiet
103              Print during running info about disappeared windows, blown fuses
104              etc.
105
106   Snow options:
107       -snowflakes <n>
108              The  higher,  the  more  snowflakes  are  generated  per second.
109              Default: 100.
110
111       -noblowsnow
112              Do not animate blowing snow from trees or windows.
113
114       -sc <c>
115              Use the given string as color for the flakes (default: "snow").
116
117       -snowspeedfactor <n>
118              Multiply the speed of snow with this number/100 (default:100).
119
120       -nosnowflakes
121              Do not show falling snowflakes. (Weird!)
122
123       -flakecountmax <n>
124              Maximum number of active flakes (default 10000).
125
126       -blowofffactor <n>
127              The higher, the more snow is  generated  in  blow-off  scenarios
128              (default: 100).
129
130   Tree options:
131       -treetype <n>[,<n> ...]
132              Choose    tree    types:   minimum   0,   maximum   6   (default
133              "1,2,3,4,5,6,").   Thanks  to  Carla  Vermin  for  numbers  >=3!
134              Credits: Image by b0red on Pixabay.
135
136       -treetype all
137              Use all available tree types.
138
139       -tc <c>
140              Use  the  given  string  as  the  color  for  the  default trees
141              (default: "chartreuse").  Works only for treetype 0.
142
143       -notrees
144              Do not display the trees.
145
146       -trees <n>
147              Desired number of trees. Default 10.
148
149       -treefill <n>
150              Region in percents of the height of the window where trees  grow
151              (default: 30).
152
153   Santa options:
154       -nosanta
155              Do not display Santa running all over the screen.
156
157       -norudolf
158              No Rudolf.
159
160       -santa <n>
161              The  minimum  size of Santa is 0, the maximum size is 4. Default
162              is 3.  Thanks to Thomas Linder for the (big) Santa 2!   Santa  3
163              is  derived from Santa 2, and shows the required eight reindeer.
164              The appearance of Santa 4 may be a  surprise,  thanks  to  Carla
165              Vermin for this one.
166
167       -santaspeedfactor <n>
168              The  speed  Santa  should not be excessive if he doesn't want to
169              get fined. The appropriate speed for the Santa  chosen  will  be
170              multiplied by santaspeedfactor/100 (default: 100).
171
172   Wind options:
173       -nowind
174              By  default  it  gets  windy  now  and then. If you prefer quiet
175              weather specify -nowind.
176
177       -whirlfactor <n>
178              This sets the whirl factor, i.e. the maximum adjustment  of  the
179              horizontal speed. The default value is 100.
180
181       -windtimer <n>
182              With  -windtimer  you can specify how often it gets  windy. It's
183              sort of a period in seconds, default value is 30.
184
185   Fallen snow options:
186       -wsnowdepth <n>
187              Maximum thickness of snow on top of windows (default: 30).
188
189       -ssnowdepth <n>
190              Maximum thickness of snow at the bottom of the screen  (default:
191              50).
192
193       -maxontrees <n>
194              Maximum number of flakes on trees. Default 200.
195
196       -nokeepsnowonwindows
197              Do not keep snow on top of the windows.
198
199       -nokeepsnowonscreen
200              Do not keep snow at the bottom of the screen.
201
202       -nokeepsnowontrees
203              Do not keep snow on trees.
204
205       -nokeepsnow
206              Do not have snow sticking anywhere.
207
208       -nofluffy
209              Do not create fluff on fallen snow.
210
211       -offsetx <n>
212              Correction   for  window-manager  provided  of  x-coordinate  of
213              window. Default 4.
214
215       -offsety <n>
216              Correction for window-managr provided of y-coordinate of window.
217              Default 0.
218
219       -offsetw <n>
220              Correction  for  window-manager  provided  of  width  of window.
221              Default -8.
222
223       -offsets <n>
224              Correction for bottom coordinate  of  your  screen.  A  negative
225              value lifts the xsnow screen up. Default 0.
226
227   Other options:
228       -stars <n>
229              The number of stars (default: 20).
230
231       -nometeorites
232              Do not show meteorites.
233
234       -cpuload <n>
235              How busy is your system with xsnow: the higher, the more load on
236              the system (default: 100).
237
238   FILES
239       $HOME/.xsnowrc
240              Settings are read from and written  to  this  file.   See  flags
241              -noconfig and -defaults how to influence this behaviour.
242
243
244       $HOME/xsnow/pixmaps/tree.xpm
245              If  present,  xsnow will try this file for displaying the trees.
246              The   format   must   be   xpm   (X    PixMap)    format,    see
247              https://en.wikipedia.org/wiki/X_PixMap .
248
249       $HOME/xsnow/pixmaps/santa<n>.xpm
250              where  <n>  = 1,2,3,4.  If present, xsnow will try this files (4
251              of them) for displaying Santa. The format must be xpm (X PixMap)
252              format, see https://en.wikipedia.org/wiki/X_PixMap .
253
254   EXAMPLES
255           $ xsnow -defaults        # run with defaults.
256           $ xsnow                  # run using values from the config file.
257           $ xsnow -treetype 1,2    # use tree types 1 and 2.
258           $ xsnow -kde -kdebg -bg blue4  # for the KDE environment.
259
260   BUGS
261       - Xsnow needs a complete rewrite: the code is a mess.
262       - Xsnow stresses the Xserver too much.
263       - The -xwininfo and -id flags do not function properly.
264       - Xsnow generates race conditions, e.g.: sometimes fallen snow
265         is not removed when it should be.
266       - Xsnow does run in Wayland, but will not snow on all windows.
267       - Remnants of fluffy snow can persist after removing the
268         fallen snow. These will gradually disappear, so no big deal.
269
270   SEE ALSO
271       man xcolors(1)
272
274       This is free software; see the source for copying conditions.  There is
275       NO warranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR
276       PURPOSE.
277
278       Thank you for using xsnow
279
280
281
282xsnow-2.0.17                         2020                             XSNOW(6)
Impressum