diff options
Diffstat (limited to 'doc/kioslave')
41 files changed, 1458 insertions, 0 deletions
diff --git a/doc/kioslave/Makefile.am b/doc/kioslave/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kioslave/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kioslave/bzip.docbook b/doc/kioslave/bzip.docbook new file mode 100644 index 000000000..9a3dc90cb --- /dev/null +++ b/doc/kioslave/bzip.docbook @@ -0,0 +1,29 @@ +<article lang="&language;" id="bzip"> +<title>bzip</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<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 kioslave is not directly usable, and is intended for use +as a filter. For example, the tar kioslave can filter a file through +the bzip kioslave, in order to display the contents of a <literal +role="extension">tar.bz</literal> file directly in a &konqueror; +window.</para> + +<para>If you click on a file compressed with a <literal +role="extension">bz</literal> extension in &konqueror;, this kioslave is +used to uncompress it and display it as a normal (uncompressed) +file.</para> + +<para>If you are a developer, and would like to use the bzip filter, +you can find documentation on using kioslaves at <ulink +url="http://developer.kde.org">http://developer.kde.org</ulink></para> + +</article> diff --git a/doc/kioslave/bzip2.docbook b/doc/kioslave/bzip2.docbook new file mode 100644 index 000000000..9551632a5 --- /dev/null +++ b/doc/kioslave/bzip2.docbook @@ -0,0 +1,29 @@ +<article lang="&language;" id="bzip2"> +<title>bzip2</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para>Bzip2 is a compression program</para> + +<para>The bzip2 kioslave is not directly usable, and is intended for use +as a filter. For example, the tar kioslave can filter a file through +the bzip2 kioslave, in order to display the contents of a <literal +role="extension">tar.bz2</literal> file directly in a &konqueror; +window.</para> + +<para>If you click on a file compressed with a <literal +role="extension">.bz2</literal> in &konqueror;, this kioslave is used to +uncompress it and display it as a normal (uncompressed) file.</para> + +<para>If you are a developer, and would like to use the bzip2 filter, +you can find documentation on using kioslaves at <ulink +url="http://developer.kde.org">http://developer.kde.org</ulink></para> + +<para> See the manual: <ulink url="man:/bzip2">bzip2</ulink>. +</para> + +</article> diff --git a/doc/kioslave/cgi.docbook b/doc/kioslave/cgi.docbook new file mode 100644 index 000000000..5df94da13 --- /dev/null +++ b/doc/kioslave/cgi.docbook @@ -0,0 +1,24 @@ +<article lang="&language;" id="cgi"> +<title>cgi</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts;&Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para>The <acronym>CGI</acronym> slave provides a way to execute +<acronym>CGI</acronym> programs without the need to have a running web +server. This can for example be used for local testing of +<acronym>CGI</acronym> programs or for using search engines that only +provide a <acronym>CGI</acronym> frontend like the one from +<application>Doxygen</application>.</para> + +<para>The slave implements the <command>cgi:</command> protocol. It +uses the filename from the given &URL; and searches a configurable +list of folders. If it finds an executable with the given name it +executes it, passes the arguments of the &URL; and sets the +environment variables needed by <acronym>CGI</acronym> +programs.</para> + +</article> diff --git a/doc/kioslave/data.docbook b/doc/kioslave/data.docbook new file mode 100644 index 000000000..ca0e4e9a5 --- /dev/null +++ b/doc/kioslave/data.docbook @@ -0,0 +1,47 @@ +<article lang="&language;" id="data"> +<title>Data URLs</title> + +<articleinfo> +<authorgroup> +<author><personname><firstname>Leo</firstname><surname>Savernik</surname></personname> +<address><email>l.savernik@aon.at</email></address> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-02-06</date> +<!--releaseinfo>2.20.00</releaseinfo--> + +</articleinfo> + +<para>Data URLs allow small document data to be included in the URL itself. +This is useful for very small HTML testcases or other occasions that do not +justify a document of their own.</para> + +<para><userinput>data:,foobar</userinput> +(note the comma after the colon) will deliver a text document that contains +nothing but <literal>foobar</literal> +</para> + +<para>The last example delivered a text document. For HTML documents one +has to specify the MIME type <literal>text/html</literal>: +<userinput>data:text/html,<title>Testcase</title><p>This +is a testcase</p></userinput>. This will produce exactly the same +output as if the content had been loaded from a document of its own. +</para> + +<para>Specifying alternate character sets is also possible. Note that 8-Bit +characters have to be escaped by a percentage sign and their two-digit +hexadecimal codes: +<userinput>data:;charset=iso-8859-1,Gr%FC%DFe aus Schl%E4gl</userinput> +results in +<literal>Grüße aus Schlägl</literal> +whereas omitting the charset attribute might lead to something like +<literal>Gr??e aus Schl?gl</literal> +</para> + +<para><ulink url="http://www.ietf.org/rfc/rfc2397.txt">IETF +RFC2397</ulink> provides more information.</para> + +</article> + diff --git a/doc/kioslave/file.docbook b/doc/kioslave/file.docbook new file mode 100644 index 000000000..a9031a259 --- /dev/null +++ b/doc/kioslave/file.docbook @@ -0,0 +1,20 @@ +<article lang="&language;" id="file"> +<title>file</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +The <emphasis>file</emphasis> protocol is used by all &kde; applications to +display locally available files. +</para> +<para> +Entering +<userinput><command>file:/directoryname</command></userinput> in &konqueror; + lists the files of this folder. +</para> + +</article> diff --git a/doc/kioslave/finger.docbook b/doc/kioslave/finger.docbook new file mode 100644 index 000000000..27b278c48 --- /dev/null +++ b/doc/kioslave/finger.docbook @@ -0,0 +1,33 @@ +<article lang="&language;" id="finger"> +<title>finger</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts;&Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para>Finger is a program to display information about users.</para> + +<para>If finger is enabled on the remote machine, you may be given +information on the user's real name, if they are currently logged in, if +they have mail and the text of their <filename>.plan</filename> file in +their home folder.</para> + +<para>Finger is normally associated with a user@hostname address, which +may or may not be the same as a users email address.</para> + +<para>Most Internet Service Providers no longer allow finger access, so, +you may find that you get no useful answer for most people.</para> + +<para>Other people use their local <filename>.plan</filename> file to +hold such information as <acronym>PGP</acronym> keys, the fact they are +on vacation, and all sorts of information.</para> + +<para>Use the finger kioslave like this: +<userinput>finger://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput></para> + +<para> See the manual: <ulink url="man:/finger">finger</ulink>. +</para> + +</article> diff --git a/doc/kioslave/fish.docbook b/doc/kioslave/fish.docbook new file mode 100644 index 000000000..5063abd04 --- /dev/null +++ b/doc/kioslave/fish.docbook @@ -0,0 +1,66 @@ +<article lang="&language;" id="fish"> +<title>fish</title> +<articleinfo> +<authorgroup> +<author>&Joerg.Walter; &Joerg.Walter.mail;</author> +<author>&Brad.Hards; &Brad.Hards.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-29</date> +<releaseinfo>1.1.2</releaseinfo> + +</articleinfo> + +<para>Allows you to access another computer's files using the SEcure Shell (<acronym>SSH</acronym>) protocol. The remote computer needs to be running the <acronym>SSH</acronym> daemon, but the remainder of the protocol uses standard commandline tools as discussed below.</para> + +<para>You can use the fish kioslave like this: +<userinput>fish://<replaceable>hostname</replaceable></userinput> or <userinput>fish://<replaceable>username</replaceable>@<replaceable>hostname</replaceable></userinput>.</para> + +<note><para>You need to use double forward slashes.</para></note> + +<para>You can omit the <replaceable>username</replaceable> (and the trailing +@ symbol) if you have the same username on both computers.</para> + +<para>You can add a password in the format: +<userinput>fish://<replaceable>username</replaceable>:<replaceable>password</replaceable>@<replaceable>hostname</replaceable></userinput> +but it is not necessary as you will be prompted for one if it is not +supplied.</para> + +<para>If you are running the <acronym>SSH</acronym> daemon on a non-standard +port, you can specify that port using the normal &URL; syntax as shown +below: +<userinput>fish://<replaceable>hostname</replaceable>:<replaceable>portnumber</replaceable></userinput>.</para> + +<para>Fish should work with any roughly <acronym>POSIX</acronym> compatible +&UNIX; based remote computer. It uses the shell commands +<command>cat</command>, <command>chgrp</command>, +<command>chmod</command>, <command>chown</command>, +<command>cp</command>, <command>dd</command>, +<command>env</command>, <command>expr</command>, +<command>grep</command>, <command>ls</command>, +<command>mkdir</command>, <command>mv</command>, +<command>rm</command>, <command>rmdir</command>, +<command>sed</command>, +and <command>wc</command>. Fish starts +<command>/bin/sh</command> as its shell and expects it to be a +Bourne shell (or compatible, like <command>bash</command>). +If the <command>sed</command> and +<command>file</command> commands are available, as well as a +<filename>/etc/apache/magic</filename> file with &MIME; type +signatures, these will be used to guess &MIME; types. +</para> + +<para>If <application>Perl</application> is available on the remote +machine, it will be used instead. Then only <command>env</command> and +<command>/bin/sh</command> are needed. Using +<application>Perl</application> has the additional benefit of being +faster.</para> + +<para>Fish may even work on &Windows; machines, if tools like +<application>Cygwin</application> are installed. All the above +utilities must be in the system <envar>PATH</envar>, and the initial +shell must be able to process the command <command>echo +FISH:;/bin/sh</command> correctly.</para> + +</article> diff --git a/doc/kioslave/floppy.docbook b/doc/kioslave/floppy.docbook new file mode 100644 index 000000000..ff32c217c --- /dev/null +++ b/doc/kioslave/floppy.docbook @@ -0,0 +1,51 @@ +<article lang="&language;" id="floppy"> +<title>Floppy</title> +<articleinfo> +<authorgroup> +<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +The floppy ioslave gives you easy access to the floppy disk drives +installed on your system. +</para> + +<para> +The drive letter becomes the first subdirectory +in the floppy &URL;. Let's say there is a file <filename>logo.png</filename> on your floppy +disk in drive A, then the &URL; will be <userinput><command>floppy:</command><replaceable>/a/logo.png</replaceable></userinput> +</para> + +<para> +If you want to access drive B, <userinput><command>floppy:/b</command></userinput> will do it. +<command>floppy:/</command> is a shortcut for <command>floppy:/a</command>. +</para> + +<note><para>Note that <command>floppy:/logo.png</command> means you have a disk drive +named <filename>logo.png</filename>.</para></note> + +<para> +To use it you need to have the mtools package +installed, and the floppy ioslave supports everything the various mtools +command line utilities support. You don't have to mount your floppy disks, +simply enter <userinput>floppy:/</userinput> in any &kde; 3.x app and you will be able to +read from and write to your floppy drive.</para> + +<para> +It also works with USB sticks, ZIP and JAZ drives. +You can use <command>floppy:/u</command> for the USB stick and <command>floppy:/z</command> for the zip drive, for example. +To make this work, you might need to adjust your <filename>/etc/mtools</filename> file. See the manpage +for documentation. +</para> + +<para>The ioslave gives read and write access to the floppy drive, but not +simultaneously. While you can read and write to the floppy during the same +session, reading and writing have to happen one after the other, not at the same +time.</para> + +<para>Author: Alexander Neundorf <email>neundorf@kde.org</email></para> + +</article> + diff --git a/doc/kioslave/ftp.docbook b/doc/kioslave/ftp.docbook new file mode 100644 index 000000000..3d4114850 --- /dev/null +++ b/doc/kioslave/ftp.docbook @@ -0,0 +1,43 @@ +<article id="ftp"> +<title>&FTP;</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +&FTP; is the Internet service used to transfer a data file from the disk of +one computer to the disk of another, regardless of the operating system type. +</para> + +<para> Similar to other Internet applications, &FTP; uses the +client-server approach — a user invokes an &FTP; program on the +computer, instructs it to contact a remote computer, and then requests +the transfer of one or more files. The local &FTP; program becomes a +client that uses <acronym>TCP</acronym> to contact an &FTP; server +program on the remote computer. Each time the user requests a file +transfer, the client and the server programs cooperate to send a copy +of the data across the Internet. </para> + +<para> &FTP; servers which allow <quote>anonymous &FTP;</quote> permit +any user, not only users with accounts on the host, to browse the +<quote>ftp</quote> archives and download files. Some &FTP; servers are +configured to allow users to upload files. </para> + +<para> +&FTP; is commonly used to retrieve information and obtain software stored in +files at &FTP; archive sites throughout the world. +</para> + + +<para> +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> + +</article> diff --git a/doc/kioslave/gopher.docbook b/doc/kioslave/gopher.docbook new file mode 100644 index 000000000..29e418faf --- /dev/null +++ b/doc/kioslave/gopher.docbook @@ -0,0 +1,39 @@ +<article lang="&language;" id="gopher"> +<title>gopher</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +<command>gopher</command> began as a distributed campus information service +at the University of Minnesota. Gopher allows the user to access information +on Gopher servers running on Internet hosts.</para> + +<para> +Gopher is an Internet information browsing service that uses a menu-driven +interface. Users select information from menus, which may return another +menu or display a text file. An item may reside on a Gopher server you +originally queried, or it may be on another Gopher server (or another host). +Gopher can <quote>tunnel</quote> from one Gopher to another without the +user knowing that the server and/or host machine have changed. Gopher keeps +the exact location of computers hidden from the user, providing the +<quote>illusion</quote> of a single, large set of interconnected menus. +</para> + +<para> +Gopher permits the user to record an item's location in a +<quote>bookmark</quote> thereby allowing users to follow a +<quote>bookmark</quote> directly to a particular item without +searching the menu system. Gopher menus are not standardized, inasmuch as +each Gopher server is individually determined. +</para> + +<para> +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> +</article> diff --git a/doc/kioslave/gzip.docbook b/doc/kioslave/gzip.docbook new file mode 100644 index 000000000..906f0d654 --- /dev/null +++ b/doc/kioslave/gzip.docbook @@ -0,0 +1,30 @@ +<article lang="&language;" id="gzip"> +<title>gzip</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para><command>gzip</command> is a compression program</para> + +<para>The gzip kioslave is not directly usable, and is intended for use +as a filter. For example, the tar kioslave can filter a file through +the gzip kioslave, in order to display the contents of a <literal +role="extension">tar.gz</literal> file directly in a &konqueror; +window.</para> + +<para>If you click on a file compressed with a <literal +role="extension">gz</literal> extension in &konqueror;, this kioslave is +used to uncompress it and display it as a normal (uncompressed) +file.</para> + +<para>If you are a developer, and would like to use the gzip filter, you +can find documentation on using kioslaves at <ulink +url="http://developer.kde.org">http://developer.kde.org</ulink></para> + +<para> See the manual: <ulink url="man:/gzip">gzip</ulink>. +</para> + +</article> diff --git a/doc/kioslave/help.docbook b/doc/kioslave/help.docbook new file mode 100644 index 000000000..0b38cb93f --- /dev/null +++ b/doc/kioslave/help.docbook @@ -0,0 +1,17 @@ +<article lang="&language;" id="help"> +<title>help</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer;&Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +The help system of &kde; +</para> +<para> + See <ulink url="help:/">The &khelpcenter;</ulink>. +</para> + +</article> diff --git a/doc/kioslave/http.docbook b/doc/kioslave/http.docbook new file mode 100644 index 000000000..0d6a8cef6 --- /dev/null +++ b/doc/kioslave/http.docbook @@ -0,0 +1,25 @@ +<article lang="&language;" id="http"> +<title>http</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para><acronym>http</acronym> is the +<emphasis>H</emphasis>yper<emphasis>T</emphasis>ext +<emphasis>T</emphasis>ransfer <emphasis>P</emphasis>rotocol.</para> + +<para>The http kioslave is used by all &kde; applications to handle +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 kioslave in &konqueror; by giving it a +<acronym>URL</acronym>. +<userinput>http://<replaceable>www.kde.org</replaceable></userinput>.</para> + +<para> See the manual: <ulink url="man:/http">http</ulink>. +</para> + +</article> diff --git a/doc/kioslave/https.docbook b/doc/kioslave/https.docbook new file mode 100644 index 000000000..38772f5dc --- /dev/null +++ b/doc/kioslave/https.docbook @@ -0,0 +1,21 @@ +<article lang="&language;" id="https"> +<title>https</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +HTTPS is +<ulink url="help:/kioslave/http.html">HTTP</ulink> + 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> + +</article> diff --git a/doc/kioslave/imap.docbook b/doc/kioslave/imap.docbook new file mode 100644 index 000000000..e34c1e4e9 --- /dev/null +++ b/doc/kioslave/imap.docbook @@ -0,0 +1,31 @@ +<article lang="&language;" id="imap"> +<title>imap</title> +<articleinfo> +<authorgroup> +<author>&Michael.Haeckel; &Michael.Haeckel.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2001-08-07</date> + + +</articleinfo> + +<para>The IMAP4rev1 protocol (Internet Message Access Protocol) allows +access to messages in mail folders on a server. Unlike POP3, which is designed +to download the mails and delete them from the server, the purpose of IMAP is +to store all mails on the server to be able to access these mails from +everywhere. Messages can be stored on the server, retrieved from there or +moved between folders.</para> + +<para>This plugin is currently mainly used by KMail, but you can also use it +in any other KDE application that uses kioslave plugins.</para> + +<para>For example in &konqueror;, simply type +<userinput>imap://username@your.mail.server/</userinput> to get your IMAP +folders listed. You can then deal with the folders and mails like with folders +and files on a local file system. +IMAP URLs are defined in <ulink url="http://www.ietf.org/rfc/rfc2192.txt?number=2192">RFC 2192</ulink>. +</para> + +</article> diff --git a/doc/kioslave/imaps.docbook b/doc/kioslave/imaps.docbook new file mode 100644 index 000000000..d5f8e7b6f --- /dev/null +++ b/doc/kioslave/imaps.docbook @@ -0,0 +1,17 @@ +<article lang="&language;" id="imaps"> +<title>imaps</title> +<articleinfo> +<authorgroup> +<author>&Michael.Haeckel; &Michael.Haeckel.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2001-08-07</date> + + +</articleinfo> + +<para>IMAPS is the <ulink url="help:/kioslave/imap.html">IMAP</ulink> protocol +encrypted via SSL.</para> + +</article> diff --git a/doc/kioslave/index.docbook b/doc/kioslave/index.docbook new file mode 100644 index 000000000..6f70d6e23 --- /dev/null +++ b/doc/kioslave/index.docbook @@ -0,0 +1,93 @@ +<?xml version="1.0" ?> +<!DOCTYPE part PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY kio-bzip SYSTEM "bzip.docbook"> +<!ENTITY kio-bzip2 SYSTEM "bzip2.docbook"> +<!ENTITY kio-cgi SYSTEM "cgi.docbook"> +<!ENTITY kio-data SYSTEM "data.docbook"> +<!ENTITY kio-file SYSTEM "file.docbook"> +<!ENTITY kio-finger SYSTEM "finger.docbook"> +<!ENTITY kio-fish SYSTEM "fish.docbook"> +<!ENTITY kio-floppy SYSTEM "floppy.docbook"> +<!ENTITY kio-ftp SYSTEM "ftp.docbook"> +<!ENTITY kio-gopher SYSTEM "gopher.docbook"> +<!ENTITY kio-gzip SYSTEM "gzip.docbook"> +<!ENTITY kio-help SYSTEM "help.docbook"> +<!ENTITY kio-http SYSTEM "http.docbook"> +<!ENTITY kio-https SYSTEM "https.docbook"> +<!ENTITY kio-imap SYSTEM "imap.docbook"> +<!ENTITY kio-imaps SYSTEM "imaps.docbook"> +<!ENTITY kio-info SYSTEM "info.docbook"> +<!ENTITY kio-lan SYSTEM "lan.docbook"> +<!ENTITY kio-ldap SYSTEM "ldap.docbook"> +<!ENTITY kio-mailto SYSTEM "mailto.docbook"> +<!ENTITY kio-mac SYSTEM "mac.docbook"> +<!ENTITY kio-man SYSTEM "man.docbook"> +<!ENTITY kio-mrml SYSTEM "mrml.docbook"> <!-- post release, put this in the right module --> +<!ENTITY kio-news SYSTEM "news.docbook"> +<!ENTITY kio-nfs SYSTEM "nfs.docbook"> +<!ENTITY kio-nntp SYSTEM "nntp.docbook"> +<!ENTITY kio-pop3 SYSTEM "pop3.docbook"> +<!ENTITY kio-pop3s SYSTEM "pop3s.docbook"> +<!ENTITY kio-print SYSTEM "print.docbook"> +<!ENTITY kio-rlan SYSTEM "rlan.docbook"> +<!ENTITY kio-rlogin SYSTEM "rlogin.docbook"> +<!ENTITY kio-sftp SYSTEM "sftp.docbook"> +<!ENTITY kio-smb SYSTEM "smb.docbook"> +<!ENTITY kio-smtp SYSTEM "smtp.docbook"> +<!ENTITY kio-tar SYSTEM "tar.docbook"> +<!ENTITY kio-telnet SYSTEM "telnet.docbook"> +<!ENTITY kio-thumbnail SYSTEM "thumbnail.docbook"> +<!ENTITY kio-webdav SYSTEM "webdav.docbook"> +<!ENTITY kio-webdavs SYSTEM "webdavs.docbook"> +<!ENTITY kdeprint "<application>KDEPrint</application>"> +<!ENTITY Ferdinand.Gassauer '<personname><firstname>Ferdinand</firstname><surname>Gassauer</surname></personname>'> +<!ENTITY Ferdinand.Gassauer.mail '<email>f.gassauer@aon.at</email>'> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<part lang="&language;"> +<title>IO-Slaves</title> +&kio-bzip; +&kio-bzip2; +&kio-cgi; +&kio-data; +&kio-file; +&kio-finger; +&kio-fish; +&kio-floppy; +&kio-ftp; +&kio-gopher; +&kio-gzip; +&kio-help; +&kio-http; +&kio-https; +&kio-imap; +&kio-imaps; +&kio-info; +&kio-lan; +&kio-ldap; +&kio-mailto; +&kio-mac; +&kio-man; +&kio-mrml; +&kio-news; +&kio-nfs; +&kio-nntp; +&kio-pop3; +&kio-pop3s; +&kio-print; +&kio-rlan; +&kio-rlogin; +&kio-sftp; +&kio-smb; +&kio-smtp; +&kio-tar; +&kio-telnet; +&kio-thumbnail; +&kio-webdav; +&kio-webdavs; + +</part> + diff --git a/doc/kioslave/info.docbook b/doc/kioslave/info.docbook new file mode 100644 index 000000000..1ea645c33 --- /dev/null +++ b/doc/kioslave/info.docbook @@ -0,0 +1,36 @@ +<article lang="&language;" id="info"> +<title>Info</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author> + <firstname>Nicolas</firstname> + <surname>Goutte</surname> + <email>goutte@kde.org</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para>Info is a type of documentation. The documents are in a file +format called texinfo, and can be read on the command line with the +<command>info</command> program.</para> + +<para>The Info ioslave allows you to read the info pages installed on +your system, from within &konqueror;. You can use it very easily:</para> + +<screen><userinput><command>info:</command><replaceable>gcc</replaceable></userinput></screen> + +<para>This would show you the top level node of the Info documentation +for the &gcc; compiler.</para> + +<para>Info is a &GNU; replacement for +<command>man</command>, but is not widely used outside of +&GNU; software.</para> + +<para>You can quite easily browse the info documentation you have +installed from within the &khelpcenter; application, or you can use the +info ioslave directly from within both &konqueror; and the +mini-cli.</para> + +</article> diff --git a/doc/kioslave/lan.docbook b/doc/kioslave/lan.docbook new file mode 100644 index 000000000..c494b5767 --- /dev/null +++ b/doc/kioslave/lan.docbook @@ -0,0 +1,23 @@ +<article lang="&language;" id="lan"> +<title>lan</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +This protocol is intended to provide a kind of <quote>network +neighborhood</quote> but only relying on the TCP/IP protocol stack and with +the ability to use other protocols than just <acronym>SMB</acronym>.</para> + +<para>The lan kioslave can use &FTP;, &HTTP;, <acronym>SMB</acronym>, +<acronym>NFS</acronym>, and <acronym>FISH</acronym></para> + +<para>It must first be configured in &kcontrol;, +<menuchoice><guimenu>Network</guimenu><guimenuitem>LAN-Browsing</guimenuitem> +</menuchoice> and for more information see <ulink url="help:/lisa">the +Lan Browsing manual</ulink>.</para> + +</article> diff --git a/doc/kioslave/ldap.docbook b/doc/kioslave/ldap.docbook new file mode 100644 index 000000000..ff23339c3 --- /dev/null +++ b/doc/kioslave/ldap.docbook @@ -0,0 +1,23 @@ +<article lang="&language;" id="ldap"> +<title>ldap</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</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>You can use the ldap kioslave as follows:</para> + +<para><userinput>ldap://host:port/ou=People,o=where,c=de??sub</userinput> +for a subtree-query</para> + +<para>or +<userinput>ldap://host:port/cn=MM,ou=People,o=where,c=de??base</userinput> +for a complete branch.</para> + +</article> diff --git a/doc/kioslave/mac.docbook b/doc/kioslave/mac.docbook new file mode 100644 index 000000000..a1398c39a --- /dev/null +++ b/doc/kioslave/mac.docbook @@ -0,0 +1,53 @@ +<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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para>The mac ioslave lets you read an HFS+ partition from &konqueror; +or any other &kde; 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> + +<para>Enter <userinput>mac:/</userinput> into &konqueror; and you +should see the contents of your &MacOS; partition. If you have not +used kio-mac before, you will probably get an error message saying you +have not specified the right partition. Enter something like +<userinput>mac:/<option>?dev=/dev/hda2</option></userinput> to specify +the partition (if you don't know which partition &MacOS; is on, you +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 +data from the HFS+ partition, but not to copy data to it or change the +filenames.</para> + +<para>HFS+ actually keeps two files for every one you see (called +forks), a resource fork and a data fork. The default copy mode when +you are copying files across to your native drive is raw data, which +means it only copies the data fork. Text files are copied in text mode +(same as raw format but changes the line endings to be &UNIX; friendly +and gets rid of some extra characters - strongly advised for text +files), unless you specify otherwise. You can also copy the files +across in Mac Binary II format or specify text or raw format with +another query: +<userinput>mac:/<option>myfile?mode=b</option></userinput> or +<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 +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 +/etc/group).--></para> + +<para>For some reason some folders in &MacOS; end in a funny tall +<quote>f</quote> character. This seems to confuse hfstools.</para> + +</article> + diff --git a/doc/kioslave/mailto.docbook b/doc/kioslave/mailto.docbook new file mode 100644 index 000000000..3603aea8d --- /dev/null +++ b/doc/kioslave/mailto.docbook @@ -0,0 +1,17 @@ +<article lang="&language;" id="mailto"> +<title>mailto</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para>The mailto kioslave 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 +supplied in the <acronym>URL</acronym> will be filled in for you.</para> + +<para> +See the manual: <ulink url="man:/mailto">mailto</ulink>. +</para> +</article> diff --git a/doc/kioslave/man.docbook b/doc/kioslave/man.docbook new file mode 100644 index 000000000..6d2d00c15 --- /dev/null +++ b/doc/kioslave/man.docbook @@ -0,0 +1,86 @@ +<article lang="&language;" id="man"> +<title>Man</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<author> + <firstname>Nicolas</firstname> + <surname>Goutte</surname> + <email>goutte@kde.org</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + +<para> +Using the man ioslave you are able to read the man pages installed +on your system. It is easy to use: +</para> + +<variablelist> +<varlistentry> +<term><userinput><command>man:</command></userinput></term> +<listitem> +<para>See the sections of the manual, click to find the rest. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><userinput><command>man:</command><replaceable>fopen</replaceable></userinput></term> +<listitem> +<para>See the man page of <command>fopen</command>. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><userinput><command>man:</command><replaceable>fopen(3)</replaceable></userinput></term> +<listitem> +<para>See the man page of <command>fopen</command> in section 3. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><userinput><command>man:</command><replaceable>(3)</replaceable></userinput></term> +<listitem> +<para>See the index of section 3. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><userinput><command>man:</command>intro<replaceable>(3)</replaceable></userinput></term> +<listitem> +<para>See the introduction of section 3. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note><para>If there are more than one man page of the name that you +have entered, you will get a list where you can choose the man page +that you want to see.</para></note> + +<para> +There is also a shortcut: <userinput><command>#fopen</command></userinput>, +which has the same effect as above. +</para> + +<para> +If you do not find all your man pages, adjust the configuration file +<filename>/etc/manpath.config</filename> +(or a file of a similar name depending on your distribution) +or adjust the environment variables +<envar>MANPATH</envar> and <envar>MANSECT</envar>. +</para> + +<para> +As with any other &kde; ioslave, it is possible to enter a &URL;, like +<userinput><command>man:socket</command></userinput> in <emphasis>any</emphasis> +&kde; application. Try it in &kwrite; and you will see the man page in +&HTML; format. +</para> + +<para> +Contact mailing list: <email>kde-devel@kde.org</email> +</para> + +</article> diff --git a/doc/kioslave/mrml.docbook b/doc/kioslave/mrml.docbook new file mode 100644 index 000000000..32af0922c --- /dev/null +++ b/doc/kioslave/mrml.docbook @@ -0,0 +1,26 @@ +<article lang="&language;" id="mrml"> +<title>mrml</title> +<articleinfo> +<authorgroup> +<author>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-01-08</date> + + +</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> + +<para>kio_mrml is used for the Image Finding feature in &kde;</para> + +<para>⪚ type <userinput>mrml:/</userinput> or <userinput>mrml:/some.other.server</userinput> in &konqueror; to start searching for +images. +</para> + +</article> diff --git a/doc/kioslave/news.docbook b/doc/kioslave/news.docbook new file mode 100644 index 000000000..c56e3a8e0 --- /dev/null +++ b/doc/kioslave/news.docbook @@ -0,0 +1,20 @@ +<article lang="&language;" id="news"> +<title>news</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> + + +<para>The news kioslave 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 +link is available from your server, it will subscribe you to the group, in +the first available account you have configured in &knode;</para> + +<para>You can unsubscribe from within &knode; if you decide you don't +want to read the group, by <mousebutton>right</mousebutton> clicking and +selecting <guimenuitem>Unsubscribe from Group</guimenuitem>.</para> + +</article> diff --git a/doc/kioslave/nfs.docbook b/doc/kioslave/nfs.docbook new file mode 100644 index 000000000..bbe9bb625 --- /dev/null +++ b/doc/kioslave/nfs.docbook @@ -0,0 +1,39 @@ +<article lang="&language;" id="nfs"> +<title>nfs</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +Sun's <acronym>NFS</acronym> protocol provides transparent remote access to +shared file systems across networks. The <acronym>NFS</acronym> protocol is +designed to be machine, operating system, network architecture, and +transport protocol independent. This independence is achieved through the +use of Remote Procedure Call (<acronym>RPC</acronym>) primitives built on +top of an eXternal Data Representation (<acronym>XDR</acronym>). +</para> + +<para> +The supporting MOUNT protocol performs the operating system-specific +functions that allow clients to attach remote folder trees to a point +within the local file system. The mount process also allows the server to +grant remote access privileges to a restricted set of clients via export +control.</para> + +<para> +The Lock Manager provides support for file locking when used in the +<acronym>NFS</acronym> environment. The Network Lock Manager +(<acronym>NLM</acronym>) protocol isolates the inherently stateful aspects +of file locking into a separate protocol.</para> + +<para> +Source: +<ulink url="http://www.networksorcery.com/enp/protocol/nfs.htm"> +http://www.networksorcery.com/enp/protocol/nfs.htm</ulink> +</para> + +<para> See the manual: <ulink url="man:/nfs">nfs</ulink>. +</para> +</article> diff --git a/doc/kioslave/nntp.docbook b/doc/kioslave/nntp.docbook new file mode 100644 index 000000000..8020b8903 --- /dev/null +++ b/doc/kioslave/nntp.docbook @@ -0,0 +1,41 @@ +<article lang="&language;" id="nntp"> +<title>nntp</title> +<articleinfo> +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para>The nntp kioslave accesses <acronym>NNTP</acronym> servers +directly.</para> + +<para>This kioslave can not be used with servers that do not implement +the <command>GROUP</command> command, including some versions of the +popular <application>INN</application> news server which is often used +by <acronym>ISP</acronym>s. It does work with +<application>leafnode</application>, which many people use to keep an +offline cache of news articles on their own hard drive or within their +<acronym>LAN</acronym>.</para> + +<para>You can use the nntp kioslave by typing +<userinput>nntp://yourserver/groupname</userinput> into the &konqueror; +<acronym>URL</acronym> bar.</para> + +<para>If you enter a group name, as above, and the group is available, +you will see the messages stored for that group as icons in +&konqueror;.</para> + +<para>Clicking on a message will display it as plain text, including all +headers. This could be useful for debugging a news client to news +server connection, for example, to ensure that your new +<application>leafnode</application> server is working correctly.</para> + +<para>If you don't enter a group name, and only the server name, you +will see a list of available groups. </para> + +<para>Please be aware that this could take an enormous amount of time, and +will cause a lot of network traffic. Some commercial usenet servers +have 60,000 or more groups available, and doing such a thing may +cause your desktop to freeze.</para> + +</article> diff --git a/doc/kioslave/pop3.docbook b/doc/kioslave/pop3.docbook new file mode 100644 index 000000000..1c956a1cd --- /dev/null +++ b/doc/kioslave/pop3.docbook @@ -0,0 +1,13 @@ +<article lang="&language;" id="pop3"> +<title>pop3</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +The Post Office Protocol (POP3) allows a user's workstation to access mail from a mailbox server. +</para> + +</article> diff --git a/doc/kioslave/pop3s.docbook b/doc/kioslave/pop3s.docbook new file mode 100644 index 000000000..856709e80 --- /dev/null +++ b/doc/kioslave/pop3s.docbook @@ -0,0 +1,14 @@ +<article lang="&language;" id="pop3s"> +<title>pop3s</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +POP3S is the POP3 protocol encrypted via SSL. + +</para> + +</article> diff --git a/doc/kioslave/print.docbook b/doc/kioslave/print.docbook new file mode 100644 index 000000000..034eddab1 --- /dev/null +++ b/doc/kioslave/print.docbook @@ -0,0 +1,170 @@ +<article lang="&language;" id="print"> +<title>print</title> +<articleinfo> +<authorgroup> +<author>&Kurt.Pfeifle; &Kurt.Pfeifle.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2002-06-23</date> +<releaseinfo>1.00.00</releaseinfo> + +</articleinfo> + +<para>The <acronym>print</acronym> KIOSlave gives quick access to browse +different &kdeprint; 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 +KIOSlaves implemented by &kde;. 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 + of your printers, of your print system and lets you create new printers + and classes.</para> + +<para>You are asked for the Administrator or root password, if you are +not allowed a view or an operation as a normal user.</para> + +<para>You can bookmark frequently used shortcuts like + <command>print:/manager</command></para> + +<para>Valid syntax is either +<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 + depend on the print subsystem that is installed on your box and presently +activated for &kde;. Pages showing printer information display only +those parts that are valid for the &kde; 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 +less printer info, because LPD is not capable of using the same amount of +print settings as are possible in CUPS).</para> + +<para>Valid syntax to access different virtual folders +and a short explanation of what they represent:</para> + +<variablelist> +<title>Some examples</title> + +<varlistentry> +<term><userinput>print:/ </userinput> (&ie; the root of +print-kioslave)</term> +<listitem> +<para> virtual root for browsing your print subsystem. + It displays subfolders <quote>Classes</quote>, + <quote>Jobs</quote>, + <quote>Manager</quote>, <quote>Printers</quote>, + and <quote>Specials</quote></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>print:/classes</userinput> or +<userinput>print:classes </userinput> +</term> <listitem> +<para> view your printer classes + (supported by and useful for CUPS only) +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><userinput>print:/classes/class_name </userinput> or + <userinput>print:classes/class_name </userinput> </term> <listitem> +<para>view all members of the named + printer class (supported by and useful only + for CUPS) </para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><userinput>print:/jobs </userinput> +or <userinput>print:jobs </userinput></term> +<listitem> +<para> lists the current and pending jobs. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>print:/printers </userinput> +or <userinput>print:printers </userinput></term> +<listitem> +<para> lists all your printers. Clicking + on a printer name shows more info about that printer. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>print:/printers/printer_name </userinput> +or <userinput>print:printers/printer_name </userinput> </term> +<listitem> +<para>displays useful info about the named + printer </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>print:/manager </userinput> or +<userinput>print:manager </userinput> +</term> <listitem> +<para>opens a page very similar to the &kdeprint; + Manager module inside the &kde; Control Center. + Switch to a different printing system here or do every + other administrative task. </para> +<para>This is the most important of access points to your printing + system. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><userinput>print:/specials </userinput> or +<userinput>print:specials </userinput> +</term><listitem> +<para>lists all presently available <quote>special printers</quote>: + Likely you'll see:</para> +<itemizedlist> +<listitem> + <para>The two that let you save a printfile to disk, in + &PostScript; or <acronym>PDF</acronym> format.</para> +</listitem> +<listitem> + <para>One that sends it as a <acronym>PDF</acronym> attachment via +&kmail;.</para> +</listitem> +<listitem> + <para>And last, send it via fax, if you have one of the + supported fax backends active, +<application>Hylafax</application> or +<application>efax</application>.</para> +</listitem> +</itemizedlist> +</listitem> +</varlistentry> + +</variablelist> + +<tip><para>You can also put <command>print:/manager</command> + or similar as the command in + the <quote>Quick Command</quote> utility (started via +<keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>)</para></tip> + +<para>You can learn more about printing and &kdeprint;'s powerful abilities +by reading the <ulink url="help:/kdeprint/index.html">&kdeprint; Handbook +locally</ulink> or at the <ulink url="http://printing.kde.org/">&kdeprint; +Website</ulink> where there are documents online (<acronym>HTML</acronym> and +<acronym>PDF</acronym>),containing +<ulink +url="http://printing.kde.org/documentation/tutorials/">Tutorials</ulink>, + as well as <ulink url="http://printing.kde.org/faq/">FAQs</ulink> and + Tips and Tricks related to printing in general.</para> + +</article> diff --git a/doc/kioslave/rlan.docbook b/doc/kioslave/rlan.docbook new file mode 100644 index 000000000..98c962444 --- /dev/null +++ b/doc/kioslave/rlan.docbook @@ -0,0 +1,11 @@ +<article lang="&language;" id="rlan"> +<title>rlan</title> +<articleinfo> +<authorgroup> +<corpauthor>The &kde; team</corpauthor> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para>Not yet documented</para> + +</article> diff --git a/doc/kioslave/rlogin.docbook b/doc/kioslave/rlogin.docbook new file mode 100644 index 000000000..a24b20f85 --- /dev/null +++ b/doc/kioslave/rlogin.docbook @@ -0,0 +1,31 @@ +<article lang="&language;" id="rlogin"> +<title>rlogin</title> +<articleinfo> +<authorgroup> +<author><personname><firstname>Christian</firstname><surname>Bunting</surname></personname></author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para>Using &konqueror; you can start up an <command>rlogin</command> +session with a server hosting the rlogin service.</para> + +<para>To use this kioslave feature, in the &konqueror; +<acronym>URL</acronym> bar, type +<userinput>rlogin:/host_to_connect_to</userinput></para> + +<para>This will initialize &konsole; with an <command>rlogin</command> +session, prompting you for your password.</para> + +<para>The <command>rlogin</command> kioslave uses the username of the +account you are currently using in &kde;.</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> + + +<!-- By Christian Bunting (need to ask if he wants crediting and email) --> + +</article> diff --git a/doc/kioslave/sftp.docbook b/doc/kioslave/sftp.docbook new file mode 100644 index 000000000..ff2770a47 --- /dev/null +++ b/doc/kioslave/sftp.docbook @@ -0,0 +1,19 @@ +<article lang="&language;" id="sftp"> +<title>sftp</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para><acronym>SFTP</acronym> is a Secure file transfer protocol. +<command>sftp</command> is an interactive file transfer program, +similar to ftp, but it performs all operations over an encrypted +<command>ssh</command> transport. It may use many of the features of +<command>ssh</command>, including public key authentication and +compression.</para> + +<para> See the manual: <ulink url="man:/sftp">sftp</ulink>. +</para> + +</article> diff --git a/doc/kioslave/smb.docbook b/doc/kioslave/smb.docbook new file mode 100644 index 000000000..716db415f --- /dev/null +++ b/doc/kioslave/smb.docbook @@ -0,0 +1,56 @@ +<article lang="&language;" id="smb"> +<title>SMB</title> +<articleinfo> +<authorgroup> +<author>&Alexander.Neundorf; &Alexander.Neundorf.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +The smb ioslave enables you to browse the shares of a &Windows; (or Samba) +network. +</para> + +<para> +To see the workgroups, enter +<userinput><command>smb:/</command></userinput>. +</para> +<para> +<userinput><command>smb://</command><replaceable>a_workgroup</replaceable></userinput> +will list the hosts in this workgroup. +</para> +<para> +To see the shares of a host, enter +<userinput><command>smb://</command><replaceable>the_host</replaceable></userinput> +or +<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable></userinput>. +</para> +<para> +To access a share directly enter +<userinput><command>smb://</command><replaceable>the_host/the_share</replaceable></userinput> +or +<userinput><command>smb:/</command><replaceable>a_workgroup</replaceable>/<replaceable>the_host</replaceable>/<replaceable>the_share</replaceable></userinput> +</para> + +<para> +The smb ioslave requires that you have libsmbclient to use this ioslave. +</para> + +<para> +You can set your default user name and password in the &kcontrol; in +<menuchoice><guisubmenu>Network</guisubmenu><guimenuitem>Windows +Shares</guimenuitem></menuchoice>. This is especially useful if you are a +member of a &Windows; <acronym>NT</acronym> domain. There you can also set your +workgroup name, but in most cases this is not required. The kioslave will ask for your username and password if a default is not set. +</para> + +<para> +This ioslave is tested and developed using mainly Samba 2.0.7, but other +versions of Samba should work too. +</para> + +<para> +Author: Alexander Neundorf <email>neundorf@kde.org</email> +</para> +</article> + diff --git a/doc/kioslave/smtp.docbook b/doc/kioslave/smtp.docbook new file mode 100644 index 000000000..2aa2c7dbf --- /dev/null +++ b/doc/kioslave/smtp.docbook @@ -0,0 +1,16 @@ +<article lang="&language;" id="smtp"> +<title>smtp</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +A protocol to send mail from the client workstation to the mail server. +</para> + +<para> See : <ulink url="http://cr.yp.to/smtp.html">Simple Mail Transfer Protocol </ulink>. +</para> + +</article> diff --git a/doc/kioslave/tar.docbook b/doc/kioslave/tar.docbook new file mode 100644 index 000000000..8a5405198 --- /dev/null +++ b/doc/kioslave/tar.docbook @@ -0,0 +1,18 @@ +<article lang="&language;" id="tar"> +<title>tar</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +An archiving program designed to store and extract files from an archive +file known as a tarfile. A tarfile may be made on a tape drive, however, it +is also common to write a tarfile to a normal file. +</para> + +<para> See the manual: <ulink url="man:/tar">tar</ulink>. +</para> + +</article> diff --git a/doc/kioslave/telnet.docbook b/doc/kioslave/telnet.docbook new file mode 100644 index 000000000..9d2131e84 --- /dev/null +++ b/doc/kioslave/telnet.docbook @@ -0,0 +1,17 @@ +<article lang="&language;" id="telnet"> +<title>telnet</title> +<articleinfo> +<authorgroup> +<author>&Ferdinand.Gassauer; &Ferdinand.Gassauer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para> +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> + +</article> diff --git a/doc/kioslave/thumbnail.docbook b/doc/kioslave/thumbnail.docbook new file mode 100644 index 000000000..7b2e0752f --- /dev/null +++ b/doc/kioslave/thumbnail.docbook @@ -0,0 +1,28 @@ +<article lang="&language;" id="thumbnail"> +<title>thumbnail</title> +<articleinfo> +<authorgroup> +<author>&Carsten.Pfeiffer; &Carsten.Pfeiffer.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</articleinfo> +<para>The thumbnail kioslave is used by &kde; for network transparent +and persistent generation of thumbnails.</para> + +<para>The thumbnail kioslave uses plugins to generate the actual +thumbnails. You can enable viewing of these thumbnails from the +<menuchoice><guimenu>View</guimenu> +<guisubmenu>Preview</guisubmenu></menuchoice> submenu, available in +&konqueror; in file manager mode.</para> + +<para>The thumbnail kioslave is not directly useful to a user, but if +you are a developer, you can use it within your own applications to +create file previews.</para> + +<para>See the documentation in the sources for more information. You +will find these at +<filename>$<envar>KDEDIR</envar>/include/kio/thumbcreator.h</filename> or +in the source folder <filename +class="directory">kdebase/kioslave/thumbnail</filename></para> + +</article> diff --git a/doc/kioslave/webdav.docbook b/doc/kioslave/webdav.docbook new file mode 100644 index 000000000..d549384f2 --- /dev/null +++ b/doc/kioslave/webdav.docbook @@ -0,0 +1,65 @@ +<article lang="&language;" id="webdav"> +<title>webdav</title> +<articleinfo> +<authorgroup> +<author>&Hamish.Rodda; &Hamish.Rodda.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-01-21</date> +</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:/kioslave/webdav.html">http</ulink> server, and has +additional features designed to simplify version management amongst +multiple authors.</para> + +<para>Usage of this protocol is simple. Type the location you want to +view, similar to a <acronym>http</acronym> URL except for the +webdav:// protocol name at the start. An example is +<userinput>webdav://<replaceable>www.hostname.com/path/</replaceable></userinput>. +If you specify a folder name, a list of files and folders will be +displayed, and you can manipulate these folders and files just as you +would with any other filesystem.</para> + +<variablelist> +<title>WebDAV Features</title> +<varlistentry> +<term>Locking</term> +<listitem> +<para>File locking allows users to lock a file, informing others that they +are +currently working on this file. This way, editing can be done without fear +that +the changes may be overwritten by another person who is also editing the +same +document.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Source file access</term> +<listitem> +<para><acronym>WebDAV</acronym> allows access to the script which is called +to +produce a specific page, so changes can be made to the script itself.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Per-document property support</term> +<listitem> +<para>Arbitrary properties may be set to assist identification of a +document, +such as the author.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>To take advantage of these additional capabilities, you will need an +application which supports them. No application currently supports them +through +this kioslave.</para> + +</article> diff --git a/doc/kioslave/webdavs.docbook b/doc/kioslave/webdavs.docbook new file mode 100644 index 000000000..edbd635e6 --- /dev/null +++ b/doc/kioslave/webdavs.docbook @@ -0,0 +1,17 @@ +<article lang="&language;" id="webdavs"> +<title>webdavs</title> +<articleinfo> +<authorgroup> +<author>&Hamish.Rodda; &Hamish.Rodda.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-01-21</date> + + +</articleinfo> + +<para>WebDAVS is the <ulink url="help:/kioslave/webdav.html">WebDAV</ulink> protocol +encrypted via SSL.</para> + +</article> |