summaryrefslogtreecommitdiffstats
path: root/doc/kweather
diff options
context:
space:
mode:
Diffstat (limited to 'doc/kweather')
-rw-r--r--doc/kweather/CMakeLists.txt5
-rw-r--r--doc/kweather/kweatherreport.156
-rw-r--r--doc/kweather/kweatherservice.153
3 files changed, 114 insertions, 0 deletions
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 <n> 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 <geiseri@kde.org>,
+Nadeem Hasan <nhasan@kde.org> and Tobias Koenig <tokoe@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/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 <n> 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 <geiseri@kde.org>,
+Nadeem Hasan <nhasan@kde.org> and Tobias Koenig <tokoe@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).