summaryrefslogtreecommitdiffstats
path: root/doc/kcontrol/proxy
diff options
context:
space:
mode:
Diffstat (limited to 'doc/kcontrol/proxy')
-rw-r--r--doc/kcontrol/proxy/Makefile.am2
-rw-r--r--doc/kcontrol/proxy/index.docbook197
-rw-r--r--doc/kcontrol/proxy/socks.docbook56
3 files changed, 255 insertions, 0 deletions
diff --git a/doc/kcontrol/proxy/Makefile.am b/doc/kcontrol/proxy/Makefile.am
new file mode 100644
index 000000000..ce9c3748a
--- /dev/null
+++ b/doc/kcontrol/proxy/Makefile.am
@@ -0,0 +1,2 @@
+KDE_LANG = en
+KDE_DOCS = kcontrol/proxy
diff --git a/doc/kcontrol/proxy/index.docbook b/doc/kcontrol/proxy/index.docbook
new file mode 100644
index 000000000..0a47cec36
--- /dev/null
+++ b/doc/kcontrol/proxy/index.docbook
@@ -0,0 +1,197 @@
+<?xml version="1.0" ?>
+<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
+"dtd/kdex.dtd" [
+<!ENTITY socks-kcontrol SYSTEM "socks.docbook">
+<!ENTITY % addindex "IGNORE">
+<!ENTITY % English "INCLUDE" > <!-- change language only here -->
+]>
+
+<article lang="&language;">
+<articleinfo>
+
+
+<authorgroup>
+<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<date>2002-02-11</date>
+<releaseinfo>3.00.00</releaseinfo>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>KControl</keyword>
+<keyword>proxy</keyword>
+<keyword>proxies</keyword>
+</keywordset>
+
+</articleinfo>
+<sect1 id="proxies">
+<title>Proxies</title>
+
+<sect2 id="proxies-intro">
+
+<title>Introduction</title>
+
+<para>Proxies are programs running on a computer that acts a server on
+the network you are connected to (whether by modem or other
+means). These programs receive &HTTP; and &FTP; requests, retrieve the
+relevant files from the internet, and pass them on to the client
+computer that made the requests.</para>
+
+<para>When you have configured a proxy, &HTTP; and/or &FTP; requests
+are re-routed through the computer that is acting as a proxy server.
+However, you can also select specific hosts which should be contacted
+directly, rather than through the proxy server. If you are on a local
+network, for example, access to local hosts probably doesn't need to
+go through a proxy server.</para>
+
+<para>You should only need to configure a proxy server if your network
+administrator requires it (if you are a dial-up user, that would be
+your internet service provider or <acronym>ISP</acronym>). Otherwise,
+especially if you are feeling a bit confused about this proxy
+business, but everything seems to be fine with your internet
+connection, you don't need to change anything.</para>
+
+<para>Please note that using proxy servers is optional, but has the
+benefit or advantage of giving you faster access to data on the
+internet.</para>
+
+<para>If you are uncertain whether or not you need to use a proxy
+server to connect to the internet, please consult with your internet
+service provider's setup guide or your system administrator.</para>
+
+</sect2>
+
+<sect2 id="proxies-use">
+
+<title>Use</title>
+
+<variablelist>
+<varlistentry>
+<term><guilabel>Connect to the Internet directly</guilabel></term>
+<listitem>
+
+<para>Select this option if you do <emphasis>not</emphasis> want to use a proxy server.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+<para>If you have decided to use a proxy, you have several methods to
+configure the settings for it.</para>
+
+<variablelist>
+<varlistentry>
+<term><guilabel>Automatically detected script file</guilabel></term>
+<listitem>
+
+<para>Select this option if you want the proxy setup configuration
+script file to be automatically detected and downloaded.</para>
+<para>This option only differs from the next choice in that it
+<emphasis>does not</emphasis> require you to supply the location of
+the configuration script file. Instead, it will be automatically
+downloaded using <quote>Web Access Protocol Discovery</quote>
+(<acronym>WAPD</acronym>).</para>
+
+<note><para>If you have a problem using this setup, please consult the
+<acronym>FAQ</acronym> section at <ulink
+url="http://www.konqueror.org">http://www.konqueror.org</ulink> for
+more information.</para></note>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Specified script file</guilabel></term>
+<listitem>
+<para>Select this option if your proxy support is provided through a
+script file located at a specific address. You can then enter the
+address in the location text box, or use the <guiicon>folder</guiicon>
+icon to browse to it.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Preset environment variables</guilabel></term>
+<listitem>
+<para>Some systems are setup with $<envar>HTTP_PROXY</envar> to allow
+graphical as well as non-graphical applications to share the same
+proxy configuration information.</para>
+<para>If you know this applies to you, select this option and click on
+the <guibutton>Setup...</guibutton> button to provide the environment
+variable names used to set the address of the proxy server(s).</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><guilabel>Manually specified settings</guilabel></term>
+<listitem>
+<para>Select this option, and click on the
+<guibutton>Setup...</guibutton> to manually setup the location of the
+proxy servers to be used.</para>
+
+<para>If you choose this option, another dialog will pop up.</para>
+
+<para>The complete addressing information for the proxy includes both
+the internet address and a port number. You should enter these into
+the relevant text boxes. The <guiicon>arrow</guiicon> button copies
+the information from the <guilabel>HTTP</guilabel> line to the
+<guilabel>FTP</guilabel> line, in order to help save some
+typing.</para>
+
+<para>If there are hosts which you can connect to without going
+through the proxy server, you can press <guibutton>Add</guibutton> to
+add the names of these hosts, separated by in the text box labeled
+<guilabel>No Proxy For:</guilabel>. For example, hosts that are on
+your local network can probably be contacted directly.</para>
+
+<para>You can also choose <guilabel>Only use proxy for entries in this
+list</guilabel>.</para>
+
+<para>Check this box to reverse the use of the exception list, &ie;
+the proxy servers will only be used when the requested &URL; matches
+one of the addresses listed here.</para>
+
+<para>This features is useful if all you need is a proxy to access a
+few specific sites, for example, an internal intranet. If you have
+more complex requirements you might want to use a configuration
+script.</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+<sect2 id="authorization">
+<title><guilabel>Authorization</guilabel></title>
+
+<para>Here you can choose between two types of authentication, if your
+proxy requires it. You can have <guilabel>Prompt as
+needed</guilabel>, the default, in which case &konqueror; will only
+ask for a username or password if it needs to.</para>
+
+<para>The other option is <guilabel>Use automatic login</guilabel>.
+Select this option if you have already set up a login entry for your
+proxy server in the
+<filename>$<envar>KDEDIR</envar>/share/config/kionetrc</filename>
+file.</para>
+
+</sect2>
+
+<sect2 id="options">
+<title><guilabel>Options</guilabel></title>
+<variablelist>
+<varlistentry>
+<term><guilabel>Use persistent connections to proxy</guilabel></term>
+<listitem>
+<para>Use persistent connection to your proxy server. Keeps connection to proxy open, helps lower bandwidth/speed up connection. Enabling this option will require the proxy server's cooperation, if the proxy server does not support this, it will bring your internet to a stop. </para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+&socks-kcontrol;
+
+</sect1>
+
+</article>
diff --git a/doc/kcontrol/proxy/socks.docbook b/doc/kcontrol/proxy/socks.docbook
new file mode 100644
index 000000000..73c5e2ec6
--- /dev/null
+++ b/doc/kcontrol/proxy/socks.docbook
@@ -0,0 +1,56 @@
+<sect2 id="socks">
+<sect2info>
+<authorgroup>
+<author>&Lauri.Watts;</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+</sect2info>
+
+<title>SOCKS</title>
+
+<para>SOCKS is a protocol to execute proxy requests for a client. SOCKS
+is capable of authentication and encryption of traffic, and is often
+found in corporate settings, as opposed to home users. For more
+information about SOCKS, see the <ulink
+url="http://www.socks.nec.com">NEC</ulink> website</para>
+
+<para>With this module you can enable most of the network aware &kde;
+applications to transparently use SOCKS.</para>
+
+<para>Setting up of a SOCKS client is outside the scope of this
+document, and the differences between the commonly used ones are very
+large. If you already have a working SOCKS implementation, allowing you
+to use commandline clients (for example, if <command>lynx</command> or
+<command>ftp</command> are already working) then you can simply check
+the <guilabel>Enable SOCKS support</guilabel> checkbox.</para>
+
+<para>When this box is checked, several further options become available
+to you.</para>
+
+<para>First, you should select which of the various SOCKS clients you
+have installed on your computer. &kde; will attempt to find this out by
+itself, if you choose <guilabel>Auto detect</guilabel>. If you know the
+client you have, you could choose either <guilabel>NEC
+Socks</guilabel> or <guilabel>Dante</guilabel>. If you have a
+custom built SOCKS library to use, you can select <guilabel>Use custom
+library</guilabel> and then enter the path to it in the
+<guilabel>Path</guilabel> field.</para>
+
+<para>If you want &kde; to auto detect the SOCKS library in use, but you
+suspect it isn't looking in the right places or you have installed it in
+a non-standard location, then you can add further paths to be searched in
+the bottom of this panel. Use the <guibutton>Add</guibutton> and
+<guibutton>Remove</guibutton> to add or remove paths.</para>
+
+<para>At any time while filling in this module, you can press the
+<guibutton>Test</guibutton> button, and &kde; will report immediately
+with a message box to tell you if it could find and initialize SOCKS or
+not.</para>
+
+<para>Changes made here will not affect any applications that are
+already open. You will need to close and restart them before they are
+able to connect via SOCKS.</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+</sect2>