Add screen blackout to qchess

[progcomp2013.git] / qchess / data / help.txt

diff --git a/qchess/data/help.txt b/qchess/data/help.txt
index c0a8b6f..8911f3b 100644 (file)
--- a/qchess/data/help.txt
+++ b/qchess/data/help.txt
@@ -60,17 +60,37 @@ OPTIONS
                Print this page
        
        --graphics
                Print this page
        
        --graphics

-               Disable/Enable the GUI
+               Enable the GUI

 
                If graphics are enabled (default), then the user will be prompted to choose any of the two players not supplied as arguments.
 
                If graphics are enabled (default), then the user will be prompted to choose any of the two players not supplied as arguments.

+
+       --no-graphics
+               Disable the GUI
+               

                
                

+       --reveal
+               If graphics are enabled, the two states for pieces will always be shown, regardless of whether both states have been revealed.
+               Note that this switch only affects the GUI and does not provide any information to agent players.
+
+               If graphics are disabled, has no effect.

 
 

-       --file[=filename]
+       --file[=filename][:events]

                Replay a game saved in file, or read from stdin if no filename given
                Replay a game saved in file, or read from stdin if no filename given

+               If a number of events is supplied, the game will advance that many events before stopping.
+
+               If no players are given, the GUI will NOT ask for player selections.
+               The game will exit after the replay finishes. Events in the replay will be subject to the normal delay (see --delay).
+
+               If black and white players are supplied, the game will continue using those players.
+               In this case, there will be no delays between events in the replay (the game starts at the end of the replay)
+
+               (We hope that) this feature will be useful for comparing how different versions of an agent respond to the same situation.

 
        --log[=filename]
                Log moves to a file or stdout if no filename given
 
 
        --log[=filename]
                Log moves to a file or stdout if no filename given
 

+               
+

        --delay[=time]
                The game pauses between moves so that it can be followed by a human observer.
                This option can be used to change the delay. If no time is given, the delay is disabled.
        --delay[=time]
                The game pauses between moves so that it can be followed by a human observer.
                This option can be used to change the delay. If no time is given, the delay is disabled.


@@ -83,6 +103,14 @@ OPTIONS
                If no time is given, the timeout is disabled.
 
                By default the timeout is disabled.
                If no time is given, the timeout is disabled.
 
                By default the timeout is disabled.

+               
+       --blackout[=time]
+               Setting a blackout time will cause the display to become black if the mouse is not moved and no keys or buttons are pressed.
+               If no time is given, the blackout time is disabled.
+               
+               By default the blackout is disabled.
+               
+               This switch was introduced for entirely obscure purposes.

 
        --classical
                If this option is used, the game will treat pieces "classically", ie: as in standard chess.
 
        --classical
                If this option is used, the game will treat pieces "classically", ie: as in standard chess.