From 40399f389dae6b1ee9a628fb1167c186be62179a Mon Sep 17 00:00:00 2001 From: gregory guy Date: Thu, 3 Dec 2020 14:30:02 +0100 Subject: Add man pages, taken from the Debian packaging. Signed-off-by: gregory guy --- doc/man/knetwalk/CMakeLists.txt | 7 ++ doc/man/knetwalk/knetwalk.6 | 145 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 152 insertions(+) create mode 100644 doc/man/knetwalk/CMakeLists.txt create mode 100644 doc/man/knetwalk/knetwalk.6 (limited to 'doc/man/knetwalk') diff --git a/doc/man/knetwalk/CMakeLists.txt b/doc/man/knetwalk/CMakeLists.txt new file mode 100644 index 00000000..8f52e818 --- /dev/null +++ b/doc/man/knetwalk/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/knetwalk/knetwalk.6 b/doc/man/knetwalk/knetwalk.6 new file mode 100644 index 00000000..983bed33 --- /dev/null +++ b/doc/man/knetwalk/knetwalk.6 @@ -0,0 +1,145 @@ +.TH KNETWALK 6 + +.SH NAME +knetwalk \- A game for system administrators + +.SH SYNOPSIS +.B knetwalk +.I [Qt-options] [TDE-options] [options] + +.SH DESCRIPTION +\fBKNetwalk\fP presents the player with a rectangular grid containing +a server, several clients, and pieces of wire. The object of the game +is to rotate these elements until every client is connected to the +server, and no wires are left unconnected. Optionally, you can try to +get a high score by minimizing the number of rotations needed. + +Left clicking on a square rotates it counterclockwise, while right +clicking rotates it clockwise. Middle clicking on a square marks the +square with a blue background and prevents you from rotating it unless +you middle click again to unmark it; this can be very useful for marking +squares which you know are in the correct orientation. + +.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\fB +Use the X-server display `displayname'. +.TP +.B \-\-session \fI\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\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\fB +Defines the application font. +.TP +.B \-\-bg, \-\-background \fI\fB +Sets the default background color and an application palette (light +and dark shades are calculated). +.TP +.B \-\-fg, \-\-foreground \fI\fB +Sets the default foreground color. +.TP +.B \-\-btn, \-\-button \fI\fB +Sets the default button color. +.TP +.B \-\-name \fI\fB +Sets the application name. +.TP +.B \-\-title \fI\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 PROGRAM OPTIONS +.TP +.B --Novice +Start in novice mode. In this mode, you get a 5x5 grid. +.TP +.B --Normal +Start in normal mode. In this mode, you get a 7x7 grid. +.TP +.B --Expert +Start in expert mode. In this mode, you get a 9x9 grid. +.TP +.B --Master +Start in master mode. In this mode, you get a 9x9 grid laid out on +a torus, so that a wire leading off one edge can connect to a wire on +the opposite edge. -- cgit v1.2.1