aboutsummaryrefslogtreecommitdiffstats
path: root/doc/info/chap/invoking.texinfo
diff options
context:
space:
mode:
authorMattias Andrée <maandree@member.fsf.org>2015-12-27 16:19:42 +0100
committerMattias Andrée <maandree@member.fsf.org>2015-12-27 16:19:42 +0100
commit7485a2c1fb69e6edb561e83ae65598abf6caef4e (patch)
tree04b91b839f9d22ef3d4633979dcc108765518ca0 /doc/info/chap/invoking.texinfo
parentm (diff)
downloadunstickpixels-7485a2c1fb69e6edb561e83ae65598abf6caef4e.tar.gz
unstickpixels-7485a2c1fb69e6edb561e83ae65598abf6caef4e.tar.bz2
unstickpixels-7485a2c1fb69e6edb561e83ae65598abf6caef4e.tar.xz
update texinfo manual + update .gitignore
Signed-off-by: Mattias Andrée <maandree@member.fsf.org>
Diffstat (limited to 'doc/info/chap/invoking.texinfo')
-rw-r--r--doc/info/chap/invoking.texinfo41
1 files changed, 33 insertions, 8 deletions
diff --git a/doc/info/chap/invoking.texinfo b/doc/info/chap/invoking.texinfo
index 5545c4c..adfc866 100644
--- a/doc/info/chap/invoking.texinfo
+++ b/doc/info/chap/invoking.texinfo
@@ -1,14 +1,39 @@
@node Invoking
@chapter Invoking
-@emph{Do not use this if you have epilepsia}
+@emph{You must not run this program if you are epileptic.}
+Seek someone else how can do it for you.
-@command{unstickpixels} will not run in a graphical environment.
-If you are using a graphical environment and do not know how
-to access the Linux VT, here is how you do it: press @kbd{Ctrl+Alt+F1},
-if this does not open non-graphical login screen, press @kbd{Alt+Right}
-until you get one. To get back to graphical environment, hold
-down @kbd{Alt+Right} until it appears.
+@command{unstickpixels} recognises the following options
+@table @option
+@item -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.
-Run @command{unstickpixels} without arguments.
+If you are using a graphical environment and do not know
+how to access the Linux VT, here is how you do it: press
+@kbd{Ctrl+Alt+F1}, if this does not open non-graphical
+login screen, press @kbd{Alt+Right} until you get one.
+To get back to graphical environment, hold down
+@kbd{Alt+Right} until it appears.
+
+Whilst @command{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.
+@end table
+
+@command{unstickpixels} accepts at most one non-option
+argument. This argument is the number of milliseconds
+to sleep between each color switch. This may be useful
+to optimise the effect. It may help to sleep 10 milliseconds
+between each colour switch rather than switching the
+colours as fast as possible.
+
+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.