[kde-doc-english] [kio-extras] doc/kioslave: reorganize the kioslave documentation #2

Aleix Pol aleixpol at kde.org
Wed Apr 9 16:57:25 UTC 2014


Git commit 1166003ee161dd1a32bdaf0b320e3993f552d47c by Aleix Pol, on behalf of Burkhard Lück.
Committed on 12/11/2008 at 19:54.
Pushed by apol into branch 'master'.

reorganize the kioslave documentation #2

svn path=/trunk/KDE/kdebase/runtime/; revision=883366

M  +14   -4    doc/kioslave/CMakeLists.txt
C  +2    -3    doc/kioslave/bookmarks/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 071% similarity]
A  +29   -0    doc/kioslave/bookmarks/index.docbook
C  +2    -3    doc/kioslave/bzip2/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 073% similarity]
A  +40   -0    doc/kioslave/bzip2/index.docbook
C  +2    -3    doc/kioslave/cgi/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +31   -0    doc/kioslave/cgi/index.docbook
C  +2    -3    doc/kioslave/finger/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 073% similarity]
A  +40   -0    doc/kioslave/finger/index.docbook
C  +2    -3    doc/kioslave/fish/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +73   -0    doc/kioslave/fish/index.docbook
C  +2    -3    doc/kioslave/floppy/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 073% similarity]
A  +58   -0    doc/kioslave/floppy/index.docbook
C  +2    -3    doc/kioslave/gzip/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +37   -0    doc/kioslave/gzip/index.docbook
C  +2    -3    doc/kioslave/info/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +43   -0    doc/kioslave/info/index.docbook
C  +2    -3    doc/kioslave/man/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +93   -0    doc/kioslave/man/index.docbook
C  +2    -3    doc/kioslave/nfs/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +46   -0    doc/kioslave/nfs/index.docbook
C  +2    -3    doc/kioslave/sftp/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +26   -0    doc/kioslave/sftp/index.docbook
C  +2    -3    doc/kioslave/smb/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +63   -0    doc/kioslave/smb/index.docbook
C  +2    -3    doc/kioslave/tar/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 074% similarity]
A  +25   -0    doc/kioslave/tar/index.docbook
C  +2    -3    doc/kioslave/thumbnail/CMakeLists.txt [from: doc/kioslave/CMakeLists.txt - 071% similarity]
A  +35   -0    doc/kioslave/thumbnail/index.docbook

http://commits.kde.org/kio-extras/1166003ee161dd1a32bdaf0b320e3993f552d47c

diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/CMakeLists.txt
index 0df9c9a..548b331 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/CMakeLists.txt
@@ -1,4 +1,14 @@
-########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+add_subdirectory(bookmarks)
+add_subdirectory(bzip2)
+add_subdirectory(cgi)
+add_subdirectory(finger)
+add_subdirectory(fish)
+add_subdirectory(floppy)
+add_subdirectory(gzip)
+add_subdirectory(info)
+add_subdirectory(man)
+add_subdirectory(nfs)
+add_subdirectory(sftp)
+add_subdirectory(smb)
+add_subdirectory(tar)
+add_subdirectory(thumbnail)
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/bookmarks/CMakeLists.txt
similarity index 71%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/bookmarks/CMakeLists.txt
index 0df9c9a..f030511 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/bookmarks/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/bookmarks)
+
diff --git a/doc/kioslave/bookmarks/index.docbook b/doc/kioslave/bookmarks/index.docbook
new file mode 100644
index 0000000..9923e6c
--- /dev/null
+++ b/doc/kioslave/bookmarks/index.docbook
@@ -0,0 +1,29 @@
+<?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="bookmarks">
+<title>bookmarks</title>
+<articleinfo>
+<authorgroup>
+<author>
+<personname><firstname>Xavier</firstname><surname>Vello</surname></personname>
+<email>xavier.vello at gmail.com</email>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2008-08-31</date>
+<releaseinfo>0.2</releaseinfo>
+
+</articleinfo>
+
+<para>This <acronym>KIO</acronym> displays your bookmarks as a nice and functional &HTML; page. You access it typing <userinput>bookmarks:/</userinput> in the &konqueror; location bar.</para>
+
+<para>The content and layout of the page is configurable. Just point &konqueror; to <userinput>bookmarks:/config</userinput> to launch the configuration dialog.</para>
+
+</article>
+
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/bzip2/CMakeLists.txt
similarity index 73%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/bzip2/CMakeLists.txt
index 0df9c9a..114efda 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/bzip2/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/bzip2)
+
diff --git a/doc/kioslave/bzip2/index.docbook b/doc/kioslave/bzip2/index.docbook
new file mode 100644
index 0000000..d104ac6
--- /dev/null
+++ b/doc/kioslave/bzip2/index.docbook
@@ -0,0 +1,40 @@
+<?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="bzip2">
+<title>bzip2 / bzip</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para><command>bzip2</command> is a compression program.</para>
+
+<para>The bzip2 kioslave is not directly usable, and is intended for use
+as a filter.  For example, the tar kioslave can filter a file through
+the bzip2 kioslave, in order to display the contents of a <literal
+role="extension">tar.bz2</literal> file directly in a &konqueror;
+window.</para>
+
+<para>If you click on a file compressed with a <literal
+role="extension">.bz2</literal> in &konqueror;, this kioslave is used to
+uncompress it and display it as a normal (uncompressed) file.</para>
+
+<para>If you are a developer, and would like to use the bzip2 filter,
+you can find documentation on using kioslaves at <ulink
+url="http://techbase.kde.org">http://techbase.kde.org</ulink></para>
+
+<para> See the manual: <ulink url="man:/bzip2">bzip2</ulink>.
+</para>
+
+<para><command>bzip</command> is the ancestor of bzip2.  It is rarely
+used today, having been replaced with bzip2, which offers much better
+compression.</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/cgi/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/cgi/CMakeLists.txt
index 0df9c9a..132d95d 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/cgi/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/cgi)
+
diff --git a/doc/kioslave/cgi/index.docbook b/doc/kioslave/cgi/index.docbook
new file mode 100644
index 0000000..053479f
--- /dev/null
+++ b/doc/kioslave/cgi/index.docbook
@@ -0,0 +1,31 @@
+<?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="cgi">
+<title>cgi</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts;&Lauri.Watts.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para>The <acronym>CGI</acronym> slave provides a way to execute
+<acronym>CGI</acronym> programs without the need to have a running web
+server. This can for example be used for local testing of
+<acronym>CGI</acronym> programs or for using search engines that only
+provide a <acronym>CGI</acronym> frontend like the one from
+<application>Doxygen</application>.</para>
+
+<para>The slave implements the <command>cgi:</command> protocol. It
+uses the filename from the given &URL; and searches a configurable
+list of folders. If it finds an executable with the given name it
+executes it, passes the arguments of the &URL; and sets the
+environment variables needed by <acronym>CGI</acronym>
+programs.</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/finger/CMakeLists.txt
similarity index 73%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/finger/CMakeLists.txt
index 0df9c9a..a3bc4b6 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/finger/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/finger)
+
diff --git a/doc/kioslave/finger/index.docbook b/doc/kioslave/finger/index.docbook
new file mode 100644
index 0000000..988450b
--- /dev/null
+++ b/doc/kioslave/finger/index.docbook
@@ -0,0 +1,40 @@
+<?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="finger">
+<title>finger</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts;&Lauri.Watts.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para>Finger is a program to display information about users.</para>
+
+<para>If finger is enabled on the remote machine, you may be given
+information on the user's real name, if they are currently logged in, if
+they have mail and the text of their <filename>.plan</filename> file in
+their home folder.</para>
+
+<para>Finger is normally associated with a user at hostname address, which
+may or may not be the same as a users email address.</para>
+
+<para>Most Internet Service Providers no longer allow finger access, so,
+you may find that you get no useful answer for most people.</para>
+
+<para>Other people use their local <filename>.plan</filename> file to
+hold such information as <acronym>PGP</acronym> keys, the fact they are
+on vacation, and all sorts of information.</para>
+
+<para>Use the finger kioslave like this:
+<userinput>finger://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput></para>
+
+<para> See the manual: <ulink url="man:/finger">finger</ulink>.
+</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/fish/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/fish/CMakeLists.txt
index 0df9c9a..cdfbbe8 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/fish/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/fish)
+
diff --git a/doc/kioslave/fish/index.docbook b/doc/kioslave/fish/index.docbook
new file mode 100644
index 0000000..76784c6
--- /dev/null
+++ b/doc/kioslave/fish/index.docbook
@@ -0,0 +1,73 @@
+<?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="fish">
+<title>fish</title>
+<articleinfo>
+<authorgroup>
+<author>&Joerg.Walter; &Joerg.Walter.mail;</author>
+<author>&Brad.Hards; &Brad.Hards.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2005-02-29</date>
+<releaseinfo>1.1.2</releaseinfo>
+
+</articleinfo>
+
+<para>Allows you to access another computer's files using the SEcure Shell (<acronym>SSH</acronym>) protocol.  The remote computer needs to be running the <acronym>SSH</acronym> daemon, but the remainder of the protocol uses standard commandline tools as discussed below.</para>
+
+<para>You can use the fish kioslave like this:
+<userinput>fish://<replaceable>hostname</replaceable></userinput> or <userinput>fish://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput>.</para>
+
+<note><para>You need to use double forward slashes.</para></note>
+
+<para>You can omit the <replaceable>username</replaceable> (and the trailing
+@ symbol) if you have the same username on both computers.</para>
+
+<para>You can add a password in the format:
+<userinput>fish://<replaceable>username</replaceable>:<replaceable>password</replaceable>@<replaceable>hostname</replaceable></userinput>
+but it is not necessary as you will be prompted for one if it is not
+supplied.</para>
+
+<para>If you are running the <acronym>SSH</acronym> daemon on a non-standard
+port, you can specify that port using the normal &URL; syntax as shown
+below:
+<userinput>fish://<replaceable>hostname</replaceable>:<replaceable>portnumber</replaceable></userinput>.</para>
+
+<para>Fish should work with any roughly <acronym>POSIX</acronym> compatible
+&UNIX; based remote computer. It uses the shell commands
+<command>cat</command>, <command>chgrp</command>,
+<command>chmod</command>, <command>chown</command>,
+<command>cp</command>, <command>dd</command>,
+<command>env</command>, <command>expr</command>,
+<command>grep</command>, <command>ls</command>,
+<command>mkdir</command>, <command>mv</command>,
+<command>rm</command>, <command>rmdir</command>,
+<command>sed</command>,
+and <command>wc</command>. Fish starts
+<command>/bin/sh</command> as its shell and expects it to be a
+Bourne shell (or compatible, like <command>bash</command>).
+If the <command>sed</command> and
+<command>file</command> commands are available, as well as a
+<filename>/etc/apache/magic</filename> file with &MIME; type
+signatures, these will be used to guess &MIME; types.
+</para>
+
+<para>If <application>Perl</application> is available on the remote
+machine, it will be used instead. Then only <command>env</command> and
+<command>/bin/sh</command> are needed. Using
+<application>Perl</application> has the additional benefit of being
+faster.</para>
+
+<para>Fish may even work on &Windows; machines, if tools like
+<application>Cygwin</application> are installed.  All the above
+utilities must be in the system <envar>PATH</envar>, and the initial
+shell must be able to process the command <command>echo
+FISH:;/bin/sh</command> correctly.</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/floppy/CMakeLists.txt
similarity index 73%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/floppy/CMakeLists.txt
index 0df9c9a..6eaae26 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/floppy/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/floppy)
+
diff --git a/doc/kioslave/floppy/index.docbook b/doc/kioslave/floppy/index.docbook
new file mode 100644
index 0000000..f90d441
--- /dev/null
+++ b/doc/kioslave/floppy/index.docbook
@@ -0,0 +1,58 @@
+<?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="floppy">
+<title>Floppy</title>
+<articleinfo>
+<authorgroup>
+<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para>
+The floppy ioslave gives you easy access to the floppy disk drives 
+installed on your system.
+</para>
+
+<para>
+The drive letter becomes the first subdirectory 
+in the floppy &URL;. Let's say there is a file <filename>logo.png</filename> on your floppy 
+disk in drive A, then the &URL; will be <userinput><command>floppy:</command><replaceable>/a/logo.png</replaceable></userinput>
+</para>
+
+<para>
+If you want to access drive B, <userinput><command>floppy:/b</command></userinput> will do it.
+<command>floppy:/</command> is a shortcut for <command>floppy:/a</command>.
+</para>
+
+<note><para>Note that <command>floppy:/logo.png</command> means you have a disk drive 
+named <filename>logo.png</filename>.</para></note>
+
+<para>
+To use it you need to have the mtools package
+installed, and the floppy ioslave supports everything the various mtools 
+command line utilities support. You don't have to mount your floppy disks, 
+simply enter <userinput>floppy:/</userinput> in any &kde; 3.x app and you will be able to 
+read from and write to your floppy drive.</para>
+
+<para>
+It also works with USB sticks, ZIP and JAZ drives.
+You can use <command>floppy:/u</command> for the USB stick and <command>floppy:/z</command> for the zip drive, for example.
+To make this work, you might need to adjust your <filename>/etc/mtools</filename> file. See the manpage
+for documentation.
+</para>
+
+<para>The ioslave gives read and write access to the floppy drive, but not 
+simultaneously. While you can read and write to the floppy during the same 
+session, reading and writing have to happen one after the other, not at the same 
+time.</para>
+
+<para>Author: Alexander Neundorf <email>neundorf at kde.org</email></para>
+
+</article>
+
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/gzip/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/gzip/CMakeLists.txt
index 0df9c9a..7a2b465 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/gzip/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/gzip)
+
diff --git a/doc/kioslave/gzip/index.docbook b/doc/kioslave/gzip/index.docbook
new file mode 100644
index 0000000..d8752a5
--- /dev/null
+++ b/doc/kioslave/gzip/index.docbook
@@ -0,0 +1,37 @@
+<?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="gzip">
+<title>gzip</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para><command>gzip</command> is a compression program</para>
+
+<para>The gzip kioslave is not directly usable, and is intended for use
+as a filter.  For example, the tar kioslave can filter a file through
+the gzip kioslave, in order to display the contents of a <literal
+role="extension">tar.gz</literal> file directly in a &konqueror;
+window.</para>
+
+<para>If you click on a file compressed with a <literal
+role="extension">gz</literal> extension in &konqueror;, this kioslave is
+used to uncompress it and display it as a normal (uncompressed)
+file.</para>
+
+<para>If you are a developer, and would like to use the gzip filter, you
+can find documentation on using kioslaves at <ulink
+url="http://techbase.kde.org">http://techbase.kde.org</ulink></para>
+
+<para> See the manual: <ulink url="man:/gzip">gzip</ulink>.
+</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/info/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/info/CMakeLists.txt
index 0df9c9a..76351ef 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/info/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/info)
+
diff --git a/doc/kioslave/info/index.docbook b/doc/kioslave/info/index.docbook
new file mode 100644
index 0000000..04e4b2d
--- /dev/null
+++ b/doc/kioslave/info/index.docbook
@@ -0,0 +1,43 @@
+<?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="info">
+<title>Info</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<author>
+  <firstname>Nicolas</firstname>
+  <surname>Goutte</surname>
+  <email>goutte at kde.org</email>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+
+<para>Info is a type of documentation.  The documents are in a file
+format called texinfo, and can be read on the command line with the
+<command>info</command> program.</para>
+
+<para>The Info ioslave allows you to read the info pages installed on
+your system, from within &konqueror;.  You can use it very easily:</para>
+
+<screen><userinput><command>info:</command><replaceable>gcc</replaceable></userinput></screen>
+
+<para>This would show you the top level node of the Info documentation
+for the &gcc; compiler.</para>
+
+<para>Info is a &GNU; replacement for
+<command>man</command>, but is not widely used outside of
+&GNU; software.</para>
+
+<para>You can quite easily browse the info documentation you have
+installed from within the &khelpcenter; application, or you can use the
+info ioslave directly from within both &konqueror; and the
+mini-cli.</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/man/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/man/CMakeLists.txt
index 0df9c9a..4d61de7 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/man/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/man)
+
diff --git a/doc/kioslave/man/index.docbook b/doc/kioslave/man/index.docbook
new file mode 100644
index 0000000..e380bc2
--- /dev/null
+++ b/doc/kioslave/man/index.docbook
@@ -0,0 +1,93 @@
+<?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>goutte at kde.org</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 &kde; ioslave, it is possible to enter a &URL;, like
+<userinput><command>man:socket</command></userinput> in <emphasis>any</emphasis>
+&kde; application.  Try it in &kwrite; and you will see the man page in
+&HTML; format.
+</para>
+
+<para>
+Contact mailing list: <email>kde-devel at kde.org</email>
+</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/nfs/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/nfs/CMakeLists.txt
index 0df9c9a..668a604 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/nfs/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/nfs)
+
diff --git a/doc/kioslave/nfs/index.docbook b/doc/kioslave/nfs/index.docbook
new file mode 100644
index 0000000..f0c8799
--- /dev/null
+++ b/doc/kioslave/nfs/index.docbook
@@ -0,0 +1,46 @@
+<?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="nfs">
+<title>nfs</title>
+<articleinfo>
+<authorgroup>
+<author>&Lauri.Watts; &Lauri.Watts.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para>
+Sun's <acronym>NFS</acronym> protocol provides transparent remote access to 
+shared file systems across networks. The <acronym>NFS</acronym> protocol is 
+designed to be machine, operating system, network architecture, and 
+transport protocol independent. This independence is achieved through the 
+use of Remote Procedure Call (<acronym>RPC</acronym>) primitives built on 
+top of an eXternal Data Representation (<acronym>XDR</acronym>).
+</para>
+
+<para>
+The supporting MOUNT protocol performs the operating system-specific 
+functions that allow clients to attach remote folder trees to a point 
+within the local file system. The mount process also allows the server to 
+grant remote access privileges to a restricted set of clients via export 
+control.</para>
+
+<para>
+The Lock Manager provides support for file locking when used in the 
+<acronym>NFS</acronym> environment. The Network Lock Manager 
+(<acronym>NLM</acronym>) protocol isolates the inherently stateful aspects 
+of file locking into a separate protocol.</para>
+
+<para>
+Source:
+<ulink url="http://www.networksorcery.com/enp/protocol/nfs.htm"> 
+http://www.networksorcery.com/enp/protocol/nfs.htm</ulink>
+</para>
+
+<para> See the manual: <ulink url="man:/nfs">nfs</ulink>.
+</para>
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/sftp/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/sftp/CMakeLists.txt
index 0df9c9a..9e83b7e 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/sftp/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/sftp)
+
diff --git a/doc/kioslave/sftp/index.docbook b/doc/kioslave/sftp/index.docbook
new file mode 100644
index 0000000..ba14a68
--- /dev/null
+++ b/doc/kioslave/sftp/index.docbook
@@ -0,0 +1,26 @@
+<?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="sftp">
+<title>sftp</title>
+<articleinfo>
+<authorgroup>
+<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para><acronym>SFTP</acronym> is a Secure file transfer protocol.
+<command>sftp</command> is an interactive file transfer program,
+similar to ftp, but it performs all operations over an encrypted
+<command>ssh</command> transport.  It may use many of the features of
+<command>ssh</command>, including public key authentication and
+compression.</para>
+
+<para> See the manual: <ulink url="man:/sftp">sftp</ulink>.
+</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/smb/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/smb/CMakeLists.txt
index 0df9c9a..0608426 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/smb/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/smb)
+
diff --git a/doc/kioslave/smb/index.docbook b/doc/kioslave/smb/index.docbook
new file mode 100644
index 0000000..c58af82
--- /dev/null
+++ b/doc/kioslave/smb/index.docbook
@@ -0,0 +1,63 @@
+<?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="smb">
+<title>SMB</title>
+<articleinfo>
+<authorgroup>
+<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para>
+The smb ioslave enables you to browse the shares of a &Windows; (or Samba)
+network.
+</para>
+
+<para>
+To see the workgroups, enter
+<userinput><command>smb:/</command></userinput>.
+</para>
+<para>
+<userinput><command>smb://</command><replaceable>a_workgroup</replaceable></userinput>
+will list the hosts in this workgroup.
+</para>
+<para>
+To see the shares of a host, enter
+<userinput><command>smb://</command><replaceable>the_host</replaceable></userinput>
+or
+<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable></userinput>.
+</para>
+<para>
+To access a share directly enter
+<userinput><command>smb://</command><replaceable>the_host/the_share</replaceable></userinput>
+or
+<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable>/<replaceable>the_share</replaceable></userinput>
+</para>
+
+<para>
+The smb ioslave requires that you have libsmbclient to use this ioslave.
+</para>
+
+<para>
+You can set your default user name and password in the &kcontrol; in
+<menuchoice><guisubmenu>Network</guisubmenu><guimenuitem>Windows
+Shares</guimenuitem></menuchoice>.  This is especially useful if you are a
+member of a &Windows; <acronym>NT</acronym> domain. There you can also set your
+workgroup name, but in most cases this is not required.  The kioslave will ask for your username and password if a default is not set.
+</para>
+
+<para>
+This ioslave is tested and developed using mainly Samba 2.0.7, but other
+versions of Samba should work too.
+</para>
+
+<para>
+Author: Alexander Neundorf <email>neundorf at kde.org</email>
+</para>
+</article>
+
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/tar/CMakeLists.txt
similarity index 74%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/tar/CMakeLists.txt
index 0df9c9a..9577b04 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/tar/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/tar)
+
diff --git a/doc/kioslave/tar/index.docbook b/doc/kioslave/tar/index.docbook
new file mode 100644
index 0000000..d15770a
--- /dev/null
+++ b/doc/kioslave/tar/index.docbook
@@ -0,0 +1,25 @@
+<?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="tar">
+<title>tar</title>
+<articleinfo>
+<authorgroup>
+<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para>
+An archiving program designed to store and extract files from an archive 
+file known as a tarfile. A tarfile may be made on a tape drive, however, it 
+is also common to write a tarfile to a normal file.
+</para>
+
+<para> See the manual: <ulink url="man:/tar">tar</ulink>.
+</para>
+
+</article>
diff --git a/doc/kioslave/CMakeLists.txt b/doc/kioslave/thumbnail/CMakeLists.txt
similarity index 71%
copy from doc/kioslave/CMakeLists.txt
copy to doc/kioslave/thumbnail/CMakeLists.txt
index 0df9c9a..987324e 100644
--- a/doc/kioslave/CMakeLists.txt
+++ b/doc/kioslave/thumbnail/CMakeLists.txt
@@ -1,4 +1,3 @@
 ########### install files ###############
