diff options
author | tpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2010-02-17 01:19:37 +0000 |
---|---|---|
committer | tpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2010-02-17 01:19:37 +0000 |
commit | ace60a4b0e75dafa8bdf3df50915999dd283d6de (patch) | |
tree | 64427cba841f561de14516d55044004d6e644505 /src/doc | |
download | knetstats-ace60a4b0e75dafa8bdf3df50915999dd283d6de.tar.gz knetstats-ace60a4b0e75dafa8bdf3df50915999dd283d6de.zip |
Added KDE3 version of knetstats
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/knetstats@1091565 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'src/doc')
-rw-r--r-- | src/doc/Makefile.am | 1 | ||||
-rw-r--r-- | src/doc/en/Makefile.am | 2 | ||||
-rw-r--r-- | src/doc/en/index.docbook | 130 | ||||
-rw-r--r-- | src/doc/man/Makefile.am | 4 | ||||
-rw-r--r-- | src/doc/man/manpage.xml | 142 |
5 files changed, 279 insertions, 0 deletions
diff --git a/src/doc/Makefile.am b/src/doc/Makefile.am new file mode 100644 index 0000000..81fee21 --- /dev/null +++ b/src/doc/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = en diff --git a/src/doc/en/Makefile.am b/src/doc/en/Makefile.am new file mode 100644 index 0000000..8f050ec --- /dev/null +++ b/src/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = knetstats diff --git a/src/doc/en/index.docbook b/src/doc/en/index.docbook new file mode 100644 index 0000000..36815bb --- /dev/null +++ b/src/doc/en/index.docbook @@ -0,0 +1,130 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY knetstats "<application>KNetStats 1.5</application>"> + <!ENTITY kappname "&knetstats;"><!-- Do *not* replace kappname--> + <!ENTITY package "kde-network"><!-- kdebase, kdeadmin, etc --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> + + + <!-- Do not define any other entities; instead, use the entities + from kde-genent.entities and $LANG/user.entities. --> +]> +<!-- kdoctemplate v0.8 October 1 1999 + Minor update to "Credits and Licenses" section on August 24, 2000 + Removed "Revision history" section on 22 January 2001 + Changed to Installation/Help menu entities 18 October 2001 + Other minor cleanup and changes 18 October 2001 --> + + +<!-- The language must NOT be changed here. --> + +<book lang="&language;"> + +<!-- This header contains all of the meta-information for the document such +as Authors, publish date, the abstract, and Keywords --> + +<bookinfo> +<title>The &knetstats; Handbook</title> + +<authorgroup> +<author> +<firstname>Hugo Parente Lima</firstname> +<othername></othername> + <surname></surname> +<affiliation> + <address><email>hugo_pl@users.sourceforge.net</email></address> +</affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>2004-2005</year> +<holder>Hugo Parente Lima</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook + and in the FDL itself on how to use it. --> +<legalnotice>&FDLNotice;</legalnotice> + +<!-- Date and version information of the documentation +Don't forget to include this last date and this last revision number, we +need them for translation coordination ! +Please respect the format of the date (YYYY-MM-DD) and of the version +(V.MM.LL), it could be used by automation scripts. +Do NOT change these in the translation. --> + +<date>2005-11-14</date> +<releaseinfo>1.1</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&knetstats; Is a simple KDE network monitor that show rx/tx LEDs of any network interface on a system tray icon. +</para> +</abstract> + +<!-- This is a set of Keywords for indexing by search engines. +Please at least include KDE, the KDE package it is in, the name + of your application, and a few relevant keywords. --> + +<keywordset> +<keyword>KDE</keyword> +<keyword>knetstats</keyword> +<keyword>network</keyword> +<keyword>monitor</keyword> +<keyword>leds</keyword> +</keywordset> + +</bookinfo> + +<!-- The contents of the documentation begin here. Label +each chapter so with the id attribute. This is necessary for two reasons: it +allows you to easily reference the chapter from other chapters of your +document, and if there is no ID, the name of the generated HTML files will vary +from time to time making it hard to manage for maintainers and for the CVS +system. Any chapter labelled (OPTIONAL) may be left out at the author's +discretion. Other chapters should not be left out in order to maintain a +consistent documentation style across all KDE apps. --> + +<chapter id="Using-KnetStats"> +<title>Using &knetstats;</title> + +<para>Choose a interface and see the leds :-).</para> +<!-- This chapter should tell the user how to use your app. You should use as +many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document +your application. --> + +</chapter> + +<chapter id="credits"> + +<!-- Include credits for the programmers, documentation writers, and +contributors here. The license for your software should then be included below +the credits with a reference to the appropriate license file included in the KDE +distribution. --> + +<title>Credits and License</title> + +<para> +&knetstats; +</para> +<para>Hugo Parente Lima - original author.</para> +<para>Thomas Windheuser - SCons help, Debian packages, etc.</para> +<para><ulink url="http://kde-apps.org/content/show.php?content=12956">KNemo</ulink> - Icon themes</para> +<para>Ilyas Bakirov, Roberto Leandrini, Carlos Ortiz, Henrik Gebauer, Edward Romantsov, Wiktor Wandachowicz, Guillaume Savaton, Petar Toushkov, Liu Di - KNetStats translation to other languages</para> + +<para>You can find more info on <ulink url="http://knetstats.sourceforge.net">KNetStats website</ulink>.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove --> +&underGPL; <!-- GPL License --> + +</chapter> + +&documentation.index; +</book> diff --git a/src/doc/man/Makefile.am b/src/doc/man/Makefile.am new file mode 100644 index 0000000..514c585 --- /dev/null +++ b/src/doc/man/Makefile.am @@ -0,0 +1,4 @@ +man_MANS = manpage.xml + +EXTRA_DIST = $(man_MANS) + diff --git a/src/doc/man/manpage.xml b/src/doc/man/manpage.xml new file mode 100644 index 0000000..52d305e --- /dev/null +++ b/src/doc/man/manpage.xml @@ -0,0 +1,142 @@ +<?xml version='1.0' encoding='ISO-8859-1'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!-- + +Process this file with an XSLT processor: `xsltproc \ +-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\ +manpages/docbook.xsl manpage.dbk'. A manual page +<package>.<section> will be generated. You may view the +manual page with: nroff -man <package>.<section> | less'. A +typical entry in a Makefile or Makefile.am is: + +DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\ +manpages/docbook.xsl +XP=xsltproc -''-nonet + +manpage.1: manpage.dbk + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The +XSL files are in docbook-xsl. Please remember that if you +create the nroff version in one of the debian/rules file +targets (such as build), you will need to include xsltproc +and docbook-xsl in your Build-Depends control field. + +--> + + <!-- Fill in your name for FIRSTNAME and SURNAME. --> + <!ENTITY dhfirstname "<firstname>Thomas</firstname>"> + <!ENTITY dhsurname "<surname>Windheuser</surname>"> + <!-- Please adjust the date whenever revising the manpage. --> + <!ENTITY dhdate "<date>16 Oct 2005</date>"> + <!-- SECTION should be 1-8, maybe w/ subsection other parameters are + allowed: see man(7), man(1). --> + <!ENTITY dhsection "<manvolnum>1</manvolnum>"> + <!ENTITY dhemail "<email>thomas@0x5c.net</email>"> + <!ENTITY dhusername "windheus"> + <!ENTITY dhucpackage "<refentrytitle>knetstats</refentrytitle>"> + <!ENTITY dhpackage "knetstats"> + + <!ENTITY debian "<productname>Debian</productname>"> + <!ENTITY gnu "<acronym>GNU</acronym>"> + <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> +]> + +<refentry> + <refentryinfo> + <address> + &dhemail; + </address> + <author> + &dhfirstname; + &dhsurname; + </author> + <copyright> + <year>2005</year> + <holder>&dhusername;</holder> + </copyright> + &dhdate; + </refentryinfo> + <refmeta> + &dhucpackage; + + &dhsection; + </refmeta> + <refnamediv> + <refname>&dhpackage;</refname> + + <refpurpose>A system tray icon, which indicates network activity</refpurpose> + </refnamediv> + <refsynopsisdiv> + <cmdsynopsis> + <command>&dhpackage;</command> + + <arg><option>--help <replaceable>Print options to console.</replaceable></option></arg> + + </cmdsynopsis> + </refsynopsisdiv> + <refsect1> + <title>DESCRIPTION</title> + + <para>This manual page documents briefly the + <command>&dhpackage;</command> + commands.</para> + + <para>This manual page was written for the &debian; distribution. + Instead, it has documentation in the &gnu; + <application>Info</application> format; see below.</para> + + <para><command>&dhpackage;</command> is a program that provides a system tray icon. This icon provides two + LED's, which begin to blink if there is network traffic.</para> + + </refsect1> + <refsect1> + <title>OPTIONS</title> + + <para>These programs follow the usual &gnu; command line syntax, + with long options starting with two dashes (`-'). A summary of + options is included below. For a complete description, see the + <application>Info</application> files.</para> + + <variablelist> + <varlistentry> + <term><option>-h</option> + <option>--help</option> + </term> + <listitem> + <para>Show summary of options.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>-v</option> + <option>--version</option> + </term> + <listitem> + <para>Show version of program.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>SEE ALSO</title> + + </refsect1> + <refsect1> + <title>AUTHOR</title> + + <para>This manual page was written by &dhusername; &dhemail; for + the &debian; system (but may be used by others). Permission is + granted to copy, distribute and/or modify this document under + the terms of the &gnu; General Public License, Version 2 any + later version published by the Free Software Foundation. + </para> + <para> + On Debian systems, the complete text of the GNU General Public + License can be found in /usr/share/common-licenses/GPL. + </para> + + </refsect1> +</refentry> + |