diff options
| author | Darrell Anderson <humanreadable@yahoo.com> | 2014-02-10 16:29:07 -0600 |
|---|---|---|
| committer | Darrell Anderson <humanreadable@yahoo.com> | 2014-02-10 16:29:07 -0600 |
| commit | 50741cc5474353bba914746aa25b091aa609a38f (patch) | |
| tree | 4749d137bae305e246f62dd290273b55d926ad3a /doc | |
| parent | 9abee0aada612f8cc875ff33f02c92c1211cb56f (diff) | |
| download | tdebase-50741cc5474353bba914746aa25b091aa609a38f.tar.gz tdebase-50741cc5474353bba914746aa25b091aa609a38f.zip | |
Remove KControl Protocols module, move protocol items to the help handbook,
rename TDEIOSlaves->Protocols, add new help files, update other help files,
make protocol handbooks consistent in format.
Diffstat (limited to 'doc')
97 files changed, 2079 insertions, 274 deletions
diff --git a/doc/glossary/index.docbook b/doc/glossary/index.docbook index a6071879e..a812b50f4 100644 --- a/doc/glossary/index.docbook +++ b/doc/glossary/index.docbook @@ -4,7 +4,6 @@ <!ENTITY % English "INCLUDE"> <!ENTITY glossary-tdeprinting SYSTEM "tdeprintingglossary.docbook"> - ]> diff --git a/doc/kcontrol/display/index.docbook b/doc/kcontrol/display/index.docbook index d7f5cb970..6e5a49d03 100644 --- a/doc/kcontrol/display/index.docbook +++ b/doc/kcontrol/display/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Display Settings</title> diff --git a/doc/kcontrol/displayconfig/index.docbook b/doc/kcontrol/displayconfig/index.docbook index 5180ef03c..b2098576c 100644 --- a/doc/kcontrol/displayconfig/index.docbook +++ b/doc/kcontrol/displayconfig/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Monitor and Display Settings</title> diff --git a/doc/kcontrol/dnssd/index.docbook b/doc/kcontrol/dnssd/index.docbook index 5ad214092..eb1d4a45b 100644 --- a/doc/kcontrol/dnssd/index.docbook +++ b/doc/kcontrol/dnssd/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Zeroconf Service Discovery</title> diff --git a/doc/kcontrol/hwmanager/index.docbook b/doc/kcontrol/hwmanager/index.docbook index 79c71babe..368dec032 100644 --- a/doc/kcontrol/hwmanager/index.docbook +++ b/doc/kcontrol/hwmanager/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Hardware Device Manager</title> diff --git a/doc/kcontrol/iccconfig/index.docbook b/doc/kcontrol/iccconfig/index.docbook index 27566d011..501826ca4 100644 --- a/doc/kcontrol/iccconfig/index.docbook +++ b/doc/kcontrol/iccconfig/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>ICC Color Profile</title> diff --git a/doc/kcontrol/khotkeys/index.docbook b/doc/kcontrol/khotkeys/index.docbook index 9e8706a94..8856aac71 100644 --- a/doc/kcontrol/khotkeys/index.docbook +++ b/doc/kcontrol/khotkeys/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Input Actions</title> diff --git a/doc/kcontrol/media/index.docbook b/doc/kcontrol/media/index.docbook index dd7d91744..bb21236f4 100644 --- a/doc/kcontrol/media/index.docbook +++ b/doc/kcontrol/media/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Storage Media</title> diff --git a/doc/kcontrol/protocols/Makefile.am b/doc/kcontrol/protocols/Makefile.am deleted file mode 100644 index f46684563..000000000 --- a/doc/kcontrol/protocols/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ - -KDE_LANG= en -KDE_DOCS = kcontrol/protocols diff --git a/doc/kcontrol/protocols/index.docbook b/doc/kcontrol/protocols/index.docbook deleted file mode 100644 index c84aef578..000000000 --- a/doc/kcontrol/protocols/index.docbook +++ /dev/null @@ -1,39 +0,0 @@ -<?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;"> -<title>Protocols</title> - -<articleinfo> -<authorgroup> -<author>&Lauri.Watts;</author> -<!-- TRANS:ROLES_OF_TRANSLATORS --> -</authorgroup> - -<keywordset> -<keyword>KDE</keyword> -<keyword>Protocols</keyword> -<keyword>IOSlaves</keyword> -</keywordset> -</articleinfo> - -<sect1 id="protocols"> -<title>Protocols</title> - -<para>On the left of the panel you will see a list of the IOSlaves that -are installed on your system. IOSlaves are how &tde; applications -<quote>talk</quote> to other computers, other applications, or act on -files.</para> - -<para>Clicking on an IOSlave name will display some help information -about that IOSlave, such as how to use it, and what it does.</para> - -<para>The protocols module is purely informational, you cannot change -any settings here.</para> - -</sect1> -</article>
\ No newline at end of file diff --git a/doc/kdcop/index.docbook b/doc/kdcop/index.docbook index 983dd53f2..4a632d4b3 100644 --- a/doc/kdcop/index.docbook +++ b/doc/kdcop/index.docbook @@ -5,10 +5,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>The &kappname; Handbook</title> diff --git a/doc/kcontrol/protocols/CMakeLists.txt b/doc/tdeioslave/about/CMakeLists.txt index 51032628c..1db847fb6 100644 --- a/doc/kcontrol/protocols/CMakeLists.txt +++ b/doc/tdeioslave/about/CMakeLists.txt @@ -1,12 +1,9 @@ ################################################# # -# (C) 2010-2011 Serghei Amelian -# serghei (DOT) amelian (AT) gmail.com -# # Improvements and feedback are welcome # # This file is released under GPL >= 2 # ################################################# -tde_create_handbook( DESTINATION kcontrol/protocols ) +tde_create_handbook( DESTINATION tdeioslave/about ) diff --git a/doc/tdeioslave/about/Makefile.am b/doc/tdeioslave/about/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/about/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/about/index.docbook b/doc/tdeioslave/about/index.docbook new file mode 100644 index 000000000..c51c5b66c --- /dev/null +++ b/doc/tdeioslave/about/index.docbook @@ -0,0 +1,57 @@ +<?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="about"> +<title>about</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 about protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>about</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/applications/CMakeLists.txt b/doc/tdeioslave/applications/CMakeLists.txt new file mode 100644 index 000000000..5e844c005 --- /dev/null +++ b/doc/tdeioslave/applications/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/applications ) diff --git a/doc/tdeioslave/applications/Makefile.am b/doc/tdeioslave/applications/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/applications/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/applications/index.docbook b/doc/tdeioslave/applications/index.docbook new file mode 100644 index 000000000..2215855e0 --- /dev/null +++ b/doc/tdeioslave/applications/index.docbook @@ -0,0 +1,57 @@ +<?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="applications"> +<title>applications</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 applications protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>applications</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/ar/CMakeLists.txt b/doc/tdeioslave/ar/CMakeLists.txt new file mode 100644 index 000000000..ab7edd941 --- /dev/null +++ b/doc/tdeioslave/ar/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/ar ) diff --git a/doc/tdeioslave/ar/Makefile.am b/doc/tdeioslave/ar/Makefile.am new file mode 100644 index 000000000..e2b4850e4 --- /dev/null +++ b/doc/tdeioslave/ar/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = tdeioslave/tar diff --git a/doc/tdeioslave/ar/index.docbook b/doc/tdeioslave/ar/index.docbook new file mode 100644 index 000000000..f577f379a --- /dev/null +++ b/doc/tdeioslave/ar/index.docbook @@ -0,0 +1,53 @@ +<?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 --> +]> + +<article lang="&language;" id="tar"> +<title>ar</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 ar protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>ar</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para> +An archiving program designed to store and extract files. Today ar generally is used only to +create and update static library files that the link editor or linker uses. For other purposes +ar is replaced by tar and other compression methods. +</para> + +<para> +Source: <ulink url="https://en.wikipedia.org/wiki/Ar_%28Unix%29"> Wikipedia</ulink> +</para> + +<para>Read the man page: <ulink url="man:/ar">ar</ulink>. +</para> + +</article> diff --git a/doc/tdeioslave/bzip/index.docbook b/doc/tdeioslave/bzip/index.docbook index be3ff6cbd..ff8cc8bfa 100644 --- a/doc/tdeioslave/bzip/index.docbook +++ b/doc/tdeioslave/bzip/index.docbook @@ -6,19 +6,47 @@ <article lang="&language;" id="bzip"> <title>bzip</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the bzip protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>bzip</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> -<para><command>bzip</command> is a compression program. It is rarely +<para><command>bzip</command> is a compression program. It is rarely used today, having been replaced with bzip2, which offers much better compression.</para> -<para>The bzip tdeioslave is not directly usable, and is intended for use -as a filter. For example, the tar tdeioslave can filter a file through +<para>The bzip tdeioslave is not directly usable and is intended for use +as a filter. For example, the tar tdeioslave can filter a file through the bzip tdeioslave, in order to display the contents of a <literal role="extension">tar.bz</literal> file directly in a &konqueror; window.</para> @@ -28,8 +56,4 @@ role="extension">bz</literal> extension in &konqueror;, this tdeioslave 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 bzip filter, -you can find documentation on using tdeioslaves at <ulink -url="http://developer.kde.org">http://developer.kde.org</ulink></para> - </article> diff --git a/doc/tdeioslave/bzip2/index.docbook b/doc/tdeioslave/bzip2/index.docbook index 3794a825f..c602ec9cb 100644 --- a/doc/tdeioslave/bzip2/index.docbook +++ b/doc/tdeioslave/bzip2/index.docbook @@ -7,16 +7,43 @@ <article lang="&language;" id="bzip2"> <title>bzip2</title> <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the bzip2 protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>bzip2</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para>Bzip2 is a compression program</para> <para>The bzip2 tdeioslave is not directly usable, and is intended for use -as a filter. For example, the tar tdeioslave can filter a file through +as a filter. For example, the tar tdeioslave can filter a file through the bzip2 tdeioslave, in order to display the contents of a <literal role="extension">tar.bz2</literal> file directly in a &konqueror; window.</para> @@ -25,11 +52,7 @@ window.</para> role="extension">.bz2</literal> in &konqueror;, this tdeioslave 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 tdeioslaves at <ulink -url="http://developer.kde.org">http://developer.kde.org</ulink></para> - -<para> See the manual: <ulink url="man:/bzip2">bzip2</ulink>. +<para>Read the man page: <ulink url="man:/bzip2">bzip2</ulink>. </para> </article> diff --git a/doc/tdeioslave/cgi/index.docbook b/doc/tdeioslave/cgi/index.docbook index 0499cb1b4..18e939a7d 100644 --- a/doc/tdeioslave/cgi/index.docbook +++ b/doc/tdeioslave/cgi/index.docbook @@ -6,11 +6,39 @@ <article lang="&language;" id="cgi"> <title>cgi</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts;&Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the cgi protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>cgi</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para>The <acronym>CGI</acronym> slave provides a way to execute diff --git a/doc/tdeioslave/data/index.docbook b/doc/tdeioslave/data/index.docbook index 68d1b3d0a..e88f4d5a1 100644 --- a/doc/tdeioslave/data/index.docbook +++ b/doc/tdeioslave/data/index.docbook @@ -8,16 +8,37 @@ <title>Data URLs</title> <articleinfo> + <authorgroup> <author><personname><firstname>Leo</firstname><surname>Savernik</surname></personname> -<address><email>l.savernik@aon.at</email></address> </author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> -<date>2003-02-06</date> -<!--releaseinfo>2.20.00</releaseinfo--> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2003</year> +<holder>Leo Savernik</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> +<abstract> +<para> +This handbook describes the data protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>data</keyword> +<keyword>protocol</keyword> +</keywordset> </articleinfo> <para>Data URLs allow small document data to be included in the URL itself. @@ -50,4 +71,3 @@ whereas omitting the charset attribute might lead to something like RFC2397</ulink> provides more information.</para> </article> - diff --git a/doc/tdeioslave/file/index.docbook b/doc/tdeioslave/file/index.docbook index e02842154..d2c6a6fa9 100644 --- a/doc/tdeioslave/file/index.docbook +++ b/doc/tdeioslave/file/index.docbook @@ -7,21 +7,47 @@ <article lang="&language;" id="file"> <title>file</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the file protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>file</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> The <emphasis>file</emphasis> protocol is used by all &tde; applications to display locally available files. </para> -<para> -Entering -<userinput><command>file:/directoryname</command></userinput> in &konqueror; - lists the files of this folder. +<para>Entering <userinput><command>file:/directoryname</command></userinput> in &konqueror; +lists the files of a folder. </para> </article> diff --git a/doc/tdeioslave/finger/index.docbook b/doc/tdeioslave/finger/index.docbook index cb49c3c3d..605a9ffcc 100644 --- a/doc/tdeioslave/finger/index.docbook +++ b/doc/tdeioslave/finger/index.docbook @@ -6,11 +6,39 @@ <article lang="&language;" id="finger"> <title>finger</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts;&Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the finger protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>finger</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para>Finger is a program to display information about users.</para> @@ -33,7 +61,7 @@ on vacation, and all sorts of information.</para> <para>Use the finger tdeioslave like this: <userinput>finger://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput></para> -<para> See the manual: <ulink url="man:/finger">finger</ulink>. +<para>Read the man page: <ulink url="man:/finger">finger</ulink>. </para> </article> diff --git a/doc/tdeioslave/fish/index.docbook b/doc/tdeioslave/fish/index.docbook index 3d35d055e..c92319319 100644 --- a/doc/tdeioslave/fish/index.docbook +++ b/doc/tdeioslave/fish/index.docbook @@ -6,36 +6,62 @@ <article lang="&language;" id="fish"> <title>fish</title> + <articleinfo> <authorgroup> -<author>&Joerg.Walter; &Joerg.Walter.mail;</author> -<author>&Brad.Hards; &Brad.Hards.mail;</author> +<author>&Joerg.Walter;</author> +<author>&Brad.Hards;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> -<date>2005-02-29</date> -<releaseinfo>1.1.2</releaseinfo> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2005</year> +<holder>&Joerg.Walter;</holder> +<holder>&Brad.Hards;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the fish protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>fish</keyword> +<keyword>protocol</keyword> +</keywordset> </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>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 command line tools.</para> <para>You can use the fish tdeioslave like this: -<userinput>fish://<replaceable>hostname</replaceable></userinput> or <userinput>fish://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput>.</para> +<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> +@ symbol) when using 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 +<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: +<para>When 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 @@ -63,8 +89,8 @@ machine, it will be used instead. Then only <command>env</command> and <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 +<para>Fish might 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> diff --git a/doc/tdeioslave/floppy/index.docbook b/doc/tdeioslave/floppy/index.docbook index cabe3323e..b0bd247eb 100644 --- a/doc/tdeioslave/floppy/index.docbook +++ b/doc/tdeioslave/floppy/index.docbook @@ -5,12 +5,40 @@ ]> <article lang="&language;" id="floppy"> -<title>Floppy</title> +<title>floppy</title> + <articleinfo> + <authorgroup> -<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author> +<author>&Alexander.Neundorf;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Alexander.Neundorf;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the floppy protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>floppy</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> @@ -21,7 +49,8 @@ installed on your system. <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> +disk in drive A, then the &URL; will be <userinput><command>floppy:</command><replaceable> +/a/logo.png</replaceable></userinput> </para> <para> @@ -41,9 +70,9 @@ 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. +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. Read the manpage for documentation. </para> <para>The ioslave gives read and write access to the floppy drive, but not @@ -51,7 +80,5 @@ 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@kde.org</email></para> - </article> diff --git a/doc/tdeioslave/fonts/CMakeLists.txt b/doc/tdeioslave/fonts/CMakeLists.txt new file mode 100644 index 000000000..aa1b98494 --- /dev/null +++ b/doc/tdeioslave/fonts/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/fonts ) diff --git a/doc/tdeioslave/fonts/Makefile.am b/doc/tdeioslave/fonts/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/fonts/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/fonts/index.docbook b/doc/tdeioslave/fonts/index.docbook new file mode 100644 index 000000000..fabc70625 --- /dev/null +++ b/doc/tdeioslave/fonts/index.docbook @@ -0,0 +1,57 @@ +<?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="fonts"> +<title>fonts</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 fonts protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>fonts</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/ftp/index.docbook b/doc/tdeioslave/ftp/index.docbook index 6d8eda542..87bbb5142 100644 --- a/doc/tdeioslave/ftp/index.docbook +++ b/doc/tdeioslave/ftp/index.docbook @@ -4,13 +4,41 @@ <!ENTITY % English "INCLUDE" > <!-- change language only here --> ]> -<article id="ftp"> +<article lang="&language;" id="ftp"> <title>&FTP;</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the &FTP; protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>ftp</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> @@ -39,11 +67,11 @@ files at &FTP; archive sites throughout the world. <para> -Source: Paraphrased from <ulink +Original source: Paraphrased from <ulink url="http://tlc.nlm.nih.gov/resources/tutorials/internetdistlrn/ftpdef.htm"> http://tlc.nlm.nih.gov/resources/tutorials/internetdistlrn/ftpdef.htm</ulink> </para> -<para> See the manual: <ulink url="man:/ftp">ftp</ulink>.</para> +<para>Read the man page: <ulink url="man:/ftp">ftp</ulink>.</para> </article> diff --git a/doc/tdeioslave/ghelp/CMakeLists.txt b/doc/tdeioslave/ghelp/CMakeLists.txt new file mode 100644 index 000000000..a68f1fe6e --- /dev/null +++ b/doc/tdeioslave/ghelp/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/ghelp ) diff --git a/doc/tdeioslave/ghelp/Makefile.am b/doc/tdeioslave/ghelp/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/ghelp/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/ghelp/index.docbook b/doc/tdeioslave/ghelp/index.docbook new file mode 100644 index 000000000..037a26554 --- /dev/null +++ b/doc/tdeioslave/ghelp/index.docbook @@ -0,0 +1,57 @@ +<?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="about"> +<title>ghelp</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 ghelp protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>ghelp</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/gopher/index.docbook b/doc/tdeioslave/gopher/index.docbook index ba131cdea..aa6c710e0 100644 --- a/doc/tdeioslave/gopher/index.docbook +++ b/doc/tdeioslave/gopher/index.docbook @@ -6,11 +6,38 @@ <article lang="&language;" id="gopher"> <title>gopher</title> + <articleinfo> <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the gopher protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>gopher</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> @@ -38,7 +65,7 @@ each Gopher server is individually determined. </para> <para> -Source: +Original source: <ulink url="http://tlc.nlm.nih.gov/resources/tutorials/internetdistlrn/gophrdef.htm"> http://tlc.nlm.nih.gov/resources/tutorials/internetdistlrn/gophrdef.htm</ulink> </para> diff --git a/doc/tdeioslave/gzip/index.docbook b/doc/tdeioslave/gzip/index.docbook index 9ce096c37..1a8ebfcef 100644 --- a/doc/tdeioslave/gzip/index.docbook +++ b/doc/tdeioslave/gzip/index.docbook @@ -6,17 +6,45 @@ <article lang="&language;" id="gzip"> <title>gzip</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the gzip protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>gzip</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para><command>gzip</command> is a compression program</para> <para>The gzip tdeioslave is not directly usable, and is intended for use -as a filter. For example, the tar tdeioslave can filter a file through +as a filter. For example, the tar tdeioslave can filter a file through the gzip tdeioslave, in order to display the contents of a <literal role="extension">tar.gz</literal> file directly in a &konqueror; window.</para> @@ -26,11 +54,7 @@ role="extension">gz</literal> extension in &konqueror;, this tdeioslave 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 tdeioslaves at <ulink -url="http://developer.kde.org">http://developer.kde.org</ulink></para> - -<para> See the manual: <ulink url="man:/gzip">gzip</ulink>. +<para>Read the man page: <ulink url="man:/gzip">gzip</ulink>. </para> </article> diff --git a/doc/tdeioslave/help/index.docbook b/doc/tdeioslave/help/index.docbook index f5d67084e..69a47be9d 100644 --- a/doc/tdeioslave/help/index.docbook +++ b/doc/tdeioslave/help/index.docbook @@ -7,18 +7,45 @@ <article lang="&language;" id="help"> <title>help</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer;&Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the help protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>help</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> The help system of &tde; </para> -<para> - See <ulink url="help:/">The &khelpcenter;</ulink>. +<para>See <ulink url="help:/khelpcenter">The &khelpcenter;</ulink>. </para> </article> diff --git a/doc/tdeioslave/home/index.docbook b/doc/tdeioslave/home/index.docbook index 414cd54d6..1a0d01649 100644 --- a/doc/tdeioslave/home/index.docbook +++ b/doc/tdeioslave/home/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Home Base URL Notifier</title> diff --git a/doc/tdeioslave/http/index.docbook b/doc/tdeioslave/http/index.docbook index 7184146d6..43ddccff9 100644 --- a/doc/tdeioslave/http/index.docbook +++ b/doc/tdeioslave/http/index.docbook @@ -7,13 +7,42 @@ <article lang="&language;" id="http"> <title>http / https</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Lauri.Watts;</author> +<author>&Ferdinand.Gassauer;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the http/https protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>http</keyword> +<keyword>https</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para><acronym>http</acronym> is the @@ -25,13 +54,16 @@ connections to http servers, that is, web servers. The most common usage is to view web pages in the &konqueror; web browser.</para> <para>You can use the http tdeioslave in &konqueror; by giving it a -<acronym>URL</acronym>, such as <userinput>http://<replaceable>www.trinitydesktop.org</replaceable></userinput>.</para> +<acronym>URL</acronym>, such as +<userinput>http://<replaceable>www.trinitydesktop.org</replaceable></userinput>.</para> + +<para>HTTPS is HTTP encapsulated in an SSL/TLS stream.</para> -<para> HTTPS is HTTP encapsulated in an SSL/TLS stream.</para> <para>SSL is the Secure Sockets Layer protocol, a security protocol that provides communications privacy over the Internet. The protocol allows client/server applications to communicate in a way that is designed to prevent eavesdropping, tampering, or message forgery.</para> + <para>TLS stands for Transport Layer Security</para> <para>Read the man page: <ulink url="man:/http">http</ulink>.</para> diff --git a/doc/tdeioslave/imap/index.docbook b/doc/tdeioslave/imap/index.docbook index 19b753eef..34247de8a 100644 --- a/doc/tdeioslave/imap/index.docbook +++ b/doc/tdeioslave/imap/index.docbook @@ -6,14 +6,39 @@ <article lang="&language;" id="imap"> <title>imap / imaps</title> + <articleinfo> + <authorgroup> -<author>&Michael.Haeckel; &Michael.Haeckel.mail;</author> +<author>&Michael.Haeckel;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> -<date>2001-08-07</date> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2001</year> +<holder>&Michael.Haeckel;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the imap protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>imap</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> diff --git a/doc/tdeioslave/info/index.docbook b/doc/tdeioslave/info/index.docbook index c0ba13ea9..ea92413d4 100644 --- a/doc/tdeioslave/info/index.docbook +++ b/doc/tdeioslave/info/index.docbook @@ -5,25 +5,53 @@ ]> <article lang="&language;" id="info"> -<title>Info</title> +<title>info</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> <author> <firstname>Nicolas</firstname> <surname>Goutte</surname> - <email>goutte@kde.org</email> </author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +<holder>Nicolas Goutte</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the info protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>info</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> -<para>Info is a type of documentation. The documents are in a file +<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> +your system, from within &konqueror;. You can use it very easily:</para> <screen><userinput><command>info:</command><replaceable>gcc</replaceable></userinput></screen> diff --git a/doc/tdeioslave/iso/CMakeLists.txt b/doc/tdeioslave/iso/CMakeLists.txt new file mode 100644 index 000000000..d9b1866a8 --- /dev/null +++ b/doc/tdeioslave/iso/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/iso ) diff --git a/doc/tdeioslave/iso/Makefile.am b/doc/tdeioslave/iso/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/iso/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/iso/index.docbook b/doc/tdeioslave/iso/index.docbook new file mode 100644 index 000000000..9a6b7ce50 --- /dev/null +++ b/doc/tdeioslave/iso/index.docbook @@ -0,0 +1,57 @@ +<?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="about"> +<title>iso</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 iso protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>iso</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/lan/index.docbook b/doc/tdeioslave/lan/index.docbook index 360c803bc..00c8d5e6d 100644 --- a/doc/tdeioslave/lan/index.docbook +++ b/doc/tdeioslave/lan/index.docbook @@ -7,11 +7,39 @@ <article lang="&language;" id="lan"> <title>lan</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the lan protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>lan</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> @@ -24,7 +52,7 @@ the ability to use other protocols than just <acronym>SMB</acronym>.</para> <para>It must first be configured in &kcontrol;, <menuchoice><guimenu>Network</guimenu><guimenuitem>LAN-Browsing</guimenuitem> -</menuchoice> and for more information see <ulink url="help:/lisa">the +</menuchoice> and for more information refer to <ulink url="help:/lisa">the Lan Browsing manual</ulink>.</para> </article> diff --git a/doc/tdeioslave/ldap/index.docbook b/doc/tdeioslave/ldap/index.docbook index 1149a5f8b..7a3d464dc 100644 --- a/doc/tdeioslave/ldap/index.docbook +++ b/doc/tdeioslave/ldap/index.docbook @@ -6,17 +6,44 @@ <article lang="&language;" id="ldap"> <title>ldap / ldaps</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the ldap protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>ldap</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> -<para><acronym>ldap</acronym> is the lightweight directory access -protocol. It provides access to an X.500 directory, or to a stand-alone -<acronym>LDAP</acronym> server.</para> +<para><acronym>ldap</acronym> is the <emphasis>L</emphasis>ightweight <emphasis>D</emphasis>irectory +<emphasis>A</emphasis>ccess <emphasis>P</emphasis>rotocol. It provides access to an X.500 directory, +or to a stand-alone <acronym>LDAP</acronym> server.</para> <para>You can use the ldap tdeioslave as follows:</para> diff --git a/doc/tdeioslave/mac/index.docbook b/doc/tdeioslave/mac/index.docbook index 7c4cf99c8..6f7381726 100644 --- a/doc/tdeioslave/mac/index.docbook +++ b/doc/tdeioslave/mac/index.docbook @@ -6,18 +6,47 @@ <article lang="&language;" id="mac"> <title>mac</title> + <articleinfo> + <authorgroup> -<author><personname><firstname>Johnathan</firstname><surname>Riddell</surname></personname><email>jr@jriddell.org</email> +<author><personname><firstname>Johnathan</firstname> +<surname>Riddell</surname></personname> </author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +<holder>Johnathan Riddell</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the mac protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>mac</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para>The mac ioslave lets you read an HFS+ partition from &konqueror; -or any other &tde; file dialog. It uses <ulink -url="http://www.google.com/search?hl=en&q=hfsplus+utils"> hfsplus -tools</ulink>, so you will need these installed for it to work.</para> +or any other &tde; file dialog. It uses hfsutils and you will need those +files installed for it to work.</para> <para>Enter <userinput>mac:/</userinput> into &konqueror; and you should see the contents of your &MacOS; partition. If you have not @@ -29,7 +58,7 @@ can probably guess by changing hda2 to hda3 and so on or use the print command from <command>mac-fdisk</command>). This partition will be used the next time, so you do not have to specify it each time.</para> -<para><application>Hfsplus tools</application> let you see the file and copy +<para><application>Hfsutils tools</application> let you see the file and copy data from the HFS+ partition, but not to copy data to it or change the filenames.</para> @@ -46,7 +75,7 @@ another query: <userinput>mac:/<option>myfile?mode=t</option></userinput>. See the <command>hpcopy</command> man page for more.</para> -<para>Note that you need permissions to read your HFS+ partition. How +<para>Note that you need permissions to read your HFS+ partition. How you get this depends on your distribution. <!-- , do a <command>ls -l /dev/hdaX</command> on it to see. Under Debian you have to be in the 'disk' group (just add your username to the end of the entry in diff --git a/doc/tdeioslave/mailto/index.docbook b/doc/tdeioslave/mailto/index.docbook index d83105fb9..1018817bc 100644 --- a/doc/tdeioslave/mailto/index.docbook +++ b/doc/tdeioslave/mailto/index.docbook @@ -7,18 +7,46 @@ <article lang="&language;" id="mailto"> <title>mailto</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the mailto protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>mailto</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para>The mailto tdeioslave is used when you click on a mailto link in an -<acronym>HTML</acronym> page. &konqueror; will open the preferred mail -client you have configured, with a composer window. Any information +<acronym>HTML</acronym> page. &konqueror; will open the preferred mail +client you have configured, with a composer window. Any information supplied in the <acronym>URL</acronym> will be filled in for you.</para> -<para> -See the manual: <ulink url="man:/mailto">mailto</ulink>. +<para>Read the man page: <ulink url="man:/mailto">mailto</ulink>. </para> </article> diff --git a/doc/tdeioslave/man/index.docbook b/doc/tdeioslave/man/index.docbook index 8fef2a88b..9530e4608 100644 --- a/doc/tdeioslave/man/index.docbook +++ b/doc/tdeioslave/man/index.docbook @@ -5,17 +5,45 @@ ]> <article lang="&language;" id="man"> -<title>Man</title> +<title>man</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> <author> <firstname>Nicolas</firstname> <surname>Goutte</surname> - <email>goutte@kde.org</email> </author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +<holder>Nicolas Goutte</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the man protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>man</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> @@ -85,8 +113,4 @@ As with any other &tde; ioslave, it is possible to enter a &URL;, like &HTML; format. </para> -<para> -Contact mailing list: <email>kde-devel@kde.org</email> -</para> - </article> diff --git a/doc/tdeioslave/media/index.docbook b/doc/tdeioslave/media/index.docbook index 6c2dcb227..de9d91d69 100644 --- a/doc/tdeioslave/media/index.docbook +++ b/doc/tdeioslave/media/index.docbook @@ -4,12 +4,8 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> -<title>Media Manager Service</title> +<title>media</title> <articleinfo> @@ -28,7 +24,7 @@ <abstract> <para> -This handbook describes the Media Manager Service. +This handbook describes the media protocol. </para> </abstract> @@ -36,14 +32,14 @@ This handbook describes the Media Manager Service. <keyword>TDE</keyword> <keyword>KDED</keyword> <keyword>media</keyword> -<keyword>service</keyword> +<keyword>protocol</keyword> </keywordset> </articleinfo> <sect1 id="apologies"> <title>We Apologize</title> -<para>No documentation has yet been written for this service.</para> +<para>No documentation has yet been written for this protocol.</para> <para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> diff --git a/doc/tdeioslave/metainfo/CMakeLists.txt b/doc/tdeioslave/metainfo/CMakeLists.txt new file mode 100644 index 000000000..b247d155b --- /dev/null +++ b/doc/tdeioslave/metainfo/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/metainfo ) diff --git a/doc/tdeioslave/metainfo/Makefile.am b/doc/tdeioslave/metainfo/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/metainfo/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/metainfo/index.docbook b/doc/tdeioslave/metainfo/index.docbook new file mode 100644 index 000000000..cd37c2a1d --- /dev/null +++ b/doc/tdeioslave/metainfo/index.docbook @@ -0,0 +1,57 @@ +<?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="about"> +<title>metainfo</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 metainfo protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>metainfo</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/mms/CMakeLists.txt b/doc/tdeioslave/mms/CMakeLists.txt new file mode 100644 index 000000000..58b212963 --- /dev/null +++ b/doc/tdeioslave/mms/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/mms ) diff --git a/doc/tdeioslave/mms/Makefile.am b/doc/tdeioslave/mms/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/mms/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/mms/index.docbook b/doc/tdeioslave/mms/index.docbook new file mode 100644 index 000000000..454164620 --- /dev/null +++ b/doc/tdeioslave/mms/index.docbook @@ -0,0 +1,49 @@ +<?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="about"> +<title>mms / mmst / mmsu</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 mms (Microsoft Media Server) protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>mms</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para>The mms/mmst/mmsu protocols are Microsoft proprietary network-streaming protocols, +previously called NetShow Services. The protocols have been deprecated in favor of the +<ulink url="help:/tdeioslave/rtsp">rtsp (Real Time Streaming Protocol)</ulink> protocol.</para> + +<para>mmst uses tcp and mmsu uses udp.</para> + +<para>Source: <ulink url="https://en.wikipedia.org/wiki/Microsoft_Media_Server">Wikipedia</ulink></para> + +&underFDL; + +</article> diff --git a/doc/tdeioslave/mrml/index.docbook b/doc/tdeioslave/mrml/index.docbook index 890f18db9..6189f37b8 100644 --- a/doc/tdeioslave/mrml/index.docbook +++ b/doc/tdeioslave/mrml/index.docbook @@ -6,27 +6,49 @@ <article lang="&language;" id="mrml"> <title>mrml</title> + <articleinfo> + <authorgroup> -<author>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail; -</author> +<author>&Carsten.Pfeiffer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> - -<date>2003-01-08</date> - +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2003</year> +<holder>&Carsten.Pfeiffer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the mrml protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>mrml</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> -<para><acronym>MRML</acronym> stands for Multimedia Retrieval Markup Language. <acronym>MRML</acronym> is an XML-based -protocol to provide standardized access to Multimedia retrieval software. -See <ulink url="http://www.mrml.net">http://www.mrml.net</ulink> for more information. +<para><acronym>MRML</acronym> stands for Multimedia Retrieval Markup Language. <acronym>MRML</acronym> +is an XML-based protocol to provide standardized access to multimedia retrieval software. </para> -<para>tdeio_mrml is used for the Image Finding feature in &tde;</para> +<para>tdeio_mrml is used for the Image Finding feature in &tde;.</para> -<para>⪚ type <userinput>mrml:/</userinput> or <userinput>mrml:/some.other.server</userinput> in &konqueror; to start searching for -images. +<para>For example, type <userinput>mrml:/</userinput> or <userinput>mrml:/some.other.server</userinput> +in &konqueror; to start searching for images. </para> </article> diff --git a/doc/tdeioslave/news/index.docbook b/doc/tdeioslave/news/index.docbook index ac356382f..56fbafc8b 100644 --- a/doc/tdeioslave/news/index.docbook +++ b/doc/tdeioslave/news/index.docbook @@ -6,16 +6,43 @@ <article lang="&language;" id="news"> <title>news</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> -</articleinfo> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the news protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>news</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> <para>The news tdeioslave is used when you click on a news link on a web -page. It will open &knode;, and if the group referred to in the news +page. It will open &knode;, and if the group referred to in the news link is available from your server, it will subscribe you to the group, in the first available account you have configured in &knode;</para> diff --git a/doc/tdeioslave/nfs/index.docbook b/doc/tdeioslave/nfs/index.docbook index 3c97237ab..44fbaddb9 100644 --- a/doc/tdeioslave/nfs/index.docbook +++ b/doc/tdeioslave/nfs/index.docbook @@ -6,12 +6,41 @@ <article lang="&language;" id="nfs"> <title>nfs</title> + <articleinfo> + <authorgroup> -<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author>&Lauri.Watts;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the nfs protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>nfs</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para> Sun's <acronym>NFS</acronym> protocol provides transparent remote access to shared file systems across networks. The <acronym>NFS</acronym> protocol is @@ -40,6 +69,6 @@ Source: http://www.networksorcery.com/enp/protocol/nfs.htm</ulink> </para> -<para> See the manual: <ulink url="man:/nfs">nfs</ulink>. +<para>Read the man page: <ulink url="man:/nfs">nfs</ulink>. </para> </article> diff --git a/doc/tdeioslave/nntp/index.docbook b/doc/tdeioslave/nntp/index.docbook index f3165d400..c0f4214a5 100644 --- a/doc/tdeioslave/nntp/index.docbook +++ b/doc/tdeioslave/nntp/index.docbook @@ -6,13 +6,41 @@ <article lang="&language;" id="nntp"> <title>nntp / nntps</title> + <articleinfo> + <authorgroup> <author>&Lauri.Watts;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Lauri.Watts;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the nntp protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>nntp</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para>The nntp tdeioslave accesses <acronym>NNTP</acronym> servers directly.</para> diff --git a/doc/tdeioslave/pnm/CMakeLists.txt b/doc/tdeioslave/pnm/CMakeLists.txt new file mode 100644 index 000000000..e1573c400 --- /dev/null +++ b/doc/tdeioslave/pnm/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/pnm ) diff --git a/doc/tdeioslave/pnm/Makefile.am b/doc/tdeioslave/pnm/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/pnm/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/pnm/index.docbook b/doc/tdeioslave/pnm/index.docbook new file mode 100644 index 000000000..883100e56 --- /dev/null +++ b/doc/tdeioslave/pnm/index.docbook @@ -0,0 +1,45 @@ +<?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="about"> +<title>pnm</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 pnm protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>pnm</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para>The pnm protocol is the former name for the +<ulink url="help:/tdeioslave/rtsp">rtsp (Real Time Streaming Protocol)</ulink> +network-streaming protocol.</para> + +&underFDL; + +</article> diff --git a/doc/tdeioslave/pop3/index.docbook b/doc/tdeioslave/pop3/index.docbook index 2e822967a..a75059f97 100644 --- a/doc/tdeioslave/pop3/index.docbook +++ b/doc/tdeioslave/pop3/index.docbook @@ -7,12 +7,39 @@ <article lang="&language;" id="pop3"> <title>pop3 / pop3s</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the pop3 protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>pop3</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para> diff --git a/doc/tdeioslave/print/index.docbook b/doc/tdeioslave/print/index.docbook index 44a7e6cb0..4febda243 100644 --- a/doc/tdeioslave/print/index.docbook +++ b/doc/tdeioslave/print/index.docbook @@ -6,26 +6,47 @@ <article lang="&language;" id="print"> <title>print</title> + <articleinfo> <authorgroup> <author>&Kurt.Pfeifle;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> - </authorgroup> -<date>2002-06-23</date> -<releaseinfo>1.00.00</releaseinfo> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2002</year> +<holder>&Kurt.Pfeifle;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the print protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>print</keyword> +<keyword>protocol</keyword> +</keywordset> </articleinfo> -<para>The <acronym>print</acronym> TDEIOSlave gives quick access to browse +<para>The <acronym>print</acronym> tdeio slave gives quick access to browse different &tdeprint; sections via <quote>virtual folders</quote>. These folders provide some information about and quick access to your print subsystem.</para> <para><command>print:/</command> represents one more of those useful -TDEIOSlaves implemented by &tde;. To access it, just type <userinput>print:/ +tdeio slaves implemented by &tde;. To access it, just type <userinput>print:/ </userinput> into the address field of &konqueror;. <userinput>print:/ </userinput> doesn't purely provide <quote>read-only</quote> access to your print subsystem, but it also allows you to change settings @@ -42,14 +63,12 @@ not allowed a view or an operation as a normal user.</para> <userinput>print:/[path-to-virtual-folder]</userinput> or <userinput>print:[path-to-virtual-folder]</userinput></para> -<para>Note, that some of the views and actions offered do heavily +<para>Note that some of the views and actions offered do heavily depend on the print subsystem that is installed on your box and presently activated for &tde;. Pages showing printer information display only those parts that are valid for the &tde; selected print subsystem. (So if you normally run <acronym>CUPS</acronym>, but switched temporarily to - - - <quote>Generic UNIX LPD Printing</quote>, which is possible, you will see +<quote>Generic UNIX LPD Printing</quote>, which is possible, you will see less printer info, because LPD is not capable of using the same amount of print settings as are possible in CUPS).</para> @@ -165,7 +184,7 @@ or <userinput>print:printers/printer_name </userinput> </term> <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>)</para></tip> <para>You can learn more about printing and &tdeprint;'s powerful abilities -by reading the <ulink url="help:/tdeprint/index.html">&tdeprint; Handbook</ulink>. +by reading the <ulink url="help:/tdeprint">&tdeprint; Handbook</ulink>. </para> </article> diff --git a/doc/tdeioslave/printdb/CMakeLists.txt b/doc/tdeioslave/printdb/CMakeLists.txt new file mode 100644 index 000000000..b56a199ea --- /dev/null +++ b/doc/tdeioslave/printdb/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/printdb ) diff --git a/doc/tdeioslave/printdb/Makefile.am b/doc/tdeioslave/printdb/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/printdb/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/printdb/index.docbook b/doc/tdeioslave/printdb/index.docbook new file mode 100644 index 000000000..3a025c395 --- /dev/null +++ b/doc/tdeioslave/printdb/index.docbook @@ -0,0 +1,57 @@ +<?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="printdb"> +<title>printdb</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 printdb protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>printdb</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/programs/CMakeLists.txt b/doc/tdeioslave/programs/CMakeLists.txt new file mode 100644 index 000000000..9c4982d3e --- /dev/null +++ b/doc/tdeioslave/programs/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/programs ) diff --git a/doc/tdeioslave/programs/Makefile.am b/doc/tdeioslave/programs/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/programs/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/programs/index.docbook b/doc/tdeioslave/programs/index.docbook new file mode 100644 index 000000000..111b8fd86 --- /dev/null +++ b/doc/tdeioslave/programs/index.docbook @@ -0,0 +1,57 @@ +<?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="programs"> +<title>programs</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 programs protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>programs</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/remote/index.docbook b/doc/tdeioslave/remote/index.docbook index 510cc436d..2d494d498 100644 --- a/doc/tdeioslave/remote/index.docbook +++ b/doc/tdeioslave/remote/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>Remote Base URL Notifier</title> diff --git a/doc/tdeioslave/rlogin/index.docbook b/doc/tdeioslave/rlogin/index.docbook index 59c448feb..215e14436 100644 --- a/doc/tdeioslave/rlogin/index.docbook +++ b/doc/tdeioslave/rlogin/index.docbook @@ -6,12 +6,41 @@ <article lang="&language;" id="rlogin"> <title>rlogin</title> + <articleinfo> + <authorgroup> <author><personname><firstname>Christian</firstname><surname>Bunting</surname></personname></author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>Christian Bunting</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the rlogin protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>rlogin</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para>Using &konqueror; you can start up an <command>rlogin</command> session with a server hosting the rlogin service.</para> @@ -28,10 +57,7 @@ account you are currently using in &tde;.</para> <para>After you have successfully entered your password, you can begin your remote session.</para> -<para> See the manual: <ulink url="man:/rlogin">rlogin</ulink>. +<para>Read the man page: <ulink url="man:/rlogin">rlogin</ulink>. </para> - -<!-- By Christian Bunting (need to ask if he wants crediting and email) --> - </article> diff --git a/doc/tdeioslave/rtsp/CMakeLists.txt b/doc/tdeioslave/rtsp/CMakeLists.txt new file mode 100644 index 000000000..4fe25d41f --- /dev/null +++ b/doc/tdeioslave/rtsp/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/rtsp ) diff --git a/doc/tdeioslave/rtsp/Makefile.am b/doc/tdeioslave/rtsp/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/rtsp/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/rtsp/index.docbook b/doc/tdeioslave/rtsp/index.docbook new file mode 100644 index 000000000..ae92527cb --- /dev/null +++ b/doc/tdeioslave/rtsp/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="about"> +<title>rtsp / rtspt / rtspu</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 rtsp (Real Time Streaming Protocol) protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>rtsp</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para>The rtsp/rtspt/rtspu protocols are Microsoft proprietary network-streaming protocols.</para> + +<para>rtspt uses tcp and rtspu uses udp.</para> + +<para>Source: <ulink url="https://en.wikipedia.org/wiki/RTSP">Wikipedia</ulink></para> + +&underFDL; + +</article> diff --git a/doc/tdeioslave/settings/CMakeLists.txt b/doc/tdeioslave/settings/CMakeLists.txt new file mode 100644 index 000000000..14ce99933 --- /dev/null +++ b/doc/tdeioslave/settings/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/settings ) diff --git a/doc/tdeioslave/settings/Makefile.am b/doc/tdeioslave/settings/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/settings/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/settings/index.docbook b/doc/tdeioslave/settings/index.docbook new file mode 100644 index 000000000..36d879c1a --- /dev/null +++ b/doc/tdeioslave/settings/index.docbook @@ -0,0 +1,57 @@ +<?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="settings"> +<title>settings</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 settings protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>settings</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this protocol.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/tdeioslave/sftp/index.docbook b/doc/tdeioslave/sftp/index.docbook index 228d43808..5ad95075d 100644 --- a/doc/tdeioslave/sftp/index.docbook +++ b/doc/tdeioslave/sftp/index.docbook @@ -7,12 +7,41 @@ <article lang="&language;" id="sftp"> <title>sftp</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the sftp protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>sftp</keyword> +<keyword>protocol</keyword> +</keywordset> + </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 @@ -20,7 +49,7 @@ similar to ftp, but it performs all operations over an encrypted <command>ssh</command>, including public key authentication and compression.</para> -<para> See the manual: <ulink url="man:/sftp">sftp</ulink>. +<para>Read the man page: <ulink url="man:/sftp">sftp</ulink>. </para> </article> diff --git a/doc/tdeioslave/smb/index.docbook b/doc/tdeioslave/smb/index.docbook index e3bca3f70..10bf302af 100644 --- a/doc/tdeioslave/smb/index.docbook +++ b/doc/tdeioslave/smb/index.docbook @@ -5,13 +5,42 @@ ]> <article lang="&language;" id="smb"> -<title>SMB</title> +<title>smb</title> + <articleinfo> + <authorgroup> -<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author> +<author>&Alexander.Neundorf;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Alexander.Neundorf;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the smb protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>smb</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para> The smb ioslave enables you to browse the shares of a &Windows; (or Samba) network. @@ -29,13 +58,15 @@ will list the hosts in this workgroup. 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>. +<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> +<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host +</replaceable>/<replaceable>the_share</replaceable></userinput> </para> <para> @@ -46,17 +77,9 @@ The smb ioslave requires that you have libsmbclient to use this ioslave. 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 tdeioslave 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. +member of a &Windows; domain. There you can also set your +workgroup name, but in most cases this is not required. The tdeioslave will ask for your username +and password if a default is not set. </para> -<para> -Author: Alexander Neundorf <email>neundorf@kde.org</email> -</para> </article> - diff --git a/doc/tdeioslave/smtp/index.docbook b/doc/tdeioslave/smtp/index.docbook index 1b8a31cbb..8b27fccf6 100644 --- a/doc/tdeioslave/smtp/index.docbook +++ b/doc/tdeioslave/smtp/index.docbook @@ -6,18 +6,49 @@ ]> <article lang="&language;" id="smtp"> -<title>smtp</title> +<title>smtp / smtps</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the smtp protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>smtp</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para> -A protocol to send mail from the client workstation to the mail server. +A protocol to send mail from a client workstation to a mail server. </para> -<para> See : <ulink url="http://cr.yp.to/smtp.html">Simple Mail Transfer Protocol </ulink>. +<para>SMTPS is the SMTP protocol encrypted via SSL.</para> + +<para>Refer to: <ulink url="http://cr.yp.to/smtp.html">Simple Mail Transfer Protocol </ulink>. </para> </article> diff --git a/doc/tdeioslave/ssh/CMakeLists.txt b/doc/tdeioslave/ssh/CMakeLists.txt new file mode 100644 index 000000000..731c4ec62 --- /dev/null +++ b/doc/tdeioslave/ssh/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/ssh ) diff --git a/doc/tdeioslave/ssh/Makefile.am b/doc/tdeioslave/ssh/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/tdeioslave/ssh/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/tdeioslave/ssh/index.docbook b/doc/tdeioslave/ssh/index.docbook new file mode 100644 index 000000000..9ecb03062 --- /dev/null +++ b/doc/tdeioslave/ssh/index.docbook @@ -0,0 +1,45 @@ +<?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="about"> +<title>ssh</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 ssh protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>ssh</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para>The ssh protocol is the Secure Shell protocol, indended for secure (encrypted) communications +across networks.The ssh protocol was developed to overcome shortcomings of similar protocols that do +not encrypt, such as <ulink url="help:/tdeioslave/telnet">telnet</ulink></para> + +&underFDL; + +</article> diff --git a/doc/tdeioslave/system/index.docbook b/doc/tdeioslave/system/index.docbook index 7ca1b58e0..d9992ec41 100644 --- a/doc/tdeioslave/system/index.docbook +++ b/doc/tdeioslave/system/index.docbook @@ -4,10 +4,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>System Base URL Notifier</title> diff --git a/doc/tdeioslave/tar/index.docbook b/doc/tdeioslave/tar/index.docbook index e785eb051..00310b37f 100644 --- a/doc/tdeioslave/tar/index.docbook +++ b/doc/tdeioslave/tar/index.docbook @@ -7,19 +7,48 @@ <article lang="&language;" id="tar"> <title>tar</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the tar protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>tar</keyword> +<keyword>protocol</keyword> +</keywordset> + </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>Read the man page: <ulink url="man:/tar">tar</ulink>. </para> </article> diff --git a/doc/tdeioslave/telnet/index.docbook b/doc/tdeioslave/telnet/index.docbook index f1326244c..cd4f21faf 100644 --- a/doc/tdeioslave/telnet/index.docbook +++ b/doc/tdeioslave/telnet/index.docbook @@ -7,18 +7,48 @@ <article lang="&language;" id="telnet"> <title>telnet</title> + <articleinfo> + <authorgroup> -<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<author>&Ferdinand.Gassauer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Ferdinand.Gassauer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the telnet protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>telnet</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para> -The network terminal protocol (TELNET) allows a user to log in on any other computer on the network supporting TELNET. +The network terminal protocol (TELNET) allows a user to log in on any other computer on the +network supporting TELNET. </para> -<para> See the manual: <ulink url="man:/telnet">telnet</ulink>. +<para>Read the man page: <ulink url="man:/telnet">telnet</ulink>. </para> </article> diff --git a/doc/tdeioslave/thumbnail/index.docbook b/doc/tdeioslave/thumbnail/index.docbook index 72b12c93b..82686625e 100644 --- a/doc/tdeioslave/thumbnail/index.docbook +++ b/doc/tdeioslave/thumbnail/index.docbook @@ -6,12 +6,41 @@ <article lang="&language;" id="thumbnail"> <title>thumbnail</title> + <articleinfo> + <authorgroup> -<author>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;</author> +<author>&Carsten.Pfeiffer;</author> +<author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Carsten.Pfeiffer;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the thumbnail protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>thumbnail</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> + <para>The thumbnail tdeioslave is used by &tde; for network transparent and persistent generation of thumbnails.</para> diff --git a/doc/tdeioslave/trash/index.docbook b/doc/tdeioslave/trash/index.docbook index 5ba20358b..d76d04187 100644 --- a/doc/tdeioslave/trash/index.docbook +++ b/doc/tdeioslave/trash/index.docbook @@ -1,15 +1,11 @@ <?xml version="1.0" ?> -<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ <!ENTITY % addindex "IGNORE"> <!ENTITY % English "INCLUDE"> ]> - -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - -<article lang="&language;"> -<title>Trash Service</title> +<article id="trash" lang="&language;"> +<title>trash</title> <articleinfo> @@ -28,22 +24,21 @@ <abstract> <para> -This handbook describes the Trash Service. +This handbook describes the trash protocol. </para> </abstract> <keywordset> <keyword>TDE</keyword> -<keyword>KDED</keyword> <keyword>trash</keyword> -<keyword>service</keyword> +<keyword>protocol</keyword> </keywordset> </articleinfo> <sect1 id="apologies"> <title>We Apologize</title> -<para>No documentation has yet been written for this service.</para> +<para>No documentation has yet been written for this protocol.</para> <para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> diff --git a/doc/tdeioslave/webdav/index.docbook b/doc/tdeioslave/webdav/index.docbook index 79f3c3973..afd15909a 100644 --- a/doc/tdeioslave/webdav/index.docbook +++ b/doc/tdeioslave/webdav/index.docbook @@ -8,19 +8,44 @@ <title>webdav / webdavs</title> <articleinfo> + <authorgroup> <author>&Hamish.Rodda;</author> <author>&tde-authors;</author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Hamish.Rodda;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the webdav protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>webdav</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para><acronym>WebDAV</acronym> is a <emphasis>D</emphasis>istributed <emphasis>A</emphasis>uthoring and <emphasis>V</emphasis>ersioning protocol for the World Wide Web. It allows for easy management of documents and scripts on a <ulink -url="help:/tdeioslave/webdav.html">http</ulink> server, and has +url="help:/tdeioslave/http">http</ulink> server, and has additional features designed to simplify version management amongst multiple authors.</para> diff --git a/doc/tdeioslave/xz/index.docbook b/doc/tdeioslave/xz/index.docbook index 74b5b0cd8..13a5b80e2 100644 --- a/doc/tdeioslave/xz/index.docbook +++ b/doc/tdeioslave/xz/index.docbook @@ -14,6 +14,30 @@ <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup> +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>Per Øyvind Karlsen</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the xz protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>xz</keyword> +<keyword>protocol</keyword> +</keywordset> + </articleinfo> <para>Xz is a compression program</para> diff --git a/doc/tdeioslave/zip/CMakeLists.txt b/doc/tdeioslave/zip/CMakeLists.txt new file mode 100644 index 000000000..10814113f --- /dev/null +++ b/doc/tdeioslave/zip/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tdeioslave/zip ) diff --git a/doc/tdeioslave/zip/Makefile.am b/doc/tdeioslave/zip/Makefile.am new file mode 100644 index 000000000..e2b4850e4 --- /dev/null +++ b/doc/tdeioslave/zip/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = tdeioslave/tar diff --git a/doc/tdeioslave/zip/index.docbook b/doc/tdeioslave/zip/index.docbook new file mode 100644 index 000000000..e564a3f58 --- /dev/null +++ b/doc/tdeioslave/zip/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="zip"> +<title>zip</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 zip protocol. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>zip</keyword> +<keyword>protocol</keyword> +</keywordset> + +</articleinfo> + +<para> +An archiving program designed to store and extract files from an archive +file known as a zip file. +</para> + +<para>Read the man page: <ulink url="man:/zip">zip</ulink>. +</para> + +</article> diff --git a/doc/tdeprintfax/index.docbook b/doc/tdeprintfax/index.docbook index b0bff8853..b752dcb34 100644 --- a/doc/tdeprintfax/index.docbook +++ b/doc/tdeprintfax/index.docbook @@ -5,10 +5,6 @@ <!ENTITY % English "INCLUDE"> ]> -<!-- Note: When updating this empty handbook, remember that usually most handbooks --> -<!-- use the book model rather than article. Feel free to use article if the new handbook --> -<!-- remains really short. --> - <article lang="&language;"> <title>The &kappname; Handbook</title> |