From ed4e04460ef9d5b3579051234567e57689e79143 Mon Sep 17 00:00:00 2001 From: gregory guy Date: Tue, 27 Nov 2018 15:39:35 +0100 Subject: add man pages to amor, kodo, kteatime, ktux, kweather and kworldclock ; this remates to bug 1043 Signed-off-by: gregory guy (cherry picked from commit 4bac1d0f6f553e4d3b1763597420a799c96435cd) --- doc/amor/CMakeLists.txt | 5 +++ doc/amor/amor.1 | 50 ++++++++++++++++++++++++++++++ doc/kodo/CMakeLists.txt | 5 +++ doc/kodo/kodo.1 | 48 +++++++++++++++++++++++++++++ doc/kteatime/CMakeLists.txt | 5 +++ doc/kteatime/kteatime.1 | 49 +++++++++++++++++++++++++++++ doc/ktux/CMakeLists.txt | 5 +++ doc/ktux/ktux.1 | 51 ++++++++++++++++++++++++++++++ doc/kweather/CMakeLists.txt | 5 +++ doc/kweather/kweatherreport.1 | 56 +++++++++++++++++++++++++++++++++ doc/kweather/kweatherservice.1 | 53 ++++++++++++++++++++++++++++++++ doc/kworldclock/CMakeLists.txt | 5 +++ doc/kworldclock/kworldclock.1 | 70 ++++++++++++++++++++++++++++++++++++++++++ 13 files changed, 407 insertions(+) create mode 100644 doc/amor/amor.1 create mode 100644 doc/kodo/kodo.1 create mode 100644 doc/kteatime/kteatime.1 create mode 100644 doc/ktux/CMakeLists.txt create mode 100644 doc/ktux/ktux.1 create mode 100644 doc/kweather/kweatherreport.1 create mode 100644 doc/kweather/kweatherservice.1 create mode 100644 doc/kworldclock/kworldclock.1 diff --git a/doc/amor/CMakeLists.txt b/doc/amor/CMakeLists.txt index 66361cb..d4791cc 100644 --- a/doc/amor/CMakeLists.txt +++ b/doc/amor/CMakeLists.txt @@ -11,3 +11,8 @@ tde_create_handbook( DESTINATION amor ) +INSTALL( + FILES amor.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/amor/amor.1 b/doc/amor/amor.1 new file mode 100644 index 0000000..f74abf3 --- /dev/null +++ b/doc/amor/amor.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 AMOR 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +amor \- a TDE creature for your desktop +.SH SYNOPSIS +.B amor +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBAMOR\fP (Amusing Misuse Of Resources) provides several different +characters who prance around your X screen doing tricks and +giving you tips. +.PP +Note AMOR will only work with some window managers. Both KWin (the TDE +window manager) and Metacity (a GTK2 window manager) are supported. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +For a full summary of options, run \fIamor \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/amor/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/amor/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/amor/\fP. +.SH AUTHOR +AMOR was written by Martin R. Jones and +Gerardo Puga . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/kodo/CMakeLists.txt b/doc/kodo/CMakeLists.txt index fd5ed4d..93fc8cf 100644 --- a/doc/kodo/CMakeLists.txt +++ b/doc/kodo/CMakeLists.txt @@ -11,3 +11,8 @@ tde_create_handbook( DESTINATION kodo ) +INSTALL( + FILES kodo.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/kodo/kodo.1 b/doc/kodo/kodo.1 new file mode 100644 index 0000000..ae14d9f --- /dev/null +++ b/doc/kodo/kodo.1 @@ -0,0 +1,48 @@ +.\" 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 KODO 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kodo \- mouse odometer for TDE +.SH SYNOPSIS +.B kodo +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKOdometer\fP measures your desktop mileage. It tracks the movement of +your mouse pointer across your desktop and renders it in +inches/feet/miles! It can do cm/metres/km too. Its most exciting +feature is the tripometer, and its utter uselessness. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +For a full summary of options, run \fIkodo \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kodo/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kodo/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kodo/\fP. +.SH AUTHOR +KOdometer was written by Armen Nakashian and +Mark H. Granoff/mhg . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/kteatime/CMakeLists.txt b/doc/kteatime/CMakeLists.txt index 3ada1bc..73c6c43 100644 --- a/doc/kteatime/CMakeLists.txt +++ b/doc/kteatime/CMakeLists.txt @@ -11,3 +11,8 @@ tde_create_handbook( DESTINATION kteatime ) +INSTALL( + FILES kteatime.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/kteatime/kteatime.1 b/doc/kteatime/kteatime.1 new file mode 100644 index 0000000..a6fe145 --- /dev/null +++ b/doc/kteatime/kteatime.1 @@ -0,0 +1,49 @@ +.\" 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 KTEATIME 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kteatime \- TDE utility for making a fine cup of tea +.SH SYNOPSIS +.B kteatime +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKTeaTime\fP is a handy timer for steeping tea. No longer will you have to +guess at how long it takes for your tea to be ready. Simply select the +type of tea you have, and it will alert you when the tea is ready to drink. +.PP +KTeaTime sits in the TDE system tray. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +For a full summary of options, run \fIkteatime \-\-help\fP. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kteatime/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kteatime/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kteatime/\fP. +.SH AUTHOR +KTeaTime was written by Matthias Hoelzer-Kluepfel and +Martin Willers . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/ktux/CMakeLists.txt b/doc/ktux/CMakeLists.txt new file mode 100644 index 0000000..d844881 --- /dev/null +++ b/doc/ktux/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES ktux.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/ktux/ktux.1 b/doc/ktux/ktux.1 new file mode 100644 index 0000000..3a17897 --- /dev/null +++ b/doc/ktux/ktux.1 @@ -0,0 +1,51 @@ +.\" 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 KTUX 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +ktux \- Tux screen saver for TDE +.SH SYNOPSIS +.B ktux +.RI "[ " generic-options " ]" +[ \fB\-\-setup\fP | \fB\-\-window-id\fP \fIwid\fP | \fB\-\-root\fP | +\fB\-\-demo\fP ] +.SH DESCRIPTION +\fBKTux\fP is a neat Tux screen saver for the Trinity Desktop Environment (TDE). +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +Below are the ktux-specific options. +For a full summary of options, run \fIktux \-\-help\fP. +.TP +\fB\-\-setup\fP +Set up the screen saver. +.TP +\fB\-\-window-id\fP \fIwid\fP +Run in the specified XWindow. +.TP +\fB\-\-root\fP +Run in the root XWindow. +.TP +\fB\-\-demo\fP +Start the screen saver in demo mode (default). +.SH SEE ALSO +.BR kxsconfig (1), +.BR kxsrun (1). +.SH AUTHOR +KTux was written by Martin R. Jones and Carlos Rego. +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/kweather/CMakeLists.txt b/doc/kweather/CMakeLists.txt index 6fde0e3..6088ebc 100644 --- a/doc/kweather/CMakeLists.txt +++ b/doc/kweather/CMakeLists.txt @@ -11,3 +11,8 @@ tde_create_handbook( DESTINATION kweather ) +INSTALL( + FILES kweatherreport.1 kweatherservice.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/kweather/kweatherreport.1 b/doc/kweather/kweatherreport.1 new file mode 100644 index 0000000..1b76019 --- /dev/null +++ b/doc/kweather/kweatherreport.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 KWEATHERREPORT 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kweatherreport \- ask KWeatherService to display a weather report +.SH SYNOPSIS +.B kweatherreport +.RI "[ " generic-options " ] " location +.SH DESCRIPTION +\fBkweatherreport\fP is a small program that asks KWeatherService to display +a weather report. Information shown includes the temperature, wind speed, +air pressure and more. +.PP +\fBKWeatherService\fP is a DCOP service that can track multiple weather +stations to provide weather data. There is no need to start +KWeatherService separately; kweatherreport will start the service +itself if needed. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +Below are the kweather-specific options. +For a full summary of options, run \fIkweatherreport \-\-help\fP. +.TP +.I location +The METAR location code for the weather station to display. +.SH SEE ALSO +.BR kweatherservice (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL \fIhelp:/kweather/\fP +directly into konqueror or you can run `\fIkhelpcenter help:/kweather/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kweather/\fP. +.SH AUTHOR +KWeather was written by Ian Reinhart Geiser , +Nadeem Hasan and Tobias Koenig . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/kweather/kweatherservice.1 b/doc/kweather/kweatherservice.1 new file mode 100644 index 0000000..c8dd85a --- /dev/null +++ b/doc/kweather/kweatherservice.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 KWEATHERSERVICE 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kweatherservice \- a DCOP service to provide weather data +.SH SYNOPSIS +.B kweatherservice +.RI "[ " generic-options " ]" +.SH DESCRIPTION +\fBKWeatherService\fP is a DCOP service that can track multiple weather +stations and provide this weather data to other applications. It is +used by the \fBKWeather\fP applet for the TDE panel, by the +\fBkweatherreport\fP application and by weather plugins for other +applications such as \fBKonqueror\fP and \fBKontact\fP. +.PP +This program is for KWeather's internal use and should not be +run directly. To obtain a weather report, use the KWeather panel applet or +run kweatherreport instead. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +For a full summary of options, run \fIkweatherservice \-\-help\fP. +.SH SEE ALSO +.BR kweatherreport (1). +.PP +Full user documentation is available through the TDE Help Centre. +You can also enter the URL \fIhelp:/kweather/\fP +directly into konqueror or you can run `\fIkhelpcenter help:/kweather/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kweather/\fP. +.SH AUTHOR +KWeather was written by Ian Reinhart Geiser , +Nadeem Hasan and Tobias Koenig . +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). diff --git a/doc/kworldclock/CMakeLists.txt b/doc/kworldclock/CMakeLists.txt index 4c39234..fec1933 100644 --- a/doc/kworldclock/CMakeLists.txt +++ b/doc/kworldclock/CMakeLists.txt @@ -11,3 +11,8 @@ tde_create_handbook( DESTINATION kworldclock ) +INSTALL( + FILES kworldclock.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/kworldclock/kworldclock.1 b/doc/kworldclock/kworldclock.1 new file mode 100644 index 0000000..bf02572 --- /dev/null +++ b/doc/kworldclock/kworldclock.1 @@ -0,0 +1,70 @@ +.\" 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 KWORLDCLOCK 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +kworldclock \- earth watcher for TDE +.SH SYNOPSIS +.B kworldclock +.RI "[ " generic-options " ]" +[ \fB\-\-dump\fP +[ \fB\-\-theme\fP \fIfile\fP ] +[ \fB\-o\fP \fIfile\fP ] +[ \fB\-\-size\fP\ \fIW\fP\fBx\fP\fIH\fP ]] +.PP +.B kworldclock \-\-themes +.SH DESCRIPTION +\fBKWorldClock\fP displays where in the world it is light and dark +depending on time, as well as offering the time in all of the major +cities of the world. This can be run standalone, as an applet in the +TDE panel or as a desktop background. +.PP +This program is part of the official TDE toys module. +.SH OPTIONS +Below are the kworldclock-specific options. +For a full summary of options, run \fIkworldclock \-\-help\fP. +.TP +\fB\-\-dump\fP +Write out a file containing the actual map. +.TP +\fB\-\-theme\fP \fIfile\fP +The name of the theme to use for a map dump (default: depths). +.TP +\fB\-\-themes\fP +Display a list of all available themes. +.TP +\fB\-o\fP \fIfile\fP +The name of the file to write to for a map dump (default: dump.ppm). +.TP +\fB\-\-size\fP\ \fIW\fP\fBx\fP\fIH\fP +The size of the map to dump. +.SH SEE ALSO +Full user documentation is available through the TDE Help Centre. +You can also enter the URL +\fIhelp:/kworldclock/\fP +directly into konqueror or you can run +`\fIkhelpcenter help:/kworldclock/\fP' +from the command-line. +.PP +If the TDE Help Centre is not installed then you can install the package +\fItdetoys-doc-html\fP and read this documentation in HTML format from +\fI/opt/trinity/share/doc/tde/HTML/en/kworldclock/\fP. +.SH AUTHOR +KWorldClock was written by Matthias Hoelzer-Kluepfel +and others. +.br +This manual page was prepared by Ben Burton +for the Debian GNU/Linux system (but may be used by others). -- cgit v1.2.1