diff options
author | gregory guy <gregory-tde@laposte.net> | 2020-12-03 14:30:02 +0100 |
---|---|---|
committer | gregory guy <gregory-tde@laposte.net> | 2021-01-12 17:01:05 +0100 |
commit | 40399f389dae6b1ee9a628fb1167c186be62179a (patch) | |
tree | 6bb3b5fe0e716f7170707c280b5b522bbf90a5a2 /doc/man/twin4 | |
parent | c18ead073e9f0cd522273df5a4218c33875300c5 (diff) | |
download | tdegames-40399f389dae6b1ee9a628fb1167c186be62179a.tar.gz tdegames-40399f389dae6b1ee9a628fb1167c186be62179a.zip |
Add man pages, taken from the Debian packaging.
Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc/man/twin4')
-rw-r--r-- | doc/man/twin4/CMakeLists.txt | 7 | ||||
-rw-r--r-- | doc/man/twin4/twin4.6 | 133 | ||||
-rw-r--r-- | doc/man/twin4/twin4proc.6 | 119 |
3 files changed, 259 insertions, 0 deletions
diff --git a/doc/man/twin4/CMakeLists.txt b/doc/man/twin4/CMakeLists.txt new file mode 100644 index 00000000..8f52e818 --- /dev/null +++ b/doc/man/twin4/CMakeLists.txt @@ -0,0 +1,7 @@ +file( GLOB _mans RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.6 ) + +INSTALL( + FILES ${_mans} + DESTINATION ${MAN_INSTALL_DIR}/man6 + COMPONENT doc +) diff --git a/doc/man/twin4/twin4.6 b/doc/man/twin4/twin4.6 new file mode 100644 index 00000000..9c1addc5 --- /dev/null +++ b/doc/man/twin4/twin4.6 @@ -0,0 +1,133 @@ +.TH TWIN4 6 + +.SH NAME +twin4 \- Connect Four clone for TDE + +.SH SYNOPSIS +.B twin4 +.I [Qt-options] [TDE-options] + +.SH DESCRIPTION +Four wins is a game for two players. Each player is represented by a +color (yellow and red). The goal of the game is to get four connected +pieces of your color into a row, column or any diagonal. This is done +by placing one of your pieces into any of the seven columns. A piece +will begin to fill a column from the bottom, i.e. it will fall down +until it reaches the ground level or another stone. After a move is +done it is the turn of the other player. This is repeated until the +game is over, i.e. one of the players has four pieces in a row, column +or diagonal or no more moves are possible because the board is filled. + +.SH GENERIC OPTIONS +.TP +.B \-\-help +Show help about options. +.TP +.B \-\-help-qt +Show Qt specific options. +.TP +.B \-\-help-tde +Show TDE specific options. +.TP +.B \-\-help-all +Show all options. +.TP +.B \-\-author +Show author information. +.TP +.B \-\-version +Show version information. +.TP +.B \-\-license +Show license information. + +.SH QT OPTIONS +.TP +.B \-\-display \fI<displayname>\fB +Use the X-server display `displayname'. +.TP +.B \-\-session \fI<sessionId>\fB +Restore the application for the given `sessionId'. +.TP +.B \-\-cmap +Causes the application to install a private color map on an 8\-bit +display. +.TP +.B \-\-ncols \fI<count>\fB +Limits the number of colors allocated in the color cube on an 8\-bit +display, if the application is using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit \-nograb, use \-dograb +to override. +.TP +.B \-\-sync +Switches to synchronous mode for debugging. +.TP +.B \-\-fn, \-\-font \fI<fontname>\fB +Defines the application font. +.TP +.B \-\-bg, \-\-background \fI<color>\fB +Sets the default background color and an application palette (light +and dark shades are calculated). +.TP +.B \-\-fg, \-\-foreground \fI<color>\fB +Sets the default foreground color. +.TP +.B \-\-btn, \-\-button \fI<color>\fB +Sets the default button color. +.TP +.B \-\-name \fI<name>\fB +Sets the application name. +.TP +.B \-\-title \fI<title>\fB +Sets the application title (caption). +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on an 8-bit display. +.TP +.B \-\-inputstyle \fI<inputstyle>\fB +Sets XIM (X Input Method) input style. Possible values are +\fIonthespot\fP, \fIoverthespot\fP, \fIoffthespot\fP and \fIroot\fP. +.TP +.B \-\-im \fI<XIM server>\fB +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. + +.SH TDE OPTIONS +.TP +.B \-\-caption \fI<caption>\fB +Use `caption' as name in the titlebar. +.TP +.B \-\-icon \fI<icon>\fB +Use `icon' as the application icon. +.TP +.B \-\-miniicon \fI<icon>\fB +Use `icon' as the icon in the titlebar. +.TP +.B \-\-dcopserver \fI<server>\fB +Use the DCOP Server specified by `server'. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.B \-\-style \fI<style>\fB +Sets the application GUI style. +.TP +.B \-\-geometry \fI<geometry>\fB +Sets the client geometry of the main widget. + +.SH SEE ALSO +More detailed user documentation is available from +.BR help:/twin4 +(either enter this URL into \fBkonqueror\fP, or run `khelpcenter +help:/twin4'). diff --git a/doc/man/twin4/twin4proc.6 b/doc/man/twin4/twin4proc.6 new file mode 100644 index 00000000..354e9884 --- /dev/null +++ b/doc/man/twin4/twin4proc.6 @@ -0,0 +1,119 @@ +.TH TWIN4PROC 6 + +.SH NAME +twin4proc \- AI backend for twin4 + +.SH DESCRIPTION +This program is used internally by twin4. Users should not run it +directly. + +.SH GENERIC OPTIONS +.TP +.B \-\-help +Show help about options. +.TP +.B \-\-help-qt +Show Qt specific options. +.TP +.B \-\-help-tde +Show TDE specific options. +.TP +.B \-\-help-all +Show all options. +.TP +.B \-\-author +Show author information. +.TP +.B \-\-version +Show version information. +.TP +.B \-\-license +Show license information. + +.SH QT OPTIONS +.TP +.B \-\-display \fI<displayname>\fB +Use the X-server display `displayname'. +.TP +.B \-\-session \fI<sessionId>\fB +Restore the application for the given `sessionId'. +.TP +.B \-\-cmap +Causes the application to install a private color map on an 8\-bit +display. +.TP +.B \-\-ncols \fI<count>\fB +Limits the number of colors allocated in the color cube on an 8\-bit +display, if the application is using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells Qt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit \-nograb, use \-dograb +to override. +.TP +.B \-\-sync +Switches to synchronous mode for debugging. +.TP +.B \-\-fn, \-\-font \fI<fontname>\fB +Defines the application font. +.TP +.B \-\-bg, \-\-background \fI<color>\fB +Sets the default background color and an application palette (light +and dark shades are calculated). +.TP +.B \-\-fg, \-\-foreground \fI<color>\fB +Sets the default foreground color. +.TP +.B \-\-btn, \-\-button \fI<color>\fB +Sets the default button color. +.TP +.B \-\-name \fI<name>\fB +Sets the application name. +.TP +.B \-\-title \fI<title>\fB +Sets the application title (caption). +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on an 8-bit display. +.TP +.B \-\-inputstyle \fI<inputstyle>\fB +Sets XIM (X Input Method) input style. Possible values are +\fIonthespot\fP, \fIoverthespot\fP, \fIoffthespot\fP and \fIroot\fP. +.TP +.B \-\-im \fI<XIM server>\fB +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. + +.SH TDE OPTIONS +.TP +.B \-\-caption \fI<caption>\fB +Use `caption' as name in the titlebar. +.TP +.B \-\-icon \fI<icon>\fB +Use `icon' as the application icon. +.TP +.B \-\-miniicon \fI<icon>\fB +Use `icon' as the icon in the titlebar. +.TP +.B \-\-dcopserver \fI<server>\fB +Use the DCOP Server specified by `server'. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.B \-\-style \fI<style>\fB +Sets the application GUI style. +.TP +.B \-\-geometry \fI<geometry>\fB +Sets the client geometry of the main widget. + +.SH SEE ALSO +.BR twin4 (6). |