Git commit 8ef9766d4799ebd9997199f805e09b6477906d47 by Burkhard Lück, on behalf of Laurent Montel. Committed on 09/11/2016 at 07:04. Pushed by lueck into branch 'master'.
Move doc for runtime here svn path=/trunk/KDE/kdebase/runtime/; revision=706565 A +2 -0 doc/kcontrol/cache/CMakeLists.txt A +69 -0 doc/kcontrol/cache/index.docbook A +2 -0 doc/kcontrol/cookies/CMakeLists.txt A +211 -0 doc/kcontrol/cookies/index.docbook A +2 -0 doc/kcontrol/ebrowsing/CMakeLists.txt A +156 -0 doc/kcontrol/ebrowsing/index.docbook A +2 -0 doc/kcontrol/netpref/CMakeLists.txt A +109 -0 doc/kcontrol/netpref/index.docbook A +2 -0 doc/kcontrol/proxy/CMakeLists.txt A +197 -0 doc/kcontrol/proxy/index.docbook A +56 -0 doc/kcontrol/proxy/socks.docbook A +2 -0 doc/kcontrol/smb/CMakeLists.txt A +106 -0 doc/kcontrol/smb/index.docbook A +2 -0 doc/kcontrol/useragent/CMakeLists.txt A +117 -0 doc/kcontrol/useragent/index.docbook http://commits.kde.org/kio/8ef9766d4799ebd9997199f805e09b6477906d47 diff --git a/doc/kcontrol/cache/CMakeLists.txt b/doc/kcontrol/cache/CMakeLists.txt new file mode 100644 index 0000000..7509aba --- /dev/null +++ b/doc/kcontrol/cache/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/cache) diff --git a/doc/kcontrol/cache/index.docbook b/doc/kcontrol/cache/index.docbook new file mode 100644 index 0000000..7392d63 --- /dev/null +++ b/doc/kcontrol/cache/index.docbook @@ -0,0 +1,69 @@ +<?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;"> +<articleinfo> + +<authorgroup> +<author><firstname></firstname><surname></surname></author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Konqueror</keyword> +<keyword>Cache</keyword> +</keywordset> +</articleinfo> + +<sect1 id="cache"> +<title>Cache</title> + +<para>This module allows you to control the size of the local cache +folder used by &konqueror;. Note that each user account on your +computer has a separate cache folder, and this folder is not +shared with other web browsers such as &Netscape;.</para> + +<para>Storing local copies of web pages that you have visited allows +&konqueror; to quickly load their contents on subsequent visits. It +will only be necessary to reload the contents from the original site +if they have changed since your last visit, or if you click the reload +button in &konqueror;.</para> + +<para>If you really don't want any of the web pages you visit to be +stored on your computer, you can disable &konqueror;'s disk cache by +clearing the checkbox labeled <guilabel>Use cache</guilabel>.</para> + +<para>You can set here how aggressively &konqueror; keeps the cache up +to date. <guilabel>Keep cache in sync</guilabel> means that &konqueror; +will hit the cache for all objects, downloading them if they are not +there, and then display the item from the cache. <guilabel>Use cache +whenever possible</guilabel> means that &konqueror; will try the cache, +and if an object is not there, it will directly download it for display. +<guilabel>Offline browsing mode</guilabel> means that &konqueror; will +try the cache, and if an object is not there, it will not attempt to +download it from the Internet.</para> + +<para>You can control the size of the cache by typing a number into the +text box labeled <guilabel>Disk cache size</guilabel>. This is the +average amount of space in kilobytes that the cache folder is allowed +to use. When the cache grows too large, &konqueror; will delete older +files to reduce the size of the cache folder.</para> + +<para>This is however, only an average, and during a browsing session +the cache could become substantially larger.</para> + +<para>You can use the <guibutton>Clear Cache</guibutton> button to empty +the cache at any time.</para> +</sect1> + +</article> diff --git a/doc/kcontrol/cookies/CMakeLists.txt b/doc/kcontrol/cookies/CMakeLists.txt new file mode 100644 index 0000000..88fac29 --- /dev/null +++ b/doc/kcontrol/cookies/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/cookies) diff --git a/doc/kcontrol/cookies/index.docbook b/doc/kcontrol/cookies/index.docbook new file mode 100644 index 0000000..a1ea6fd --- /dev/null +++ b/doc/kcontrol/cookies/index.docbook @@ -0,0 +1,211 @@ +<?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;"> +<articleinfo> + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>cookie</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="cookie"> +<title>Cookies</title> + +<para>Cookies are a mechanism used by web sites to store and retrieve +information using your browser. For example, a web site may allow you +to customize the content and layout of the pages you see, so that your +choices are persistent across different visits to that web site.</para> + +<para>The web site is able to remember your preferences by storing a +cookie on your computer. Then, on future visits, the web site retrieves +the information stored in the cookie to format the content of the site +according to your previously specified preferences.</para> + +<para>Thus, cookies play a very useful role in web browsing. +Unfortunately, web sites often store and retrieve information in cookies +without your explicit knowledge or consent. Some of this information may +be quite useful to the web site owners, for example, by allowing them to +collect summary statistics on the number of visits different areas of +the web sites get, or to customize banner advertising.</para> + +<para>The cookies module of the &kcontrol; allows you to set policies +for the use of cookies when you are browsing the web with the +&konqueror; web browser. </para> + +<warning><para>Note that the policies that you set using this control +module will <emphasis>not</emphasis> apply to other web browsers such +as &Netscape;.</para></warning> + +<sect2 id="cookie-policy"> + +<title>Policy</title> + +<para>Using the <guilabel>Policy</guilabel> tab, you can configure the +&kde; applications that will handle cookies. You can do this by specifying a +general cookie policy as well as special cookie policies for certain +domains or hosts.</para> + +<para>The top of the policy tab has a checkbox labeled <guilabel>Enable +cookies</guilabel>. If you leave this unchecked, cookies will be +completely disabled. However, this may make browsing rather +inconvenient, especially as some web sites require the use of browsers +with cookies enabled.</para> + +<para>You will probably want to enable cookies and then set +specific policies on how you want them to be handled.</para> + +<para>The first group of options create settings that apply to all cookies.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Only accept cookies from originating server</guilabel></term> +<listitem> +<para>Some pages try to set cookies from servers other than the one +you are seeing the <acronym>HTML</acronym> page from. For example, +they show you advertisements, and the advertisements are from another +computer, often one that belongs to a large advertising group. These +advertisements may try to set a cookie which would allow them to +track the pages you view across multiple web sites.</para> +<para>Enabling this option will mean only cookies that come from the +same web server as you are explicitly connecting to will be +accepted.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Automatically accept session cookies</guilabel></term> +<listitem> + +<para>An increasingly common use for cookies is not to track your +movements across many visits to a web site, but to just follow what you +do during one single visit. Session cookies are saved as long as you +are looking at the site, and deleted when you leave it.</para> + +<para>Web sites can use this information for various things, most +commonly it is a convenience so that you do not have to keep logging in +to view pages. For example, on a webmail site, without some kind of +session <acronym>ID</acronym>, you would have to give your password +again for each email you want to read. There are other ways to +achieve this, but cookies are simple and very common.</para> + +<para>Enabling this option means that session cookies are always +accepted, even if you don't accept any other kind, and even if you +choose to reject cookies from a particular site, session cookies from +that site will be accepted.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Treat all cookies as session cookies</guilabel></term> +<listitem> +<para>If this option is enabled, all cookies are treated as session +cookies. That is, they are not kept when you leave the +web site.</para> +<note> +<para>The definition of <quote>leave the web site</quote> is vague. +Some cookies may hang around for a little while after you are no +longer viewing any pages on a particular web site. This is +normal.</para> +</note> +</listitem> +</varlistentry> +</variablelist> + +<para>The section for <guilabel>Default Policy</guilabel> sets some +further options that are mutually exclusive — you can choose only one +of these options as the default, but you are free to set a different +option for any specific web server.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Ask for confirmation</guilabel></term> +<listitem> +<para>If this option is selected, you will be asked for confirmation +every time a cookie is stored or retrieved. You can selectively accept +or reject each cookie. The confirmation dialog will also allow you to +set a domain specific policy, if you do not want to confirm each +cookie for that domain.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Accept all cookies</guilabel></term> +<listitem> +<para>If this option is selected, all cookies will be accepted without +asking for confirmation.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Reject all cookies</guilabel></term> +<listitem> +<para>If this option is selected, all cookies will be rejected without +asking for confirmation.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>In addition to the default policy for handling of cookies, which you can +set by selecting one of the three options described above, you can also set +policies for specific host domains using the controls in the <guilabel>Domain +Specific</guilabel> group.</para> + +<para>The Ask, Accept, or Reject policy can be applied to a specific +domain by clicking on the <guibutton>New...</guibutton> button, which +brings up a dialog. In this dialog, you can type the name of the +domain (with a leading dot), then select the policy you want to apply +to this domain. Note that entries may also get added while you are +browsing, if the default policy is to ask for confirmation, and you +choose a general policy for a specific host (for example, by selecting +<guilabel>Reject all cookies from this domain</guilabel> when asked to +confirm a cookie).</para> + +<para>You can also select a specific host domain from the list and click the +<guibutton>Change</guibutton> button to choose a different policy for that +domain than the one shown in the list.</para> + +<para>To delete a domain specific policy, choose a domain from the list, and +then click the <guibutton>Delete</guibutton> button. The default policy will +apply to domains which have been deleted from the list.</para> + +</sect2> + +<sect2 id="cookie-management"> +<title>Management</title> + +<para>In the <guilabel>Management</guilabel> tab you can browse and selectively +delete cookies that have been set in the past.</para> + +<para>In the upper part of this dialog, you can see a list of domains displayed +as a tree. Click on the little <guiicon>+</guiicon> next to a domain to see all +cookies that have been set for this particular target domain. If you select one +of these cookies, you will notice that its contents will show up in the frame +<guilabel>Cookie Details</guilabel> below.</para> + +<para>By clicking the <guibutton>Delete</guibutton> button you can now delete the selected +cookie. Click <guibutton>Delete All</guibutton> to delete all cookies stored.</para> + +<para>Choose <guibutton>Reload List</guibutton> to reload the list +from your hard disk. You might want to do this if you have had the +module open and are testing web sites, or have made many changes in the +module itself.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/ebrowsing/CMakeLists.txt b/doc/kcontrol/ebrowsing/CMakeLists.txt new file mode 100644 index 0000000..2bdd4b0 --- /dev/null +++ b/doc/kcontrol/ebrowsing/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/ebrowsing) diff --git a/doc/kcontrol/ebrowsing/index.docbook b/doc/kcontrol/ebrowsing/index.docbook new file mode 100644 index 0000000..da9167f --- /dev/null +++ b/doc/kcontrol/ebrowsing/index.docbook @@ -0,0 +1,156 @@ +<?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;"> +<articleinfo> + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<author>&Yves.Arrouye; &Yves.Arrouye.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>enhanced browsing</keyword> +<keyword>web shortcuts</keyword> +<keyword>browsing</keyword> +</keywordset> + +</articleinfo> +<sect1 id="ebrowse"> + +<title>Web Shortcuts</title> + +<sect2 id="ebrowse-intro"> + +<title>Introduction</title> + +<para>&konqueror; offers some features to enhance your browsing +experience. One such feature is <emphasis>Web Shortcuts</emphasis>.</para> + +<para>You may already have noticed that &kde; is very Internet friendly. +For example, you can click on the <guimenuitem>Run</guimenuitem> menu +item or type the keyboard shortcut assigned to that command (<keycombo +action="simul"><keycap>Alt</keycap><keycap>F2</keycap></keycombo>, +unless you have changed it) and type in a <acronym>URI</acronym>. +<footnote><para>Uniform Resource Identifier. A standardized way of +referring to a resource such as a file on your computer, a World Wide +Web address, an email address, +<abbrev>etc...</abbrev>.</para></footnote></para> + +<para>Web shortcuts, on the other hand, let you come up with new pseudo +<acronym>URL</acronym> schemes, or shortcuts, that basically let you +<emphasis>parameterize</emphasis> commonly used +<acronym>URI</acronym>s. For example, if you like the Google search +engine, you can configure KDE so that a pseudo <acronym>URL</acronym> +scheme like <emphasis>gg</emphasis> will trigger a search on +Google. This way, typing <userinput>gg:<replaceable>my +query</replaceable></userinput> will search for <replaceable>my +query</replaceable> on Google.</para> + +<note><para>One can see why we call these pseudo <acronym>URL</acronym> +schemes. They are used like a <acronym>URL</acronym> scheme, but the +input is not properly <acronym>URL</acronym> encoded, so one will type +<userinput>google:kde apps</userinput> and not +<userinput>google:kde+apps</userinput>.</para></note> + +<para>You can use web +shortcuts wherever you would normally use +<acronym>URI</acronym>s. Shortcuts for several search engines should +already be configured on your system, but you can add new keywords, and +change or delete existing ones in the enhanced browsing control +module. </para> + +</sect2> + +<sect2 id="ebrowse-use"> + +<title>Use</title> + +<para>There is a single tab in this control module. The title of the tab +is <guilabel>Keywords</guilabel>. This tab features two main boxes, one +for Internet Keywords and one for web shortcuts.</para> + +<sect3 id="ebrowse-srch-use"> + +<title>Web Shortcuts</title> + +<para>The descriptive names of defined web shortcuts are shown in a +listbox. As with other lists in &kde;, you can click on a column +heading to toggle the sort order between ascending and +descending, and you can resize the columns.</para> + +<para>If you double-click on a specific entry in the list of defined +search providers, the details for that entry are shown in a popup +dialog. In addition to the descriptive name for the item, you can +also see the <acronym>URI</acronym> which is used, as well as the +associated shortcuts which you can type anywhere in &kde; where +<acronym>URI</acronym>s are expected. A given search provider can have +multiple shortcuts, each separated by a comma.</para> + +<para> The text boxes are used not only for displaying information +about an item in the list of web shortcuts, but also for modifying or +adding new items.</para> + +<para>You can change the contents of either the <guilabel>Search +URI</guilabel> or the <guilabel>URI Shortcuts</guilabel> text box. +Click <guibutton>OK</guibutton> to save your changes or +<guibutton>Cancel</guibutton> to exit the dialog with no +changes.</para> + +<para>If you examine the contents of the <guilabel>Search +URI</guilabel> text box, you will find that most, if not all of the +entries have a <option>\{@}</option> in them. This sequence of two +characters acts as a parameter, which is to say that they are replaced +by whatever you happen to type after the colon character that is +between a shortcut and its parameter. Let's consider some examples to +clarify this idea.</para> + +<para>Suppose that the <acronym>URI</acronym> is +<userinput>http://www.google.com/search?q=\{@}</userinput>, and +<userinput>gg</userinput> is a shortcut to this +<acronym>URI</acronym>. Then, typing +<userinput>gg:<replaceable>alpha</replaceable></userinput> is +equivalent to +<userinput>http://www.google.com/search?q=<replaceable>alpha</replaceable></userinput>. +You could type anything after the <userinput>:</userinput> character; +whatever you have typed simply replaces the <option>\{@}</option> +characters, after being converted to the appropriate character set for +the search provider and then properly +<acronym>URL</acronym>-encoded. Only the <option>\{@}</option> part of +the search <acronym>URI</acronym> is touched, the rest of it is +supposed to be properly <acronym>URL</acronym>-encoded already and is +left as is.</para> + +<para>You can also have shortcuts without parameters. Suppose the +<acronym>URI</acronym> was +<emphasis>file:/home/me/mydocs/kofficefiles/kword</emphasis> and the +shortcut was <emphasis>mykword</emphasis>. Then, typing +<userinput>mykword:</userinput> is the same as typing the complete +<acronym>URI</acronym>. Note that there is nothing after the colon +when typing the shortcut, but the colon is still required in order for +the shortcut to be recognized as such.</para> + +<para>By now, you will have understood that even though these shortcuts +are called web shortcuts, they really are shortcuts to parameterized +<acronym>URI</acronym>s, which can point not only to web sites like +search engines but also to anything else that can be pointed to by a +<acronym>URI</acronym>. Web shortcuts are a very powerful feature of +navigation in &kde;.</para> + +</sect3> + +</sect2> + +</sect1> + +</article> \ No newline at end of file diff --git a/doc/kcontrol/netpref/CMakeLists.txt b/doc/kcontrol/netpref/CMakeLists.txt new file mode 100644 index 0000000..1d634b5 --- /dev/null +++ b/doc/kcontrol/netpref/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/netpref) diff --git a/doc/kcontrol/netpref/index.docbook b/doc/kcontrol/netpref/index.docbook new file mode 100644 index 0000000..f97b30b --- /dev/null +++ b/doc/kcontrol/netpref/index.docbook @@ -0,0 +1,109 @@ +<?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;"> +<articleinfo> + +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdebase</keyword> +<keyword>kcontrol</keyword> +<keyword>network</keyword> +<keyword>timeouts</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="timeouts"> + +<title>Preferences</title> + +<para>Here you can set timeout values. You might want to tweak them +if your connection is very slow, but the default settings are +appropriate for most users.</para> + +<para>Here <guilabel>Timeout Values</guilabel> are the length of time +an application should wait for an answer from a network operation.</para> + +<para>You can configure the following timeouts:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Socket read:</guilabel></term> +<listitem> +<para> Some applications use <firstterm>sockets</firstterm> to +communicate. You can think of a socket as a water tap; while it is +open, water (or in our case, data) comes out, without any interaction. +If something stops this flow of data, the application will wait for +more to come. This could be a very long time, but you can configure a +maximum time for an application to wait with this option.</para> +<para>This setting will only apply to &kde; applications, of course.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Proxy connect:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a connection to a proxy server, if one is configured. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server connect:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a connection to a remote server. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server response:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a reply from a remote server. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>You can configure <guilabel>FTP Options</guilabel> here. At +present there is just two options:</para> +<variablelist> +<varlistentry> +<term><guilabel>Enable passive mode (PASV)</guilabel></term> +<listitem><para>Passive &FTP; is often required when you are behind a firewall. +Many firewalls only permit connections that were initiated from +<quote>the inside</quote>. Passive &FTP; is controlled by the client, +which makes it usable through firewalls.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mark partially uploaded files</guilabel></term> +<listitem><para>When a mark is placed in this box, partially uploaded files will +have a <literal role="extension">.part</literal> extension added to the end +of the file. This extension is removed once the file download is complete. </para></listitem> +</varlistentry> + +</variablelist> + + + +</sect1> +</article> \ No newline at end of file diff --git a/doc/kcontrol/proxy/CMakeLists.txt b/doc/kcontrol/proxy/CMakeLists.txt new file mode 100644 index 0000000..7777c4e --- /dev/null +++ b/doc/kcontrol/proxy/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/proxy) diff --git a/doc/kcontrol/proxy/index.docbook b/doc/kcontrol/proxy/index.docbook new file mode 100644 index 0000000..0a47cec --- /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 0000000..73c5e2e --- /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> diff --git a/doc/kcontrol/smb/CMakeLists.txt b/doc/kcontrol/smb/CMakeLists.txt new file mode 100644 index 0000000..295359a --- /dev/null +++ b/doc/kcontrol/smb/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/smb) diff --git a/doc/kcontrol/smb/index.docbook b/doc/kcontrol/smb/index.docbook new file mode 100644 index 0000000..3d3a0ea --- /dev/null +++ b/doc/kcontrol/smb/index.docbook @@ -0,0 +1,106 @@ +<?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;"> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Windows shares</keyword> +</keywordset> +</articleinfo> +<sect1 id="windows-shares"> +<title>Windows Shares</title> + +<sect2 id="windows-shares-intro"> +<title>Introduction</title> + +<para>In many small local area networks, the <acronym>SMB</acronym> +protocol is used to offer network services. Names like +<quote>&Windows; Network</quote> or <quote>&Windows; for Workgroups +Network</quote> or <quote>LanManager</quote> are often used as +well. Using <acronym>SMB</acronym> you can access so-called +<quote>shares</quote> (&ie; folders made available by the server) +as well as printers. </para> + +<para>&kde; comes with built-in support for the <acronym>SMB</acronym> +protocol. As &kde; is network-transparent that means you can access +<acronym>SMB</acronym> shares from everywhere you can access your +local files, for example in the &konqueror; file manager and in the +file dialog. To make use of this you should provide &kde; with some +information on your <acronym>SMB</acronym> network. But don't worry, +this is normally pretty simple as, for example, all the Windows +clients in your network need and have the same information.</para> + +<!-- Don't know if the following info should go in the base +documentation --> + +<!-- this smb-ioslave doesn't support showing a list +of hosts (like e.g. smb:/), for this you need the lan or rlan-ioslave, +very cool thing (TM) btw. If you want to write some documentation for +this one too, have a look at kdenetwork/lanbrowsing/lisa/README and +contact me if you have questions. --> + +<note><para>For the <acronym>SMB</acronym> protocol to work, it is +required to have <application>Samba</application> correctly +installed. If you have an NT domain controller, you will need at least +<application>Samba</application> version 2.0 or higher. If you want to +access &Windows; 2000 shares, you will need +<application>Samba</application> version 2.0.7 or higher. Older +versions may work too, but have not been tested.</para></note> + +<!-- TODO: link to some place which explains USING SMB, i.e. konqueror +or file dialog manual --> + +</sect2> + +<sect2 id="windows-shares-use"> +<title>Use</title> + +<para>Although there are a lot of insecure <acronym>SMB</acronym> +networks out there which allow access to anyone, in principle you have +to authenticate yourself to access the services of an +<acronym>SMB</acronym> server. By default, &kde; will use the data +entered in the <guilabel>Default user name</guilabel> and +<guilabel>Default password</guilabel> fields to authenticate itself on +<acronym>SMB</acronym> hosts. If you leave the field <guilabel>Default +user name</guilabel> empty, &kde; will try to access +<acronym>SMB</acronym> hosts without a username. If you leave the +default password empty, it will try without a password. If &kde; is +unsuccessful accessing the host using these settings, you will be +asked for a username and a password.</para> + +<important><para>While it makes things more comfortable if &kde; +stores your <acronym>SMB</acronym> password, this may be a security +problem. If you are using <acronym>SMB</acronym> in a security +conscious environment, you should not store your password here but +rather enter it anew every time you need to access an +<acronym>SMB</acronym> host.</para></important> + +<para>In the <guilabel>Workgroup</guilabel> field, you can enter your +workgroup name. If you don't know it, ask your system administrator +or have a look at other already configured machines in your network. +However, in most cases providing the workgroup name is not required, +so you probably can also leave this empty.</para> + +<para>If the option <guilabel>Show hidden shares</guilabel> is +checked, shares ending with a <quote>$</quote> will be shown.</para> +</sect2> + +</sect1> + +</article> \ No newline at end of file diff --git a/doc/kcontrol/useragent/CMakeLists.txt b/doc/kcontrol/useragent/CMakeLists.txt new file mode 100644 index 0000000..c350c7b --- /dev/null +++ b/doc/kcontrol/useragent/CMakeLists.txt @@ -0,0 +1,2 @@ +########### install files ############### +kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcontrol/useragent) diff --git a/doc/kcontrol/useragent/index.docbook b/doc/kcontrol/useragent/index.docbook new file mode 100644 index 0000000..14be0fc --- /dev/null +++ b/doc/kcontrol/useragent/index.docbook @@ -0,0 +1,117 @@ +<?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>Browser Identification</title> +<articleinfo> +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>user agent</keyword> +<keyword>browser</keyword> +<keyword>identification</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="user-agent"> +<title>Browser Identification</title> + + +<sect2 id="user-agent-intro"> +<title>Introduction</title> + +<para>When &konqueror; connects to a web site to retrieve information, +some basic identifying information is sent to the web site in the form +of a <quote>User Agent</quote> header.</para> + +<para>Because of minor differences in the way that different web +browsers function, web sites that rely too much on a single browser may +sometimes not display as intended when viewed using another +browser. Some web sites are smart enough to examine the contents of the +user agent header and incorporate this information in the +<acronym>HTML</acronym> code so that the content is displayed correctly +regardless of the browser used.</para> + +<para>However, you may find that some web sites refuse to function +correctly unless you are using a browser recognized as +<quote>proper</quote> by that site. In these cases, you may find it +necessary to fool the web site by having &konqueror; report itself to be +another browser by means of the user agent header.</para> + +</sect2> + +<sect2 id="user-agent-use"> +<title>Use</title> + +<para>In this module you can configure the +type of browser that &konqueror; will report itself to be. You can +control this information by web site. Usually, the list box that is +labeled <guilabel>Site/Domain Specific Identification</guilabel> will be +empty, so that &konqueror; will always use its default useragent +string.</para> + +<para>You can disable the sending of a user agent entirely, by +unchecking the <guilabel>Send identification</guilabel> +checkbox. This may cause strange behavior on some sites, and may even +deny you access to some websites, so disable this with caution.</para> + +<para>To configure a new agent binding, press the +<guibutton>New...</guibutton> button. Type the name of the server or +a domain in the text box at the top of the dialog that pops up, which +is labeled <guilabel>When browsing the following +site</guilabel>.</para> + +<para>Note that you can <emphasis>not</emphasis> use the wildcard +character <token>*</token> in this text box. However, the string +<userinput>kde.org</userinput> will match all hosts in the domain +<systemitem>kde.org</systemitem></para> + +<para>After typing the name of the server, type in the identifying +string in the next combo box, which is labeled <guilabel>Use the +following identity:</guilabel>, or choose a string from the list. If +you don't choose a string from the list, you will need to know what a +valid string from the browser looks like. For example, you could type +<userinput>Mozilla/4.0 (compatible; MSIE 4.0)</userinput>. </para> + +<para>In the field labeled <guilabel>Alias (description)</guilabel> +you can enter a descriptive name for the configured binding, ⪚ +<userinput>Netscape Navigator 4.75 on Linux</userinput> for the +useragent string <userinput>Mozilla/4.75 (X11; U; Linux 2.2.14 +i686)</userinput>.</para> + +<para>You can click on an existing entry in the <guilabel>Configured +agent bindings</guilabel> list, and then modify the contents of the +text boxes, followed by clicking <guibutton>Change...</guibutton>.</para> + +<para>The <guibutton>Delete</guibutton> button can be used to delete +the selected entry in the list of configured agent bindings. The +<guibutton>Delete All</guibutton> will remove all the configured user +agent strings. Click the <guibutton>Apply</guibutton> to take your +changes in effect.</para> + +<para>You can use the checkboxes at the top of the screen to build a +user agent that is uniquely yours, by choosing your own combination of +operating system name and version, platform, processor type, and +language.</para> + +<para>In all cases, the user agent that is being sent by default is +displayed in bold text at the top of the page.</para> + +</sect2> + +</sect1> + +</article> \ No newline at end of file
