aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README89
-rw-r--r--TODO3
2 files changed, 75 insertions, 17 deletions
diff --git a/README b/README
index 0dbd86b..2c61b77 100644
--- a/README
+++ b/README
@@ -1,20 +1,79 @@
-Acer/Packard Bell is not willing to repair all defects on my
-computer, but at least I can run this for several hours and
-try to revive dead pixels.
+NAME
+ unstickpixels - Screen loop to try to unstick stuck dots
-Dead (always black) pixels are hard to revive, stuck pixels
-on the other hand are more probable to get fixed.
+SYNOPSIS
+ unstickpixels [OPTIONS...] [--] [INTERVAL]
+DESCRIPTION
+ unstickpixels shall cycle the colours on the screen between
+ sRGB(100 %, 0, 0), sRGB(0, 100 %, 0), and sRGB(0, 0, 100 %),
+ as fast as possible, or sleep INTERVAL milliseconds between
+ each switch.
-This program should be run under the Linux VT. It works by
-cycling the colour on the screen between sRGB(100 %, 0, 0),
-sRGB(0, 100 %, 0) and sRGB(0, 0, 100 %), as fast as possible.
-If you want to slow down the cycling you can add, as the only
-argument, the millisecond time sleep between the colours.
+ You should disable powersaving on your monitors and disable
+ the screensaver whilst running this program, or otherwise
+ make sure that screen loop is always displayed.
-If you are using a graphical environment and do not know how
-to access the Linux VT, here is how you do it: press Ctrl+Alt+F1,
-if this does not open non-graphical login screen, press Alt+Right
-until you get one. To get back to graphical environment, hold
-down Alt+Right until it appears.
+ Running this program for a number of hours, especially if
+ combined with massaging defective dots, may heal defective
+ dots. Dead dots (always black) are hard to revive, but
+ stuck dots are more probable to get fixed.
+
+ You must not run this program if you are epileptic. Seek
+ someone else how can do it for you.
+
+ unstickpixels uses the graphics cards' colour lookup tables
+ to switch the colour displayed on the screen. If your
+ computers does not supports this, the option -v may help,
+ it will use the framebuffer indirectly, via the terminal.
+ Unless -v is used, unstickpixels runs both in X and on the
+ Linux VT.
+
+OPTIONS
+ -v Use the Linux VT instead of the graphics cards'
+ colour lookup tables (CLUT). This requires that the
+ program runs under the Linux VT, otherwise known
+ as the TTY. This may not work too great one all
+ graphics cards, some very expensive graphics cards
+ are really bad. NVIDIA is known case of this,
+ why the CLUT utilisation was added.
+
+ If you are using a graphical environment and do not
+ know how to access the Linux VT, here is how you do
+ it: press Ctrl+Alt+F1, if this does not open non-graphical
+ login screen, press Alt+Right until you get one. To
+ get back to graphical environment, hold down Alt+Right
+ until it appears.
+
+ Whilst unstickpixels may run on most systems
+ (although Mir and, by Wayland's design, Wayland
+ are not supported) this option is only known to
+ function on Linux.
+
+RATIONALE
+ Acer/Packard Bell is not willing to repair all defects on
+ my computer, but at least I can run this for several hours
+ and try to revive dead pixels. Playing back a video that is
+ already available on the Internet has some deficiencies:
+
+ * Requires a graphics card and video player that can
+ play back the video in full screen mode efficiently.
+
+ * Requires X or a video player than can play video
+ outside X efficiently.
+
+ * Requires the video to be downloaded if it was uploaded
+ on Youtube, because Youtube does not properly support
+ full screen.
+
+ * One video playback is required per defective monitor.
+
+SEE ALSO
+ No similar or otherwise related programs known, please
+ file a bug if you know any.
+
+ There are some similar works in form of videos available
+ on the Internet.
+
+ Full documentation available locally via: info '(unstickpixels)'
diff --git a/TODO b/TODO
index 7e2c639..4fb12c3 100644
--- a/TODO
+++ b/TODO
@@ -1,5 +1,4 @@
-Update readme
Update manual
-Write makefile
+Write man page
Update build system