summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDarrell Anderson <[email protected]>2014-02-11 22:49:56 -0600
committerDarrell Anderson <[email protected]>2014-02-11 22:49:56 -0600
commitaf72e1310c8339e27ff4dbd2acc30d73864e2c6e (patch)
tree5310418b2e57fcf0bb8e73ad0591974c7c25278b /doc
parentfa9e71d3ac38cdaa690a7e551736929f056a9c56 (diff)
downloadtdebase-af72e1310c8339e27ff4dbd2acc30d73864e2c6e.tar.gz
tdebase-af72e1310c8339e27ff4dbd2acc30d73864e2c6e.zip
Update help handbooks, add new help handbooks, make handbook format consistent.
Diffstat (limited to 'doc')
-rw-r--r--doc/tdeioslave/ar/index.docbook1
-rw-r--r--doc/tdeioslave/file/index.docbook1
-rw-r--r--doc/tdeioslave/help/index.docbook1
-rw-r--r--doc/tdeioslave/http/index.docbook1
-rw-r--r--doc/tdeioslave/lan/index.docbook7
-rw-r--r--doc/tdeioslave/mailto/index.docbook1
-rw-r--r--doc/tdeioslave/nxfish/CMakeLists.txt9
-rw-r--r--doc/tdeioslave/nxfish/Makefile.am2
-rw-r--r--doc/tdeioslave/nxfish/index.docbook41
-rw-r--r--doc/tdeioslave/pop3/index.docbook1
-rw-r--r--doc/tdeioslave/rlan/CMakeLists.txt9
-rw-r--r--doc/tdeioslave/rlan/Makefile.am2
-rw-r--r--doc/tdeioslave/rlan/index.docbook44
-rw-r--r--doc/tdeioslave/sftp/index.docbook1
-rw-r--r--doc/tdeioslave/smtp/index.docbook1
-rw-r--r--doc/tdeioslave/tar/index.docbook1
-rw-r--r--doc/tdeioslave/telnet/index.docbook1
-rw-r--r--doc/tdeioslave/zeroconf/CMakeLists.txt9
-rw-r--r--doc/tdeioslave/zeroconf/Makefile.am2
-rw-r--r--doc/tdeioslave/zeroconf/index.docbook47
20 files changed, 168 insertions, 14 deletions
diff --git a/doc/tdeioslave/ar/index.docbook b/doc/tdeioslave/ar/index.docbook
index f577f379a..b0ec5bea3 100644
--- a/doc/tdeioslave/ar/index.docbook
+++ b/doc/tdeioslave/ar/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/file/index.docbook b/doc/tdeioslave/file/index.docbook
index d2c6a6fa9..04d9a8320 100644
--- a/doc/tdeioslave/file/index.docbook
+++ b/doc/tdeioslave/file/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/help/index.docbook b/doc/tdeioslave/help/index.docbook
index 69a47be9d..3e3e433e7 100644
--- a/doc/tdeioslave/help/index.docbook
+++ b/doc/tdeioslave/help/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/http/index.docbook b/doc/tdeioslave/http/index.docbook
index 43ddccff9..5d463f980 100644
--- a/doc/tdeioslave/http/index.docbook
+++ b/doc/tdeioslave/http/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/lan/index.docbook b/doc/tdeioslave/lan/index.docbook
index 00c8d5e6d..67add2117 100644
--- a/doc/tdeioslave/lan/index.docbook
+++ b/doc/tdeioslave/lan/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
@@ -51,8 +50,8 @@ the ability to use other protocols than just <acronym>SMB</acronym>.</para>
<acronym>NFS</acronym>, and <acronym>FISH</acronym></para>
<para>It must first be configured in &kcontrol;,
-<menuchoice><guimenu>Network</guimenu><guimenuitem>LAN-Browsing</guimenuitem>
-</menuchoice> and for more information refer to <ulink url="help:/lisa">the
-Lan Browsing manual</ulink>.</para>
+<menuchoice><guimenu>Internet &amp; Network</guimenu><guimenuitem>Local Network Browsing</guimenuitem>
+</menuchoice> and for more information refer to the
+<ulink url="help:/lisa">LISa (LAN Information Server) handbook</ulink>.</para>
</article>
diff --git a/doc/tdeioslave/mailto/index.docbook b/doc/tdeioslave/mailto/index.docbook
index 1018817bc..24131e9bf 100644
--- a/doc/tdeioslave/mailto/index.docbook
+++ b/doc/tdeioslave/mailto/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/nxfish/CMakeLists.txt b/doc/tdeioslave/nxfish/CMakeLists.txt
new file mode 100644
index 000000000..da685dafe
--- /dev/null
+++ b/doc/tdeioslave/nxfish/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION tdeioslave/nxfish )
diff --git a/doc/tdeioslave/nxfish/Makefile.am b/doc/tdeioslave/nxfish/Makefile.am
new file mode 100644
index 000000000..4a3e8575d
--- /dev/null
+++ b/doc/tdeioslave/nxfish/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = tdeioslave/fish
diff --git a/doc/tdeioslave/nxfish/index.docbook b/doc/tdeioslave/nxfish/index.docbook
new file mode 100644
index 000000000..6f326ddaf
--- /dev/null
+++ b/doc/tdeioslave/nxfish/index.docbook
@@ -0,0 +1,41 @@
+<?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="nxfish">
+<title>nxfish</title>
+
+<articleinfo>
+<authorgroup>
+<author>&tde-authors;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<releaseinfo>&tde-release-version;</releaseinfo>
+<date>Reviewed: &tde-release-date;</date>
+
+<copyright>
+<year>&tde-copyright-date;</year>
+<holder>&tde-team;</holder>
+</copyright>
+
+<abstract>
+<para>
+This handbook describes the nxfish protocol.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+<keyword>nxfish</keyword>
+<keyword>protocol</keyword>
+</keywordset>
+
+</articleinfo>
+
+<para>The nxfish protocol is simlar to the <ulink url="help:/tdeioslave/fish">fish</ulink>
+protocol but intended for file sharing between a local NX client and remote NX server.</para>
+
+</article>
diff --git a/doc/tdeioslave/pop3/index.docbook b/doc/tdeioslave/pop3/index.docbook
index a75059f97..52b1dcac7 100644
--- a/doc/tdeioslave/pop3/index.docbook
+++ b/doc/tdeioslave/pop3/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/rlan/CMakeLists.txt b/doc/tdeioslave/rlan/CMakeLists.txt
new file mode 100644
index 000000000..74fbb07f8
--- /dev/null
+++ b/doc/tdeioslave/rlan/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION tdeioslave/rlan )
diff --git a/doc/tdeioslave/rlan/Makefile.am b/doc/tdeioslave/rlan/Makefile.am
new file mode 100644
index 000000000..cdd303dea
--- /dev/null
+++ b/doc/tdeioslave/rlan/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = tdeioslave/lan
diff --git a/doc/tdeioslave/rlan/index.docbook b/doc/tdeioslave/rlan/index.docbook
new file mode 100644
index 000000000..7825e1f53
--- /dev/null
+++ b/doc/tdeioslave/rlan/index.docbook
@@ -0,0 +1,44 @@
+<?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="lan">
+<title>rlan</title>
+
+<articleinfo>
+
+<authorgroup>
+<author>&tde-authors;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<releaseinfo>&tde-release-version;</releaseinfo>
+<date>Reviewed: &tde-release-date;</date>
+
+<copyright>
+<year>&tde-copyright-date;</year>
+<holder>&tde-team;</holder>
+</copyright>
+
+<abstract>
+<para>
+This handbook describes the rlan protocol.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+<keyword>rlan</keyword>
+<keyword>protocol</keyword>
+</keywordset>
+
+</articleinfo>
+
+<para>The rlan protocol is similar to the <ulink url="help:/tdeioslave/lan">lan</ulink>
+protocol but intended for sessions on a remote server. Whereas the
+<ulink url="help:/tdeioslave/lan">lan</ulink> protocol is used with the LAN Information
+Service (LISa), rlan is used with the restricted LISa service (resLISa).</para>
+
+</article>
diff --git a/doc/tdeioslave/sftp/index.docbook b/doc/tdeioslave/sftp/index.docbook
index 5ad95075d..a2ca20005 100644
--- a/doc/tdeioslave/sftp/index.docbook
+++ b/doc/tdeioslave/sftp/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/smtp/index.docbook b/doc/tdeioslave/smtp/index.docbook
index 8b27fccf6..39c1c06bb 100644
--- a/doc/tdeioslave/smtp/index.docbook
+++ b/doc/tdeioslave/smtp/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/tar/index.docbook b/doc/tdeioslave/tar/index.docbook
index 00310b37f..65b19a5e4 100644
--- a/doc/tdeioslave/tar/index.docbook
+++ b/doc/tdeioslave/tar/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/telnet/index.docbook b/doc/tdeioslave/telnet/index.docbook
index cd4f21faf..5b61cf63b 100644
--- a/doc/tdeioslave/telnet/index.docbook
+++ b/doc/tdeioslave/telnet/index.docbook
@@ -1,6 +1,5 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
- <!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'>
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
diff --git a/doc/tdeioslave/zeroconf/CMakeLists.txt b/doc/tdeioslave/zeroconf/CMakeLists.txt
new file mode 100644
index 000000000..04c3a35f5
--- /dev/null
+++ b/doc/tdeioslave/zeroconf/CMakeLists.txt
@@ -0,0 +1,9 @@
+#################################################
+#
+# Improvements and feedback are welcome
+#
+# This file is released under GPL >= 2
+#
+#################################################
+
+tde_create_handbook( DESTINATION tdeioslave/zeroconf )
diff --git a/doc/tdeioslave/zeroconf/Makefile.am b/doc/tdeioslave/zeroconf/Makefile.am
new file mode 100644
index 000000000..cdd303dea
--- /dev/null
+++ b/doc/tdeioslave/zeroconf/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = tdeioslave/lan
diff --git a/doc/tdeioslave/zeroconf/index.docbook b/doc/tdeioslave/zeroconf/index.docbook
new file mode 100644
index 000000000..823d07406
--- /dev/null
+++ b/doc/tdeioslave/zeroconf/index.docbook
@@ -0,0 +1,47 @@
+<?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="lan">
+<title>zeroconf</title>
+
+<articleinfo>
+
+<authorgroup>
+<author>&tde-authors;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<releaseinfo>&tde-release-version;</releaseinfo>
+<date>Reviewed: &tde-release-date;</date>
+
+<copyright>
+<year>&tde-copyright-date;</year>
+<holder>&tde-team;</holder>
+</copyright>
+
+<abstract>
+<para>
+This handbook describes the zeroconf protocol.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>TDE</keyword>
+<keyword>zeroconf</keyword>
+<keyword>protocol</keyword>
+</keywordset>
+
+</articleinfo>
+
+<para>The zeroconf protocol is used in network device discovery, commonly known as
+DNS Service Discovery (DNSSD). To be useful &tde; must be compiled with zeroconf support.
+Typically that means installing the <ulink url="http://www.avahi.org/">avahi</ulink>
+service before compiling &tde;.</para>
+
+<para>DNS-SD is defined in <ulink url="https://tools.ietf.org/html/rfc6763">RFC 6763</ulink>.
+</para>
+
+</article>