diff options
author | Slávek Banko <[email protected]> | 2018-10-26 04:07:01 +0200 |
---|---|---|
committer | Slávek Banko <[email protected]> | 2018-10-27 13:36:02 +0200 |
commit | 42673b0179d00e2b5a05fb48438577b923f00b8b (patch) | |
tree | c42ef21f0799c5e73ae1ccb6ed439d690ec9e59c /doc/man | |
parent | 0e396d6b00651d811959f8d4c7ccad9ff868a1a1 (diff) | |
download | knetstats-42673b0179d00e2b5a05fb48438577b923f00b8b.tar.gz knetstats-42673b0179d00e2b5a05fb48438577b923f00b8b.zip |
Fix structure of directories
Signed-off-by: Slávek Banko <[email protected]>
(cherry picked from commit 06772a369f2beef80bb291ded30cbe125a24af56)
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/CMakeLists.txt | 5 | ||||
-rw-r--r-- | doc/man/Makefile.am | 3 | ||||
-rw-r--r-- | doc/man/knetstats.1 | 53 | ||||
-rw-r--r-- | doc/man/manpage.xml | 142 |
4 files changed, 203 insertions, 0 deletions
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/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..5894f60 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1,3 @@ +man_MANS = knetstats.1 + +EXTRA_DIST = $(man_MANS) diff --git a/doc/man/knetstats.1 b/doc/man/knetstats.1 new file mode 100644 index 0000000..7197c48 --- /dev/null +++ b/doc/man/knetstats.1 @@ -0,0 +1,53 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH knetstats 1 "16 Oct 2005" "" "" +.SH NAME +knetstats \- A system tray icon, which indicates network activity +.SH SYNOPSIS +'nh +.fi +.ad l +\fBknetstats\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[\fB--help \fIPrint options to console.\fB\fR] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +This manual page documents briefly the +\fBknetstats\fR +commands. +.PP +This manual page was written for the Debian distribution. +Instead, it has documentation in the GNU +Info format; see below. +.PP +\fBknetstats\fR is a program that provides a system tray icon. This icon provides two +LED's, which begin to blink if there is network traffic. +.SH OPTIONS +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 +Info files. +.TP +\*(T<\fB\-h\fR\*(T> \*(T<\fB\-\-help\fR\*(T> +Show summary of options. +.TP +\*(T<\fB\-v\fR\*(T> \*(T<\fB\-\-version\fR\*(T> +Show version of program. +.SH "SEE ALSO" +.SH AUTHOR +This manual page was written by windheus <\*(T<[email protected]\*(T>> 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. +.PP +On Debian systems, the complete text of the GNU General Public +License can be found in /usr/share/common-licenses/GPL. diff --git a/doc/man/manpage.xml b/doc/man/manpage.xml new file mode 100644 index 0000000..52d305e --- /dev/null +++ b/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>[email protected]</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> + |