diff options
Diffstat (limited to 'doc/man')
59 files changed, 2479 insertions, 0 deletions
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 00000000..6f2b90f2 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,20 @@ +tde_conditional_add_subdirectory( BUILD_BLINKEN blinken ) +tde_conditional_add_subdirectory( BUILD_KALZIUM kalzium ) +tde_conditional_add_subdirectory( BUILD_KANAGRAM kanagram ) +tde_conditional_add_subdirectory( BUILD_KBRUCH kbruch ) +tde_conditional_add_subdirectory( BUILD_KEDUCA keduca ) +tde_conditional_add_subdirectory( BUILD_KGEOGRAPHY kgeography ) +tde_conditional_add_subdirectory( BUILD_KHANGMAN khangman ) +tde_conditional_add_subdirectory( BUILD_KIG kig ) +tde_conditional_add_subdirectory( BUILD_KITEN kiten ) +tde_conditional_add_subdirectory( BUILD_KLATIN klatin ) +tde_conditional_add_subdirectory( BUILD_KLETTRES klettres ) +tde_conditional_add_subdirectory( BUILD_KMPLOT kmplot ) +tde_conditional_add_subdirectory( BUILD_KPERCENTAGE kpercentage ) +tde_conditional_add_subdirectory( BUILD_KSTARS indi ) +tde_conditional_add_subdirectory( BUILD_KSTARS kstars ) +tde_conditional_add_subdirectory( BUILD_KTOUCH ktouch ) +tde_conditional_add_subdirectory( BUILD_KTURTLE kturtle ) +tde_conditional_add_subdirectory( BUILD_KVERBOS kverbos ) +tde_conditional_add_subdirectory( BUILD_KVOCTRAIN kvoctrain ) +tde_conditional_add_subdirectory( BUILD_KWORDQUIZ kwordquiz ) diff --git a/doc/man/blinken/CMakeLists.txt b/doc/man/blinken/CMakeLists.txt new file mode 100644 index 00000000..9b8f71ca --- /dev/null +++ b/doc/man/blinken/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES blinken.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/blinken/blinken.1 b/doc/man/blinken/blinken.1 new file mode 100644 index 00000000..745feac0 --- /dev/null +++ b/doc/man/blinken/blinken.1 @@ -0,0 +1,52 @@ +.\" 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) +.TH BLINKEN 1 "December 13, 2005" +.\" 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 +blinken \- electronic memory game for TDE +.SH SYNOPSIS +.B blinken +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBBlinken\fP is based on an electronic game released in 1978 called +``Simon Says'', which challenges players to remember sequences of +increasing length. On the face of the device, there are 4 different +color buttons, each with its own distinctive sound. These buttons +light up randomly, creating the sequence that the player must then +recall. If the player is successful in remembering the sequence of +lights in the correct order, they advance to the next stage, where an +identical sequence with one extra step is presented. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIblinken \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/blinken/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/blinken/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/blinken/\fP. +.SH AUTHOR +Blinken was written by Albert Astals Cid <tsdgeos@terra.es> and +Danny Allen <danny@dannyallen.co.uk>. +.br +This manual page was prepared by Daniel Schepler <schepler@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/CMakeLists.txt b/doc/man/indi/CMakeLists.txt new file mode 100644 index 00000000..451eb394 --- /dev/null +++ b/doc/man/indi/CMakeLists.txt @@ -0,0 +1,17 @@ +INSTALL( + FILES + celestrongps.1 + indiserver.1 + lx200classic.1 + temma.1 + lx200_16.1 + lx200generic.1 + v4ldriver.1 + fliccd.1 + lx200autostar.1 + lx200gps.1 + v4lphilips.1 + + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/indi/celestrongps.1 b/doc/man/indi/celestrongps.1 new file mode 100644 index 00000000..45adf8fd --- /dev/null +++ b/doc/man/indi/celestrongps.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH CELESTRONGPS 1 "March 16, 2005" +.\" 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 +celestrongps \- Celestron GPS driver for INDI telescope control +.SH SYNOPSIS +.B celestrongps +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBcelestrongps\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/fliccd.1 b/doc/man/indi/fliccd.1 new file mode 100644 index 00000000..3a0a73c0 --- /dev/null +++ b/doc/man/indi/fliccd.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH FLICCD 1 "March 16, 2005" +.\" 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 +fliccd \- Finger Lakes Instruments CCD driver for INDI telescope control +.SH SYNOPSIS +.B v4ldriver +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBfliccd\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/indiserver.1 b/doc/man/indi/indiserver.1 new file mode 100644 index 00000000..d11ee6dc --- /dev/null +++ b/doc/man/indi/indiserver.1 @@ -0,0 +1,123 @@ +.\" 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) +.TH INDISERVER 1 "October 16, 2004" +.\" 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 +indiserver \- INDI server for telescope control under KStars +.SH SYNOPSIS +.B indiserver +[ \fB\-p\fP \fIport\fP ] +[ \fB\-r\fP \fIattempts\fP ] +[ \fB\-vv\fP ] +\fIdriver\fP [ \fIdriver\fP ... ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBindiserver\fP is a server that sits between the +KStars user interface and the low-level hardware drivers. +.PP +The INDI server is a network server, in that either local or remote clients +may connect to it to control astronomical instruments. The INDI server must +be running on the machine that is physically connected to the +astronomical instruments. +.PP +Note that there is no need for you to run the INDI server directly. Using +the KStars device manager, you can set up astronomical instruments and start +or stop the INDI server all from within KStars. +.PP +You may however choose to run the INDI server manually from the command +line. In this case you must pass the names of one or more drivers for +individual astronomical instruments. The current list of available +drivers is: +.PP +.RS +celestrongps (Celestron GPS) +.br +fliccd (Finger Lakes Instruments CCD) +.br +lx200_16 (LX200 16") +.br +lx200autostar (LX200 Autostar) +.br +lx200classic (LX200 Classic) +.br +lx200generic (LX200 Generic) +.br +lx200gps (LX200 GPS) +.br +temma (Temma Takahashi) +.br +v4ldriver (Video4Linux Generic) +.br +v4lphilips (Philips Webcam) +.RE +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-p\fP \fIport\fP +Specify the port to listen on (defaults to 7624). +.TP +\fB\-r\fP \fIattempts\fP +Specify the maximum number of restart attempts for each driver (defaults to 2). +.TP +\fB\-vv\fP +Write more verbose output to stderr. +.SH EXAMPLE +To start an INDI server running an LX200 GPS driver and listening to +connections on port 8000: +.PP +.RS +\fIprompt$\fP indiserver -p 8000 lx200gps +.RE +.SH SEE ALSO +.BR celestrongps (1), +.BR fliccd (1), +.BR lx200_16 (1), +.BR lx200autostar (1), +.BR lx200classic (1), +.BR lx200generic (1), +.BR lx200gps (1), +.BR kstars (1), +.BR temma (1), +.BR v4ldriver (1), +.BR v4lphilips (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/lx200_16.1 b/doc/man/indi/lx200_16.1 new file mode 100644 index 00000000..d169ebf1 --- /dev/null +++ b/doc/man/indi/lx200_16.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH LX200_16 1 "March 16, 2005" +.\" 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 +lx200_16 \- LX200 16" driver for INDI telescope control +.SH SYNOPSIS +.B lx200_16 +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBlx200_16\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/lx200autostar.1 b/doc/man/indi/lx200autostar.1 new file mode 100644 index 00000000..b13bbffe --- /dev/null +++ b/doc/man/indi/lx200autostar.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH LX200AUTOSTAR 1 "March 16, 2005" +.\" 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 +lx200autostar \- LX200 Autostar driver for INDI telescope control +.SH SYNOPSIS +.B lx200autostar +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBlx200autostar\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/lx200classic.1 b/doc/man/indi/lx200classic.1 new file mode 100644 index 00000000..a37527a8 --- /dev/null +++ b/doc/man/indi/lx200classic.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH LX200CLASSIC 1 "March 16, 2005" +.\" 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 +lx200classic \- LX200 Classic driver for INDI telescope control +.SH SYNOPSIS +.B lx200classic +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBlx200classic\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/lx200generic.1 b/doc/man/indi/lx200generic.1 new file mode 100644 index 00000000..b37ccfee --- /dev/null +++ b/doc/man/indi/lx200generic.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH LX200GENERIC 1 "March 16, 2005" +.\" 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 +lx200generic \- LX200 Generic driver for INDI telescope control +.SH SYNOPSIS +.B lx200generic +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBlx200generic\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/lx200gps.1 b/doc/man/indi/lx200gps.1 new file mode 100644 index 00000000..ea0d2fc8 --- /dev/null +++ b/doc/man/indi/lx200gps.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH LX200GPS 1 "March 16, 2005" +.\" 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 +lx200gps \- LX200 GPS driver for INDI telescope control +.SH SYNOPSIS +.B lx200gps +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBlx200gps\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/temma.1 b/doc/man/indi/temma.1 new file mode 100644 index 00000000..46b9e4ea --- /dev/null +++ b/doc/man/indi/temma.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH TEMMA 1 "March 16, 2005" +.\" 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 +temma \- Temma Takahashi driver for INDI telescope control +.SH SYNOPSIS +.B temma +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBtemma\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/v4ldriver.1 b/doc/man/indi/v4ldriver.1 new file mode 100644 index 00000000..9220a16b --- /dev/null +++ b/doc/man/indi/v4ldriver.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH V4LDRIVER 1 "March 16, 2005" +.\" 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 +v4ldriver \- Video4Linux Generic driver for INDI telescope control +.SH SYNOPSIS +.B v4ldriver +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBv4ldriver\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/indi/v4lphilips.1 b/doc/man/indi/v4lphilips.1 new file mode 100644 index 00000000..1553652d --- /dev/null +++ b/doc/man/indi/v4lphilips.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH V4LPHILIPS 1 "March 16, 2005" +.\" 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 +v4lphilips \- Philips Webcam driver for INDI telescope control +.SH SYNOPSIS +.B v4lphilips +[ \fB\-v\fP ] +.SH DESCRIPTION +KStars allows you to configure +and control astronomical instruments such as telescopes and focusers via +the INDI protocol. \fBv4lphilips\fP is a device driver for supporting +particular types of external hardware. +.PP +You should normally not need to run this driver directly. Instead you +should use KStars to configure and operate your astronomical instruments. +Most operations can be found under the Devices menu within KStars. +.PP +KStars will start the INDI server internally, and the INDI server will +in turn start this device driver. +.PP +Much more detailed information can be found in the KStars Handbook, as +described below. +.PP +KStars is a graphical desktop planetarium for TDE, and forms part of +the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-v\fP +Write more verbose output to stderr. +.SH SEE ALSO +.BR indiserver (1), +.BR kstars (1). +.PP +The KStars Handbook contains detailed information on how to use INDI for +telescope control. You can read this handbook in the TDE Help Centre. +Alternatively you can enter the URL +\fIhelp:/kstars/indi.html\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/indi.html\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/indi.html\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kalzium/CMakeLists.txt b/doc/man/kalzium/CMakeLists.txt new file mode 100644 index 00000000..937a8237 --- /dev/null +++ b/doc/man/kalzium/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kalzium.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kalzium/kalzium.1 b/doc/man/kalzium/kalzium.1 new file mode 100644 index 00000000..b01903f1 --- /dev/null +++ b/doc/man/kalzium/kalzium.1 @@ -0,0 +1,55 @@ +.\" 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) +.TH KALZIUM 1 "March 16, 2005" +.\" 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 +kalzium \- a chemistry teaching tool for TDE +.SH SYNOPSIS +.B kalzium +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKalzium\fP is a program which shows you the Periodic System of +Elements (PSE). You can use Kalzium to search for information about +the elements or to learn facts about the PSE. +.PP +Kalzium provides you with all kinds of information about the PSE. You +can look up lots of information about the elements and also use +visualisations to show them. +.PP +You can visualize the Periodic Table of the Elements by blocks, groups, +acidic behavior or different states of matter. You can also plot data for a +range of elements (weight, mean weight, density, IE1, IE2, electronegativity), +and you can go back in time to see what elements were known at a given date. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkalzium \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kalzium/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kalzium/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kalzium/\fP. +.SH AUTHOR +Kalzium was written by Carsten Niehaus <cniehaus@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kanagram/CMakeLists.txt b/doc/man/kanagram/CMakeLists.txt new file mode 100644 index 00000000..ef8290d9 --- /dev/null +++ b/doc/man/kanagram/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kanagram.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kanagram/kanagram.1 b/doc/man/kanagram/kanagram.1 new file mode 100644 index 00000000..0955cd6d --- /dev/null +++ b/doc/man/kanagram/kanagram.1 @@ -0,0 +1,53 @@ +.\" 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) +.TH KANAGRAM 1 "December 13, 2005" +.\" 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 +kanagram \- a letter order game for TDE +.SH SYNOPSIS +.B kanagram +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKAnagram\fP is a game that is based on the word/letter puzzles that the +author played as a child. A word is picked at random and displayed with +its letters in a messed order, with difficulty dependent on the chosen level. +You have an unlimited number of attempts, and scores are kept. +.PP +It is a very simply constructed game, with 3 dificulty levels of play. +It is fully customizable, allowing you to write in your own words and set +your own 'look and feel' of the game. It is aimed for children aged 10+ +because of the difficulty, but of course everyone is welcome to try. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkanagram \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kanagram/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kanagram/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kanagram/\fP. +.SH AUTHOR +KAnagram was written by Joshua Keel <joshuakeel@gmail.com> and +Danny Allen <danny@dannyallen.co.uk>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kbruch/CMakeLists.txt b/doc/man/kbruch/CMakeLists.txt new file mode 100644 index 00000000..315b557f --- /dev/null +++ b/doc/man/kbruch/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kbruch.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kbruch/kbruch.1 b/doc/man/kbruch/kbruch.1 new file mode 100644 index 00000000..68655e82 --- /dev/null +++ b/doc/man/kbruch/kbruch.1 @@ -0,0 +1,47 @@ +.\" 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) +.TH KBRUCH 1 "October 16, 2004" +.\" 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 +kbruch \- a fraction calculation teaching tool for TDE +.SH SYNOPSIS +.B kbruch +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKBruch\fP is a small program to practice calculating with fractions. +Different exercises are provided for this purpose. The program checks +the user's input and gives feedback. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkbruch \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kbruch/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kbruch/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kbruch/\fP. +.SH AUTHOR +KBruch was written by Sebastian Stein <seb.kde@hpfsc.de>, +Eva Brucherseifer <eva@kde.org> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/keduca/CMakeLists.txt b/doc/man/keduca/CMakeLists.txt new file mode 100644 index 00000000..3a78fe2d --- /dev/null +++ b/doc/man/keduca/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES keduca.1 keducabuilder.1 keduca-shrinker.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/keduca/keduca-shrinker.1 b/doc/man/keduca/keduca-shrinker.1 new file mode 100644 index 00000000..57de2841 --- /dev/null +++ b/doc/man/keduca/keduca-shrinker.1 @@ -0,0 +1,66 @@ +.\" 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) +.TH KEDUCA-SHRINKER 1 "September 1, 2005" +.\" 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 +keduca-shrinker \- extract a random sample from a large KEduca test file +.SH SYNOPSIS +.B keduca-shrinker +[ \fB\-o, \-\-output\fP=\fIfile\fP ] +[ \fB\-n, \-\-number\fP=\fInumber\fP ] +\fB\-i, \-\-input\fP=\fIfile\fP +.SH DESCRIPTION +\fBkeduca-shrinker\fP is a small program that reads a large KEduca +test file (.edu) and extracts a random sample of questions to create a +new smaller test file. For example, it could take a 100 question test +file as input and then output a test file with 20 questions selected at +random. +.PP +Note that the input file \fBmust\fP be uncompressed. When you save the +original test in the KEduca Editor, you should explicitly clear the "Compress +the file" checkbox. Otherwise keduca-shrinker will not be able to read it. +.PP +\fBKEduca\fP is a flash-card application for working with interactive +form-based tests. It is shipped as part of the official TDE edutainment +module. +.SH OPTIONS +.TP +\fB\-i, \-\-input\fP=\fIfile\fP +The large KEduca test file that should be read as input. +.TP +\fB\-o, \-\-output\fP=\fIfile\fP +The smaller KEduca test file that should be written as output. +This defaults to the input filename with \fI-shrinked\fP appended to its +base. For example, if the input file is \fIfoo.edu\fP then the +default output file is \fIfoo-shrinked.edu\fP. +.TP +\fB\-n, \-\-number\fP=\fInumber\fP +The number of random questions to select from the input file. +This defaults to 20. +.SH SEE ALSO +.BR keduca (1), +.BR keducabuilder (1). +.PP +This tool is not yet part of the official TDE edutainment module. +Its upstream site is +\fIhttps://gna.org/projects/keduca-shrinker/\fP. +.SH AUTHOR +keduca-shrinker was written by Mathieu Roy <yeupou@coleumes.org>. +It is licensed under the GNU General Public License (see the script +itself for details). +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/keduca/keduca.1 b/doc/man/keduca/keduca.1 new file mode 100644 index 00000000..634977aa --- /dev/null +++ b/doc/man/keduca/keduca.1 @@ -0,0 +1,53 @@ +.\" 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) +.TH KEDUCA 1 "September 1, 2005" +.\" 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 +keduca \- interactive form-based tests for TDE +.SH SYNOPSIS +.B keduca +.RI "[ " generic-options " ]" +[ \fIfile\fP ] +.SH DESCRIPTION +\fBKEduca\fP is a flash-card application that allows you to work with +interactive form-based tests. This application is used only for viewing +and taking these tests \- you can create and edit tests using the +related application \fBKEducaBuilder\fP. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkeduca \-\-help\fP. +.SH SEE ALSO +.BR keduca-shrinker (1), +.BR keducabuilder (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/keduca/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/keduca/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/keduca/\fP. +.SH AUTHOR +KEduca was written by Javier Campos <javi@asyris.org>, +Klas Kalass <klas@kde.org>, Henrique Pinto <henrique.pinto@kdemail.net> +and Anne-Marie Mahfouf <annma@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/keduca/keducabuilder.1 b/doc/man/keduca/keducabuilder.1 new file mode 100644 index 00000000..a6431a28 --- /dev/null +++ b/doc/man/keduca/keducabuilder.1 @@ -0,0 +1,53 @@ +.\" 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) +.TH KEDUCABUILDER 1 "September 1, 2005" +.\" 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 +keducabuilder \- test/exam editor for KEduca +.SH SYNOPSIS +.B keducabuilder +.RI "[ " generic-options " ]" +[ \fIfile\fP ] +.SH DESCRIPTION +\fBKEducaBuilder\fP is the test editor for \fBKEduca\fP, a flash-card +application for working with interactive form-based tests. +KEducaBuilder is used to create and edit these tests, whereas KEduca +itself can be used to view and take these tests. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkeduca \-\-help\fP. +.SH SEE ALSO +.BR keduca (1), +.BR keduca-shrinker (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/keduca/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/keduca/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/keduca/\fP. +.SH AUTHOR +KEduca was written by Javier Campos <javi@asyris.org>, +Klas Kalass <klas@kde.org>, Henrique Pinto <henrique.pinto@kdemail.net> +and Anne-Marie Mahfouf <annma@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kgeography/CMakeLists.txt b/doc/man/kgeography/CMakeLists.txt new file mode 100644 index 00000000..9d7f9033 --- /dev/null +++ b/doc/man/kgeography/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kgeography.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kgeography/kgeography.1 b/doc/man/kgeography/kgeography.1 new file mode 100644 index 00000000..451605d9 --- /dev/null +++ b/doc/man/kgeography/kgeography.1 @@ -0,0 +1,47 @@ +.\" 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) +.TH KGEOGRAPHY 1 "December 13, 2005" +.\" 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 +kgeography \- geography learning tool for TDE +.SH SYNOPSIS +.B kgeography +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKGeography\fP contains maps allowing you to learn various countries or + the political divisions of several countries. It has several modes, + including a map browser and games involving the names, capitals, or + flags of the map divisions. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkgeography \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kgeography/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kgeography/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kgeography/\fP. +.SH AUTHOR +KGeography was written by Albert Astals Cid <tsdgeos@terra.es>. +.br +This manual page was prepared by Daniel Schepler <schepler@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/khangman/CMakeLists.txt b/doc/man/khangman/CMakeLists.txt new file mode 100644 index 00000000..7b589ffa --- /dev/null +++ b/doc/man/khangman/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES khangman.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/khangman/khangman.1 b/doc/man/khangman/khangman.1 new file mode 100644 index 00000000..b130aa3c --- /dev/null +++ b/doc/man/khangman/khangman.1 @@ -0,0 +1,52 @@ +.\" 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) +.TH KHANGMAN 1 "October 16, 2004" +.\" 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 +khangman \- the classical hangman game for TDE +.SH SYNOPSIS +.B khangman +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKHangMan\fP is a game based on the well known hangman game. It is aimed +for children aged 6 and above. It has four levels of difficulty: +Animals (animals words), Easy, Medium and Hard. +.PP +A word is picked at random and the letters are hidden. You must guess +the word by trying one letter after another. Each time you guess a wrong +letter, a picture of a hangman is drawn. You must guess the word before +getting hanged! You have 10 tries. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkhangman \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/khangman/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/khangman/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/khangman/\fP. +.SH AUTHOR +KHangMan was written by Primoz Anzur <zerokode@gmx.net> and +Anne-Marie Mahfouf <annma@kde.org>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kig/CMakeLists.txt b/doc/man/kig/CMakeLists.txt new file mode 100644 index 00000000..2fc853a2 --- /dev/null +++ b/doc/man/kig/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kig.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kig/kig.1 b/doc/man/kig/kig.1 new file mode 100644 index 00000000..208ed916 --- /dev/null +++ b/doc/man/kig/kig.1 @@ -0,0 +1,81 @@ +.\" 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) +.TH KIG 1 "October 16, 2004" +.\" 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 +kig \- an interactive geometry program for TDE +.SH SYNOPSIS +.B kig +.RI "[ " generic-options " ]" +[ \fIURL\fP ] +.br +.B kig \-c, \-\-convert\-to\-native +[ \fB\-o, \-\-outfile\fP \fInative-file\fP ] +\fIfile\fP +.SH DESCRIPTION +\fBKig\fP is an application for interactive geometry. It is intended to +serve two purposes: +.PP +.RS +\- to allow students to interactively explore mathematical figures and +concepts using the computer; +.PP +\- to serve as a WYSIWYG tool for drawing mathematical figures and +including them in other documents. +.RE +.PP +With this program you can do geometry on a computer just like you would +on a blackboard in a classroom. However, the program allows you to move +and change parts of a geometrical drawing so that you can see how the other +parts change as a result. +.PP +Kig supports loci and user-defined macros. It also supports imports +and exports to/from foreign file formats including Cabri, Dr. Geo, KGeo, +KSeg and XFig. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +Below are the kig-specific options. +For a full summary of options, run \fIkig \-\-help\fP. +.TP +.B \-c, \-\-convert\-to\-native +Do not show a GUI. Instead, convert the specified file to the native +Kig format. The native Kig file will be written to standard output +unless \-\-outfile is passed (see below). +.TP +\fB\-o, \-\-outfile\fP \fInative-file\fP +Used with \-\-convert\-to\-native to specify where to save the newly +created Kig file. Note that a filename of '\-' means standard +output (which is also the default). +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kig/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kig/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kig/\fP. +.SH AUTHOR +Kig was written by Dominique Devriese <devriese@kde.org>, +Maurizio Paolini <paolini@dmf.bs.unicatt.it>, +Franco Pasquarelli <pasqui@dmf.bs.unicatt.it>, +Pino Toscano <toscano.pino@tiscali.it> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kiten/CMakeLists.txt b/doc/man/kiten/CMakeLists.txt new file mode 100644 index 00000000..7b7866e5 --- /dev/null +++ b/doc/man/kiten/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kiten.1 kitengen.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kiten/kiten.1 b/doc/man/kiten/kiten.1 new file mode 100644 index 00000000..8ae3bd3e --- /dev/null +++ b/doc/man/kiten/kiten.1 @@ -0,0 +1,52 @@ +.\" 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) +.TH KITEN 1 "May 12, 2003" +.\" 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 +kiten \- a Japanese reference/study tool for TDE +.SH SYNOPSIS +.B kiten +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKiten\fP is a Japanese reference and study tool for TDE. It is an +application with multiple functions. Firstly, it is a convenient +English to Japanese and Japanese to English dictionary. Secondly, it is +a Kanji dictionary, with multiple ways to look up specific characters. +Thirdly, it is a tool to help you learn Kanji. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkiten \-\-help\fP. +.SH SEE ALSO +.BR kitengen (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kiten/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kiten/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kiten/\fP. +.SH AUTHOR +Kiten was written by Jason Katz-Brown <jason@katzbrown.com>, +Jim Breen <jwb@csse.monash.edu.au> and +Neil Stevens <neil@qualityassistant.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kiten/kitengen.1 b/doc/man/kiten/kitengen.1 new file mode 100644 index 00000000..12b27ee1 --- /dev/null +++ b/doc/man/kiten/kitengen.1 @@ -0,0 +1,55 @@ +.\" 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) +.TH KITENGEN 1 "May 12, 2003" +.\" 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 +kitengen \- index table generator for Kiten +.SH SYNOPSIS +.B kitengen +.I input output.xjdx +.SH DESCRIPTION +\fBkitengen\fP is an index table generator for Kiten. +.PP +This program is for Kiten's internal use and should \fBnot\fP be run +directly. +.PP +\fBKiten\fP is a Japanese reference and study tool for TDE. It is an +application with multiple functions. Firstly, it is a convenient +English to Japanese and Japanese to English dictionary. Secondly, it is +a Kanji dictionary, with multiple ways to look up specific characters. +Thirdly, it is a tool to help you learn Kanji. +.PP +This application is part of the official TDE edutainment module. +.SH SEE ALSO +.BR kiten (1). +.PP +Full user documentation for Kiten is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kiten/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kiten/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kiten/\fP. +.SH AUTHOR +Kiten was written by Jason Katz-Brown <jason@katzbrown.com>, +Jim Breen <jwb@csse.monash.edu.au> and +Neil Stevens <neil@qualityassistant.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/klatin/CMakeLists.txt b/doc/man/klatin/CMakeLists.txt new file mode 100644 index 00000000..11a6862c --- /dev/null +++ b/doc/man/klatin/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES klatin.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/klatin/klatin.1 b/doc/man/klatin/klatin.1 new file mode 100644 index 00000000..35c59e21 --- /dev/null +++ b/doc/man/klatin/klatin.1 @@ -0,0 +1,56 @@ +.\" 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) +.TH KLATIN 1 "March 16, 2005" +.\" 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 +klatin \- an application to help revise/teach Latin +.SH SYNOPSIS +.B klatin +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKLatin\fP is a program to help revise Latin. There are three "sections" +in which different aspects of the language can be revised. These are the +vocabulary, grammar and verb testing sections. In addition there is a +set of revision notes that can be used for self-guided revision. +.PP +In the vocabulary section an XML file is loaded containing various +words and their local language translations. KLatin asks you what each +of these words translate into. The questions take place in a +multiple-choice environment. +.PP +In the grammar and verb sections KLatin asks for a particular part of a +noun or a verb, such as the "ablative singular", or the "1st person +indicative passive plural", and is not multiple choice. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIklatin \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/klatin/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/klatin/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/klatin/\fP. +.SH AUTHOR +KLatin was written by George Wright <gwright@kde.org> and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/klettres/CMakeLists.txt b/doc/man/klettres/CMakeLists.txt new file mode 100644 index 00000000..76b03538 --- /dev/null +++ b/doc/man/klettres/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES klettres.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/klettres/klettres.1 b/doc/man/klettres/klettres.1 new file mode 100644 index 00000000..6f6a3177 --- /dev/null +++ b/doc/man/klettres/klettres.1 @@ -0,0 +1,50 @@ +.\" 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) +.TH KLETTRES 1 "March 16, 2005" +.\" 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 +klettres \- a foreign alphabet tutor for TDE +.SH SYNOPSIS +.B klettres +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKLettres\fP is an application specially designed to help the user to +learn the alphabet in a new language and then to learn to read simple +syllables. The user can be a young child aged from two and a half or an +adult that wants to learn the basics of a foreign language. +.PP +Seven languages are currently available: Czech, Danish, Dutch, English, +French, Italian and Slovak. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIklettres \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/klettres/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/klettres/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/klettres/\fP. +.SH AUTHOR +KLettres was written by Anne-Marie Mahfouf <annma@kde.org> and many others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kmplot/CMakeLists.txt b/doc/man/kmplot/CMakeLists.txt new file mode 100644 index 00000000..8ae09555 --- /dev/null +++ b/doc/man/kmplot/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kmplot.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kmplot/kmplot.1 b/doc/man/kmplot/kmplot.1 new file mode 100644 index 00000000..aa8e4cb5 --- /dev/null +++ b/doc/man/kmplot/kmplot.1 @@ -0,0 +1,58 @@ +.\" 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) +.TH KMPLOT 1 "March 16, 2005" +.\" 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 +kmplot \- a mathematical function plotter for TDE +.SH SYNOPSIS +.B kmplot +.RI "[ " generic-options " ]" +[ \fIURL\fP ] +.SH DESCRIPTION +\fBKmPlot\fP is a mathematical function plotter for TDE. +It has a powerful built-in parser. You can plot different functions +simultaneously and combine them to build new functions. +.PP +KmPlot supports parametric functions and functions in polar +coordinates. Several grid modes are supported. Plots may be printed +with high precision in the correct scale. +.PP +KmPlot also provides some numerical and visual features, like +filling and calculating the area between the plot and the first axis, +finding maximum and minimum values, +changing function parameters dynamically and +plotting derivatives and integral functions. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkmplot \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kmplot/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kmplot/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kmplot/\fP. +.SH AUTHOR +KmPlot was written by Klaus-Dieter Moeller <tdmoeller@foni.net>, +Matthias Messmer <bmlmessmer@web.de> and Fredrik Edemar <f_edemar@linux.se>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kpercentage/CMakeLists.txt b/doc/man/kpercentage/CMakeLists.txt new file mode 100644 index 00000000..ca578f95 --- /dev/null +++ b/doc/man/kpercentage/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kpercentage.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kpercentage/kpercentage.1 b/doc/man/kpercentage/kpercentage.1 new file mode 100644 index 00000000..26aceb23 --- /dev/null +++ b/doc/man/kpercentage/kpercentage.1 @@ -0,0 +1,50 @@ +.\" 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) +.TH KPERCENTAGE 1 "May 12, 2003" +.\" 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 +kpercentage \- a percentage calculation teaching tool for TDE +.SH SYNOPSIS +.B kpercentage +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKPercentage\fP is a small math application that will help pupils to +improve their skills in calculating percentages. +.PP +There is a special training section for the three basic tasks. Finally +the pupil can select a random mode, in which all three tasks are mixed +randomly. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkpercentage \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kpercentage/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kpercentage/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kpercentage/\fP. +.SH AUTHOR +KPercentage was written by Matthias Messmer <bmlmessmer@web.de>, +Carsten Niehaus <cniehaus@gmx.de> and Robert Gogolok <mail@robert-gogolok.de>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kstars/CMakeLists.txt b/doc/man/kstars/CMakeLists.txt new file mode 100644 index 00000000..d169cb9b --- /dev/null +++ b/doc/man/kstars/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kstars.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kstars/kstars.1 b/doc/man/kstars/kstars.1 new file mode 100644 index 00000000..d6cce79b --- /dev/null +++ b/doc/man/kstars/kstars.1 @@ -0,0 +1,117 @@ +.\" 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) +.TH KSTARS 1 "March 16, 2005" +.\" 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 +kstars \- a desktop planetarium for TDE +.SH SYNOPSIS +.B kstars +.RI "[ " generic-options " ]" +[ \fB\-\-date\fP \fIdate-and-time\fP ] +[ \fB\-\-paused\fP ] +.PP +.B kstars \fB\-\-dump\fP +[ \fB\-\-filename\fP \fIimage-file\fP ] +[ \fB\-\-height\fP \fIpixels\fP ] [ \fB\-\-width\fP \fIpixels\fP ] +[ \fB\-\-date\fP \fIdate-and-time\fP ] +[ \fB\-\-script\fP \fIscript-file\fP ] +.SH DESCRIPTION +\fBKStars\fP is a graphical desktop planetarium for TDE. It depicts an +accurate simulation of the night sky, including stars, constellations, +star clusters, nebulae, galaxies, all planets, the Sun, the Moon, +comets and asteroids. You can see the sky as it appears from any +location on Earth, on any date. +.PP +The user interface is highly intuitive and flexible. The display can +be panned and zoomed with the mouse, and you can easily identify +objects and track their motion across the sky. KStars includes many +powerful features, yet the interface is clean and simple and fun to use. +.PP +Normally KStars launches a full graphical user interface. By passing the +\fB\-\-dump\fP option, you can make KStars dump an image of the sky to +a graphics file and exit immediately without launching a graphical user +interface at all. Several other options are available to control +precisely how this image is dumped. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +Below are the kstars-specific options. +For a full summary of options, run \fIkstars \-\-help\fP. +.PP +Options that can be used when starting the full graphical user interface +are as follows. +.TP +\fB\-\-date\fP \fIdate-and-time\fP +Starts with the simulation clock set to the given date and time (default is +current date and time). +.TP +\fB\-\-paused\fP +Starts with the simulation clock paused. +.PP +Options that can be used when dumping an image of the sky are as +follows. +.TP +\fB\-\-dump\fP +Dumps the sky image to a graphics file and exits immediately. +Several other options (described below) are available to control +precisely how the image is dumped. +.TP +\fB\-\-date\fP \fIdate-and-time\fP +Specifies the date and time for the sky image to dump (default is +current date and time). +.TP +\fB\-\-filename\fP \fIimage-file\fP +Dumps the sky image to the given file (default is \fIkstars.png\fP). +.TP +\fB\-\-height\fP \fIpixels\fP +Specifies the height of the sky image to dump (default is 480). +.TP +\fB\-\-script\fP \fIscript-file\fP +Specifies a DCOP script to run before the sky image is dumped. +The script can be used to set where the image is pointing, set the +geographic location, set the time and date, change the zoom level, and +adjust other view options. +.br +KStars includes a script builder (found in the Tools menu) to help +with writing DCOP scripts. The full user documentation (discussed +below) contains a more detailed explanation of how such scripts can +be written and used. +.TP +\fB\-\-width\fP \fIpixels\fP +Specifies the width of the sky image to dump (default is 640). +.SH SEE ALSO +.BR indiserver (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kstars/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kstars/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kstars/\fP. +.SH AUTHOR +KStars was written by Jason Harris <jharris@30doradus.org>, +Heiko Evermann <heiko@evermann.de>, Thomas Kabelmann <tk78@gmx.de>, +Pablo de Vicente <pvicentea@wanadoo.es>, Jasem Mutlaq <mutlaqja@ikarustech.com>, +Carsten Niehaus <cniehaus@gmx.de>, Mark Hollomon <mhh@mindspring.com>, +Vincent Jagot <vincent.jagot@free.fr> and +Martin Piskernig <martin.piskernig@stuwo.at>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/ktouch/CMakeLists.txt b/doc/man/ktouch/CMakeLists.txt new file mode 100644 index 00000000..5f042bb3 --- /dev/null +++ b/doc/man/ktouch/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES ktouch.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/ktouch/ktouch.1 b/doc/man/ktouch/ktouch.1 new file mode 100644 index 00000000..4738c6a8 --- /dev/null +++ b/doc/man/ktouch/ktouch.1 @@ -0,0 +1,56 @@ +.\" 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) +.TH KTOUCH 1 "January 31, 2004" +.\" 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 +ktouch \- a touch typing tutor for TDE +.SH SYNOPSIS +.B ktouch +.RI "[ " generic-options " ]" +[ \fIURL\fP ] +.SH DESCRIPTION +\fBKTouch\fP is a program for learning touch typing \- it helps you learn to +type on a keyboard quickly and correctly. Every finger has its place on +the keyboard with associated keys to press. +.PP +KTouch helps you learn to touch type by providing you with text to +train on, and adjusts to different levels depending on how good you are. +It can display which key to press next, and the correct finger to use. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +Below are the ktouch-specific options. +For a full summary of options, run \fIktouch \-\-help\fP. +.TP +\fIURL\fP +The training file to open. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/ktouch/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/ktouch/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/ktouch/\fP. +.SH AUTHOR +KTouch was written by Haavard Froeiland <haavard@users.sourceforge.net> +and Andreas Nicolai <Andreas.Nicolai@gmx.net>. +.br +This manual page was prepared +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kturtle/CMakeLists.txt b/doc/man/kturtle/CMakeLists.txt new file mode 100644 index 00000000..6f15fe8f --- /dev/null +++ b/doc/man/kturtle/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kturtle.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kturtle/kturtle.1 b/doc/man/kturtle/kturtle.1 new file mode 100644 index 00000000..756e2c62 --- /dev/null +++ b/doc/man/kturtle/kturtle.1 @@ -0,0 +1,61 @@ +.\" 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) +.TH KTURTLE 1 "March 16, 2005" +.\" 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 +kturtle \- an educational Logo programming environment +.SH SYNOPSIS +.B kturtle +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKTurtle\fP is an educational programming environment using the Logo +programming language. It tries to make programming as easy and +accessible as possible. This makes KTurtle suitable for teaching kids +the basics of mathematics, geometry and programming. +.PP +The commands used to program are in the style of the Logo programming +language. The unique feature of Logo is that the commands are often +translated into the speaking language of the programmer. +.PP +KTurtle is named after "the turtle" that plays a central role in the +programming environment. The user programs the turtle, using the Logo +commands, to draw a picture on the canvas. +.PP +Note that this version of Logo is only focused on the educational +qualities of the programming language and will not try to suit +professional programmers' needs. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkturtle \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kturtle/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kturtle/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kturtle/\fP. +.SH AUTHOR +KTurtle was written by Cies Breijs <cies # kde.nl>, +Walter Schreppers <Walter.Schreppers # ua.ac.be> and +Anne-Marie Mahfouf <annemarie.mahfouf # free.fr>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kverbos/CMakeLists.txt b/doc/man/kverbos/CMakeLists.txt new file mode 100644 index 00000000..82fab51c --- /dev/null +++ b/doc/man/kverbos/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kverbos.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kverbos/kverbos.1 b/doc/man/kverbos/kverbos.1 new file mode 100644 index 00000000..a78e0dec --- /dev/null +++ b/doc/man/kverbos/kverbos.1 @@ -0,0 +1,54 @@ +.\" 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) +.TH KVERBOS 1 "October 16, 2004" +.\" 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 +kverbos \- a Spanish verb form study application for TDE +.SH SYNOPSIS +.B kverbos +.RI "[ " generic-options " ] [ " file " ]" +.SH DESCRIPTION +\fBKverbos\fP allows the user to learn the forms of Spanish verbs. The program +suggests a verb and a time and the user enters the different verb forms. +The program corrects the user input and gives feedback. +.PP +The user can edit the list of the verbs that can be studied. The program +can build regular verb forms by itself. Irregular verb forms have to be +entered by the user. +.PP +If a form of a verb is uncertain then the internet offers good sources: +.br +http://csgrs6k1.uwaterloo.ca/~dmg/lando/verbos/con-jugador.html +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkverbos \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kverbos/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kverbos/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kverbos/\fP. +.SH AUTHOR +Kverbos was written by Arnold Kraschinski <arnold.k67@gmx.de>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kvoctrain/CMakeLists.txt b/doc/man/kvoctrain/CMakeLists.txt new file mode 100644 index 00000000..acc3225d --- /dev/null +++ b/doc/man/kvoctrain/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kvoctrain.1 langen2kvtml.1 spotlight2kvtml.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kvoctrain/kvoctrain.1 b/doc/man/kvoctrain/kvoctrain.1 new file mode 100644 index 00000000..50b8bd39 --- /dev/null +++ b/doc/man/kvoctrain/kvoctrain.1 @@ -0,0 +1,60 @@ +.\" 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) +.TH KVOCTRAIN 1 "March 16, 2005" +.\" 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 +kvoctrain \- a vocabulary trainer for TDE +.SH SYNOPSIS +.B kvoctrain +.RI "[ " generic-options " ] [ " file " ]" +.SH DESCRIPTION +\fBKVocTrain\fP is a little utility to help you train your vocabulary when you +are trying to learn a foreign language. You can create your own database +with the words you need. It is intended as a replacement for index +(flash) cards. +.PP +You probably remember flashcards from school. The teacher would write the +original expression on the front side of the card and the translation on +the back. Then look at the cards one after another. If you knew the +translation, you could put it away. If you failed, you put it back to +try again. +.PP +KVocTrain is not intended to teach you grammer or other sophisticated +things. This is and probably will stay beyond the scope of this application. +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fIkvoctrain \-\-help\fP. +.SH SEE ALSO +.BR langen2kvtml (1), +.BR spotlight2kvtml (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kvoctrain/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kvoctrain/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kvoctrain/\fP. +.SH AUTHOR +KVocTrain was written by Ewald Arnold <kvoctrain@ewald-arnold.de> +and Peter Hedlund <peter@peterandlinda.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kvoctrain/langen2kvtml.1 b/doc/man/kvoctrain/langen2kvtml.1 new file mode 100644 index 00000000..226baef4 --- /dev/null +++ b/doc/man/kvoctrain/langen2kvtml.1 @@ -0,0 +1,83 @@ +.\" 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) +.TH LANGEN2KVTML 1 "November 22, 2002" +.\" 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 +langen2kvtml \- convert Langenscheidt data files to KVocTrain data files +.SH SYNOPSIS +.B langen2kvtml +[ \fB\-\-lang=\fP\fIxx\fP ] [ \fB\-\-trans=\fP\fIxx\fP ] +[ \fB\-\-author=\fP\fIname\fP ] [ \fB\-\-longlesson\fP ] +[ \fB\-\-outdir=\fP\fIdir\fP ] [ \fB\-\-proxy=\fP\fIproxy\fP ] +{ \fB\-\-country=\fP\fIxx\fP | \fIvocfile\fP ... } +.SH DESCRIPTION +\fBlangen2kvtml\fP is a script that will convert Langenscheidt +data files (*.voc) to KVocTrain data files (*.kvtml). +.PP +For each Langenscheidt data file given on the command-line, a +corresponding KVocTrain data file will be created. If no Langenscheidt +data files are given, a set of data files for the given country (see +the \fB\-\-country\fP option) will be downloaded from the internet and +converted. If neither data files nor a country are specified, country +GB (Great Britain) will be assumed. +.PP +Note that you \fBmust\fP run KVocTrain at least once before this script +can be used. In some circumstances this script will edit the user's +KVocTrain preferences file. +.PP +This utility is part of the official TDE edutainment module. +.SH OPTIONS +.TP +\fB\-\-lang=\fP\fIxx\fP +Specifies the original language used in the data file(s). The script +will try to guess this based on the names of the Langenscheidt data files. +.TP +\fB\-\-trans=\fP\fIxx\fP +Specifies the translated language used in the data file(s). This +defaults to de (Deutsch). +.TP +\fB\-\-author=\fP\fIname\fP +Specifies the author of the data file(s). This defaults to +http://www.vokabeln.de. +.TP +\fB\-\-longlesson\fP +Specifies that long lesson names should be used in the converted +KVocTrain data file(s). Short lesson names are the default. +.TP +\fB\-\-outdir=\fP\fIdir\fP +Specifies that the converted KVocTrain data files be written in the +given directory. This defaults to the current directory. +.TP +\fB\-\-proxy=\fP\fIproxy\fP +Specifies a proxy to use when downloading Langenscheidt data files from +the internet. +.TP +\fB\-\-country=\fP\fIxx\fP +Requests that Langenscheidt data files for the given country be +downloaded from the internet and converted. The country should be +specified by the code used at \fIhttp://www.vokabeln.de/\fP, such as +GB for Great Britain, D for Germany and so on. +.SH SEE ALSO +.BR kvoctrain (1), +.BR spotlight2kvtml (1). +.PP +Langenscheidt data files can be downloaded directly from +\fIhttp://www.vokabeln.de/files.htm\fP. +.SH AUTHOR +langen2kvtml was written by Andreas Neuper. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kvoctrain/spotlight2kvtml.1 b/doc/man/kvoctrain/spotlight2kvtml.1 new file mode 100644 index 00000000..eaff0a1a --- /dev/null +++ b/doc/man/kvoctrain/spotlight2kvtml.1 @@ -0,0 +1,52 @@ +.\" 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) +.TH SPOTLIGHT2KVTML 1 "March 16, 2005" +.\" 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 +spotlight2kvtml \- convert a Spotlight Online vocabulary list to a +KVocTrain data file +.SH SYNOPSIS +.B spotlight2kvtml +.I spotfile month year +.SH DESCRIPTION +\fBspotlight2kvtml\fP is used to convert a Spotlight Online vocabulary +list to a KVocTrain data file (*.kvtml). +.PP +The given vocabulary list (\fIspotfile\fP) must be in plain text format +(i.e., you will need to convert the downloaded RTF or Word document into +a plain text file). The name of the new KVocTrain data file +will be derived from the given \fIspotfile\fP. +.PP +The given month and year will be used in the title and lesson names +in the new KVocTrain data file. +.PP +Note that Spotlight Online changes its vocabulary list format from time +to time, so spotlight2kvtml might be out of date and might not behave +correctly. +.PP +This utility is part of the official TDE edutainment module. +.SH SEE ALSO +.BR kvoctrain (1), +.BR langen2kvtml (1). +.PP +Spotlight Online vocabulary lists can be downloaded from +\fIhttp://www.spotlight-online.de/\fP. +.SH AUTHOR +spotlight2kvtml was written by Ewald Arnold <kvoctrain@ewald-arnold.de> +and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/kwordquiz/CMakeLists.txt b/doc/man/kwordquiz/CMakeLists.txt new file mode 100644 index 00000000..a5e33e4c --- /dev/null +++ b/doc/man/kwordquiz/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES kwordquiz.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/kwordquiz/kwordquiz.1 b/doc/man/kwordquiz/kwordquiz.1 new file mode 100644 index 00000000..538db52f --- /dev/null +++ b/doc/man/kwordquiz/kwordquiz.1 @@ -0,0 +1,69 @@ +.\" 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) +.TH KWORDQUIZ 1 "March 16, 2005" +.\" 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 +kwordquiz \- a flashcard and vocabulary learning program for TDE +.SH SYNOPSIS +.B kwordquiz +.RI "[ " generic-options " ]" +.PP +.B kwordquiz +.RI "[ " generic-options " ]" +[ \fB\-m, \-\-mode\fP \fInumber\fP ] +[ \fB\-g, \-\-goto\fP \fIsession\fP ] +.I file +.SH DESCRIPTION +\fBKWordQuiz\fP is a flashcard-based tool that helps you to master new +vocabularies. It may be a language or any other kind of terminology. +.PP +KWordQuiz can open several types of vocabulary data. Supported +are \fI.kvtml\fP files used by other TDE programs such as KVocTrain, +\fI.wql\fP files used by WordQuiz for Windows, \fI.csv\fP files with +comma-separated text, and \fI.xml.gz\fP +files created by Pauker (\fIhttp://pauker.sourceforge.net/\fP). +.PP +This application is part of the official TDE edutainment module. +.SH OPTIONS +Below are the kwordquiz-specific options. +For a full summary of options, run \fIkwordquiz \-\-help\fP. +.PP +.TP +\fB\-m, \-\-mode\fP \fInumber\fP +Specify the order and direction in which questions are asked. +The \fInumber\fP argument must be 1, 2, 3, 4 or 5 (corresponding to the +five entries in the Mode menu). +.TP +\fB\-g, \-\-goto\fP \fIsession\fP +Begin a quiz immediately. The \fIsession\fP argument may be +\fBflash\fP (for a flashcard quiz), \fBmc\fP (for a multiple choice +quiz) or \fBqa\fP (for a question and answer quiz). +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kwordquiz/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kwordquiz/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdeedu-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kwordquiz/\fP. +.SH AUTHOR +KWordQuiz was written by Peter Hedlund <peter@peterandlinda.com>. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/libtdeedu/CMakeLists.txt b/doc/man/libtdeedu/CMakeLists.txt new file mode 100644 index 00000000..fb1f2c0a --- /dev/null +++ b/doc/man/libtdeedu/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES test_extdate.1 test_extdatepicker.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/libtdeedu/test_extdate.1 b/doc/man/libtdeedu/test_extdate.1 new file mode 100644 index 00000000..90bd63d8 --- /dev/null +++ b/doc/man/libtdeedu/test_extdate.1 @@ -0,0 +1,47 @@ +.\" 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) +.TH TEST_EXTDATE 1 "October 16, 2004" +.\" 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 +test_extdate \- text-based tests for the ExtDate classes +.SH SYNOPSIS +.B test_extdate +.SH DESCRIPTION +This is a simple test program for testing the non-GUI functionality of the +ExtDate classes. It compares the results of several operations against +the results from QDate and writes the results to the console. +.PP +The \fBExtDate library\fP consists of a group of classes allowing TDE +applications to access calendar dates outside of the limited range of +years imposed by QDate. +.PP +The QDate class has a limited range of valid dates. It does not +recognize dates prior to 14 Oct 1752 (when the Gregorian calendar +was adopted by England), nor dates after 31 Dec 8000. Both of these +limits are arbitrary. +.PP +This library is part of the official TDE edutainment module. +.SH SEE ALSO +.BR test_extdatepicker (1). +.PP +See \fI/opt/trinity/share/doc/libtdeedu-dev/README.extdate\fP for further +information on this library. +.SH AUTHOR +The ExtDate library was written by Jason Harris <jharris@30doradus.org> +and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/man/libtdeedu/test_extdatepicker.1 b/doc/man/libtdeedu/test_extdatepicker.1 new file mode 100644 index 00000000..9a25504f --- /dev/null +++ b/doc/man/libtdeedu/test_extdatepicker.1 @@ -0,0 +1,50 @@ +.\" 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) +.TH TEST_EXTDATEPICKER 1 "October 16, 2004" +.\" 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 +test_extdatepicker \- GUI-based tests for the ExtDate classes +.SH SYNOPSIS +.B test_extdatepicker +[ \fIgeneric-options\fP ] +.SH DESCRIPTION +This is a simple test program for testing the graphical functionality of +the ExtDate classes. It presents a KDatePicker widget and an +ExtDatePicker widget side by side for user interaction. +.PP +The \fBExtDate library\fP consists of a group of classes allowing TDE +applications to access calendar dates outside of the limited range of +years imposed by QDate. +.PP +The QDate class has a limited range of valid dates. It does not +recognize dates prior to 14 Oct 1752 (when the Gregorian calendar +was adopted by England), nor dates after 31 Dec 8000. Both of these +limits are arbitrary. +.PP +This library is part of the official TDE edutainment module. +.SH OPTIONS +For a full summary of options, run \fItest_extdatepicker \-\-help\fP. +.SH SEE ALSO +.BR test_extdate (1). +.PP +See \fI/opt/trinity/share/doc/libtdeedu-dev/README.extdate\fP for further +information on this library. +.SH AUTHOR +The ExtDate library was written by Jason Harris <jharris@30doradus.org> +and others. +.br +This manual page was prepared by Ben Burton <bab@debian.org> +for the Debian GNU/Linux system (but may be used by others). |