diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | doc/en/index.docbook (renamed from doc/help_en.docbook) | 0 | ||||
| -rw-r--r-- | doc/fr/index.docbook (renamed from doc/help_fr.docbook) | 28 | ||||
| -rw-r--r-- | doc/man/CMakeLists.txt | 5 | ||||
| -rw-r--r-- | doc/man/knights.1 | 154 |
5 files changed, 176 insertions, 12 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..6d0aa9f --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1 @@ +tde_auto_add_subdirectories( ) diff --git a/doc/help_en.docbook b/doc/en/index.docbook index 6bc3be7..6bc3be7 100644 --- a/doc/help_en.docbook +++ b/doc/en/index.docbook diff --git a/doc/help_fr.docbook b/doc/fr/index.docbook index bd052bb..274c59a 100644 --- a/doc/help_fr.docbook +++ b/doc/fr/index.docbook @@ -8,24 +8,28 @@ <book lang="&language;"> <bookinfo> - <title -> </title> + <title> + The Knights Handbook + </title> <authorgroup> - <author -> </author> + <author> + <firstname>Troy</firstname> + <surname>Corbin Jr.</surname> + <affiliation> + <address> + <email>[email protected]</email> + </address> + </affiliation> + </author> <othercredit role="developer"> - <firstname ->Troy</firstname> - <surname ->Corbin Jr.</surname> + <firstname>Troy</firstname> + <surname>Corbin Jr.</surname> <affiliation> <address> - <email ->[email protected]</email> + <email>[email protected]</email> </address> </affiliation> - <contrib -></contrib> + <contrib>Developer</contrib> </othercredit> </authorgroup> <!-- TRANS:ROLES_OF_TRANSLATORS --> diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 0000000..8512250 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES ${PROJECT_NAME}.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/knights.1 b/doc/man/knights.1 new file mode 100644 index 0000000..b62873a --- /dev/null +++ b/doc/man/knights.1 @@ -0,0 +1,154 @@ +.\" This file was generated by kdemangen.pl +.TH KNIGHTS 1 "Jun 2004" "Trinity Desktop Environment" "The Knights Chess Interface" +.SH NAME +knights +- The Knights Chess Interface +.SH SYNOPSIS +knights [Qt-options] [TDE-options] [options] [filename] +.SH DESCRIPTION +The Knights Chess Interface +.SH OPTIONS +.SS +.SS Arguments: +.TP +.B filename +A .pgn file to be loaded. +.SS Options: +.B -d <path> +Specify the location of your Knights data directory. +.SS 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 -v, --version +Show version information +.TP +.B --license +Show license information +.TP +.B -- +End of options +.SS +.SS TDE options: +.TP +.B --caption <caption> +Use 'caption' as name in the titlebar. +.TP +.B --icon <icon> +Use 'icon' as the application icon. +.TP +.B --miniicon <icon> +Use 'icon' as the icon in the titlebar. +.TP +.B --config <filename> +Use alternative configuration file. +.TP +.B --dcopserver <server> +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 <style> +sets the application GUI style. +.TP +.B --geometry <geometry> +sets the client geometry of the main widget. +.SS +.SS Qt options: +.TP +.B --display <displayname> +Use the X-server display 'displayname'. +.TP +.B --session <sessionId> +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 <count> +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 <fontname> +defines the application font. +.TP +.B --bg, --background <color> +sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.B --fg, --foreground <color> +sets the default foreground color. +.TP +.B --btn, --button <color> +sets the default button color. +.TP +.B --name <name> +sets the application name. +.TP +.B --title <title> +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 <inputstyle> +sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root. +.TP +.B --im <XIM server> +set XIM server. +.TP +.B --noxim +disable XIM. +.TP +.B --reverse +mirrors the whole layout of widgets. +.SS + +.SH SEE ALSO +Full user documentation is available through the TDE Help Center. You can also enter the URL +.BR help:/knights/ +directly into konqueror or you can run +.BR "`khelpcenter help:/knights/'" +from the command-line. +.br +.SH AUTHORS +.nf +Troy Corbin Jr. <[email protected]> +.br +Alexander Wels <[email protected]> +.br + |