gameclock.6 2.84 KB
Newer Older
1 2 3 4
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
5
.TH GAMECLOCK 6 "August 13, 2008"
6 7 8 9 10 11 12 13 14 15 16 17 18
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
19
gameclock \- a simple game clock
20
.SH SYNOPSIS
21
.B gameclock
22 23
.SH DESCRIPTION
This manual page documents briefly the
24
.B gameclock
25 26 27 28 29
command.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
30
\fBgameclock\fP is a simple application designed to track the time
31 32
spent thinking by the players during a chess game. Various ways of
tracking time are supported, with only `countdown' (aka `blitz') and
33
`fischer' for now. The graphical interface is keyboard driven and is
34 35
intended to be minimal and simple. The code is made to be extensible
to other game types.
36 37
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
Antoine Beaupré's avatar
Antoine Beaupré committed
38
options starting with two dashes (\-\-).
39 40 41
A summary of options is included below.
.TP
.B \-h, \-\-help
Antoine Beaupré's avatar
Antoine Beaupré committed
42
Show summary of options. This includes the program's version and license.
43 44
.TP
.B \-v, \-\-verbose
Antoine Beaupré's avatar
Antoine Beaupré committed
45
Show progress information to standard output. More `\-v' will display
46
more information: timestamps then game state engine.
47 48 49
.TP
.B \-f, \-\-fullscreen
Start the application in fullscreen mode.
50 51 52 53 54 55 56
.SH KEYBINDINGS
Most of the interface is keyboard-driven, apart from the initial clock
and game configuration.
.TP
.B space
start the game / end turn
.TP
57 58 59
.B shift keys
end the turn, but only for the appropriate side (left or right side)
.TP
60 61 62
.B p
pause game
.TP
63
.B control-r, escape
64 65 66
reset game - this resets all counters and clocks to the initial
configuration, use this to restart the game.
.TP
67 68 69
.B f
toggle the fullscreen mode
.TP
70 71
.B control-q
quit application
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
.SH THEMING
The look of
.B gameclock
can be customized fairly easily using GTK resource files. The clock
widgets are conveniently named to allow easy customizing. Take for
example the sample "Green" builtin theme:
.PP
.nf
style "clockui" {
  bg[NORMAL] = "black"
  fg[NORMAL] = "white"
  bg[SELECTED] = "red"
  fg[SELECTED] = "black"
  bg[ACTIVE] = "green"
  fg[ACTIVE] = "black"
}

widget "*.clockui.GtkEventBox" style "clockui"
widget "*.clockui.*Label" style "clockui"
.fi
92
.SH SEE ALSO
93 94
.BR xboard (1),
.BR http://gnomecoder.wordpress.com/chessclock/ .
95 96
.br
.SH AUTHOR
97
gameclock was written by Antoine Beaupré.