summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgregory guy <[email protected]>2018-09-01 17:37:07 +0200
committerSlávek Banko <[email protected]>2018-09-02 02:25:05 +0200
commit72f379d3ba87fb06959f06945548e11b984e047f (patch)
tree9d09e56c2327188d386047f2bcc34497ebd15c42 /doc
parenta896fdef0a292cc9e98608fdf9e88c1c46aced27 (diff)
downloadknetload-72f379d3ba87fb06959f06945548e11b984e047f.tar.gz
knetload-72f379d3ba87fb06959f06945548e11b984e047f.zip
conversion to cmake build system
Signed-off-by: gregory guy <[email protected]> (cherry picked from commit 676a81fc784c057271e1a417ab734595eb3f2313)
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt1
-rw-r--r--doc/en/CMakeLists.txt1
-rw-r--r--doc/man/CMakeLists.txt5
-rw-r--r--doc/man/knetload.156
4 files changed, 63 insertions, 0 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..6d0aa9f
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1 @@
+tde_auto_add_subdirectories( )
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
new file mode 100644
index 0000000..ba3ef3e
--- /dev/null
+++ b/doc/en/CMakeLists.txt
@@ -0,0 +1 @@
+tde_create_handbook( DESTINATION ${PROJECT_NAME} )
diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt
new file mode 100644
index 0000000..8512250
--- /dev/null
+++ b/doc/man/CMakeLists.txt
@@ -0,0 +1,5 @@
+INSTALL(
+ FILES ${PROJECT_NAME}.1
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/knetload.1 b/doc/man/knetload.1
new file mode 100644
index 0000000..ba26dcd
--- /dev/null
+++ b/doc/man/knetload.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 KNETLOAD 1 "January 14, 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
+knetload \- a network meter for Kicker
+.SH SYNOPSIS
+.B knetload
+.RI "[ " generic-options " ]"
+.SH DESCRIPTION
+\fBKNetLoad\fP is a small program for Kicker (the TDE panel). It
+shows a recent history of network usage in the form of two
+configurable diagrams in the system tray, one for incoming and one
+for outgoing data.
+These diagrams have settings for colors and various different styles.
+.PP
+Left click on a diagram to bring up a small information box which
+will show the exact input and output rates in text form as well as
+the total amount incoming and outgoing data.
+.PP
+Note that before KNetLoad can be useful you must select which
+network device it should monitor and select an appropriate scaling
+value that reflects the speed of this network device.
+.PP
+KNetLoad can monitor almost any network device; if your device is
+not in the predefined list of devices (such as eth0, ppp0 and
+ippp0) then you can type in your own device.
+.SH OPTIONS
+For a full summary of options, run \fIknetload \-\-help\fP.
+.SH SEE ALSO
+Full user documentation is available through the TDE Help Centre.
+You can also enter the URL
+\fIhelp:/knetload/\fP
+directly into konqueror or you can run
+`\fIkhelpcenter help:/knetload/\fP'
+from the command-line.
+.PP
+If the TDE Help Centre is not installed then you can
+read this documentation in HTML format from
+\fI/usr/share/doc/tde/HTML/en/knetload/\fP.
+.SH AUTHOR
+KNetLoad was written by Flameeyes <[email protected]>,
+Markus Gustavsson <[email protected]> and Ben Burton <[email protected]>.