Reorganize tdeioslave help handbooks, fix related protocol files and issues, update and add handbooks.

3 files changed, 103 insertions, 0 deletions

diff --git a/doc/tdeioslave/man/CMakeLists.txt b/doc/tdeioslave/man/CMakeLists.txt
new file mode 100644
index 000000000..4bdfa76b1
--- /dev/null
+++ b/doc/tdeioslave/man/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+#  Improvements and feedback are welcome
+#
+#  This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION tdeioslave/man )
diff --git a/doc/tdeioslave/man/Makefile.am b/doc/tdeioslave/man/Makefile.am
new file mode 100644
index 000000000..a74f9d7a3
--- /dev/null
+++ b/doc/tdeioslave/man/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = tdeioslave/man
diff --git a/doc/tdeioslave/man/index.docbook b/doc/tdeioslave/man/index.docbook
new file mode 100644
index 000000000..8fef2a88b
--- /dev/null
+++ b/doc/tdeioslave/man/index.docbook
@@ -0,0 +1,92 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
+  <!ENTITY % addindex "IGNORE">
+  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article lang="&language;" id="man">
+<title>Man</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<author>
+  <firstname>Nicolas</firstname>
+  <surname>Goutte</surname>
+  <email>[email protected]</email>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para>
+Using the man ioslave you are able to read the man pages installed
+on your system. It is easy to use:
+</para>
+
+<variablelist>
+<varlistentry>
+<term><userinput><command>man:</command></userinput></term>
+<listitem>
+<para>See the sections of the manual, click to find the rest.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><userinput><command>man:</command><replaceable>fopen</replaceable></userinput></term>
+<listitem>
+<para>See the man page of <command>fopen</command>.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><userinput><command>man:</command><replaceable>fopen(3)</replaceable></userinput></term>
+<listitem>
+<para>See the man page of <command>fopen</command> in section 3.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><userinput><command>man:</command><replaceable>(3)</replaceable></userinput></term>
+<listitem>
+<para>See the index of section 3.
+</para>
+</listitem>
+</varlistentry>
+<varlistentry>
+<term><userinput><command>man:</command>intro<replaceable>(3)</replaceable></userinput></term>
+<listitem>
+<para>See the introduction of section 3.
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+<note><para>If there are more than one man page of the name that you
+have entered, you will get a list where you can choose the man page
+that you want to see.</para></note>
+
+<para>
+There is also a shortcut: <userinput><command>#fopen</command></userinput>,
+which has the same effect as above.
+</para>
+
+<para>
+If you do not find all your man pages, adjust the configuration file
+<filename>/etc/manpath.config</filename>
+(or a file of a similar name depending on your distribution)
+or adjust the environment variables
+<envar>MANPATH</envar> and <envar>MANSECT</envar>.
+</para>
+
+<para>
+As with any other &tde; ioslave, it is possible to enter a &URL;, like
+<userinput><command>man:socket</command></userinput> in <emphasis>any</emphasis>
+&tde; application.  Try it in &kwrite; and you will see the man page in
+&HTML; format.
+</para>
+
+<para>
+Contact mailing list: <email>[email protected]</email>
+</para>
+
+</article>