-#
-#
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kioslave/thumbnail)
+
diff --git a/doc/kioslave/thumbnail/index.docbook b/doc/kioslave/thumbnail/index.docbook
new file mode 100644
index 0000000..5cbd9a2
--- /dev/null
+++ b/doc/kioslave/thumbnail/index.docbook
@@ -0,0 +1,35 @@
+<?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="thumbnail">
+<title>thumbnail</title>
+<articleinfo>
+<authorgroup>
+<author>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</articleinfo>
+<para>The thumbnail kioslave is used by &kde; for network transparent
+and persistent generation of thumbnails.</para>
+
+<para>The thumbnail kioslave uses plugins to generate the actual
+thumbnails.  You can enable viewing of these thumbnails from the
+<menuchoice><guimenu>View</guimenu>
+<guisubmenu>Preview</guisubmenu></menuchoice> submenu, available in
+&konqueror; in file manager mode.</para>
+
+<para>The thumbnail kioslave is not directly useful to a user, but if
+you are a developer, you can use it within your own applications to
+create file previews.</para>
+
+<para>See the documentation in the sources for more information.  You
+will find these at
+<filename>$<envar>KDEDIR</envar>/include/kio/thumbcreator.h</filename> or
+in the source folder <filename
+class="directory">kdebase/runtime/kioslave/thumbnail</filename></para>
+
+</article>



More information about the kde-doc-english mailing list