git.hungrycats.org Git - xscreensaver/blob - hacks/glitchpeg.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 glitchpeg - glitched image screen saver.
   4 .SH SYNOPSIS
   5 .B glitchpeg
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fInumber\fP]
  11 [\-duration \fInumber\fP]
  12 [\-count \fInumber\fP]
  13 .SH DESCRIPTION
  14 Loads an image, corrupts it, and then displays the corrupted version,
  15 several times a second. After a while, finds a new image to corrupt.
  16
  17 It glitches the image by altering random bytes in the compressed image
  18 file before de-compressing it. This creates interesting visual effects
  19 on JPEG files, but doesn't work well on PNG files, since PNG contains
  20 checksums that detect simple corruption.
  21 .SH OPTIONS
  22 .TP 8
  23 .B \-visual \fIvisual\fP
  24 Specify which visual to use.  Legal values are the name of a visual class,
  25 or the id number (decimal or hex) of a specific visual.
  26 .TP 8
  27 .B \-window
  28 Draw on a newly-created window.  This is the default.
  29 .TP 8
  30 .B \-root
  31 Draw on the root window.
  32 .TP 8
  33 .B \-delay \fInumber\fP
  34 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds).
  35 .TP 8
  36 .B \-duration \fInumber\fP
  37 How many seconds before loading a new image.  Default: 120.
  38 .TP 8
  39 .B \-count \fInumber\fP
  40 Number of glitches to introduce per iteration. Default: 100.
  41 .SH ENVIRONMENT
  42 .PP
  43 .TP 8
  44 .B DISPLAY
  45 to get the default host and display number.
  46 .TP 8
  47 .B XENVIRONMENT
  48 to get the name of a resource file that overrides the global resources
  49 stored in the RESOURCE_MANAGER property.
  50 .SH SECURITY
  51 Because this program is feeding intentionally-invalid data into your
  52 operating system's image-decoding libraries, it is possible that it
  53 may crash as a result of that corrupted data.
  54
  55 That should not be possible -- but it might be.
  56
  57 Please note that if this happens, that indicates a serious security
  58 bug in your system's image libraries!  It likely means that your
  59 libraries are susceptible to buffer overflow attacks or similar, which
  60 can lead to remote code execution.  You should report that bug to the
  61 maintainers of those image libraries.
  62
  63 In the context of xscreensaver, when configured to load only local
  64 image files, this should not be a direct security concern: this screen
  65 saver crashing will not affect the xscreensaver daemon and will not
  66 unlock your screen.
  67 .SH SEE ALSO
  68 .BR X (1),
  69 .BR xscreensaver (1)
  70 .SH COPYRIGHT
  71 Copyright \(co 2018 by Jamie Zawinski.  Permission to use, copy, modify,
  72 distribute, and sell this software and its documentation for any purpose is
  73 hereby granted without fee, provided that the above copyright notice appear
  74 in all copies and that both that copyright notice and this permission notice
  75 appear in supporting documentation.  No representations are made about the
  76 suitability of this software for any purpose.  It is provided "as is" without
  77 express or implied warranty.
  78 .SH AUTHOR
  79 Jamie Zawinski.