1XSNOW(6) User Commands XSNOW(6)
2
6 xsnow - Snow and Santa on your desktop
7
9 xsnow [OPTION]...
10
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 If xsnow is misbehaving, try to remove the file $HOME/.xsnowrc.
21 General options:
23 Below:
24 <n> denotes an unsigned decimal (e.g 123) or octal (e.g. 017) or hex
25 (e.g. 0x50009) number.
26 <c> denotes a string like "red" or "#123456".
27 <f> denotes a file name, like "/home/rick/Pictures/background.jpg".
28 -h, -help
31 print this text.
32 -H, -manpage
34 print man page.
35 -v, -version
37 prints version of xsnow.
38 -changelog
40 prints ChangeLog.
41 -display <c>
43 Drop the snowflakes on the given display. Make sure the display
44 is nearby, so you can hear them enjoy...
45 -screen <n>
47 If you have multiple monitors: snow in monitor n.
48 -1: use all monitors (default: -1)
49 Note: for this to work, Xinerama has to be functional.
50 -outline <n>
52 1: draw outline around snow window. 0: no outline.
53 Default: 0.
54 -vintage
56 Run xsnow in vintage settings.
57 -defaults
59 Do not read config file (see FILES).
60 -noconfig
62 Do not read or write config file (see FILES).
63 -hidemenu
65 Start with hidden interactive menu.
66 -nomenu
68 Do not show interactive menu.
69 -lang <c>
71 Set language, example: -lang it, see LANGUAGES below. Default:
72 sys.
73 -scale <n>
75 Apply scalefactor (default: 100).
76 -doublebuffer <n>
78 1: use double buffering; 0: do not use double buffering
79 (default: 1). Only effective with '-root' or '-id' or
80 '-xwininfo'.
81 -transparency <n>
83 Transparency in % (default: 0)
84 -theme <n>
86 1: use xsnow theme for menu; 0: use system theme (default: 1)
87 -checkgtk <n>
89 0: Do not check gtk version before starting the user interface.
90 1: Check gtk version before starting the user interface.
91 (default: 1).
92 -id <n>, -window-id <n>
94 Snow in window with id (for example from xwininfo).
95 --window-id <n>
97 see -id.
98 -desktop
100 Act as if window is a desktop.
101 -allworkspaces <n>
103 0: use one desktop for snow, 1: use all desktops (default: 1).
104 -above Snow above your windows. Default is to snow below your windows.
106 NOTE: in some environments this results in an un-clickable
107 desktop.
108 -xwininfo
110 Use a cursor to point at the window you want the snow to be
111 fallen in.
112 -stopafter <n>
114 Stop xsnow after so many seconds.
115 -root, --root
117 Force to paint on (virtual) root window.
118 Use this for xscreensaver:
119 Make sure xscreensaver is running, either as a start-up
120 application
121 or from the command line, e.g:
122 nohup xscreensaver &
123 or
124 nohup xscreensaver -no-capture-stderr &
125 Run the program xscreensaver-demo to create the file
126 ~/.xscreensaver
127 In the file ~.xscreensaver add after the line 'programs:' this
128 line:
129 xsnow -root
130 Use the program xscreensaver-demo to select xsnow as
131 screensaver.
132 You probably want to select: Mode: Only One Screen Saver.
133 -bg <f>
135 file to be used as background when running under xscreensaver.
136 -noisy Write extra info about some mouse clicks, X errors etc, to
138 stdout.
139 -cpuload <n>
141 How busy is your system with xsnow: the higher, the more load on
142 the system (default: 100).
143 Snow options:
145 -snowflakes <n>
146 The higher, the more snowflakes are generated per second.
147 Default: 100.
148 -blowsnow
150 (Default) Animate blow-off snow.
151 -noblowsnow
153 Do not animate blowing snow from trees or windows
154 -sc <c>
156 Use the given string as color for the flakes (default: #fffafa).
157 -snowspeedfactor <n>
159 Multiply the speed of snow with this number/100 (default: 100).
160 -snowsize <n>
162 Set size of (non-vintage) snow flakes (default: 8).
163 -snow (Default) Show snow.
165 -nosnow -nosnowflakes
167 Do not show snow.
168 -flakecountmax <n>
170 Maximum number of active flakes (default: 300).
171 -blowofffactor <n>
173 The higher, the more snow is generated in blow-off scenarios
174 (default: 40).
175 Tree options:
177 -treetype <n>[,<n> ...]
178 Choose tree types: minimum 0, maximum 8 (default:
179 1,2,3,4,5,6,7,). Thanks to Carla Vermin for numbers >=3!
180 Credits: Image by b0red on Pixabay.
181 -treetype all
183 (Default) Use all non-vintage available tree types.
184 -tc <c>
186 Use the given string as the color for the vintage tree (default:
187 #7fff00). Works only for treetype 0.
188 -notrees
190 Do not display the trees.
191 -showtrees
193 (Default) Display the trees.
194 -trees <n>
196 Desired number of trees. Default 10.
197 -treefill <n>
199 Region in percents of the height of the window where trees grow
200 (default: 30).
201 -treescale <n>
203 Scale scenery (default: 100).
204 -treeoverlap
206 Allow scenery items to overlap each other (default).
207 -notreeoverlap
209 Do not allow scenery items to overlap each other.
210 Santa options:
212 -showsanta
213 (Default) Display Santa running all over the screen.
214 -nosanta
216 Do not display Santa running all over the screen.
217 -showrudolph
219 (Default) With Rudolph.
220 -norudolph
222 No Rudolph.
223 -santa <n>
225 The minimum size of Santa is 0, the maximum size is 4. Default
226 is 3. Thanks to Thomas Linder for the (big) Santa 2! Santa 3
227 is derived from Santa 2, and shows the required eight reindeer.
228 The appearance of Santa 4 may be a surprise, thanks to Carla
229 Vermin for this one.
230 -santaspeedfactor <n>
232 The speed Santa should not be excessive if he doesn't want to
233 get fined. The appropriate speed for the Santa chosen will be
234 multiplied by santaspeedfactor/100 (default: 100).
235 -santascale <n>
237 The scale to be used when drawing Santa (default: 100).
238 Celestial options:
240 -wind (Default) It will get windy now and then.
241 -nowind
243 By default it gets windy now and then. If you prefer quiet
244 weather specify -nowind.
245 -whirlfactor <n>
247 This sets the whirl factor, i.e. the maximum adjustment of the
248 horizontal speed. The default value is 100.
249 -windtimer <n>
251 With -windtimer you can specify how often it gets windy. It's
252 sort of a period in seconds, default value is 30.
253 -stars <n>
255 The number of stars (default: 20).
256 -meteors
258 (Default) Show meteors.
259 -nometeors
261 Do not show meteors.
262 -meteorfrequency
264 Frequency of falling of meteors, 0..100 (default: 40).
265 -moon <n>
267 1: show moon, 0: do not show moon (default: 1).
268 Picture of moon thanks to Pedro Lasta on Unsplash.
269 https://unsplash.com/photos/wCujVcf0JDw
270 -moonspeed <n>
272 Speed of moon in pixels/minute (default: 120).
273 -moonsize <n>
275 Relative size of moon (default: 100).
276 -mooncolor <n>
278 Color of moon 0: yellow-ish; 1: white-ish (default: 0).
279 -halo <n>
281 1: show halo around moon, 0: do not show halo (default: 1).
282 -halobrightness <n>
284 Brightness of halo (default: 25).
285 -aurora <n>
287 To show (1) or not to show(0) aurora (default: 1).
288 On most desktops aurora works, but not on all. Try!
289 -auroraleft
291 Place aurora in top left of screen.
292 -auroramiddle
294 Place aurora in top middle of screen.
295 -auroraright
297 Place aurora in top right of screen (default).
298 -aurorawidth <n>
300 Width of aurora in percentage of screen width (default: 60).
301 -aurorabase <n>
303 Height of aurora's base line in percentage of screen height
304 (default: 50).
305 -auroraheight <n>
307 Height of aurora (default: 30).
308 -auroraspeed <n>
310 Animation speed of aurora (default: 50).
311 10: about real value, 100: timelapse.
312 -aurorabrightness <n>
314 Brightness of aurora (default: 15).
315 Fallen snow options:
317 -wsnowdepth <n>
318 Maximum thickness of snow on top of windows (default: 30).
319 -ssnowdepth <n>
321 Maximum thickness of snow at the bottom of the screen (default:
322 50).
323 -maxontrees <n>
325 Maximum number of flakes on trees. Default 200.
326 -keepsnowonwindows
328 (Default) Keep snow on top of the windows.
329 -nokeepsnowonwindows
331 Do not keep snow on top of the windows.
332 -keepsnowonscreen
334 (Default) Keep snow at the bottom of the screen.
335 -nokeepsnowonscreen
337 Do not keep snow at the bottom of the screen.
338 -keepsnowontrees
340 (Default) Keep snow on trees.
341 -nokeepsnowontrees
343 Do not keep snow on trees.
344 -keepsnow
346 (Default) Have snow sticking anywhere.
347 -nokeepsnow
349 Do not have snow sticking anywhere.
350 -fluffy
352 (Default) Create fluff on fallen snow.
353 -nofluffy
355 Do not create fluff on fallen snow.
356 -offsetx <n>
358 Correction for window-manager provided x-coordinate of window.
359 Default 4.
360 -offsety <n>
362 Correction for window-manager provided y-coordinate of window.
363 Default 0.
364 -offsetw <n>
366 Correction for window-manager provided width of window. Default
367 -8.
368 -offsets <n>
370 Correction for bottom coordinate of your screen. A negative
371 value lifts the xsnow screen up. Default 0.
372 -ignoretop <n>
374 Do not collect snow on window > 0.8*width of screen and closer
375 than <n> pixels from the top. Sometimes an hidden window is
376 sitting there, but treated as a normal window by xsnow. Default
377 0.
378 -ignorebottom <n>
380 Analog to -ignoretop, but now for the bottom. Default 0.
381 Birds options:
383 -anarchy <n>
384 Anarchy factor ( 0..100 default: 50).
385 -birdscolor <c>
387 Use the given string as color for the birds (default: #361A07).
388 -birdsonly <n>
390 Show only birds ( 0/1 default: 0).
391 -birdsspeed <n>
393 Speed of birds ( 0..300 default: 100).
394 -disweight <n>
396 Eagerness to keep desired distance ( 0..100 default: 20).
397 -focuscentre <n>
399 Eagerness to fly to the focus ( 0..300 default: 100).
400 -followneighbours <n>
402 Eagerness to follow neighbours ( 0..100 default: 30).
403 -nbirds <n>
405 Number of birds ( 0..400 default: 70).
406 -neighbours <n>
408 Number of neighbours to watch ( 0..20 default: 7).
409 -prefdistance <n>
411 Preferred distance to neighbours ( 0..100 default: 40).
412 -showbirds <n>
414 Show birds ( 0/1 default: 1).
415 -showattr <n>
417 Show attraction point ( 0/1 default: 0).
418 -attrspace <n>
420 Vertical space to be used by the attraction point (default: 40).
421 -followsanta <n>
423 Birds like Santa ( 0/1 default: 0).
424 -viewingdistance <n>
426 Viewing distance ( 0..95 default: 40).
427 -birdsscale <n>
429 Scalefactor used painting the birds (default: 100).
430 LANGUAGES
432 Xsnow comes with some translations to non-english languages.
433 The translations are done with the aid of translate.google.com
434 (implemented in package 'trans'), so there will be room for
435 improvement. Any suggestions are welcome: contact@ratrabbit.nl .
436 FILES
438 $HOME/.xsnowrc
439 Settings are read from and written to this file. See flags
440 -noconfig and -defaults how to influence this behaviour.
441 NOTE: the following settings are not read or written:
442 -above -defaults -desktop -fullscreen -noconfig -id
443 -nomenu -stopafter -xwininfo -display -noisy
444 -checkgtk
445 $HOME/xsnow/pixmaps/tree.xpm
448 If present, xsnow will try this file for displaying the trees.
449 The format must be xpm (X PixMap) format, see
450 https://en.wikipedia.org/wiki/X_PixMap .
451 $HOME/xsnow/pixmaps/santa<n>.xpm
454 where <n> = 1,2,3,4. If present, xsnow will try this files (4
455 of them) for displaying Santa. The format must be xpm (X PixMap)
456 format, see https://en.wikipedia.org/wiki/X_PixMap .
457 NOTE: To show: activate the first Santa in the menu.
458 EXAMPLES
461 $ xsnow -defaults # run with defaults.
462 $ xsnow # run using values from the config file.
463 $ xsnow -treetype 1,2 # use tree types 1 and 2.
464 WINDOW MANAGER ISSUES
466 In general, xsnow works better when using a compositing window manager
467 like xcompmgr, compton or picom. However, with some window managers
468 (FVWM for example), the xsnow-window is transparent, but not
469 click-through. Flags to be tried in this case include: -root,
470 -doublebuffer, -xwininfo, -id.
471 Here follow some window managers with their issues:
472 Tiling window managers
475 Here you need to float windows with class=Xsnow.
476 AWESOME
478 Without compositor: no issues.
479 With compositor: no click-through xsnow window, and issues with
480 multi-monitor setup.
481 BSPWM No issues if you add to your bspwmrc (the bspwm configuration
483 file):
484 bspc rule -a Xsnow state=floating border=off
485 CINNAMON
487 No issues.
488 DWM No issues, except the "Below Windows" setting in the "settings"
490 panel.
491 ENLIGHTENMENT
493 With one monitor: no issuses.
494 With more montors: probems with showing in 'all monitors'
495 FLUXBOX
497 Without compositor: no issues.
498 With compositor: no click-through xsnow window
499 FVWM Without compositor: no issues.
501 With compositor: no click-through xsnow window
502 GNOME on Xorg
504 No issues.
505 GNOME on Wayland
507 Most windows don't catch snow.
508 HERBSTLUFTWM
510 No issues.
511 I3 Without compositor: windows don't catch snow, use the next line
513 in "config":
514 for_window [class="Xsnow"] floating enable;border none
515 With compositor: unworkable.
516 JVM No issues.
518 LXDE With compositor: no issues.
520 Without compositor: works with one monitor.
521 Maybe you need to run with the flag -xwininfo
522 LXQT Without compositor: unworkable. With compositor: no issues.
524 MATE No issues.
526 OPENBOX
528 No issues.
529 PLASMA (KDE)
531 No issues.
532 SPECTRWM
534 Various issues. In any case you need in spectrwm.conf:
535 quirk[Xsnow] = FLOAT
536 TWM Without compositor: no issues.
538 With compositor: no click-through xsnow window and
539 you need to tweak settings->lift snow on windows.
540 WINDOW MAKER
542 Without compositor: no issues. With compositor: no
543 click-through xsnow window
544 XFCE No issues when compositing is on, unworkable when compositing is
546 off.
547 See settings -> Window Manager Tweaks -> Compositor
548 XMONAD No issues if you add to your xmonad.hs:
550 import XMonad.Hooks.EwmhDesktops
551 xmonad $ ewmh $ defaultConfig
552 in the ManageHook section:
553 className = ? "Xsnow" --> doFloat
554 BUGS
556 - Xsnow needs a complete rewrite: the code is a mess.
557 - The flags are not consistent, caused by trying to be
558 compatible with older versions.
559 - Xsnow stresses the Xserver too much.
560 - Xsnow does run in Wayland, but will not snow on all windows.
561 - Xsnow tries to create a click-through window. This is not successful
562 in for example FVWM/xcompmgr. In that case, xsnow tries to keep
563 the snow window below all others, resulting in a transient effect
564 when you click on the desktop. Sadly, no FVWM menu will appear...
565 - Remnants of fluffy snow can persist after removing the
566 fallen snow. These will gradually disappear, so no big deal.
567 - Remnants of meteors can persist after passage of Santa.
568 These will eventually be wiped out by snow or Santa.
569 - Xsnow tries to adapt its snowing window if the display
570 settings are changed while xsnow is running.
571 This does not function always well.
572 - Xsnow does not play well with 'xcompmgr -a'. In some environments
573 (Raspberry 64 bit) xcompmgr is started with the flag '-a',
574 resulting in a black snow window. Remedy:
575 In a terminal window type:
576 killall xcompmgr
577 nohup xcompmgr -n &
578 and try again.
579 - In XFCE, compositing must be enabled for xsnow.
580 Settings -> Window Manager Tweaks -> Compositor -> Enable display
581 compositing
582 - In multi-screen environments, it depends on the display settings
583 if it is snowing on all screens. Experiment!
584 Please report your comments via:
586 https://ratrabbit.nl/ratrabbit/contact .
587
589 https://ratrabbit.nl/ratrabbit/xsnow
590
592 This is free software; see the source for copying conditions. There is
593 NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
594 PURPOSE.
595xsnow-3.7.6 2023 XSNOW(6)