summaryrefslogtreecommitdiffstats
path: root/doc/kworldclock
diff options
context:
space:
mode:
authorgregory guy <g-gregory@gmx.fr>2018-11-27 15:39:35 +0100
committergregory guy <g-gregory@gmx.fr>2018-11-27 15:39:35 +0100
commit4bac1d0f6f553e4d3b1763597420a799c96435cd (patch)
tree244a7fdfdb73a70adeaa55f395c9d0023bbbcc84 /doc/kworldclock
parente2cd367100cf4be8a2540777f36bd905601e01e2 (diff)
downloadtdetoys-4bac1d0f6f553e4d3b1763597420a799c96435cd.tar.gz
tdetoys-4bac1d0f6f553e4d3b1763597420a799c96435cd.zip
add man pages to amor, kodo, kteatime, ktux, kweather and kworldclock ; this remates to bug 1043
Signed-off-by: gregory guy <g-gregory@gmx.fr>
Diffstat (limited to 'doc/kworldclock')
-rw-r--r--doc/kworldclock/CMakeLists.txt5
-rw-r--r--doc/kworldclock/kworldclock.170
2 files changed, 75 insertions, 0 deletions
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 <n> 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 <hoelzer@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).