diff options
Diffstat (limited to 'doc/kcontrol')
239 files changed, 12158 insertions, 0 deletions
diff --git a/doc/kcontrol/CMakeLists.txt b/doc/kcontrol/CMakeLists.txt new file mode 100644 index 000000000..778bbb0e2 --- /dev/null +++ b/doc/kcontrol/CMakeLists.txt @@ -0,0 +1,13 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_auto_add_subdirectories() +tde_create_handbook( DESTINATION kcontrol ) diff --git a/doc/kcontrol/Makefile.am b/doc/kcontrol/Makefile.am new file mode 100644 index 000000000..930c270cd --- /dev/null +++ b/doc/kcontrol/Makefile.am @@ -0,0 +1,6 @@ + +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/arts/CMakeLists.txt b/doc/kcontrol/arts/CMakeLists.txt new file mode 100644 index 000000000..99dd64da1 --- /dev/null +++ b/doc/kcontrol/arts/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/arts ) diff --git a/doc/kcontrol/arts/Makefile.am b/doc/kcontrol/arts/Makefile.am new file mode 100644 index 000000000..093f0a698 --- /dev/null +++ b/doc/kcontrol/arts/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/arts diff --git a/doc/kcontrol/arts/index.docbook b/doc/kcontrol/arts/index.docbook new file mode 100644 index 000000000..34131161a --- /dev/null +++ b/doc/kcontrol/arts/index.docbook @@ -0,0 +1,201 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY midi-kcontrol SYSTEM "midi.docbook"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride;</author> +<author>&Jost.Schenck;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-20</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>sound server</keyword> +<keyword>sound</keyword> +<keyword>aRts</keyword> +</keywordset> +</articleinfo> + +<sect1 id="sndserver"> +<title>Sound System</title> + +<para>This control module is used to configure the settings for the +&arts; sound server (the &tde; sound server).</para> + +<sect2 id="sndserver-general"> +<title>&arts;</title> + +<para>The top option, labeled <guilabel>Enable the sound system</guilabel>, +enables (or disables) the &arts; sound server entirely.</para> + +<tip> +<para>You can find out more about &arts; in general by typing +<userinput>help:/artsbuilder</userinput> into the &konqueror; location +bar, or by finding the &arts-builder; documentation in &khelpcenter;. +</para> +</tip> + +<para>The rest of the panel consists of options for the &arts; +sound server.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Enable networked sound</guilabel></term> +<listitem> +<para>If this option is enabled, then sound requests from the network +will be honored by the sound server. If this option is disabled, the sound +server will only honor requests from the local computer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Run with the highest possible priority (realtime priority)</guilabel></term> +<listitem><para>Enabling this option will give the sound server priority over +other applications, which will help alleviate any problems delivering +uninterrupted sound.</para> +<note><para>This option may require permissions you do not have as a regular +user.</para> +<para>This option also relies on certain real time support from your +system which may not be available.</para> +<para>If you do not have the necessary permissions, or your system does +not have the real time support necessary, enabling this option will not +cause problems.</para></note></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Sound buffer:</guilabel></term> +<listitem><para>This slider determines how quickly the sound server can use your +computer's resources. The faster the response time, the higher the +<acronym>CPU</acronym> load will be.</para> +<tip><para>I would recommend that you start with the sound server set at +250 ms, and use &tde; for a while. If you notice that the sound does +not work correctly, increase the responsiveness one step at a time until +the problems disappear.</para></tip> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Auto-suspend if idle after:</guilabel></term> +<listitem> +<para>Normally &arts; locks the sound card device, so that other +applications cannot use it. If you enable this option, then if &arts; +has been idle for the amount of time you set, it will suspend itself, +allowing any application access to the sound hardware. If &arts; +receives another request, it will unsuspend, and continue as normal. +Enabling this option may cause a small delay when you start an &arts; +application.</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>At the bottom of this page are two buttons to allow you to test your +settings, labelled <guibutton>Test Sound</guibutton> and <guilabel>Test +MIDI</guilabel> respectively.</para> + +</sect2> + +<sect2 id="sndserver-soundio"> +<title>Hardware</title> + +<para>The first option you can configure in the +<guilabel>Hardware</guilabel> panel is <guilabel>Select the audio +device:</guilabel>. It tells &arts; which sound system to use for input and +output of sound. Current choices are <acronym>ALSA</acronym> (Advanced +&Linux; Sound Architecture), <acronym>OSS</acronym> (Open Sound System), +<acronym>ESD</acronym> (Enlightenment Sound Daemon), no audio at all and +autodetect. In most cases <quote>Autodetect</quote> will be perfect for +you.</para> + +<para>Other options are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Full duplex</guilabel></term> +<listitem><para>This option allows the sound server to play and record sound at +the same time. This option should be enabled if you use applications (such as +Internet telephones) which require simultaneous record and +playback.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Use custom sampling rate:</guilabel></term> +<listitem> +<para>Normally, the sound server defaults to using a sampling rate of +44100 Hz (<acronym>CD</acronym> quality), which is supported on almost all +hardware. If you are using certain Yamaha soundcards, you might need to +configure this to 48000 Hz here; if you are using old SoundBlaster cards, like +SoundBlaster Pro, you might need to change this to 22050 Hz. All other values +are possible too and may make sense in certain contexts (&ie; professional +studio equipment).</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Quality:</guilabel></term> +<listitem> +<para>These settings allow you to configure the quality of the sounds that +will be played.</para> +<tip> +<para>Note that a higher sound quality causes a higher <acronym>CPU</acronym> +usage.</para> +<para>If you find sound is slow, or using too much +<acronym>CPU</acronym>, try reducing this setting.</para> +</tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Override device location:</guilabel></term> +<listitem> +<para>Normally, the sound server defaults to using the device called +<filename class="devicefile">/dev/dsp</filename> for sound output. This +should work in most cases. An exception is, for instance, if you are using +devfs, then you should use <filename +class="devicefile">/dev/sound/dsp</filename> instead. Other alternatives +are things like <filename class="devicefile">/dev/dsp0</filename> or +<filename class="devicefile">/dev/dsp1</filename> if you have a +soundcard that supports multiple outputs or you have multiple +soundcards.</para> +<tip> +<para>If you often use non-&arts; aware applications, and you have a +soundcard that supports it, try setting &arts; to use a different +device than <filename class="devicefile">/dev/dsp</filename>. This +way, other applications will be able to use the default device, while +&arts; is still running, without giving any error messages.</para> +</tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Other custom options:</guilabel></term> +<listitem><para>There are some options offered by +&arts; which may not be available in this control module, so you can add +command line options here which will be passed directly to +<application>artsd</application>. The options will be appended, so they +will override the choices made in the +<acronym>GUI</acronym>. To see the possible choices, open a &konsole; +window, and type <userinput><command>artsd</command> +<option>-h</option></userinput>.</para> +</listitem> +</varlistentry> + + +</variablelist> + +</sect2> + +&midi-kcontrol; + +</sect1> + +</article> diff --git a/doc/kcontrol/arts/midi.docbook b/doc/kcontrol/arts/midi.docbook new file mode 100644 index 000000000..3ec0062cb --- /dev/null +++ b/doc/kcontrol/arts/midi.docbook @@ -0,0 +1,24 @@ +<sect2 id="midi"> +<sect2info> +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect2info> +<title><acronym>MIDI</acronym> Configuration</title> + +<para>This section is used to determine which <acronym>MIDI</acronym> device +&tde; should use. You can also install a <acronym>MIDI</acronym> wrapper around +the device if you want.</para> + +<para>The use of this module is simple. Click once on the +<acronym>MIDI</acronym> device that you would like to use from the +list.</para> + +<para>If you want to use a <acronym>MIDI</acronym> mapper, simply mark +the checkbox below the list labeled <guilabel>Use MIDI +Mapper</guilabel>. This will allow you to select the map in the text +box below. You can click on the folder icon to browse your filesystem +to find the map if you need it.</para> + +</sect2>
\ No newline at end of file diff --git a/doc/kcontrol/background/CMakeLists.txt b/doc/kcontrol/background/CMakeLists.txt new file mode 100644 index 000000000..80711365e --- /dev/null +++ b/doc/kcontrol/background/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/background ) diff --git a/doc/kcontrol/background/Makefile.am b/doc/kcontrol/background/Makefile.am new file mode 100644 index 000000000..2a68936db --- /dev/null +++ b/doc/kcontrol/background/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/background diff --git a/doc/kcontrol/background/index.docbook b/doc/kcontrol/background/index.docbook new file mode 100644 index 000000000..393375942 --- /dev/null +++ b/doc/kcontrol/background/index.docbook @@ -0,0 +1,383 @@ +<?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>&Mark.Donohoe;</author> +<author>&Martin.R.Jones;</author> +<!-- <author>&Duncan.H;</author> --> +<author>&Mike.McBride;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-01-18</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>background</keyword> +<keyword>wallpaper</keyword> +</keywordset> +</articleinfo> + +<sect1 id="background"> + +<title>Background</title> + +<para>The Background module allows you to configure colors or wallpapers for +your desktop background.</para> + +<para>It is comprised of four areas:</para> + +<orderedlist> +<listitem> +<para>Desktop selection area</para> +</listitem> +<listitem> +<para>An area for selecting background images</para> +</listitem> +<listitem> +<para>The background Preview Monitor</para> +</listitem> +<listitem> +<para>An area for determining the background color</para> +</listitem> +</orderedlist> + +<variablelist> +<varlistentry> +<term>Selecting the desktop</term> +<listitem> +<para>The drop down box labeled <guilabel>Setting for +desktop:</guilabel> is used to select the desktop you want to +configure. You can select any of the desktops individually, or you +can select <guilabel>All Desktops</guilabel> and the changes you make +will be applied to all desktops.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Preview Monitor</term> +<listitem> +<para>This is a preview window. It will give you a sense of what to +expect with each change.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem> +<para>This section allows you to load a wallpaper on top of the color +gradient chosen in the section below.</para> + +<para>There are three choices available here:</para> + +<variablelist> +<varlistentry> +<term><guilabel>No Picture</guilabel></term> +<listitem> +<para>No picture background will be shown. The color and pattern +choices below will still take effect.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Picture</guilabel></term> +<listitem> +<para>A single picture will be used as the background for the selected +desktops.</para> +<para>How this picture is positioned and scaled can be fine tuned +below.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Slide show</guilabel></term> +<listitem> +<para>&tde; allows you to have an automatic slide show of wallpaper +images. To enable this option, press the <guibutton>Setup...</guibutton> +button. In the resulting dialog you may choose any +image or folder of images available on your computer, using the +<guibutton>Add...</guibutton> button to navigate your file system. +<guibutton>Remove</guibutton> will remove the currently selected +entry from the list.</para> + +<para>You may choose the length of time any image is displayed in the +<guilabel>Change picture after:</guilabel> box, and you may choose +<guibutton>Show pictures in random order</guibutton> if you don't want +them displayed in the order they are listed.</para> + +<tip><para>Displaying wallpaper requires that the image be kept in +memory. If you are low on memory, using a small, tiled image or none +at all is recommended.</para> + +<para>Scaling or centering a small image still requires an image the +size of your display to be maintained in memory.</para></tip> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Options</guilabel></term> +<listitem> + +<variablelist><!-- Positioning --> +<title><guilabel>Position:</guilabel></title> +<varlistentry> +<term>Centered</term> +<listitem><para>The image will be centered on the screen without changing the +size of the image. The background colors will be present anywhere the image +does not cover.</para> </listitem> +</varlistentry> +<varlistentry> +<term>Tiled</term> +<listitem><para>The image will be duplicated until it fills the entire +desktop. The first image will be placed in the upper left corner of the screen, +and duplicated downward and to the right.</para></listitem> +</varlistentry> +<varlistentry> +<term>Center Tiled</term> +<listitem><para>The image will be duplicated until it +fills the entire desktop. The first image will be placed in the center of the +screen, and duplicated upward, downward to the right, and to the left.</para> +</listitem></varlistentry> +<varlistentry> +<term>Centered Maxpect</term> +<listitem><para>The image will be placed in the center of the screen. It will +be scaled to fit the desktop, but it will not change the aspect ratio of the +original image. This will provide you with an image that is not distorted. +</para></listitem> +</varlistentry> +<varlistentry> +<term>Tiled Maxpect</term> +<listitem> +<para>The image will be placed in the corner of the screen. It will +be scaled to fit the desktop, but it will not change the aspect ratio +of the original image. This will provide you with an image that is +not distorted. If there is any space over, the image will be +duplicated to fill it.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Scaled</term> +<listitem><para>The image will be scaled to fit the desktop. It will be +stretched to fit to all four corners. This may distort the image.</para></listitem> +</varlistentry> +<varlistentry> +<term>Centered Auto fit</term> +<listitem> +<para>If the picture fits the desktop size, this mode works like the +centered option. If the picture is larger than the desktop then it is +scaled down to fit while keeping the aspect ratio. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>Scale and Crop</term> +<listitem> +<para>Magnify the picture without distorting it until it fills both the +width and height of the desktop (cropping the picture if necessary), and +then center it on the desktop.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist><!-- Colors --> +<varlistentry> +<term><guilabel>Colors:</guilabel></term> +<listitem> +<para>The first drop down box allows you to choose the type of color, +gradient, or pattern to display under (or in place of) wallpaper.</para> +<tip><para>If you are going to be using a picture as a wallpaper, you +can skip this section of the dialog box.</para> +<para>However, if your chosen wallpaper does not cover the entire +desktop, the chosen colors will still show in the remaining +space.</para></tip> + +<variablelist> +<varlistentry> +<term><guilabel>Single Color</guilabel></term> +<listitem><para>By choosing this mode, you select one color using the +first color bar, and the entire background is covered with this one +color.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Horizontal Gradient</guilabel></term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &tde; will then start with the color selected by <guilabel>Primary +Color</guilabel> on the left edge of the screen, and slowly transform into the +color selected by <guilabel>Blend Color</guilabel> by the time it gets to the +right edge of the screen.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Vertical Gradient</guilabel></term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &tde; will then start with the color selected by <guilabel>Primary +Color</guilabel> on the top edge of the screen, and slowly transform into the +color selected by <guilabel>Blend Color</guilabel> as it moves to the bottom of +the screen.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Pyramid Gradient</guilabel></term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &tde; will then start with the color selected by +<guilabel>Primary Color</guilabel> in each +corner of the screen, and slowly transform into the color selected by +<guilabel>Blend Color</guilabel> as it moves to the center of the +screen.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Pipecross Gradient</guilabel></term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &tde; will then start with the color selected by +<guilabel>Primary Color</guilabel> in each corner of the screen, and slowly +transform into the color selected by <guilabel>Blend Color</guilabel> +as it moves to the center of the screen. The shape of +this gradient is different than the pyramid gradient.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Elliptic Gradient</guilabel></term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &tde; will then start with the color selected by +<guilabel>Blend Color</guilabel> in the center of the screen, and slowly +transform into the color selected by <guilabel>Primary Color</guilabel> +as it moves to the edges, in an elliptical pattern.</para></listitem> +</varlistentry> + +<varlistentry> +<term><replaceable>Pattern</replaceable></term> +<listitem> +<para>The rest of the list are the names of various patterns +or textures you can choose.</para> +<para>Click on +<guibutton>OK</guibutton>, and &tde; will render the pattern you +selected using the two colors you selected. For more on patterns, see +the section <link linkend="bkgnd-patterns">Adding, Removing and +Modifying Patterns</link>.</para> + +<para>Select the primary color with the first color bar. If you have +chosen a pattern that requires two colors to be set the secondary +color can be set by pressing the appropriate button.</para> +</listitem> +</varlistentry> +</variablelist> + +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><guilabel>Blending:</guilabel></term> +<listitem> +<para>The drop down box labeled <guilabel>Blending:</guilabel> contains the +options to make a smooth transition (blend) from the wallpaper as it +changes to the background.</para> + +<orderedlist> +<listitem><para>A drop down box allows you to select the blending mode. +Many of the modes are similar to blending modes for background colors. Select +your mode from the list, and the preview window shows you what it will look +like.</para></listitem> +<listitem><para>The <guilabel>Balance</guilabel> slider adjusts the +blending. The results can be seen immediately in the preview +window.</para></listitem> +<listitem><para>The <guilabel>Reverse roles</guilabel> can reverse the +role of the picture and the background for some types of +blending.</para> +</listitem> +</orderedlist> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +<sect2 id="bkgnd-advanced"> +<title>Advanced options</title> +<para>Located below the preview monitor is a button labeled +<guibutton>Advanced Options</guibutton>.</para> + +<para>To use an external program to determine and change the +background of &tde;, simply select <guilabel>Use the following program +for drawing the background</guilabel>. Available &tde; programs are +listed, select one to enable it. To modify your choice, for example +to change the refresh times, you may press the +<guibutton>Modify...</guibutton> button.</para> + +<para>To add a third party application (⪚ +<application>XEarth</application>) you may use the +<guibutton>Add...</guibutton> button. A dialog will open allowing you +to choose your application, and fill in other data about it. You may +remove any entries from this list by selecting it and pressing the +<guibutton>Remove</guibutton> button.</para> + +<para>Using third party external programs to modify or change the +background is beyond the scope of this document, see their respective +documentation for the format of command-line switches and other +configuration information.</para> + +<para>Also in this section you may choose to set the color of text +that is used for icons on the desktop. If you find icon text +difficult to read against a wallpaper or pattern, you can choose a +solid color to show beneath text, or enable a shadow under the text to +enhance its appearance.</para> + +<para>It is possible to set how many lines of text will be shown beneath each icon with the <guilabel>Lines for icon text:</guilabel> If the text is longer than can be shown in the configured number of lines, it will be truncated. You can also set a value for the <guilabel>Width for icon text:</guilabel> option. The value is in pixels, and the default is <guilabel>Auto</guilabel>, which is a default calculated based on the current font. +<!-- TODO: Find out what the actual calculation here is, in case someone needs it --> +</para> + +<para>Finally you can set the <guilabel>Size of the background +cache:</guilabel>. The default (2048 KB) is usually a safe +choice.</para> + +</sect2> + +<sect2 id="bkgnd-patterns"> +<title>Adding, Removing and Modifying Wallpapers and Patterns</title> + +<para>There is a button under the preview monitor labelled <guibutton>Get +New Wallpapers</guibutton> that helps you fetch new wallpaper images from a +selection of popular images from the <ulink +url="http://www.kde-look.org">KDE-Look</ulink> website. You can of course +select any image you have available to use as wallpaper, and it may be +stored in any location on your hard drive. To have a wallpaper show up in +the list automatically for all users, you should save it to the <filename +class="directory">$<envar>TDEDIR</envar>/share/wallpapers</filename> +folder.</para> + +<para>A pattern is a picture file which &tde; uses as a template to +draw your background. The picture file provides the shapes, but &tde; +provides the colors. &tde; is packaged with several patterns, and you also +can add new patterns.</para> + +<para>To add a new pattern that is available to every user on your +computer, simply place the file in <filename +class="directory">$<envar>TDEDIR</envar>/share/apps/kdesktop/patterns/</filename>.</para> + +<para>Copy a <literal role="extension">.desktop</literal> file from +this folder, and name it the same as your new pattern image file. +Modify the contents to suit your new pattern.</para> + +<para>To add a new pattern for a single user, add the files to +<filename +class="directory">$<envar>TDEHOME</envar>/share/apps/kdesktop/patterns/</filename>.</para> + +<para>For best results, the pattern should be a grayscale PNG file.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/bell/CMakeLists.txt b/doc/kcontrol/bell/CMakeLists.txt new file mode 100644 index 000000000..84a3c3cf7 --- /dev/null +++ b/doc/kcontrol/bell/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/bell ) diff --git a/doc/kcontrol/bell/Makefile.am b/doc/kcontrol/bell/Makefile.am new file mode 100644 index 000000000..dbbc3935c --- /dev/null +++ b/doc/kcontrol/bell/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/bell diff --git a/doc/kcontrol/bell/index.docbook b/doc/kcontrol/bell/index.docbook new file mode 100644 index 000000000..3fc67c48d --- /dev/null +++ b/doc/kcontrol/bell/index.docbook @@ -0,0 +1,74 @@ +<?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>Pat</firstname> +<surname>Dowler</surname> +</author> + +<author> +<firstname>Matthias</firstname> +<surname>Hoelzer</surname> +</author> + +<author> +<firstname>Mike</firstname> +<surname>McBride</surname> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +<date>2003-10-16</date> +<releaseinfo>3.2</releaseinfo> +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Bell</keyword> +<keyword>Settings</keyword> +</keywordset> +</articleinfo> + +<sect1 id="bell"> +<title>System bell</title> + +<para>The system bell or beep is a feature of the X server, which +attempts to make good use of the available hardware.</para> + +<para>&tde; normally doesn't use the system bell; instead using its +own system notifications, which could include log entries, message +popups, or its own beep. You can configure these in the +<guilabel>System Notifications</guilabel> &kcontrol; module.</para> + +<note><para>It isn't always possible for the X server to actually make +a beep sound with exactly the parameters selected due to hardware +limitations. For example, on most PCs, volume control is not very good +so the X server seems to fake low volume with a reduced duration of +the sound. Thus, if the settings don't seem to do anything, this is +because the X server and/or the hardware don't support anything +better.</para></note> + +<para>Users are able to set the following parameters for the bell:</para> + +<itemizedlist> +<listitem> <para>volume (percentage of <quote>maximum</quote> volume)</para> </listitem> +<listitem> <para>pitch (in Hz)</para> </listitem> +<listitem> <para>duration (in milliseconds)</para> </listitem> +</itemizedlist> + +<para>You can use the <guibutton>test</guibutton> button to hear how +the current settings will sound.</para> + +<sect2 id="bell-author"><title>Section Authors</title> +<para>Pat Dowler, Matthias Hoelzer <email>[email protected]</email></para> +<para>Converted to KDE 2.0 by Mike McBride <email>[email protected]</email></para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/cache/CMakeLists.txt b/doc/kcontrol/cache/CMakeLists.txt new file mode 100644 index 000000000..9b8927e44 --- /dev/null +++ b/doc/kcontrol/cache/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/cache ) diff --git a/doc/kcontrol/cache/Makefile.am b/doc/kcontrol/cache/Makefile.am new file mode 100644 index 000000000..12a7570f3 --- /dev/null +++ b/doc/kcontrol/cache/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/cache diff --git a/doc/kcontrol/cache/index.docbook b/doc/kcontrol/cache/index.docbook new file mode 100644 index 000000000..7392d63fc --- /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/cdinfo/CMakeLists.txt b/doc/kcontrol/cdinfo/CMakeLists.txt new file mode 100644 index 000000000..e4cfd45b9 --- /dev/null +++ b/doc/kcontrol/cdinfo/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/cdinfo ) diff --git a/doc/kcontrol/cdinfo/Makefile.am b/doc/kcontrol/cdinfo/Makefile.am new file mode 100644 index 000000000..318cb35a6 --- /dev/null +++ b/doc/kcontrol/cdinfo/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/cdinfo diff --git a/doc/kcontrol/cdinfo/index.docbook b/doc/kcontrol/cdinfo/index.docbook new file mode 100644 index 000000000..6048e5873 --- /dev/null +++ b/doc/kcontrol/cdinfo/index.docbook @@ -0,0 +1,51 @@ +<?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>CD-ROM Information/Capabilities</title> +<articleinfo> + +<authorgroup> +<author> +<firstname>Jahshan</firstname> +<surname>Bhatti</surname> +<affiliation><address><email>[email protected]</email></address></affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2006-06-13</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>cd-rom</keyword> +<keyword>capabilities information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>CD-ROM Information/Capabilities</title> + +<para> +This page displays information about the attached CD-ROM drives and their capabilites, +</para> + +<para> +On &Linux;, this information is read from <filename +class="devicefile">/proc/sys/dev/cdrom/info</filename>, which are only available if +the <filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel. +</para> + +<para> +The user cannot modify any settings on this page. +</para> + +</sect1> +</article> diff --git a/doc/kcontrol/clock/CMakeLists.txt b/doc/kcontrol/clock/CMakeLists.txt new file mode 100644 index 000000000..b93936f5c --- /dev/null +++ b/doc/kcontrol/clock/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/clock ) diff --git a/doc/kcontrol/clock/Makefile.am b/doc/kcontrol/clock/Makefile.am new file mode 100644 index 000000000..a38969bfe --- /dev/null +++ b/doc/kcontrol/clock/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/clock diff --git a/doc/kcontrol/clock/index.docbook b/doc/kcontrol/clock/index.docbook new file mode 100644 index 000000000..ba59f9d53 --- /dev/null +++ b/doc/kcontrol/clock/index.docbook @@ -0,0 +1,74 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-19</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>clock</keyword> +<keyword>date</keyword> +<keyword>time</keyword> +<keyword>set</keyword> +<keyword>configure</keyword> +</keywordset> +</articleinfo> + +<sect1 id="datetime"> + +<title>Date & Time</title> + +<para>You can use this module to alter the system date and time, using a +convenient graphical interface.</para> + +<note><para>You must have system administrator (<systemitem +class="username">root</systemitem>) access to change the system date and +time. If you do not have this access level, this module will only show +you the current settings.</para></note> + +<para>When you first start, you are in display mode only. To modify +your settings, click on <guibutton>Administrator Mode</guibutton>. If +you are logged in as <systemitem class="username">root</systemitem>, +you will go straight to the change dialog. If not, &tde; will ask for +a superuser password.</para> + +<sect2 id="date-change"> +<title>Modifying your settings</title> + +<para>You set the date using the left half of the module. Simply +choose your month (the drop down box at the top), year (the spin box +at the top), and the day of the month (simply click on the day in the +calendar).</para> + +<para>You set the time using the spin boxes at the bottom of the clock. +You can also directly enter your value.</para> + +<note><para>The time is represented in 24 hour format. If you want +the system time to be set to 8:00 PM, you need to set the hour spinbox +to <guilabel>20</guilabel> (8 + 12). If you want the system time set +to 8:00 AM, you should set the hour spinbox to +<guilabel>8</guilabel>.</para></note> + +<para>To set a new time zone, simply select one from +the drop down box at the bottom.</para> + +<para>When you have set the correct date and time, simply click +<guibutton>Apply</guibutton> to make the changes permanent.</para> +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/colors/CMakeLists.txt b/doc/kcontrol/colors/CMakeLists.txt new file mode 100644 index 000000000..2008301ce --- /dev/null +++ b/doc/kcontrol/colors/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/colors ) diff --git a/doc/kcontrol/colors/Makefile.am b/doc/kcontrol/colors/Makefile.am new file mode 100644 index 000000000..ec7030b15 --- /dev/null +++ b/doc/kcontrol/colors/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/colors diff --git a/doc/kcontrol/colors/index.docbook b/doc/kcontrol/colors/index.docbook new file mode 100644 index 000000000..bfc508a47 --- /dev/null +++ b/doc/kcontrol/colors/index.docbook @@ -0,0 +1,132 @@ +<?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>&Mark.Donohoe; &Mark.Donohoe.mail;</author> +<author>&Martin.R.Jones; &Martin.R.Jones.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-09-22</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>color</keyword> +</keywordset> +</articleinfo> + +<sect1 id="color"> + +<title>Colors</title> +<sect2 id="color-intro"> +<title>Introduction</title> + +<para>The Color Selection module is comprised of 4 sections:</para> + +<orderedlist> +<listitem><para><link linkend="kcmdisplay-preview">The color scheme +preview</link>.</para></listitem> +<listitem><para><link linkend="kcmdisplay-widget-color">The current +<guilabel>Widget Color</guilabel></link>.</para> +</listitem> +<listitem><para><link linkend="kcmdisplay-color-schemes">The available Color +Schemes</link>.</para></listitem> +<listitem><para><link linkend="kcmdisplay-contrast">The contrast +slider</link>.</para></listitem> +</orderedlist> + +<note><para>A <emphasis>Widget</emphasis> is a commonly-used +programmer's term for referring to User Interface elements such as +buttons, menus, and scroll bars. You can think of them as the +fundamental pieces that are assembled to make your +application.</para></note> + +<sect3 id="kcmdisplay-preview"> +<title>Preview</title> + +<para>This section of the dialog demonstrates how a color scheme applies +to a sample selection of widgets. It provides you with a +<guilabel>preview</guilabel> of your current color choices.</para> + +<para>A color scheme consists of a set of 18 colors.</para> + +<para>Each of the widgets is labeled to help you identify how your +changes will impact the color scheme.</para> + +</sect3> + +<sect3 id="kcmdisplay-widget-color"> +<title><guilabel>Widget Color</guilabel></title> + +<para>The currently selected member of the color scheme is shown in the +combo box. This widget color can be changed by clicking on the colored +box below the combo box. A color selection dialog will then appear, from +which you may select a new color. When you are happy with your color +selection, press <guibutton>OK</guibutton> in the color selection +dialog. The color will be updated in the Preview Area.</para> + +<para>You may select any member of the color scheme from the +color combination box.</para> + +</sect3> + +<sect3 id="kcmdisplay-contrast"> +<title><guilabel>Contrast</guilabel> Slider</title> + +<para>The <guilabel>Contrast</guilabel> slider allows you to change the +contrast between different shadings of the selected colors.</para> + +<para>The preview area instantly updates to show the effect of your +change.</para> + +</sect3> + +<sect3 id="kcmdisplay-color-schemes"> +<title><guilabel>Color Scheme</guilabel></title> + +<para>Various color schemes are supplied with &tde;, and you are free to +define your own.</para> + +<para>The three major color components of each scheme are shown beside +the name in the list. To preview a scheme in the larger preview area, +click on its name in the list box.</para> + +<para>You can use the &tde;-supplied Color Schemes as a starting point +to devise your own Scheme. Click on the <guibutton>Save +Scheme...</guibutton> button to store the color scheme under a new name, +then modify it.</para> + +<para>When such a user-created Color Scheme is selected, changes to it +(as shown in the Preview) can be saved with the <guibutton>Save +Scheme...</guibutton> button; it can also be deleted with the +<guibutton>Remove Scheme</guibutton> button.</para> + +<note><para>The &tde;-supplied Schemes themselves cannot be changed or +deleted.</para></note> + +<para>You can use the <guibutton>Import Scheme...</guibutton> button to +add new entries to the list. This might be color schemes that you +have created on another computer and saved, or color schemes you have +downloaded from a website.</para> + +<para>You can choose if you want &tde; to apply the color scheme even +to non-&tde; applications by enabling the <guilabel>Apply colors to +non-TDE applications</guilabel>. Not all applications will allow +this, but most do.</para> + +</sect3> +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/componentchooser/CMakeLists.txt b/doc/kcontrol/componentchooser/CMakeLists.txt new file mode 100644 index 000000000..20d23b51c --- /dev/null +++ b/doc/kcontrol/componentchooser/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/componentchooser ) diff --git a/doc/kcontrol/componentchooser/Makefile.am b/doc/kcontrol/componentchooser/Makefile.am new file mode 100644 index 000000000..51f3f7609 --- /dev/null +++ b/doc/kcontrol/componentchooser/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/componentchooser diff --git a/doc/kcontrol/componentchooser/index.docbook b/doc/kcontrol/componentchooser/index.docbook new file mode 100644 index 000000000..ddb440011 --- /dev/null +++ b/doc/kcontrol/componentchooser/index.docbook @@ -0,0 +1,83 @@ +<?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>Default Applications</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Burkhard</firstname><surname>Lück</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2009</year> +<holder>Burkhard Lück</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>System Settings</keyword> +<keyword>components</keyword> +<keyword>default applications</keyword> +</keywordset> +</articleinfo> + +<sect1 id="default-applications"> +<title>Default Applications</title> + +<para>In this module you can change &tde; default applications, sometimes referred to as components.</para> + +<para>Components are programs that handle basic tasks, like the terminal emulator, the text +editor and the email client. Different &tde; applications sometimes need to +invoke a console emulator, send a mail or display some text.</para> + +<para>To do so consistently, these applications always call the same components. Here you +can select which programs these components are.</para> + +<para>The list on the left shows the configurable component types:</para> +<itemizedlist> +<listitem> +<para>Email Client</para> +</listitem> +<listitem> +<para>Embedded Text Editor</para> +</listitem> +<!--<listitem> +<para>File Manager</para> +</listitem>--> +<listitem> +<para>Instant Messenger</para> +</listitem> +<listitem> +<para>Terminal Emulator</para> +</listitem> +<listitem> +<para>Web Browser</para> +</listitem> +<!--<listitem> +<para>Window Manager</para> +</listitem>--> +</itemizedlist> + +<para> Select the component you want to configure. In the right part of the dialog you are +able to select your favorite application.</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/cookies/CMakeLists.txt b/doc/kcontrol/cookies/CMakeLists.txt new file mode 100644 index 000000000..4bd404706 --- /dev/null +++ b/doc/kcontrol/cookies/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/cookies ) diff --git a/doc/kcontrol/cookies/Makefile.am b/doc/kcontrol/cookies/Makefile.am new file mode 100644 index 000000000..ed988eefc --- /dev/null +++ b/doc/kcontrol/cookies/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/cookies diff --git a/doc/kcontrol/cookies/index.docbook b/doc/kcontrol/cookies/index.docbook new file mode 100644 index 000000000..72080bc27 --- /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 +&tde; 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/crypto/CMakeLists.txt b/doc/kcontrol/crypto/CMakeLists.txt new file mode 100644 index 000000000..5b0b4bfc2 --- /dev/null +++ b/doc/kcontrol/crypto/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/crypto ) diff --git a/doc/kcontrol/crypto/Makefile.am b/doc/kcontrol/crypto/Makefile.am new file mode 100644 index 000000000..3911417ea --- /dev/null +++ b/doc/kcontrol/crypto/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/crypto diff --git a/doc/kcontrol/crypto/index.docbook b/doc/kcontrol/crypto/index.docbook new file mode 100644 index 000000000..5063a723f --- /dev/null +++ b/doc/kcontrol/crypto/index.docbook @@ -0,0 +1,205 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-17</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>crypto</keyword> +<keyword>SSL</keyword> +<keyword>encryption</keyword> + +</keywordset> +</articleinfo> + +<sect1 id="crypto"> + +<title>Encryption Configuration</title> + +<sect2 id="crypto-intro"> +<title>Introduction</title> +<para>Many applications within &tde; are capable of exchanging information using +encrypted files and/or network transmissions.</para> +</sect2> + +<sect2 id="crypto-use"> +<title>Use</title> + +<warning><para>All encryption schemes are only as strong as their +weakest link. In general, unless you have some previous +training/knowledge, it is better to leave this module +unchanged.</para></warning> + +<para>The options within this module can be divided into two +groups:</para> + +<para>Two options along the bottom of the module, <guilabel>Warn on +entering SSL Mode</guilabel> and <guilabel>Warn on leaving SSL +mode</guilabel>, allow you to determine if &tde; should inform you when +you enter or leave SSL encryption.</para> + +<para>The remainder of the options are about determining which +encryption methods to use, and which should not be used. Once you have +selected the appropriate encryption protocols, simply click +<guibutton>Apply</guibutton> to commit your changes.</para> + +<tip><para>Only make changes to this module if specific information +about the strength or weakness of a particular encryption method is +given to you from <emphasis>a reliable source</emphasis>.</para></tip> + +</sect2> + +<!-- Ugh.. write a bunch of stuff about the rest of it --> +<sect2 id="ssl_tab"> +<title>The <guilabel>SSL</guilabel> Tab</title> + +<para>The first option is <guilabel>Enable TLS support if supported by +the server</guilabel>. <acronym>TLS</acronym> is Transport Layer +Security, and is the newest version of <acronym>SSL</acronym>. It +integrates better than <acronym>SSL</acronym> with other protocols, +and it has replaced <acronym>SSL</acronym> in protocols such as POP3 +and <acronym>SMTP</acronym>.</para> + +<para>Then next options are <guilabel>Enable SSL v2</guilabel> and +<guilabel>Enable SSL v3</guilabel>. These are the second and third +revision of the <acronym>SSL</acronym> protocol, and it is normal to +enable both.</para> + +<para>There are several different <firstterm>Ciphers</firstterm> +available, and you can enable these separately in the lists labeled +<guilabel>SSL v2 Ciphers to Use</guilabel> and <guilabel>SSL v3 +Ciphers to Use</guilabel>. The actual protocol to use is negotiated +by the application and the server when the connection is +created.</para> + +<para>There are several <guilabel>Cipher Wizards</guilabel> to help +you choose a set that is suitable for your use.</para> + +<variablelist> +<varlistentry> +<term><guibutton>Most Compatible</guibutton></term> +<listitem> +<para>Select the settings found to be most compatible with the most +servers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guibutton>US Ciphers Only</guibutton></term> +<listitem> +<para>Select only the US <quote>strong</quote> (128 bit or greater) +ciphers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Export Ciphers Only</guibutton></term> +<listitem> +<para>Select only the weak (56 bit or less) ciphers.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guibutton>Enable All</guibutton></term> +<listitem> +<para>Select all ciphers and methods.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Finally, there are some general <acronym>SSL</acronym> settings.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Use EGD</guilabel></term> +<listitem> +<para>If selected, <application>OpenSSL</application> will be asked to +use the entropy gathering daemon (<acronym>EGD</acronym>) for +initializing the pseudo-random number generator.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use entropy file</guilabel></term> +<listitem> +<para>If selected, <application>OpenSSL</application> will be asked to +use the given file as entropy for initializing the pseudo-random number +generator.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Warn on entering SSL mode</guilabel></term> +<listitem> +<para>If selected, you will be notified when entering an +<acronym>SSL</acronym> enabled site.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Warn on leaving SSL mode</guilabel></term> +<listitem> +<para>If selected, you will be notified when leaving an +<acronym>SSL</acronym> based site.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Warn on sending unencrypted data</guilabel></term> +<listitem> +<para>If selected, you will be notified before sending unencrypted +data via a web browser.</para> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="openssl"> +<title>The <guilabel>OpenSSL</guilabel> Tab</title> + +<para>Here you can test if your <application>OpenSSL</application> +libraries have been detected correctly by &tde;, with the +<guibutton>Test</guibutton> button.</para> + +<para>If the test is unsuccessful, you can specify a path to the +libraries in the field labelled <guilabel>Path to OpenSSL Shared +Libraries</guilabel>.</para> + +</sect2> + +<sect2 id="your-certificates"> +<title>The <guilabel>Your Certificates</guilabel> Tab</title> + +<para>The list shows which certificates of yours &tde; knows about. +You can easily manage them from here.</para> + +</sect2> + +<sect2 id="authentication"> +<title>The <guilabel>Authentication</guilabel> Tab</title> + +<para>Not yet documented<!-- No "what's this" to get any info from --></para> +</sect2> + +<sect2 id="peer-ssl-certificates"> +<title>The <guilabel>Peer SSL Certificates</guilabel> Tab</title> + +<para>The list box shows which site and personal certificates &tde; +knows about. You can easily manage them from here.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/desktop/CMakeLists.txt b/doc/kcontrol/desktop/CMakeLists.txt new file mode 100644 index 000000000..acde96f88 --- /dev/null +++ b/doc/kcontrol/desktop/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/desktop ) diff --git a/doc/kcontrol/desktop/Makefile.am b/doc/kcontrol/desktop/Makefile.am new file mode 100644 index 000000000..545365a4a --- /dev/null +++ b/doc/kcontrol/desktop/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/desktop diff --git a/doc/kcontrol/desktop/index.docbook b/doc/kcontrol/desktop/index.docbook new file mode 100644 index 000000000..e1a25f5b1 --- /dev/null +++ b/doc/kcontrol/desktop/index.docbook @@ -0,0 +1,111 @@ +<?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;</author> +<author>&Jost.Schenck;</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2010</year> +<holder>&Mike.McBride;</holder> +<holder>&Jost.Schenck;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>System Settings</keyword> +<keyword>desktop</keyword> +</keywordset> +</articleinfo> + +<sect1 id="multiple-desktops"> +<title>Multiple Desktops</title> + +<sect2 id="multiple-desktops-introduction"> +<title>Introduction</title> + +<para>&tde; supports multiple desktops, widely known as virtual desktops.</para> + +<para>Virtual desktops are like having multiple computers. In older operating systems, users +had access only to one desktop. Virtual desktops work much the same way as having multiple +computers. Many users configure their virtual desktops by grouping similar tasks.</para> + +<para>Virtual desktops apply only to each user's session. Other users logged in also can define +virtual desktops.</para> + +</sect2> + +<sect2 id="multiple-desktops-number"> +<title>Number of Desktops</title> + +<para>&tde; offers the possibility to define up to 20 virtual +desktops. In this module you can configure the number of desktops as well +as names. Use the slider or spinner widgets to adjust the number of +desktops. Assign names to the desktops by entering text into the respective +text fields.</para> + +</sect2> + +<sect2 id="multiple-desktops-switching"> +<title>Desktop Switching</title> + +<para>There are several ways to switch to the different desktops.</para> + +<para>When you enable <guilabel>Mouse wheel over desktop switches +desktop</guilabel>, then scrolling the wheel over an empty space on the +desktop will change to the next virtual desktop numerically, in the +direction scrolled. Scrolling forward (up) will select the desktop in the +next numerical order. Scrolling backwards (down) will do the opposite.</para> + +<para>Keyboard shortcuts provide a way to switch desktops. For virtual +desktops 1 through 12, use <keycombo action="simul">&Ctrl;<keycap>F1</keycap></keycombo>, +<keycombo action="simul">&Ctrl;<keycap>F2</keycap></keycombo>, +<keycombo action="simul">&Ctrl;<keycap>F3</keycap></keycombo>, etc. For virtual desktops +13 through 20, use <keycombo action="simul">&Ctrl;&Shift;<keycap>F1</keycap></keycombo>, +<keycombo action="simul">&Ctrl;&Shift;<keycap>F2</keycap></keycombo>, +<keycombo action="simul">&Ctrl;&Shift;<keycap>F3</keycap></keycombo>, etc.</para> + +<para>Another keyboard shortcut includes <keycombo action="simul"> &Ctrl;	</keycombo>.</para> + +<para>A feature called <guilabel>Active Desktop Borders</guilabel> can be used with the mouse pointer +to switch desktops. This feature is configured in the +<ulink url="help:/kcontrol/windowbehavior/index.html#advanced">Window Behavior Advanced</ulink> +module.</para> + +<para>Another method is to install the Desktop Preview & and Pager Menu panel applet. The +default &tde; desktop has this applet already installed with a default number of virtual desktops +set to four. When this applet is installed in the panel, miniature desktops can be viewed and +selected with the mouse pointer.</para> + +<para>Like the desktop mouse wheel scrolling support, the scroll wheel can be used with the pager +applet too.</para> + +<para>The Desktop Preview & and Pager Menu panel applet has its own set of configuration +options. Like many panel applets, the Desktop Preview & and Pager Menu panel applet has a handle, +from which a popup menu appears when using the &RMB;. When the popup menu appears, select the +<guimenuitem>Desktop Preview & Pager Menu</guimenuitem> option, then +select the <guisubmenu>Pager Options</guisubmenu> submenu option.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/desktopbehavior/CMakeLists.txt b/doc/kcontrol/desktopbehavior/CMakeLists.txt new file mode 100644 index 000000000..fcc5a94c9 --- /dev/null +++ b/doc/kcontrol/desktopbehavior/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/desktopbehavior ) diff --git a/doc/kcontrol/desktopbehavior/Makefile.am b/doc/kcontrol/desktopbehavior/Makefile.am new file mode 100644 index 000000000..9ff6d953a --- /dev/null +++ b/doc/kcontrol/desktopbehavior/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/desktopbehavior diff --git a/doc/kcontrol/desktopbehavior/index.docbook b/doc/kcontrol/desktopbehavior/index.docbook new file mode 100644 index 000000000..6ebfe57ec --- /dev/null +++ b/doc/kcontrol/desktopbehavior/index.docbook @@ -0,0 +1,198 @@ +<?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>2005-02-20</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>desktop</keyword> +</keywordset> +</articleinfo> + +<sect1 id="desktop"> + +<title>Desktop Behavior</title> + +<sect2 id="desktop-desktop"> +<title><guilabel>Desktop</guilabel> Tab</title> + +<variablelist> +<varlistentry> +<term><guilabel>Show icons on desktop</guilabel></term> +<listitem> +<para>Uncheck this option if you do not want to have icons on the +desktop. Without icons the desktop may be somewhat faster, but you +will no longer be able to drag files to the desktop.</para> +<para>This will not remove any files already stored on the desktop, +they will instead be hidden.</para> + +<para>If this is enabled, you may also enable the ability to <guilabel>Allow programs in desktop window</guilabel>.</para> + +<para>Enabling this option allows you to set a program as your desktop +background, for example <command>xearth</command>, or &kworldclock;</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show tooltips</guilabel></term> +<listitem> +<para>Check this option if you would like to see tooltips for icons on +the desktop as you hover the mouse over them. These tooltips display +information about the file represented by the icon. Depending on the +type of file, the information can range from simple file size and +creation dates for unfamiliar file types, to complete meta information +such as the content of tags for music files.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Menu Bar at Top of Screen:</guilabel></term> +<listitem> +<para>This option determines whether there is a menu across +the top of the &tde; Desktop similar to the style of &MacOS;.</para> + +<para>The default is <guilabel>None</guilabel>. If you select +<guilabel>Desktop menu bar</guilabel> one static menu is shown at the +top of the screen, displaying the desktop menu. Finally there is +<guilabel>Current application's menu bar (Mac OS-style)</guilabel>. +If this option is selected, applications won't have their menu bar +attached to their own window anymore. Instead, there is one menu bar +at the top of the screen which shows the menus of the currently active +application. You might recognize this behavior from &MacOS;. +</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mouse button actions:</guilabel></term> +<listitem> + +<para>The mouse button section allows you to determine what happens when +you click one of the three mouse buttons on the Desktop (where there is +no window).</para> + +<note><para>Not all mice have three buttons. Two button mice can +usually activate the <mousebutton>Middle</mousebutton> button by +pressing both the <mousebutton>Left</mousebutton> and +<mousebutton>Right</mousebutton> mouse buttons at the same +time.</para></note> + +<para>For each of the three mouse buttons, you can select:</para> + +<variablelist> +<varlistentry> +<term>No Action</term> +<listitem><para>When you use this mouse button, nothing +happens.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Window list menu</term> +<listitem><para>This brings up a submenu with all the virtual desktops. +Under each virtual desktop, you can select any window currently located +on that desktop. Once selected, &tde; will switch to that desktop, and +place the focus on that window.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Desktop Menu.</term> +<listitem><para>This brings up a submenu with commands specific to +&tde;. You can create icons, edit bookmarks, cut and paste, +run commands, configure &tde;, arrange icons, lock the session and log +out of &tde;. The exact content of the menu varies depending on the +current status of &tde;.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Application Menu</term> +<listitem><para>This brings up the <guimenu>Application</guimenu> Menus +(also know as the <guimenu>TDE</guimenu> Menus), so you can start a new +application.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Custom Menu 1</term> +<term>Custom Menu 2</term> +<listitem> +<para>You may also configure up to two custom menus. If you choose either of these, the <guibutton>Edit...</guibutton> becomes available, allowing you to edit the contents of the custom menus.</para> +<!-- FIXME: Need to find out what else can be added here (for instance, it lets me type 'emacsclient' which isn't available in the TDE menu) --> +</listitem> +</varlistentry> +</variablelist> + +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="desktop-behavior-file-icons"> +<title><guilabel>File Icons</guilabel></title> + +<para>First are two options regarding the placement of icons:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Automatically line up icons</guilabel></term> +<listitem><para>If this option is enabled, &tde; will align icons on a +grid on the desktop. If it is not enabled, you may drop icons +anywhere, and they will not be aligned for you.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Show hidden files</guilabel></term> +<listitem><para>If this option is enabled, then all hidden files will +appear on the desktop. Generally this only clutters your desktop area, +but if you are often working with hidden files or folders, this can +be useful.</para> +<warning><para>Be very careful when deleting or modifying hidden files. +Many of these files are configuration files and are essential for the +correct operation of your computer.</para></warning> +</listitem> +</varlistentry> +</variablelist> + +<para>The &tde; desktop has a preview feature for many file types, +including <acronym>HTML</acronym> files, images, &PostScript; and +<acronym>PDF</acronym>, sound, web archives (if you have the +appropriate &konqueror; plugin installed) and text files.</para> + +<para>if you enable previews for one of these, files of that particular +file type will not be represented by standard icons on the desktop, but +will instead be shown as miniature previews. On slow computers, the +previews can take some time to show up, so you might not want to enable +this feature.</para> + +</sect2> + +<sect2 id="desktop-behavior-device-icons"> +<title><guilabel>Device Icons</guilabel></title> + +<para>On some operating systems (&Linux; and FreeBSD, so far) &tde; can +dynamically display icons for each <firstterm>mountable</firstterm> +device you have available. This could be &CD-ROM; drives, floppy disk +drives, or network shares.</para> + +<para>If you enable this, you can choose what kind, if any, of these +devices you would like quick access icons to be displayed for.</para> + +</sect2> +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/devices/CMakeLists.txt b/doc/kcontrol/devices/CMakeLists.txt new file mode 100644 index 000000000..5a747385e --- /dev/null +++ b/doc/kcontrol/devices/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/devices ) diff --git a/doc/kcontrol/devices/Makefile.am b/doc/kcontrol/devices/Makefile.am new file mode 100644 index 000000000..f2449c0e0 --- /dev/null +++ b/doc/kcontrol/devices/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/devices diff --git a/doc/kcontrol/devices/index.docbook b/doc/kcontrol/devices/index.docbook new file mode 100644 index 000000000..43eac4de9 --- /dev/null +++ b/doc/kcontrol/devices/index.docbook @@ -0,0 +1,60 @@ +<?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>Device Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>device</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Device Information</title> + +<para> +This page displays information about the available devices, +</para> + +<note> +<para> +The exact information displayed is system-dependent. On some systems, +device information cannot be displayed yet. +</para> +</note> + +<para> +On &Linux;, this information is read from <filename +class="devicefile">/proc/devices</filename> and <filename +class="devicefile">/proc/misc</filename>, which are only available if +the <filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel. Devices are listed by group (Character, Block, +or Miscellaneous). The device major number is listed, followed by an +identifying label. +</para> + +<para> +The user cannot modify any settings on this page. +</para> + +</sect1> +</article> diff --git a/doc/kcontrol/display/CMakeLists.txt b/doc/kcontrol/display/CMakeLists.txt new file mode 100644 index 000000000..ee36f8c13 --- /dev/null +++ b/doc/kcontrol/display/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/display ) diff --git a/doc/kcontrol/display/Makefile.am b/doc/kcontrol/display/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/display/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/display/index.docbook b/doc/kcontrol/display/index.docbook new file mode 100644 index 000000000..6e5a49d03 --- /dev/null +++ b/doc/kcontrol/display/index.docbook @@ -0,0 +1,55 @@ +<?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"> +]> + +<article lang="&language;"> +<title>Display Settings</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes user-specific display settings. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/displayconfig/CMakeLists.txt b/doc/kcontrol/displayconfig/CMakeLists.txt new file mode 100644 index 000000000..d322b7fc8 --- /dev/null +++ b/doc/kcontrol/displayconfig/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/displayconfig ) diff --git a/doc/kcontrol/displayconfig/Makefile.am b/doc/kcontrol/displayconfig/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/displayconfig/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/displayconfig/index.docbook b/doc/kcontrol/displayconfig/index.docbook new file mode 100644 index 000000000..b2098576c --- /dev/null +++ b/doc/kcontrol/displayconfig/index.docbook @@ -0,0 +1,55 @@ +<?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"> +]> + +<article lang="&language;"> +<title>Monitor and Display Settings</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes system-wide monitor and display settings. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/dma/CMakeLists.txt b/doc/kcontrol/dma/CMakeLists.txt new file mode 100644 index 000000000..2c3752d1c --- /dev/null +++ b/doc/kcontrol/dma/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/dma ) diff --git a/doc/kcontrol/dma/Makefile.am b/doc/kcontrol/dma/Makefile.am new file mode 100644 index 000000000..f8fd8f8e9 --- /dev/null +++ b/doc/kcontrol/dma/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/dma diff --git a/doc/kcontrol/dma/index.docbook b/doc/kcontrol/dma/index.docbook new file mode 100644 index 000000000..415666095 --- /dev/null +++ b/doc/kcontrol/dma/index.docbook @@ -0,0 +1,64 @@ +<?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><acronym>DMA</acronym> Channel Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>DMA</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title><acronym>DMA</acronym> Channel Information</title> + +<para> This page displays information about the <acronym>DMA</acronym> +(Direct Memory Access) Channels. A <acronym>DMA</acronym> channel is a +direct connection that allows devices to transfer data to and from +memory without going through the processor. Typically, i386-architecture +systems (<acronym>PC</acronym>'s) have eight <acronym>DMA</acronym> +channels (0-7).</para> + +<note> <para> The exact information displayed is system-dependent. On +some systems, <acronym>DMA</acronym> Channel information cannot be +displayed yet.</para> </note> + +<para> On &Linux;, this information is read from <filename +class="devicefile">/proc/dma</filename>, which is only available if the +<filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel.</para> + +<para> A list of all currently-registered (<acronym>ISA</acronym> bus) +<acronym>DMA</acronym> channels that are in use is shown. The first +column shows the <acronym>DMA</acronym> channel, and the second column +shows the device which uses that channel.</para> + +<para> +Unused <acronym>DMA</acronym> channels are not listed. +</para> + +<para> +The user cannot modify any settings on this page. +</para> + +</sect1> +</article> diff --git a/doc/kcontrol/dnssd/CMakeLists.txt b/doc/kcontrol/dnssd/CMakeLists.txt new file mode 100644 index 000000000..8b04b8f65 --- /dev/null +++ b/doc/kcontrol/dnssd/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/dnssd ) diff --git a/doc/kcontrol/dnssd/Makefile.am b/doc/kcontrol/dnssd/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/dnssd/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/dnssd/index.docbook b/doc/kcontrol/dnssd/index.docbook new file mode 100644 index 000000000..eb1d4a45b --- /dev/null +++ b/doc/kcontrol/dnssd/index.docbook @@ -0,0 +1,58 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>Zeroconf Service Discovery</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the Zeroconf Service Discovery module. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>Zeroconf</keyword> +<keyword>dnssd</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +&documentation.index; +</article> diff --git a/doc/kcontrol/ebrowsing/CMakeLists.txt b/doc/kcontrol/ebrowsing/CMakeLists.txt new file mode 100644 index 000000000..e76bf184c --- /dev/null +++ b/doc/kcontrol/ebrowsing/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/ebrowsing ) diff --git a/doc/kcontrol/ebrowsing/Makefile.am b/doc/kcontrol/ebrowsing/Makefile.am new file mode 100644 index 000000000..4d7741915 --- /dev/null +++ b/doc/kcontrol/ebrowsing/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/ebrowsing diff --git a/doc/kcontrol/ebrowsing/index.docbook b/doc/kcontrol/ebrowsing/index.docbook new file mode 100644 index 000000000..87c19ae52 --- /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 &tde; 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 &tde;, 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 &tde; 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 &tde;.</para> + +</sect3> + +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/energy/CMakeLists.txt b/doc/kcontrol/energy/CMakeLists.txt new file mode 100644 index 000000000..75048ea4f --- /dev/null +++ b/doc/kcontrol/energy/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/energy ) diff --git a/doc/kcontrol/energy/Makefile.am b/doc/kcontrol/energy/Makefile.am new file mode 100644 index 000000000..b45cc2539 --- /dev/null +++ b/doc/kcontrol/energy/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/energy diff --git a/doc/kcontrol/energy/index.docbook b/doc/kcontrol/energy/index.docbook new file mode 100644 index 000000000..640108495 --- /dev/null +++ b/doc/kcontrol/energy/index.docbook @@ -0,0 +1,110 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>energy</keyword> +</keywordset> +</articleinfo> + +<sect1 id="energy"> +<title>Energy</title> + +<sect2 id="energy-intro"> +<title>Introduction</title> + +<para>This module is useful for any computer having a monitor labeled +Energy Star Compliant. (Energy Star Compliant equipment is equipment +that can be configured to automatically enter a power saving mode when +appropriate, without human intervention.)</para> + +<tip><para>Energy Star Compliance can be applied to nearly any +electrical device. This module, however, does not spin down hard +drives, does not shutdown printers, &etc; These settings only affect +the behavior of your monitor.</para> + +<para>For information on shutting down components on a laptop, do not +use this module. Instead, install tdeutils, and refer to the module +entitled <ulink url="help://kcontrol/powerctrl/index.html">Laptop +Power Control Center</ulink>, for details.</para></tip> + +<para>In the case of computer monitors, the computer can control the +monitor, switching it between four states: On, Standby, Suspend, and +Off.</para> + +<note><para>The following list of states is a generalization, and you +may find that your monitor will differ from the descriptions +below.</para></note> + +<para><quote>ON</quote> is the normal operation of your monitor while you are using +it.</para> + +<para><quote>STANDBY</quote> is usually a minor power saving level. +This setting usually involves blanking the screen, and not firing the +electron gun, but keeping the electron gun <quote>energized</quote> +and ready to go. When you need to use the monitor again, the monitor +will come back on very quickly.</para> + +<para><quote>SUSPEND</quote> is a very low power mode alternative. +With most monitors the screen is blanked, the electron +gun is shut down and the magnets that control the electron gun are +powered down. While the power saving is substantial, to reactivate +the monitor may take up to 10-15 seconds. The computer should always +be able to return the monitor to On or Standby while in suspend +mode.</para> + +<para><quote>OFF</quote>, usually means just that. The computer +monitor is turned off. This usually means that the computer will not +be able to turn the monitor back on by itself. Obviously, this keeps +power consumption to a bare minimum (zero).</para> + +</sect2> +<sect2 id="energy-use"> +<title>Use</title> + +<para>Using this module is very simple:</para> + +<para>If your monitor is Energy Star Compliant, then you should put a +mark in the check box labeled <guilabel>Enable Display Energy +Saving</guilabel>. This will activate the energy saving +commands.</para> + +<para>The next three slider bars, tell the computer how many minutes of +inactivity before automatically switching to a new state. These numbers +can be adjusted with either the sliders, or the spin boxes.</para> + +<note><para>These times are not additive, but all start counting at +zero.</para> + +<para>As an example:</para> + +<para>If you set the Standby Mode to 10 minutes, the Suspend mode to 20 +minutes, and the Power off at 30 minutes, and you stop using your +computer at 9:00, then the monitor will:</para> <para>Enter Standby mode +at 9:10, enter Suspend mode at 9:20, and shut the power off at +9:30.</para></note> + +<para>When you are happy with the settings, click +<guibutton>OK</guibutton>.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/filemanager/CMakeLists.txt b/doc/kcontrol/filemanager/CMakeLists.txt new file mode 100644 index 000000000..52d3f3646 --- /dev/null +++ b/doc/kcontrol/filemanager/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/filemanager ) diff --git a/doc/kcontrol/filemanager/Makefile.am b/doc/kcontrol/filemanager/Makefile.am new file mode 100644 index 000000000..8e045365e --- /dev/null +++ b/doc/kcontrol/filemanager/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/filemanager diff --git a/doc/kcontrol/filemanager/index.docbook b/doc/kcontrol/filemanager/index.docbook new file mode 100644 index 000000000..110f3177f --- /dev/null +++ b/doc/kcontrol/filemanager/index.docbook @@ -0,0 +1,297 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>file manager</keyword> +</keywordset> +</articleinfo> +<sect1 id="file-manager"> +<title>File Manager</title> + +<para>In this module, you can configure various aspects of +&konqueror;'s file manager functionality.</para> + +<note><para>&konqueror;'s web browser functionality has its <ulink +url="help:/kcontrol/tdehtml/index.html">own configuration +modules</ulink>.</para></note> + +<sect2 id="fileman-use"> +<title>Use</title> + +<para> The configuration options for the file manager are +organized under tabs as follows:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Appearance</guilabel></term> +<listitem><para>This tab contains options for customizing the appearance of +&konqueror; windows, such as the default font +text color.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Behavior</guilabel></term> +<listitem><para>This tab contains a couple of &konqueror; +global options.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Previews</guilabel></term> +<listitem> +<para>On this tab, you can customize when &konqueror; should show +previews.</para> +</listitem> +</varlistentry> +</variablelist> + +<sect3 id="fileman-appearance"> +<title>Appearance</title> + +<para>The following settings determine how text and colors are displayed in +&konqueror; File Manager mode windows.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Standard font:</guilabel></term> +<listitem> +<para>This is the font used to display text such as file names in +&konqueror; windows.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Font size:</guilabel></term> +<listitem> + +<para>Lets you control the size of text, while the <guilabel>Standard +Font</guilabel> setting determines the font face used.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Normal text color:</guilabel></term> +<listitem> +<para>Determines the standard text color.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Height for icon text:</guilabel></term> +<listitem> +<para>The maximum number of lines that can be used to draw icon text. Long lines are truncated at the end of the last line.</para> +<tip> <para>You can still see word-wrapped filenames by pausing the mouse pointer over the icon.</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Width for icon text:</guilabel></term> +<listitem> +<para>The maximum width for the icon text when &konqueror; is in multi-column view mode.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Underline filenames:</guilabel></term> +<listitem> +<para>When <guilabel>Underline filenames</guilabel> is checked, + filenames will be underlined so that they look like links on a web + page.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Display file sizes in bytes:</guilabel></term> +<listitem> +<para>The final check box on this page determines how &konqueror; +displays file sizes, when you are in one of the file manager modes +that normally shows this information. If you check the +<guilabel>Display file sizes in bytes</guilabel> box then file sizes +are always shown in bytes. If you leave it unchecked then file sizes +are shown in bytes, kilobytes or megabytes, depending on their +size.</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3 id="fileman-behav"> +<title>Behavior</title> + +<variablelist> +<title><guilabel>Misc Options</guilabel></title> +<varlistentry> +<term>Open folders in separate windows</term> +<listitem> <para>If this option is checked, a new +&konqueror; window will be created when you open a +folder, rather than simply showing that folder's contents in the + current +window.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Show network operations in a single window</term> +<listitem> +<para>If unchecked, and you download a +file, a dialog box will appear that shows the status of the +download.</para> + +<screenshot> + <screeninfo>Download Dialog Box</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="tdefileman2.png" + format="PNG"/></imageobject> + <textobject> <phrase>Download Dialog Box</phrase> </textobject> + <caption> + <para>Individual Download Dialog Box</para> + </caption> + </mediaobject> +</screenshot> + +<para>If you start a new transfer, another dialog box will +appear. (&Netscape; users will be familiar with +this behavior) </para> + +<para>If checked, all transfer status windows will be grouped +together under a single dialog box.</para> +<screenshot> + <screeninfo>Download Dialog Box</screeninfo> + <mediaobject> + <imageobject><imagedata fileref="tdefileman1.png" + format="PNG"/></imageobject> + <textobject><phrase>Download Dialog Box</phrase></textobject> + <caption> + <para>Collected Download Dialog Box</para> + </caption> + </mediaobject> +</screenshot> + +<para>If you choose to use the Collected download dialog box, you can +delete transfers by clicking once on the transfer you want to cancel, +then clicking the <guibutton>Delete</guibutton> Button on the +left.</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show file tips</guilabel></term> +<listitem> +<para> Here you can control if, when moving the mouse over a file, you +want to see a small popup window with additional information about +that file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show previews in file tips</guilabel></term> +<listitem> +<para>Here you can control if the file tip should show a +thumbnail preview of the file. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Home URL</guilabel></term> +<listitem><para>This is the &URL; (⪚ a +folder or a web page) where &konqueror; will jump to +when the <guibutton>Home</guibutton> button is pressed.</para><para>The +default is the users home folder, indicated with a +<literal>~</literal>.</para></listitem> +</varlistentry> +</variablelist> + +<para>You can set a path that is your <guilabel>Home URL</guilabel> by +typing into the text field, or using the <guiicon>browse</guiicon> +icon. The default is <literal>~</literal> which is a standard +shortcut for your $<envar>HOME</envar> folder. When you choose the +<guiicon>home</guiicon> icon on your panel, in a file open or save +dialog, or from within &konqueror; in file manager mode, this is the +folder you will be shown.</para> + +<para>The <guilabel>Ask confirmation for</guilabel> setting tells +&konqueror; what to do when you choose to <quote>Delete</quote>, +<quote>Trash</quote>, or <quote>Shred</quote> a file in a &konqueror; +window. If any box is checked, &konqueror; asks for confirmation before +performing the corresponding action.</para> + +</sect3> + +<sect3> +<title>Previews</title> + +<para>&konqueror; has a +preview feature for many file types, including <acronym>HTML</acronym> +files, images, &PostScript; and <acronym>PDF</acronym>, sound, web +archives (if you have the appropriate &konqueror; plugin installed) +and text files.</para> + +<para>If you enable previews for one of these, files of that particular +file type will not be represented by standard icons in the filemanager, but +will instead be shown as miniature previews. On slow computers, the +previews can take some time to show up, so you might not want to enable +this feature.</para> + +<para>In this module you can specify which <quote>protocols</quote> +you wish the previews to be available for. Creating the previews +requires that &konqueror; download at least part of the file, in order +to create the preview. &konqueror;, like the rest of &tde; is +entirely network transparent, and will treat a remote &FTP; folder +just as if it was on your local hard drive. This can result in a +delay, especially if you are viewing, for example, a folder full of +images over a slow network connection.</para> + +<para>For each protocol, you can independently enable or disable +previews. For example, you might enable previews for +<acronym>NFS</acronym> mounted drives if you have a fast network, but +disable them for &FTP; because your Internet connection is via a +modem.</para> + +<para>You can further refine the maximum size file that &konqueror; +will attempt to show a preview for. The default is 1 MB. In other +words, by default, if a file is 900 kB in size, and the protocol you +are viewing the folder with is enabled, then &konqueror; will +create a preview icon for it. If the file is 1.1 MB in size, +&konqueror; will not make a preview, even if the protocol is +enabled.</para> + +<para>You can turn on and off previews <quote>on the fly</quote> from +within &konqueror;, using the <guimenu>View</guimenu> menu. For +example, if you normally want to see image previews on every protocol, +but find a particular server is very slow to send you the data, you +might turn it off for the present, and turn it on again later.</para> + +<para>You may also like to enable the checkbox <guilabel>Increase size +of previews relative to icons</guilabel>, in order to see more +information in the thumbnails.</para> + +<para>Many image files already contain a thumbnail. You can enable +the <guilabel>Use thumbnails embedded in files</guilabel> to make use +of these. This will save time waiting for thumbnails to be created +when viewing a folder full of images you have not previously seen in +&konqueror;.</para> + +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/filemanager/tdefileman1.png b/doc/kcontrol/filemanager/tdefileman1.png Binary files differnew file mode 100644 index 000000000..0505d604d --- /dev/null +++ b/doc/kcontrol/filemanager/tdefileman1.png diff --git a/doc/kcontrol/filemanager/tdefileman2.png b/doc/kcontrol/filemanager/tdefileman2.png Binary files differnew file mode 100644 index 000000000..6c8d17d75 --- /dev/null +++ b/doc/kcontrol/filemanager/tdefileman2.png diff --git a/doc/kcontrol/filetypes/CMakeLists.txt b/doc/kcontrol/filetypes/CMakeLists.txt new file mode 100644 index 000000000..d66290d23 --- /dev/null +++ b/doc/kcontrol/filetypes/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/filetypes ) diff --git a/doc/kcontrol/filetypes/Makefile.am b/doc/kcontrol/filetypes/Makefile.am new file mode 100644 index 000000000..ae43c3018 --- /dev/null +++ b/doc/kcontrol/filetypes/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/filetypes diff --git a/doc/kcontrol/filetypes/index.docbook b/doc/kcontrol/filetypes/index.docbook new file mode 100644 index 000000000..6d8d2355a --- /dev/null +++ b/doc/kcontrol/filetypes/index.docbook @@ -0,0 +1,338 @@ +<?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> + +<title>File Associations</title> +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-13</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>files association</keyword> +<keyword>association</keyword> +</keywordset> +</articleinfo> +<sect1 id="file-assoc"> +<title>File Associations</title> + +<sect2 id="file-assoc-intro"> +<title>Introduction</title> + +<para>One of the most convenient aspects of &tde;, is its ability to +automatically match a data file, with its application. As an example, +when you click on your favorite &kword; document in &konqueror;, &tde; +automatically starts &kword;, and automatically loads that file into +&kword; so you can begin working on it.</para> + +<para>In the example above, the &kword; Data file is +<emphasis>associated</emphasis> with &kword; (the application). These +file associations are crucial to the functioning of &tde;.</para> + +<para>When &tde; is installed, it automatically creates hundreds of file +associations to many of the most common data types. These initial +associations are based on the most commonly included software, and the +most common user preferences.</para> + +<para>Unfortunately, &tde; can not:</para> + +<itemizedlist> +<listitem><para>predict every possible combination of software and data files</para></listitem> +<listitem><para>prepare for file formats not yet invented</para></listitem> +<listitem><para>or predict everyone's favorite application for certain file formats</para></listitem> +</itemizedlist> + +<para>You can change your current file associations or add new file +associations using this module.</para> + +<para>Each file association is recorded as a mime type. +&MIME; stands for <quote>Multipurpose Internet Mail +Extensions</quote>. It allows a computer to determine the type of file, +without opening and analyzing the format of each and every file.</para> + +</sect2> + +<sect2 id="file-assoc-use"> +<title>How to use this module</title> + +<para>The file associations are organized into several categories, and +at a minimum you will have:</para> + +<orderedlist> +<listitem><para>Application</para></listitem> +<listitem><para>Audio</para></listitem> +<listitem><para>Image</para></listitem> +<listitem><para>Inode</para></listitem> +<listitem><para>Message</para></listitem> +<listitem><para>Multipart</para></listitem> +<listitem><para>Print</para></listitem> +<listitem><para>Text</para></listitem> +<listitem><para>Video</para></listitem> +</orderedlist> + +<para>All of the file associations are sorted into one of these +categories.</para> + +<para>There is also an overview category <quote>All</quote>, which +displays all the file types in one list, without categorizing +them.</para> + +<note><para>There is no functional difference between any of the +categories. These categories are designed to help organize your file +associations, but they do not alter the associations in any way. +</para></note> + +<para>The categories are listed in the box labeled <guilabel>Known +Types</guilabel>.</para> + +<para>You can explore each of these categories, and see the file +associations contained within each one, by simply double-clicking on the +category name. You will be presented with a list of the associated +mime-types under that category.</para> + +<tip><para>You can also search for a particular &MIME; type by using the +search box. The search box is labeled <guilabel>Find filename +pattern</guilabel> and is located above the category list.</para> + +<para>Simply type the first letter of the &MIME; type you are interested +in. The categories are automatically expanded, and only the mime-types +that include that letter are displayed.</para> + +<para>You can then enter a second character and the mime-types will be +further limited to mime types containing those two +characters.</para></tip> + +<sect3 id="file-assoc-use-add"> +<title>Adding a new mime type</title> + +<para>If you want to add a new &MIME; type to your file associations, +you can click on the <guibutton>Add...</guibutton> button. A small +dialog box will appear. You select the category from the drop down +box, and type the &MIME; name in the blank labeled <guilabel>Type +name</guilabel>. Click <guibutton>OK</guibutton> to add the new mime +type, or click <guibutton>Cancel</guibutton> to not add any new +mime-types.</para> + +</sect3> + +<sect3 id="file-assoc-use-del"> +<title>Removing a mime type</title> + +<para>If you want to remove a &MIME; type, simply select the &MIME; +type you want to delete by clicking once with the mouse on the &MIME; +type name. Then click the button labeled +<guibutton>Remove</guibutton>. The &MIME; type will be deleted +immediately.</para> + +</sect3> + +<sect3 id="file-assoc-use-edit"> +<title>Editing a mime types properties</title> + +<para>Before you can edit a &MIME; types property, you must first +specify which &MIME; type. Simply browse through the categories until +you find the &MIME; type you want to edit, then click once on it with +the mouse.</para> + +<para>As soon as you have selected the &MIME; type, the current values of +the &MIME; type will appear in the module window.</para> + +<para>You will notice the current values are split into two tabs: +<guilabel>General</guilabel> and <guilabel>Embedding</guilabel></para> + +<variablelist> +<varlistentry> +<term><guilabel>General</guilabel></term> +<listitem> +<para>There are 4 properties for each &MIME; type in this tab:</para> + +<orderedlist> +<listitem><para><guilabel>Mime Type Icon</guilabel> is the icon that +will be visible when using &konqueror; as a file +manager.</para></listitem> +<listitem><para><guilabel>Filename Patterns</guilabel> is a search +pattern which &tde; will use to determine the &MIME; type.</para></listitem> +<listitem><para><guilabel>Description</guilabel> is a short description +of the file type. This is for your benefit only.</para></listitem> +<listitem><para><guilabel>Application Preference Order</guilabel> +determines which applications will be associated with the specified +&MIME; type.</para></listitem> +</orderedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Embedding Tab</guilabel></term> +<listitem> +<para>The Embedding tab allows you to determine if an file will be +viewed within a &konqueror; window, or by starting the +application.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="file-assoc-use-icon"> +<title>Changing the Icon</title> + +<para>To change the icon, simply click on the Icon button. A dialog box +will appear, which will show you all available icons. Simply click once +with the mouse on the icon of your choice, and click +<guibutton>OK</guibutton>.</para> + +</sect3> + +<sect3 id="file-assoc-use-pattern"> +<title>Editing the mime-type patterns</title> + +<para>The box labeled <guilabel>Filename Patterns</guilabel>, determines +what files will be included within this mime-type.</para> + +<para>Usually, files are selected based on their suffix. (Examples: +Files that end with <literal role="extension">.wav</literal> are sound +files, using the WAV format and files that end in <literal +role="extension">.c</literal> are program files written in C).</para> + +<para>You should enter your filename mask in this combo box.</para> + +<para>The asterisk (<literal>*</literal>) is a wildcard character that +will be used with nearly every mime type mask. A complete discussion +of wildcards is beyond the scope of this manual, but it is important +to understand that the asterisk (in this context), +<quote>matches</quote> any number of characters. As an example: +<userinput>*.pdf</userinput> will match +<filename>Datafile.pdf</filename>, <filename>Graphics.pdf</filename> +and <filename>User.pdf</filename>, but not <filename>PDF</filename>, +<filename>Datafile.PDF</filename>, or +<filename>.pdf</filename>.</para> + +<tip><para>It is very beneficial to have multiple masks. One for lower +case, one for upper case, &etc; This will help ensure that &tde; can +determine the file type more accurately.</para></tip> + +</sect3> + +<sect3 id="file-assoc-use-desc"> +<title>Editing a mime types description.</title> + +<para>You can type a short description of the &MIME; type in the text +box labeled <guilabel>Description</guilabel>. This label is to help +you, it does not affect the function of the &MIME; type.</para> + +</sect3> + +<sect3 id="file-assoc-use-app"> +<title>Editing the application associations</title> + +<para>There are four buttons (<guibutton>Move Up</guibutton>, +<guibutton>Move Down</guibutton>, <guibutton>Add</guibutton> and +<guibutton>Remove</guibutton>) and a combo box (which lists the +applications) which are used to configure the applications.</para> + +<para>The combo box lists all of the applications associated with a +specific &MIME; type. The list is in a specific order. The top +application is the first application tried. The next application down +the list is the second, etc.</para> + +<note><para>What do you mean there is more than one application per +&MIME; type? Why is this necessary?</para> + +<para>We started out by saying that &tde; comes preconfigured with +hundreds of file associations. The reality is, each system that &tde; +is installed on has a different selection of applications. By +allowing multiple associations per &MIME; type, &tde; can continue to +operate when a certain application is not installed on the +system.</para> + +<para>As an example:</para> +<para>For the &MIME; type <literal>pdf</literal>, there are two +applications associated with this file type. The first program is +called <application>PS Viewer</application>. If your system does not +have <application>PS Viewer</application> installed, then &tde; +automatically starts the second application <application>Adobe Acrobat +Reader</application>. As you can see, this will help keep &tde; running +strong as you add and subtract applications.</para></note> + +<para>We have established that the order is important. You can change +the order of the applications by clicking once with the mouse on the +application you want to move, and then clicking either <guibutton>Move +Up</guibutton> or <guibutton>Move Down</guibutton>. This will shift +the currently selected application up or down the list of +applications.</para> + +<para>You can add new applications to the list by clicking the button +labeled <guibutton>Add</guibutton>. A dialog box will appear. Using the +dialog box, you can select the application you want to use for this mime +type. Click <guibutton>OK</guibutton> when you are done, and the +application will be added to the current list.</para> + +<para>You can remove an application (thereby ensuring that the +application will never run with this &MIME; type by clicking once on the +name of the application, and clicking the <guibutton>Remove</guibutton> +button.</para> + +<tip><para>It is a good idea to use the <guibutton>Move Up</guibutton> +and <guibutton>Move Down</guibutton> buttons to adjust the unwanted +application to a lower position in the list, rather than deleting the +application from the list entirely. Once you have deleted an +application, if your preferred application should become compromised, +there will not be an application to view the data document.</para></tip> + +</sect3> + +<sect3 id="file-assoc-embedding"> +<title>Embedding</title> +<para>By clicking on the <guilabel>Embedding</guilabel> tab, you are +presented with three radio buttons in the <guilabel>Left click +action</guilabel> group. These determine how &konqueror; views the selected +&MIME; type:</para> + +<variablelist> +<varlistentry><term>Show file in embedded viewer</term> +<listitem><para>If this is selected, the file will be shown <emphasis>within</emphasis> the &konqueror; window.</para></listitem></varlistentry> +<varlistentry><term>Show file in separate viewer</term> +<listitem><para>This will cause a separate window to be created when showing this mime-type.</para></listitem></varlistentry> +<varlistentry><term>Use group settings.</term> +<listitem><para>This will cause the mime-type to use the settings for the mime-type group. +(if you are editing an audio mime type, then the settings for the audio group are used).</para></listitem></varlistentry> +</variablelist> + +<para>Below this is a listbox labeled <guilabel>Services Preference +Order</guilabel>.</para> + +<para>When you are in &konqueror;, you can +<mousebutton>right</mousebutton> mouse click, and a menu will with an +entry labeled <guimenu>Preview with...</guimenu> will appear. This box +lists the applications that will appear, in the order they will +appear, under this menu.</para> + +<para>You can use the <guibutton>Move Up</guibutton> and +<guibutton>Move Down</guibutton> buttons to change the order.</para> + +</sect3> + +<sect3 id="file-assoc-use-done"> +<title>Making changes permanent</title> + +<para>When you are done making any changes to mime types, you can click +<guibutton>Apply</guibutton> to make your changes permanent, but keep +you in this module.</para> + +</sect3> +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/fonts/CMakeLists.txt b/doc/kcontrol/fonts/CMakeLists.txt new file mode 100644 index 000000000..0a011fbad --- /dev/null +++ b/doc/kcontrol/fonts/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/fonts ) diff --git a/doc/kcontrol/fonts/Makefile.am b/doc/kcontrol/fonts/Makefile.am new file mode 100644 index 000000000..b79d06618 --- /dev/null +++ b/doc/kcontrol/fonts/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/fonts diff --git a/doc/kcontrol/fonts/index.docbook b/doc/kcontrol/fonts/index.docbook new file mode 100644 index 000000000..bb55f20f2 --- /dev/null +++ b/doc/kcontrol/fonts/index.docbook @@ -0,0 +1,121 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-09-22</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>fonts</keyword> +</keywordset> +</articleinfo> + +<sect1 id="fonts"> + +<title>Fonts</title> + +<para>This module is designed to allow you to easily select different +fonts for different parts of the &tde; Desktop.</para> + +<para>The panel consists of different font groups to give you a lot of +flexibility in configuring your fonts: </para> + +<itemizedlist> +<listitem><para><guilabel>General:</guilabel> Used everywhere the other font +groups don't apply</para></listitem> + +<listitem><para><guilabel>Fixed width:</guilabel> Anywhere a +non-proportional font is specified</para></listitem> + +<!-- <listitem><para><guilabel>File Manager</guilabel> (Font to use in the +&tde; file manager)</para></listitem> --> + +<listitem><para><guilabel>Toolbar:</guilabel> Font used in &tde; application +toolbars</para></listitem> + +<listitem><para><guilabel>Menu:</guilabel> Font used in &tde; application +menus</para></listitem> + +<listitem><para><guilabel>Window title:</guilabel> Font used in the window +title</para></listitem> + +<listitem><para><guilabel>Taskbar:</guilabel> Font used in the taskbar +panel applet</para></listitem> + +<listitem><para><guilabel>Desktop:</guilabel> Font used on the desktop +to label icons</para></listitem> + +</itemizedlist> + +<para>Each font has a corresponding <guibutton>Choose...</guibutton> +button. By clicking on this button, a dialog box appears. You can +use this dialog box to choose a new font, font style, size and +character set. Then press <guibutton>OK</guibutton>.</para> + +<para>An example of the font you have chosen will be displayed in the space +between the font group name and the <guibutton>Choose...</guibutton> +button.</para> + +<para>When you are done, simply click <guibutton>OK</guibutton>, and +all necessary components of &tde; will be restarted so your changes +can take affect immediately.</para> + +<para>The <guibutton>Adjust All Fonts...</guibutton> button allows you to +quickly set properties for all the fonts selected +above. A font selection dialog similar to the standard one will +appear, but you will notice checkboxes that allow you to change the +<guilabel>Font</guilabel>, <guilabel>Font style</guilabel> or +<guilabel>Size</guilabel> independently of each other. You can +choose any one, two, or three of these options, and they will be +applied to all the font groups.</para> + +<para>For example, if you have selected several different font faces +above, and realize they are all a size too big (this often happens +when you change screen resolution, for instance), you can apply a new +font size to all the fonts, without affecting your customized font +faces and styles.</para> + +<sect2 id="fonts-aa"> +<title>Anti-alias text</title> + +<para>To use anti-aliasing, simply place a mark in the checkbox labeled +<guilabel>Use anti-aliasing for fonts</guilabel>.</para> + +<para>Placing a mark in the checkbox will allow you to specify which range of +fonts will <emphasis>not</emphasis> be anti-aliased. This range is specified +with the two combo boxes on the same line.</para> + +<para>You can also choose the method that &tde; uses to create an anti-alias +look to your fonts, and how strongly it should be applied. If you are not +familiar with the individual methods, you should leave this option +alone.</para> + +<!-- FIXME: Cop-out, I need to write a 'hinting and AA for beginners' +paragraph in here --> + +<note><para> +The ability to use anti-aliased fonts and icons requires that you have +support in both X and the &Qt; toolkit, that you have suitable fonts +installed, and that you are using the built-in font serving capabilities +of the X server. If you still are having problems, please contact the +appropriate &tde; mailing list, or check the +<acronym>FAQ</acronym>.</para></note> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/helpindex/CMakeLists.txt b/doc/kcontrol/helpindex/CMakeLists.txt new file mode 100644 index 000000000..f2c0c72b3 --- /dev/null +++ b/doc/kcontrol/helpindex/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +# tde_create_handbook( DESTINATION kcontrol/helpindex ) diff --git a/doc/kcontrol/helpindex/Makefile.am b/doc/kcontrol/helpindex/Makefile.am new file mode 100644 index 000000000..130eaca75 --- /dev/null +++ b/doc/kcontrol/helpindex/Makefile.am @@ -0,0 +1,2 @@ +# KDE_LANG = en +# KDE_DOCS = kcontrol/helpindex.html diff --git a/doc/kcontrol/helpindex/index.docbook b/doc/kcontrol/helpindex/index.docbook new file mode 100644 index 000000000..54457f205 --- /dev/null +++ b/doc/kcontrol/helpindex/index.docbook @@ -0,0 +1,144 @@ +<?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-10-17</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Help Index</keyword> +<keyword>Index</keyword> +</keywordset> +</articleinfo> + +<sect1 id="help-index"> + +<title>Help Index</title> + +<note><para>At the time of writing, for most installations of &tde; the entire search engine function in &khelpcenter; is disabled, and settings made in this &kcontrol; module will have no effect. We hope to have it back in a future release.</para></note> + +<para>&tde; comes with a lot of documentation for applications and +components. While it is possible to just browse the manuals until you +find that piece of information you're looking for, this may be a very +time-consuming task. To make this easier for you, &tde; offers +fulltext search using a program called +<application>ht://dig</application>. It works quite similar to search +engines on the web, in fact some search engines you know might even use +it. Just click on the <guilabel>Search</guilabel> tab in the +&khelpcenter;, enter the word you are looking for, click +<guibutton>Search</guibutton> and enjoy!</para> + +<para>However, to make use of this feature, +<application>ht://dig</application> has to be installed on your system +and &tde; has to be configured to make use of it. This control module +tries to help you doing the latter. If you haven't installed +<application>ht://dig</application> and it wasn't shipped with your +operating system you have to get ht://dig yourself. Have a look at +<ulink url="http://www.htdig.org">the ht://dig homepage</ulink> on how +to download and install it.</para> + +<para>When you first start, you are in display mode only. To modify +your settings, click on <guibutton>Administrator Mode</guibutton>. If +you are logged in as <systemitem class="username">root</systemitem>, +you will go straight to the change dialog. If not, &tde; will ask for +a superuser password.</para> +<sect2 id="help-index-use"> + +<title>Use</title> + +<para>There are two important things to tell &tde; so it can make use of the +fulltext search engine:</para> + +<itemizedlist> +<listitem><para>where to find the <application>ht://dig</application> programs +KDE uses for fulltext search</para></listitem> +<listitem><para>where to search</para></listitem> +</itemizedlist> + +<sect3 id="help-index-use-progs"> + +<title>The <application>ht://dig</application> Programs</title> + +<para> There are three programs &tde; needs that come with +<application>ht://dig</application>: <command>htdig</command>, +<command>htsearch</command> and <command>htmerge</command>. For each program you +have to provide the full path including the program name, for example: <filename +class="directory">/usr/bin/htdig</filename>.</para> + +<para>Where exactly these programs are installed depends on your operating +system or your distribution. However, there are some good guesses you might want +to try:</para> + +<itemizedlist> + +<listitem><para><command>htdig</command> and <command>htmerge</command> are +often found in <filename class="directory">/usr/bin/</filename> or in something +like <filename +class="directory">/usr/local/www/htdig/bin/</filename>.</para></listitem> + +<listitem><para>the <command>htsearch</command> command is often found in a sub +folder called <filename class="directory">cgi-bin</filename>, for example +<filename class="directory">/usr/local/httpd/cgi-bin/</filename>.</para> + +</listitem> +</itemizedlist> + +<tip><para>To find out where for example <command>htdig</command> is installed +you can always type <command>whereis htdig</command> on the +console. <command>whereis</command> will look for the specified command in the +standard execution path folders. However, folders like <filename +class="directory">cgi-bin</filename> are often not in the standard execution +path.</para></tip> + +</sect3> + +<sect3 id="help-index-use-scope"> +<title>Scope and Search Paths</title> + +<para>In this section you can choose which help resources should be indexed, +&ie; made available to the search engine.</para> + +<para>In the <guilabel>Scope</guilabel> frame you can select some +typical resources you want to be indexed, &ie; the &tde; help files, +and the information offered by the <command>man</command> and +<command>info</command> commands. Note that some of those may still be +disabled, which means that support for them has not been added +yet.</para> + +<para>Maybe you have additional files you want to access using the +&khelpcenter; fulltext search feature. For example, you might have an +<acronym>HTML</acronym> reference installed in +<filename>/home/jdoe/docs/selfhtml</filename>. By adding this path to +the list of additional search paths you make this documentation +available to &khelpcenter;'s fulltext search, too. Just click on the +<guibutton>Add</guibutton> button and a file dialog will ask you for +an additional search folder. Select +<filename class="directory">/home/jdoe/docs/selfhtml</filename> and click +<guibutton>OK</guibutton>. To remove an additional search path, just +select it and click <guibutton>Delete</guibutton>.</para> + +<important><para>Your changes to the scope and additional search paths +will not take effect if you don't click on the <guibutton>Generate +index</guibutton> button.</para></important> +</sect3> + +</sect2> + +</sect1> +</article> + diff --git a/doc/kcontrol/hwmanager/CMakeLists.txt b/doc/kcontrol/hwmanager/CMakeLists.txt new file mode 100644 index 000000000..ee5223f34 --- /dev/null +++ b/doc/kcontrol/hwmanager/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/hwmanager ) diff --git a/doc/kcontrol/hwmanager/Makefile.am b/doc/kcontrol/hwmanager/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/hwmanager/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/hwmanager/index.docbook b/doc/kcontrol/hwmanager/index.docbook new file mode 100644 index 000000000..368dec032 --- /dev/null +++ b/doc/kcontrol/hwmanager/index.docbook @@ -0,0 +1,56 @@ +<?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"> +]> + +<article lang="&language;"> +<title>Hardware Device Manager</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the hardware device manager. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +&documentation.index; +</article> diff --git a/doc/kcontrol/iccconfig/CMakeLists.txt b/doc/kcontrol/iccconfig/CMakeLists.txt new file mode 100644 index 000000000..afe85c79b --- /dev/null +++ b/doc/kcontrol/iccconfig/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/iccconfig ) diff --git a/doc/kcontrol/iccconfig/Makefile.am b/doc/kcontrol/iccconfig/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/iccconfig/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/iccconfig/index.docbook b/doc/kcontrol/iccconfig/index.docbook new file mode 100644 index 000000000..501826ca4 --- /dev/null +++ b/doc/kcontrol/iccconfig/index.docbook @@ -0,0 +1,55 @@ +<?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"> +]> + +<article lang="&language;"> +<title>ICC Color Profile</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the International Color Consortium (ICC) color profile configuration. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/icons/CMakeLists.txt b/doc/kcontrol/icons/CMakeLists.txt new file mode 100644 index 000000000..082c12246 --- /dev/null +++ b/doc/kcontrol/icons/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/icons ) diff --git a/doc/kcontrol/icons/Makefile.am b/doc/kcontrol/icons/Makefile.am new file mode 100644 index 000000000..9de711f69 --- /dev/null +++ b/doc/kcontrol/icons/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/icons diff --git a/doc/kcontrol/icons/index.docbook b/doc/kcontrol/icons/index.docbook new file mode 100644 index 000000000..beeab0c8d --- /dev/null +++ b/doc/kcontrol/icons/index.docbook @@ -0,0 +1,233 @@ +<?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>2003-09-22</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>icon</keyword> +</keywordset> +</articleinfo> +<sect1 id="icons"> +<title>Icons</title> + +<sect2 id="icons-intro"> +<title>Introduction</title> + +<para>&tde; comes with a full set of icons in several sizes. These icons +are being used all over &tde;: the desktop, the panel, the &konqueror; file +manager, in every toolbar of every &tde; application, etc. The icons +control module offers you very flexible ways of customizing the way &tde; +handles icons. You can:</para> + +<itemizedlist> +<listitem><para>install and choose icon themes</para></listitem> +<listitem><para>choose different icon sizes</para></listitem> +<listitem><para>assign effects to icons (for example make them +semi-transparent or colorize them) </para></listitem> +<listitem><para>configure these settings for each of the different places +icons will be used in: for example the desktop, toolbars &etc; +</para></listitem> +</itemizedlist> + +<important><para>Please note that some of these settings may depend on +your selected icon theme. &tde; comes with two icon themes by default, +&tde;-Classic (HiColor) and Crystal SVG. There is also a low color theme +in the tdeartwork package, along with others.</para></important> + +</sect2> + +<sect2 id="icon-theme"> +<title><guilabel>Theme</guilabel></title> + +<para>Starting at the top, you can see some example icons. These change +in appearance depending on the icon theme you select. Most default +installations will have only one icon theme available, the &tde; default +Crystal SVG theme. There are others contained separately in the +tdeartwork package, and you can download more from the Internet.</para> + +<para>Use the <guibutton>Install New Theme...</guibutton> to browse to the +location of newly downloaded themes, and they will then become available +to select from above.</para> + +</sect2> + +<sect2 id="icons-use"> +<title>Advanced</title> + +<para>Looking at this second page of the icons control module, you +will see two areas:</para> + +<itemizedlist> +<listitem> +<para>An area labelled <guilabel>Use of Icon</guilabel>. Here you can +choose which particular usage of icons you want to configure, for +example <guilabel>Toolbar</guilabel> or <guilabel>Panel</guilabel>.</para> +</listitem> + +<listitem> <para>A preview area where you can see how +icons of the selected kind will look using the current +settings. Note that the state of this preview also depends on the icon +state selected in the effects below (do not worry +about that now, we will explain that below).</para> </listitem> +</itemizedlist> + +<para>When you want to configure icons, first select the usage of icons +you want to configure. Change the settings until you like the +preview. You can then choose a different icon usage and configure +that. At the end, if you are satisfied with your settings, click +<guibutton>OK</guibutton> or <guibutton>Apply</guibutton> to take the +changes in effect.</para> + +<para>There are two further options to consider, +<guilabel>Size</guilabel> and <guilabel>Effects</guilabel>.</para> + +<sect3 id="icons-use-size"> +<title>Icon Size</title> + +<para>You have two options relating to icon sizes. First, you can choose +from a list of icon sizes. Second, you can tell &tde; to draw all icons +using double sized pixels. The largest icon sizes are especially useful +for visually impaired people.</para> + +<para>Which sizes will be offered by the icon size listbox depends on +the icon theme you have selected in the icon themes control module. For +example, the low color icon theme only offers the sizes 16 and 32 for +desktop icons and 16, 22 and 32 for toolbar icons. The HiColor theme +offers icon sizes 16, 32 and 48 as well as sizes from 64 to 128. +However, as &tde; can not have all these icon sizes in store, icons +using size 64 to 128 will be automatically generated which may result in +a loss of quality.</para> + +<para>If the icon sizes offered by your chosen icon theme are not enough +for you, there is still the option <guilabel>Double-sized +pixels</guilabel>. If this option is selected, all icons will have +double sized pixels, &ie; a 2x2 block instead of normal pixels. While +this makes it possible to achieve very large icon sizes, the quality is +poor: icons will look <quote>blocky</quote>, an effect you may remember +if you've grown up using a Sinclair ZX Spectrum or similar. If this is +an option for you, using the large sizes offered by &tde;'s HiColor +icon theme will always result in a much better quality than using the +low color icon theme with double sized pixels.</para> +<!-- +<para>You can also choose to have smoothed icons, an effect similar to +anti-aliasing of fonts. Enable the checkbox <guilabel>Blend alpha +channel</guilabel> to see this in action, but note that it will slow +down graphics on a slower computer.</para> +--> + +<para>You can also choose animated icons. Many of the icons have +animations associated with them. Enable the checkbox labelled +<guilabel>Animate Icons</guilabel>, to enable this effect, but note +that it may appear slow or jerky if your graphics card is old or you +are low on memory.</para> + +</sect3> + +<sect3 id="icons-use-effects"> +<title>Effects</title> + +<para>Finally you can configure certain <quote>filters</quote> to be +applied on icons which are in one of three states:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Default</guilabel></term> +<listitem><para>This is how the icon will look normally.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Active</guilabel>:</term> +<listitem><para>This is how the icon will look when the mouse cursor is over the icon.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Disabled</guilabel>:</term> +<listitem><para>This is how the icon will look if its corresponding action is +disabled, &ie; clicking on it will not lead to any +result.</para></listitem> +</varlistentry> +</variablelist> + +<para>Select one of these states, and press the <guibutton>Set +Effect...</guibutton> button to configure a corresponding icon effect. +Please note that this configuration will only affect icons of the +currently selected <guilabel>Use of Icon</guilabel> category (see +above): configuring an effect for active icons, while +<guilabel>Toolbar</guilabel> icon usage is selected, will +<emphasis>not</emphasis> affect active icons used in other +places.</para> + +<para>Below the list of icon states there are two options: you can +configure an effect and you can select the +<guilabel>Semi-transparent</guilabel> option, which will make the +background <quote>shine through</quote> the icon. To the right of the +effects list box there is a slider button to pass additional parameters to +a filter for colours and <guilabel>Amount</guilabel>.</para> +<!-- TODO: Figure out what 'amount' really means --> + +<para>The following effects can be applied to icons:</para> + +<variablelist> +<varlistentry> +<term><guilabel>No Effect</guilabel>:</term> +<listitem><para>Icons will be used without applying any +effect.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>To Gray</guilabel>:</term> +<listitem><para>This filter will apply a grayish look to the icon. Click +<guibutton>Setup...</guibutton> to configure the intensity of this filter. Note +that it is customary for most user interfaces to use this effect for disabled +icons only.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Colorize</guilabel>:</term> +<listitem><para>Icons will be colorized using a custom color. For example, you +may configure active icons (&ie; the icon the mouse cursor is over) to +shine golden. Use the color and <guilabel>Amount</guilabel> buttons to configure the used color and the intensity of the colorization.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Gamma</guilabel>:</term> +<listitem><para>A different gamma value will be applied to all icons. If you're +no photographer and don't know what Gamma is: it's quite similar to what people +call contrast. Just play around with the gamma settings by clicking on +<guibutton>Setup...</guibutton> to get a feeling for this +effect.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Desaturate</guilabel>:</term> +<listitem><para>Icons will be drawn desaturated. This is quite similar to the +<quote>Color</quote> setting on your television. Click +<guibutton>Setup...</guibutton> to configure the amount of desaturation. +</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>To Monochrome:</guilabel></term> +<listitem> +<para>Icons will be drawn using only the two colours selected.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/index.docbook b/doc/kcontrol/index.docbook new file mode 100644 index 000000000..f55b3e8e4 --- /dev/null +++ b/doc/kcontrol/index.docbook @@ -0,0 +1,637 @@ +<?xml version="1.0" ?> +<!DOCTYPE book 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 --> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kcontrolcenter;</title> + +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-03-05</date> +<releaseinfo>3.4.0</releaseinfo> + +<abstract> +<para>This documentation describes &tde;'s control center.</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kcontrol</keyword> +<keyword>configuration</keyword> +<keyword>settings</keyword> +<keyword>module</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>The &kcontrolcenter;</title> + +<para> +The &kcontrolcenter; (from now on referred to simply as <quote>the +control center</quote>) provides you with a centralized and convenient +way to configure all of your &tde; settings. +</para> + +<para> +The control center is made up of multiple modules. Each module is a +separate application, but the control center organizes all of these +programs into a convenient location. +</para> + +<tip> +<para> +Each control center module can be executed individually +</para> + +<para> +See section entitled <link linkend="control-center-run-indiv">Running +individual control center modules</link> for more information. +</para> +</tip> + +<para> +The control center groups the configuration modules into categories, so +they are easy to locate. Within each category, the control center shows +all the modules in a list, so it is easier to find the right +configuration module. +</para> +</chapter> + +<chapter id="control-center"> +<title>Using the &kcontrolcenter;</title> + +<para> +This next section details the use of the control center itself. For +information on individual modules, please see <link linkend="module">Control +Center Modules</link> +</para> + +<sect1 id="control-center-starting"> +<title>Starting the &kcontrol;</title> + +<para>The &kcontrolcenter; can be started in 3 ways: +</para> + +<orderedlist> +<listitem> +<para> +By selecting <menuchoice><guimenu>TDE Button</guimenu><guimenuitem>Control +Center</guimenuitem></menuchoice> from the &tde; Panel. +</para> +</listitem> +<listitem> +<para> +By pressing <keycombo +action="simul">&Alt;<keycap>F2</keycap></keycombo>. +</para> + +<para> +This will bring up a dialog box. Type +<userinput><command>kcontrol</command></userinput>, and click +<guibutton>Run</guibutton>. +</para> +</listitem> + +<listitem> +<para> +You can type <command>kcontrol &</command> at any command prompt. +</para> +</listitem> +</orderedlist> + +<para> +All three of these methods are equivalent, and produce the same result. +</para> + +</sect1> + +<sect1 id="control-center-screen"> +<title>The &kcontrolcenter; Screen</title> + +<para> +When you start the control center, you are presented with a window, +which can be divided into 3 functional parts. +</para> + +<screenshot> +<screeninfo>Screenshot</screeninfo> +<mediaobject> +<imageobject> <imagedata fileref="screenshot.png" format="PNG"/> +</imageobject> +<textobject> <phrase>Screenshot</phrase> </textobject> +<caption> +<para>The &tde; Control Center Screen</para> +</caption> +</mediaobject> +</screenshot> + +<para> +Across the top is a menubar. The menubar will provide you with quick +access to most of &kcontrolcenter;'s features. The menus are detailed in +<link linkend="control-center-menus">The &tde; Control Center +Menus</link>. +</para> + +<para> +Along the left hand side, is a icon tree. Here you can choose which +module to configure. +</para> + +<para> +The main panel shows you some system information. +</para> + +<para> +In this example, we are running &tde; 3.4.0, we started &kcontrolcenter; +as user <systemitem class="username">newkde</systemitem>, the computer is +named <systemitem class="systemname">turtle</systemitem>, it is a +&Linux; system running the 2.6 kernel, on a i686 processor. +</para> + +</sect1> + +<sect1 id="control-center-menus"> +<title>The &kcontrolcenter; Menus</title> + +<para> +This next section gives you a brief description of what each menu item +does. +</para> + +<sect2 id="control-center-menu-file"> +<title><guimenu>File</guimenu> Menu</title> + +<para> +The <guimenu>File</guimenu> menu has a single entry. +</para> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem> +<para> +<action>Closes the control center.</action> +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="control-center-menu-view"> +<title><guimenu>View</guimenu> Menu</title> + +<para> +These options determine how the module selection looks and behaves. +</para> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenu>View</guimenu> <guimenuitem>Mode</guimenuitem> +</menuchoice></term> + +<listitem> +<para> +Determines whether to use <guimenuitem>Tree</guimenuitem> view, +or <guimenuitem>Icon</guimenuitem> view for your modules. +</para> + +<para> +With <guimenuitem>Tree</guimenuitem> view, each submenu appears as an +indented list. +</para> + +<para> +With <guimenuitem>Icon</guimenuitem> view, when you click on a category, +the categories disappear and are replaced with the module list. You +then use the <guiicon>Back</guiicon> button to return to the categories. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guisubmenu>Icon size</guisubmenu> +</menuchoice></term> + +<listitem> +<para> +Using this option, you can choose +<guimenuitem>Small</guimenuitem>, <guimenuitem>Medium</guimenuitem>, or +<guimenuitem>Large</guimenuitem> icons to select your modules. +</para> + +<note><para> +This menu item only controls the icon size if you are in +<guimenuitem>Icon View</guimenuitem>. If you choose +<guimenuitem>Tree View</guimenuitem>, the <guimenuitem>Small</guimenuitem> +icon size will be used, no matter what size was previously selected in +<guimenuitem>Icon View</guimenuitem>. +</para> +</note> +</listitem> + +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="control-center-menu-settings"> +<title><guimenu>Settings</guimenu> Menu</title> + +<para> + The <guimenu>Settings</guimenu> menu has a single entry, +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>. From here you can map keyboard shortcuts to the +other menu options. +</para> + +</sect2> + +<sect2 id="control-center-menu-help"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> + +<sect1 id="control-center-exiting"> +<title>Exiting The &tde; Control Center</title> + +<para> +You can exit the control center one of three ways: +</para> + +<itemizedlist> +<listitem> +<para> +Select <menuchoice><guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem></menuchoice> from the menu bar. +</para> +</listitem> + +<listitem> +<para>Type <keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +on the keyboard. +</para> +</listitem> + +<listitem> +<para> +Click on the <guiicon>Close</guiicon> button on the frame surrounding +the control center. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="control-center-run-indiv"> +<title>Running Individual Modules</title> + +<para> +You can run individual modules without running kcontrol using the command <command>tdecmshell</command> from &konsole;. Type <userinput> <command>tdecmshell</command><option> --list</option></userinput> to see a list of the available &kcontrolcenter; modules. You can also access individual &kcontrolcenter; modules through adding the <guilabel>Preferences</guilabel> button to either &kicker; or the &kmenu; through their respective configuration dialogs. +</para> + +</sect1> + +</chapter> + +<!--*****************************************************************--> + +<chapter id="module"> +<title>The &kcontrolcenter; Modules</title> + +<para> +In order to make it as easy as possible, the &kcontrolcenter; has organized +similar options into groups. Each group is called a module. When you +click on the name of a module in the left window, you will be presented +with the options of the module on the right. +</para> + +<para> +Each module will have some or all of the following buttons: +</para> + +<variablelist> + +<varlistentry> +<term>Help</term> +<listitem> +<para> +This button will give you help specific to the current module. The +button will show you a short summary help page in the left window. At +the bottom of that window, you can click on a link to get more detailed +help. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Defaults</guilabel></term> +<listitem> +<para> +This button will restore this module to its default values. You must +click <guibutton>OK</guibutton> to save the options. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Apply</guibutton></term> +<listitem> +<para> +Clicking this button will save all changes to &tde;. If you have +changed anything, clicking <guibutton>Apply</guibutton> will cause the +changes to take effect. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Reset</guibutton></term> +<listitem> +<para> +This button will <quote>Reset</quote> the module to the previous settings. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<note> +<para> +You must save the options of the current module using +<guibutton>Apply</guibutton> before you can change to a different +module. +</para> +<para> +If you try to change without saving your options, you will be asked if +you want to save your changes, or discard them. +</para> +</note> +</chapter> +<!-- + Commented until fixed arrangement is made +<sect1 id="module-intro"> +<title>Navigating Modules</title> + +<para> +This is a list of the <emphasis>standard</emphasis> configuration +modules (sorted by category) provided by the <application +role="package">KDE base</application> package. Please note that there +may be many more modules on your system if you have installed additional +software. +</para> + +<variablelist> +<varlistentry> +<term>File Browsing</term> +<listitem> +<para> +<link linkend="file-assoc">File Associations</link>, +<link linkend="file-manager">File Manager</link>, +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Look and Feel</term> +<listitem> +<para> +<link linkend="background">Background</link>, +<!- - <link linkend="borders">Borders</link>,- -> +<link linkend="color">Colors</link>, +<link linkend="desktop">Desktop</link>, +<link linkend="fonts">Fonts</link>, +<link linkend="icons">Icons</link>, +<!- - <link linkend="iconstyle">Icon Style</link>, - -> +<link linkend="key-bindings">Key Bindings</link>, +<link linkend="launch-feedback">Launch feedback</link>, +<link linkend="panel">Panel</link>, +<link linkend="screensaver">Screensaver</link>, +<link linkend="style">Style</link>, +<link linkend="sys-notify">System Notifications</link>, +<link linkend="taskbar">Taskbar</link>, +<link linkend="theme-manager">Theme Manager</link>, +<!- - <link linkend="numbername">Virtual Desktops</link>,- -> +<link linkend="window-behavior">Window Behavior</link>, +<link linkend="window-deco">Window Decoration</link>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Network</term> +<listitem> +<para> +<link linkend="e-mail">E-Mail</link>, +<link linkend="lan-browsing">LAN Browsing</link>, +<link linkend="timeouts">Preferences</link>, <!- - FIXME - -> +<link linkend="socks">SOCKS</link>, +<link linkend="talk">Talk Configuration</link> +<link linkend="windows-shares">Windows Shares</link> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Peripherals</term> +<listitem> +<para> +<link linkend="kbd">Keyboard</link>, +<link linkend="mouse">Mouse</link> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Personalization</term> +<listitem> +<para> +<link linkend="accessibility">Accessibility</link>, +<link linkend="locale">Country & Language</link>, +<link linkend="crypto">Crypto</link>, +<!- - <link linkend="kblayout">Keyboard Layout</link>, - -> +<link linkend="passwords">Passwords</link> +<link linkend="spell-checking">Spell Checking</link>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Power Control</term> +<listitem> +<para> +<link linkend="battery-monitor">Battery Monitor</link>, +<link linkend="energy">Energy</link>, +<link linkend="powerctrl">Laptop Power Control</link>, +<link linkend="lowbatcrit">Low Battery Critical</link>, +<link linkend="lowbatwarn">Low Battery Warning</link> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Sound</term> +<listitem> +<para> +<link linkend="midi">Midi</link>, +<link linkend="mixer">Mixer</link>, +<link linkend="sndserver">Sound Server</link>, +<link linkend="bell">System Bell</link> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>System</term> +<listitem> +<para> +<link linkend="datetime">Date and Time</link>, +<link linkend="konsole">&konsole;</link>, +<link linkend="login-manager">Login Manager</link>, +<link linkend="print-manager">Printing Manager</link>, +<link linkend="sessions">Session Manager</link>, +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Web Browsing</term> +<listitem> +<para> +<link linkend="cookie">Cookies</link>, +<link linkend="ebrowse">Enhanced Browsing</link>, +<link linkend="konq-browsing">Konqueror Browser</link>, +<link linkend="nsplugins">Netscape Plugins</link>, +<link linkend="proxies">Proxies & Cache</link>, +<link linkend="stylesheets">Stylesheets</link>, +<link linkend="user-agent">User Agent</link>, +</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> +</chapter> +--> + +<!-- commenting this section out until I figure out what to do with it :) +<chapter id="laptop"> +<title>Laptop Modules Notes</title> + +<para> +In order to use the laptop modules, you must have the kernel +<acronym>APM</acronym> package installed in your kernel. Useful information + +on +how to do this can be found at +<ulink url="http://www.cs.utexas.edu/users/kharker/linux-laptop/apm.html"> +http://www.cs.utexas.edu/users/kharker/linux-laptop/apm.html</ulink> and +in the Battery Powered Linux mini-HOWTO at <ulink +url="http://metalab.unc.edu/LDP/HOWTO/mini/Battery-Powered.html"> +http://metalab.unc.edu/LDP/HOWTO/mini/Battery-Powered.html</ulink>. +</para> + +<para> +If you want the <guimenuitem>suspend</guimenuitem> and +<guimenuitem>standby</guimenuitem> menu commands to work then you should +install the &Linux; <application>apmd</application> package (version 2.4 +or later). If you want to use them from non-root accounts you must mark +the <application>apm</application> command <quote>set uid root</quote>. +</para> + +<para> +To do this, log on as <systemitem class="username">root</systemitem> and +enter: +</para> + +<screen> +<prompt>%</prompt><userinput><command>chown</command> <option>root +/usr/bin/apm</option>;<command>chmod</command> <option>+s +/usr/bin/apm</option></userinput> +</screen> + +<warning> +<para> +By doing this you will allow any user of your system to put it into suspend +or +standby states - if you are the only user, this should not be a problem. +</para> + +<para> +Also note that any program which has <systemitem +class="username">root</systemitem> access, can be a potential security +problem. You should carefully determine if there are any security +concerns <emphasis>before</emphasis> giving any program <systemitem +class="username">root</systemitem> permissions. +</para> +</warning> +</chapter> +--> + +<chapter id="credits"> +<title>Credits and License</title> + +<para>&kcontrol;</para> +<para>Program copyright 1997-2001 The &kcontrolcenter; Developers</para> +<para>Contributors:</para> + +<itemizedlist> +<listitem><para>&Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail;</para></listitem> +<listitem><para>&Matthias.Elter; &Matthias.Elter.mail;</para></listitem> +</itemizedlist> + +<para>Documentation <trademark class="copyright">copyright 2000 &Mike.McBride;</trademark> &Mike.McBride.mail;</para> + +<para>Contributors:</para> + +<itemizedlist> +<listitem><para>&Paul.Campbell; &Paul.Campbell.mail;</para></listitem> +<listitem><para>&Helge.Deller; &Helge.Deller.mail;</para></listitem> +<listitem><para>&Mark.Donohoe; </para></listitem> +<listitem><para>&Patrick.Dowler; </para></listitem> +<listitem><para>&Duncan.Haldane; <email>[email protected]</email></para></listitem> +<listitem><para>&Steffen.Hansen; <email>[email protected]</email>.</para></listitem> +<listitem><para>&Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail;</para></listitem> +<listitem><para>&Martin.R.Jones; &Martin.R.Jones.mail;</para></listitem> +<listitem><para>&Jost.Schenck; &Jost.Schenck.mail;</para></listitem> +<listitem><para>&Jonathan.Singer; &Jonathan.Singer.mail;</para></listitem> +<listitem><para>&Thomas.Tanghus; &Thomas.Tanghus.mail;</para></listitem> +<listitem><para>&Krishna.Tateneni; &Krishna.Tateneni.mail;</para></listitem> +<listitem><para>Ellis Whitehead <email>[email protected]</email></para></listitem> +</itemizedlist> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; +</chapter> + +</book> + +<!-- +Local Variables: +mode: sgml +End: +--> + diff --git a/doc/kcontrol/interrupts/CMakeLists.txt b/doc/kcontrol/interrupts/CMakeLists.txt new file mode 100644 index 000000000..67690437f --- /dev/null +++ b/doc/kcontrol/interrupts/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/interrupts ) diff --git a/doc/kcontrol/interrupts/Makefile.am b/doc/kcontrol/interrupts/Makefile.am new file mode 100644 index 000000000..5d81a10cd --- /dev/null +++ b/doc/kcontrol/interrupts/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/interrupts diff --git a/doc/kcontrol/interrupts/index.docbook b/doc/kcontrol/interrupts/index.docbook new file mode 100644 index 000000000..b29611202 --- /dev/null +++ b/doc/kcontrol/interrupts/index.docbook @@ -0,0 +1,70 @@ +<?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>Interrupt Request (<abbrev>IRQ</abbrev>) Lines</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>IRQ</keyword> +<keyword>interrupts</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Interrupt Request (<abbrev>IRQ</abbrev>) Lines in Use</title> + +<para>This page displays information about the Interrupt Request +Lines in use, and the devices that use them.</para> + +<para>An <acronym>IRQ</acronym> is a hardware line used in a +<acronym>PC</acronym> by (<acronym>ISA</acronym> bus) devices like +keyboards, modems, sound cards, &etc;, to send interrupt signals to the +processor to tell it that the device is ready to send or accept data. +Unfortunately, there are only sixteen <acronym>IRQ</acronym>'s (0-15) +available in the i386 (<acronym>PC</acronym>) architecture for sharing among +the various <acronym>ISA</acronym> devices.</para> + +<para>Many hardware problems are the result of <acronym>IRQ</acronym> +conflicts, when two devices try to use the same <acronym>IRQ</acronym>, or +software is misconfigured to use a different <acronym>IRQ</acronym> from the +one a device is actually configured for.</para> + +<note><para>The exact information displayed is system-dependent. On some +systems, <acronym>IRQ</acronym> information cannot be displayed + yet.</para></note> + +<para>On &Linux;, this information is read from +<filename class="directory">/proc/interrupts</filename>, which is only +available if the <filename class="directory">/proc</filename> +pseudo-filesystem is compiled into the kernel.</para> + +<para>The first column, is the <acronym>IRQ</acronym> number. The second +column, is the number of interrupts that have been received since the last +reboot. The third column shows the type of interrupt. The fourth, +identifies the device assigned to that interrupt.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> + diff --git a/doc/kcontrol/ioports/CMakeLists.txt b/doc/kcontrol/ioports/CMakeLists.txt new file mode 100644 index 000000000..c8ca4ced6 --- /dev/null +++ b/doc/kcontrol/ioports/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/ioports ) diff --git a/doc/kcontrol/ioports/Makefile.am b/doc/kcontrol/ioports/Makefile.am new file mode 100644 index 000000000..e5f86f7b3 --- /dev/null +++ b/doc/kcontrol/ioports/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/ioports diff --git a/doc/kcontrol/ioports/index.docbook b/doc/kcontrol/ioports/index.docbook new file mode 100644 index 000000000..65bcb1f1e --- /dev/null +++ b/doc/kcontrol/ioports/index.docbook @@ -0,0 +1,64 @@ +<?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>I/O Port</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>ioports</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Input/Output Port Information</title> + +<para>This page displays information about the I/O ports.</para> + +<para>I/O Ports are memory addresses used by the processor for direct +communication with a device that has sent an +interrupt signal to the processor.</para> + +<para>The exchange of commands or data between the processor and the device +takes place through the I/O port address of the device, which is a + hexadecimal +number. No two devices can share the same I/O port. Many devices use + multiple +I/O port addresses, which are expressed as a range of hexadecimal +numbers.</para> + +<note><para>The exact information displayed is system-dependent. On some +systems, I/O port information can not yet be displayed.</para></note> + +<para>On &Linux;, this information is read from <filename +class="devicefile">/proc/ioports</filename> which is only available if +the <filename class="devicefile">/proc</filename> pseudo-filesystem is +compiled into the kernel. A list of all currently-registered I/O port +regions that are in use is shown.</para> + +<para>The first column is the I/O port (or the range of I/O ports), the +second column identifies the device that uses these I/O ports.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> +</article> diff --git a/doc/kcontrol/joystick/CMakeLists.txt b/doc/kcontrol/joystick/CMakeLists.txt new file mode 100644 index 000000000..cd9842628 --- /dev/null +++ b/doc/kcontrol/joystick/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/joystick ) diff --git a/doc/kcontrol/joystick/Makefile.am b/doc/kcontrol/joystick/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/joystick/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/joystick/index.docbook b/doc/kcontrol/joystick/index.docbook new file mode 100644 index 000000000..8d1a86635 --- /dev/null +++ b/doc/kcontrol/joystick/index.docbook @@ -0,0 +1,137 @@ +<?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"> +]> + +<article lang="&language;"> +<title>Joystick</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Michael</firstname> +<surname>Anderson</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2008</year> +<holder>Michael Anderson</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<keywordset> +<keyword>TDE</keyword> +<keyword>System Settings</keyword> +<keyword>joystick</keyword> +<keyword>calibrate</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="kcm_joystick"> +<title>Joystick Configuration</title> + +<para>This module provides an interface to calibrate your joystick device as well as +viewing which functions on your joystick are mapped to which logical button or +axis.</para> + +<!--<para> +<screenshot> +<screeninfo>Here's a screenshot of the joystick module</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="joystick-main.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The joystick module</phrase> + </textobject> + </mediaobject> +</screenshot> +</para>--> + +<variablelist> +<varlistentry><term><guilabel>Device</guilabel></term> +<listitem> +<para> +Here you can see the logical location of the device. When you have more +than one joystick device, you can also select which device to configure. +</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Position</guilabel></term> +<listitem> +<para> +The plotted location of the X and Y axes of the joystick. Enable <guibutton>Show trace</guibutton> +to plot the path of the joystick from one point to another. +</para> +<tip><para> +When the joystick cannot reach every point on this graph, or does not center correctly, you need to calibrate your device. +</para></tip> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Buttons</guilabel></term> +<listitem> +<para> +A place to observe the pressed state of buttons on your joystick and when the buttons +are mapped correctly. When a joystick button is pressed, <guilabel>PRESSED</guilabel> will appear +next to the logical number (as the computer sees it) of the button which was +pressed. +</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Axes</guilabel></term> +<listitem> +<para> +This displays the numerical values of the axis positions. 0 is centered and the +maximum and minimum values depend on the joystick and the particular axis. +</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Calibrate</guilabel></term> +<listitem> +<para> +Selecting the <guibutton>Calibrate</guibutton> button will open a dialog to calibrate every axis on your joystick. +</para> + +<!--<para> +<screenshot> +<screeninfo>Calibrating your joystick</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="joystick-calibration.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Calibrating your joystick</phrase> + </textobject> + </mediaobject> +</screenshot> +</para>--> + +<para> +Each axis will have to be moved to the minimum position, then the center, and finally the +maximum position. A meter in the bottom left corner of the dialog will help +determine which way increases and which way decreases the values. +</para> + +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmaccess/CMakeLists.txt b/doc/kcontrol/kcmaccess/CMakeLists.txt new file mode 100644 index 000000000..5cd340744 --- /dev/null +++ b/doc/kcontrol/kcmaccess/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmaccess ) diff --git a/doc/kcontrol/kcmaccess/Makefile.am b/doc/kcontrol/kcmaccess/Makefile.am new file mode 100644 index 000000000..c0d281754 --- /dev/null +++ b/doc/kcontrol/kcmaccess/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = kcontrol/kcmaccess + diff --git a/doc/kcontrol/kcmaccess/index.docbook b/doc/kcontrol/kcmaccess/index.docbook new file mode 100644 index 000000000..bb5d93cab --- /dev/null +++ b/doc/kcontrol/kcmaccess/index.docbook @@ -0,0 +1,179 @@ +<?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> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-12-21</date> +<releaseinfo>3.01.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>accessibility</keyword> +</keywordset> +</articleinfo> + +<sect1 id="accessibility"> +<title>Accessibility</title> +<sect2 id="accessibility-intro"> + +<title>Introduction</title> + +<para>This module is designed to help users who have difficulty hearing +audible cues, or who have difficulty using a keyboard.</para> + +<para> +The module is divided into two tabs: <link +linkend="access-bell"><guilabel>Bell</guilabel></link> and <link +linkend="access-kb"><guilabel>Keyboard</guilabel></link>. +</para> + +<sect3 id="access-bell"> +<title><guilabel>Bell</guilabel></title> + +<para> +This panel is divided into an <guilabel>Audible Bell</guilabel> section +and a <guilabel>Visible Bell</guilabel> section. +</para> + +<para> +The top check box labeled <guilabel>Use System Bell</guilabel>, determines +whether the normal System bell rings. If this option is disabled, the +System bell will be silenced. +</para> + +<para> +The next check box down can be used to play a different sound whenever +the system bell is triggered. To activate, place a mark in the check +box labeled <guilabel>Use customized bell</guilabel>, and enter the +complete pathname to the sound file in the text box labeled +<guilabel>Sound to Play</guilabel>. If you want, you can select the +<guibutton>Browse</guibutton> button to navigate through your filesystem +to find the exact file. +</para> + +<para> +For those users who have difficulty hearing the System bell, or those +users who have a silent computer, &tde; offers the <emphasis>visible bell</emphasis>. This +provides a visual signal (inverting the screen or flashing a color +across it) when the system bell would normally sound. +</para> + +<para> +To use the visible bell, first place a mark in the check box labeled +<guilabel>Use visible bell</guilabel>. +</para> + +<para> +You can then select between <guilabel>Invert screen</guilabel>, or +<guilabel>Flash screen</guilabel>. If you select <guilabel>Invert +screen</guilabel>, all colors on the screen will be reversed. If you +choose <guilabel>Flash screen</guilabel>, you can choose the color by +clicking the button to the right of the <guilabel>Flash +screen</guilabel> selection. +</para> + +<para> +The slider bar can be used to adjust the duration of the visible +bell. The default value is 500ms, or half a second. +</para> + +</sect3> + +<sect3 id="access-kb"> +<title><guilabel>Keyboard</guilabel></title> + +<para>There are three sections to this panel.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Use Sticky Keys</guilabel></term> +<listitem> +<para> +If this option is enabled, you can press and release the &Shift;, +&Alt; or &Ctrl; keys, and then press another key to get a key combo +(example: <keycombo action="simul">&Ctrl; &Alt; +<keycap>Delete</keycap></keycombo> could be done with &Ctrl; then &Alt; +then <keycap>Delete</keycap>). +</para> + +<para> +Also in this section is a check box labeled <guilabel>Lock Sticky +Keys</guilabel>. If this check box is enabled, the &Alt;, &Ctrl; +and &Shift; keys stay <quote>selected</quote> until you +<quote>de-selected</quote> them. +</para> + +<para> +As an example: +</para> +<variablelist> +<varlistentry> +<term>With <guilabel>Lock Sticky Keys</guilabel> disabled:</term> +<listitem> +<para>If you press the &Shift; key then press the +<keycap>F</keycap> key, the computer interprets this as <keycombo +action="simul">&Shift;<keycap>F</keycap></keycombo>. Now if you +type a <keycap>P</keycap>, the computer interprets this as the letter p +(no shift). +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>With <guilabel>Lock Sticky Keys</guilabel> enabled:</term> +<listitem> +<para> +If you press the &Shift; key <emphasis>twice</emphasis> then press the <keycap>F</keycap> key, +the computer interprets this as <keycombo +action="simul">&Shift;<keycap>F</keycap></keycombo>. Now if you +type a <keycap>p</keycap>, the computer interprets this as the letter P +(<keycombo action="simul">&Shift;<keycap>P</keycap></keycombo>). To +de-select the &Shift; key, press it again. +</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Slow keys</guilabel></term> +<listitem> +<para> +If this option is enabled, you must hold the key down for a +specified length of time (adjustable with the slider) before the +keystroke will be accepted. This helps prevent accidental key strokes. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Bounce keys</guilabel></term> +<listitem> +<para> +If this option is enabled, you must wait for a specified length of time +(configurable with the slider) before the next key press can be +accepted. This prevents accidental multiple key strokes. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmcgi/CMakeLists.txt b/doc/kcontrol/kcmcgi/CMakeLists.txt new file mode 100644 index 000000000..2a5308452 --- /dev/null +++ b/doc/kcontrol/kcmcgi/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmcgi ) diff --git a/doc/kcontrol/kcmcgi/Makefile.am b/doc/kcontrol/kcmcgi/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/kcmcgi/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/kcmcgi/index.docbook b/doc/kcontrol/kcmcgi/index.docbook new file mode 100644 index 000000000..9ab61d968 --- /dev/null +++ b/doc/kcontrol/kcmcgi/index.docbook @@ -0,0 +1,63 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article id="kcmcgi" lang="&language;"> +<title>CGI Scripts</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Burkhard</firstname> +<surname> +Lück +</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2009</year> +<holder>Burkhard Lück</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<keywordset> +<keyword>TDE</keyword> +<keyword>kcontrol</keyword> +<keyword>Systemsettings</keyword> +<keyword>cgi</keyword> +</keywordset> +</articleinfo> + +<sect1 id="cg-scripts"> +<title>CGI Scripts</title> + +<para> +The CGI TDEIO slave lets you execute local CGI programs +without the need to run a web server.</para> + +<para>In this system settings module you can +configure the paths that are searched for CGI scripts. +</para> + +<para>Paths to CGI scripts are displayed in the list box at the +bottom of this dialog. +</para> + +<para>Use the buttons below the list box to add or remove paths from the search. +</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmcss/CMakeLists.txt b/doc/kcontrol/kcmcss/CMakeLists.txt new file mode 100644 index 000000000..0a505ff4e --- /dev/null +++ b/doc/kcontrol/kcmcss/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmcss ) diff --git a/doc/kcontrol/kcmcss/Makefile.am b/doc/kcontrol/kcmcss/Makefile.am new file mode 100644 index 000000000..fc406ca64 --- /dev/null +++ b/doc/kcontrol/kcmcss/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG= en +KDE_DOCS = kcontrol/kcmcss diff --git a/doc/kcontrol/kcmcss/index.docbook b/doc/kcontrol/kcmcss/index.docbook new file mode 100644 index 000000000..8560fa8a7 --- /dev/null +++ b/doc/kcontrol/kcmcss/index.docbook @@ -0,0 +1,257 @@ +<?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> +<articleinfo> + +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>CSS</keyword> +<keyword>Stylesheets</keyword> +<keyword>Accessibility</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="stylesheets"> + +<title>Stylesheets</title> + +<sect2> +<title>Introduction</title> + +<para><acronym>CSS</acronym> style sheets affect the way web pages +appear. <acronym>CSS</acronym> stands for +<emphasis>C</emphasis>ascading <emphasis>S</emphasis>tyle +<emphasis>S</emphasis>heets.</para> + +<para>&tde; can use its own stylesheet, based on simple defaults and +the color scheme you are using for your desktop. &tde; can also use a +stylesheet that you have written yourself. Finally, you can specify a +stylesheet in this module. The options presented in this module are +tuned for accessibility purposes, especially for people with reduced +vision.</para> + +<para>Your choices here affect every &tde; application that renders HTML +with &tde;'s own renderer, which is called tdehtml. These include +&kmail;, &khelpcenter; and of course &konqueror;. Choices here do not +affect other browsers such as &Netscape;.</para> + +<para>The module has two pages, <guilabel>General</guilabel>, where you +can choose which stylesheet to use, and <guilabel>Customize</guilabel> +where you can design an accessibility stylesheet.</para> + +</sect2> + +<sect2 id="css-general"> +<title>General</title> + +<para>This page contains the following options:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Use default stylesheet</guilabel></term> +<listitem> +<para>&tde; will use the default stylesheet. Some of the colors will +default to those defined in your chosen color scheme. Most settings are +easily overridden by the page you are viewing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use user-defined stylesheet</guilabel></term> +<listitem> +<para>&tde; will use a stylesheet that you have written yourself. You +can use the browse button to locate the stylesheet on your system. +<acronym>CSS</acronym> files traditionally have a <literal +role="extension">.css</literal> extension, but this is not +required.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use accessibility stylesheet defined in +"Customize"-tab</guilabel></term> +<listitem> +<para>Use the settings defined in the <guilabel>Customize</guilabel> +tab. Enabling this option will enable the options on the +<guilabel>Customize</guilabel> page.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="css-customize"> +<title>Customize</title> + +<para>Here you can set up a user stylesheet. The options available are +only a subset of the instructions you can add in a stylesheet, and they +are geared towards people with reduced vision, to allow users to create +a stylesheet that makes web pages and the &tde; help files more +readable.</para> + +<para>The options on this page are disabled unless you chose +<guilabel>Use accessibility stylesheet defined in +"Customize"-tab</guilabel> on the previous page.</para> + +<sect3> +<title><guilabel>Font Family</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Base family</guilabel></term> +<listitem> +<para>Choose a font family to use for body text.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use same family for all text</guilabel></term> +<listitem> +<para>If you enable this, then the same font family will be used for all +text, regardless of the settings on the page you are viewing. This is +useful for pages which have used a decorative or hard to read font for +headlines.</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Font Size</title> + +<variablelist> +<varlistentry> +<term><guilabel>Base Font Size</guilabel></term> +<listitem> +<para>This is the default size for text on the page. Many web sites set +their font sizes relative to this default, using <quote>larger</quote> +or <quote>+1</quote> to make the text bigger, and <quote>smaller</quote> +or <quote>-1</quote> to make the text smaller.</para> +<para>Many people design their web pages on platforms where the ordinary +default text size is too large for the average user to read, so it is +very common to come across web pages that have forced the font smaller +in this way.</para> +<para>This setting will allow you to set the default font to a +comfortable size, so that the relative sizes are also enlarged enough to +be comfortable.</para> +<para>Do not forget you can also have &konqueror; enforce a minimum size, +so that text is <emphasis>never</emphasis> too small to read. Set that +under Behavior, in the Web Browser section in &kcontrol;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use same size for all elements</guilabel></term> +<listitem> +<para>If you enable this option, then all text will be rendered at your +specified font size, regardless of the instructions the page contains. +Relative font sizes as discussed earlier, and even specific instructions +that text should be rendered at a certain size will be overridden +here.</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Colors</title> + +<variablelist> +<varlistentry> +<term><guilabel>Black on White</guilabel></term> +<listitem> +<para>Many people with reduced vision find black text on a white screen +gives the most contrast, and is easiest to read. If this applies to +you, you can set this here.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>White on Black</guilabel></term> +<listitem> +<para>Many other people with reduced vision find the opposite to be +true, that white text on a black screen is easier to read.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Custom</guilabel></term> +<listitem> +<para>Still other people find that pure black and white, in either +order, is difficult to read. You can set custom colors here for both +the <guilabel>Background</guilabel> and the +<guilabel>Foreground</guilabel>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use same color for all text</guilabel></term> +<listitem> +<para>Many web sites use a different, often contrasting color for +headings or other flourishes. If this interferes with your ability to +read the content, you can enable this checkbox to have &tde; use the +colors you have set above for all text.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Images</title> + +<variablelist> +<varlistentry> +<term><guilabel>Suppress images</guilabel></term> +<listitem> +<para>If you do not want to view images, you can turn this off +here.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Suppress background images</guilabel></term> +<listitem> +<para>One major problem for reduced vision users is that background +images do not give sufficient contrast to allow them to read the text. +You can disable background images here, independently of your choice +above to view all images.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3> +<title>Preview</title> + +<para>The <guibutton>Preview</guibutton> allows you to see the effect of +your changes. A window will pop up, showing how several types of +headings will appear with your stylesheet, and a sentence in the default +body text.</para> + +<para>This should allow you to fine tune your stylesheet until you have +something that you can comfortably read.</para> + +<para>Happy surfing!</para> + +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmfontinst/CMakeLists.txt b/doc/kcontrol/kcmfontinst/CMakeLists.txt new file mode 100644 index 000000000..6aa1c19fd --- /dev/null +++ b/doc/kcontrol/kcmfontinst/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmfontinst ) diff --git a/doc/kcontrol/kcmfontinst/Makefile.am b/doc/kcontrol/kcmfontinst/Makefile.am new file mode 100644 index 000000000..16be3161e --- /dev/null +++ b/doc/kcontrol/kcmfontinst/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmfontinst diff --git a/doc/kcontrol/kcmfontinst/index.docbook b/doc/kcontrol/kcmfontinst/index.docbook new file mode 100644 index 000000000..a46a8ee0f --- /dev/null +++ b/doc/kcontrol/kcmfontinst/index.docbook @@ -0,0 +1,76 @@ +<?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>&Craig.Drummond; &Craig.Drummond.Mail;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-22</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>fonts</keyword> +</keywordset> +</articleinfo> +<sect1 id="fontinst"> +<title>Font Installer</title> + +<para>This module is responsible for installing (and uninstalling) +fonts. The installer will configure X (X.org, XFree86), XRender, +(anti-aliasing), fontconfig, and <application>Ghostscript</application> (printing), +for any TrueType +(<literal role="extension">.ttf</literal>) and Type1 (<literal +role="extension">.pfa</literal>, <literal +role="extension">.pfb</literal>) fonts that you care to install - +bitmap (<literal role="extension">.bdf</literal>, <literal +role="extension">.pcf</literal>) fonts will also be installed, but +these can only used by X.</para> + +<para>When the module is started by a normal (non-root) user, then the +settings will refer to their personal configuration, and installed +fonts will be available to them only. For <systemitem +class="username">root</systemitem>, the settings will usually refer to +the system-wide configuration, and as such any installed fonts should +be available to all users.</para> +<para>If you install fonts as a normal user and notice the fonts used for +display (and for print preview) do not match those of the printed output +- then you should re-install the fonts system-wide (i.e. as <systemitem +class="username">root</systemitem>). This can occur because when printing +the output is sent to a printer queue - and when the system comes to actually +send the information to the printer, it is running as a different user (usually +<systemitem class="username">lp</systemitem>), and cannot find the font files.</para> +<para>To install fonts, simply select the "Add Fonts" button - this will +produce a file dialog, then just locate the fonts to install. Likewise, to +remove a font, simply highlight a font and press the "Delete" button.</para> +<sect2 id="using-konqueror"> +<title>Using Konqueror</title> +<para>You can also use Konqueror to install fonts via drag-and-drop. +To do this just type <ulink url="fonts:/">fonts:/</ulink> into Konqueror's Location bar.</para> +<para>As a normal (non-root) user, this will produce 2 top-level folders:</para> +<orderedlist> +<listitem> +<para><ulink url="fonts:/Personal">Personal</ulink> - this will display your personal fonts.</para> +</listitem> +<listitem> +<para><ulink url="fonts:/System">System</ulink> - this will display the system wide fonts. If you drag-n-drop a font +on to the folders here, you will be asked for the root password in order +to install the font.</para> +</listitem> +</orderedlist> +<para>If you drop a font over <ulink url="fonts:/">fonts:/</ulink>, then you will be asked whether this +should go into "Personal", or "System".</para> +<para>As root, just the contents of the system font folder will be displayed +- as root does not have any "personal" fonts.</para> +</sect2> +</sect1> +</article> diff --git a/doc/kcontrol/kcmhistory/CMakeLists.txt b/doc/kcontrol/kcmhistory/CMakeLists.txt new file mode 100644 index 000000000..e45bb6953 --- /dev/null +++ b/doc/kcontrol/kcmhistory/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmhistory ) diff --git a/doc/kcontrol/kcmhistory/Makefile.am b/doc/kcontrol/kcmhistory/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/kcmhistory/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/kcmhistory/index.docbook b/doc/kcontrol/kcmhistory/index.docbook new file mode 100644 index 000000000..926f17a5e --- /dev/null +++ b/doc/kcontrol/kcmhistory/index.docbook @@ -0,0 +1,87 @@ +<?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"> +]> + +<article id="history" lang="&language;"> +<title>History Sidebar</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Burkhard</firstname> +<surname> +Lück +</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2009</year> +<holder>Burkhard Lück</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>system settings</keyword> +<keyword>history</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="history-sidebard"> +<title>HIstory Sidebar</title> + +<para> +This dialog allows you to configure the history sidebar. +</para> + +<variablelist> +<varlistentry><term><guilabel>Limits</guilabel></term> +<listitem><para> +The options in this section can be used to set the maximum size of your history and set a time after which +items are automatically removed. +<!-- URLs expire after +Maximum number of URLs--> +</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Custom Fonts</guilabel></term> +<listitem><para> +Here you can also set different fonts for new and +old &URL;s by selecting the <guibutton>Choose Font</guibutton> button. +<!--URLs older than +URLs newer than--> +</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Details</guilabel></term> +<listitem><para> +The <guilabel>Detailed tooltips</guilabel> check box controls how much +information is displayed when you hover the mouse pointer over an item in the +history page.</para> +<para>If checked the number of times visited and the dates of the first and last +visits are shown, in addition to the URL.</para></listitem> +</varlistentry> + +</variablelist> + +<para>Selecting <guibutton>Clear History</guibutton> will +clear out the entire history. +</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmkded/CMakeLists.txt b/doc/kcontrol/kcmkded/CMakeLists.txt new file mode 100644 index 000000000..dadaba19e --- /dev/null +++ b/doc/kcontrol/kcmkded/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmkded ) diff --git a/doc/kcontrol/kcmkded/Makefile.am b/doc/kcontrol/kcmkded/Makefile.am new file mode 100644 index 000000000..c7b22c34e --- /dev/null +++ b/doc/kcontrol/kcmkded/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmkded diff --git a/doc/kcontrol/kcmkded/index.docbook b/doc/kcontrol/kcmkded/index.docbook new file mode 100644 index 000000000..10dc53b76 --- /dev/null +++ b/doc/kcontrol/kcmkded/index.docbook @@ -0,0 +1,79 @@ +<?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>Service Manager</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Burkhard</firstname><surname>Lück</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2009</year> +<holder>Burkhard Lück</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>System Settings</keyword> +<keyword>services</keyword> +</keywordset> +</articleinfo> + +<sect1 id="service-manager"> +<title>Service Manager</title> + +<para> +The <guilabel>Service Manager</guilabel> module allows you view all +plugins of the &tde; Daemon, also referred to as &tde; Services. Generally, +there are two types of services:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Load-on-Demand Services</guilabel></term> +<listitem><para> +This is a list of available &tde; services that will be started on demand. +They are only listed for convenience, as you cannot manipulate these +services. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Startup Services</guilabel></term> +<listitem><para> +This shows all &tde; services that can be loaded on &tde; startup. +Services checked in the <guilabel>Use</guilabel> column will be launched the next &tde; startup.</para> +<para>Be careful with deactivating unknown services as some services are vital for &tde;. Basically, +do not deactivate services when you do not know what you are doing. +</para> +<para>Change the <guilabel>Status</guilabel> of a service by selecting the service in the list. +Use the <guibutton>Start</guibutton> and <guibutton>Stop</guibutton> +to change the status of a service from <guilabel>Not running</guilabel> to <guilabel>Running</guilabel> +and vice versa. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmkonsole/CMakeLists.txt b/doc/kcontrol/kcmkonsole/CMakeLists.txt new file mode 100644 index 000000000..6847d04a2 --- /dev/null +++ b/doc/kcontrol/kcmkonsole/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmkonsole ) diff --git a/doc/kcontrol/kcmkonsole/Makefile.am b/doc/kcontrol/kcmkonsole/Makefile.am new file mode 100644 index 000000000..6b3d56240 --- /dev/null +++ b/doc/kcontrol/kcmkonsole/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmkonsole diff --git a/doc/kcontrol/kcmkonsole/index.docbook b/doc/kcontrol/kcmkonsole/index.docbook new file mode 100644 index 000000000..24208ded2 --- /dev/null +++ b/doc/kcontrol/kcmkonsole/index.docbook @@ -0,0 +1,246 @@ +<?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>&Jonathan.Singer; &Jonathan.Singer.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>konsole</keyword> +<keyword>terminal</keyword> +</keywordset> +</articleinfo> + +<sect1 id="konsole"> +<title>&konsole;</title> + +<para>In this module, you can configure basic settings for &konsole;, +the &tde; terminal. You can also easily create new schemata (appearance +files) for &konsole;.</para> + +<para>This module contains several tab pages: +<guilabel>General</guilabel>, <guilabel>Schema</guilabel>, +<guilabel>Session</guilabel> and <guilabel>Write +Daemon</guilabel>.</para> + +<sect2> +<title><guilabel>General</guilabel></title> + +<para>This tab page allows you to configure aspects of &konsole;'s +functions. It contains the following options:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Show Terminal Size when Resizing</guilabel></term> +<listitem> +<para>By default, &konsole; will show the size (in characters) of the +window when you are resizing, allowing you to make the window a +specific size. Uncheck this box to turn off this +behavior.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show Frame</guilabel></term> +<listitem> +<para>Draw an inner frame around the inside of the &konsole; window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Confirm quit when closing more than one session</guilabel></term> +<listitem> +<para>When set, a warning appears when you try to close a &konsole; +window with multiple sessions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Blinking Cursor</guilabel></term> +<listitem><para>If you have trouble spotting the cursor in the +&konsole; window, you can have it blink to draw your +attention.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Require Ctrl key for drag and drop</guilabel></term> +<listitem><para>If unchecked, you can drag and drop selected text by using the mouse. +If checked, the Ctrl key needs to be held down to allow drag and drop (this is +a good way to avoid erroneous drag and drop operations). +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Triple click selects only from the current word forward</guilabel></term> +<listitem><para>If checked, a mouse triple click will select everything from the +current cursor position to the end of the lime. If unchecked, a mouse triple click will select +the entire current row. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow programs to resize terminal window</guilabel></term> +<listitem><para>If checked, programs can resize the terminal window. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Use Ctrl+S/Ctrl+Q flow control</guilabel></term> +<listitem><para>If checked, Ctrl+S/Ctrl+Q can be used to control the flow of output +characters sent to the terminal. After pressing CTRL-S, the system will not send any +more data to the screen until a CTRL-Q is pressed. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable bidirectional text rendering</guilabel></term> +<listitem><para>If checked, text can be rendered from left to right or from right to left. +This is useful to support languages which are written in the second way. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Set tab title to match window title</guilabel></term> +<listitem><para>If checked, the title of the tab representing the current session will match +the text displayed on the window title bar. Whenever the window title changes, the tab +tile changes as well. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Cycle tabs with mouse wheel</guilabel></term> +<listitem><para>If checked, you can move through the different session tabs +using the mouse wheel over the tabbar control. If unchecked, the action is disabled. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable main menu accelerator keys</guilabel></term> +<listitem><para>If checked, the main menu shortcut keys are enabled, otherwise +they are disabled. +</para> +<note><para>If menu accelerators are enabled, some Alt-key combinations may not +be handled correctly any longer in Konsole applications.</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Handle Meta key as Alt Key</guilabel></term> +<listitem><para>If checked, the Meta key will be handled as if it was an Alt key. +</para> +<note><para>This is a useful option if you have enabled the main menu shortcut keys. +You can use the Meta key to activate those Alt-key combinations that otherwise +would not work any longer in Konsole.</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Line Spacing</guilabel></term> +<listitem><para>Change the space between lines of text.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Seconds to detect silence</guilabel></term> +<listitem><para>Allows to specify the time interval used for monitoring the +Konsole for silence. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Consider the following characters part of a word when +double clicking</guilabel></term> +<listitem><para>It is a common &UNIX; behavior to select a whole word +when you double click on it, however, the computer's idea of a word may +differ from yours. Add characters here that you would like to be +considered always to be <quote>part of a word</quote>. For example, +adding the <literal>@</literal> character will allow you to double +click to select an entire email address.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>Schema</title> + +<para>The <guilabel>Schema</guilabel> page will allow you to easily +create, edit and save schemata, with text and background coloring, +transparency and background images.</para> + + +<!-- +<variablelist> +<varlistentry> +<term><guilabel>Font</guilabel></term> +<listitem> +<para>Use the drop-down box to select the default font size. Use the +<guibutton>Custom...</guibutton> button to select your own combination +of font, size, and style.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Full Screen</guilabel></term> +<listitem> +<para>Check the box to make &konsole; windows full-screen by +default.</para> +</listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Bars</guilabel></term> +<listitem> + +<variablelist> +<varlistentry> +<term><guilabel>Show menubar</guilabel></term> +<listitem> +<para>Check to show the menubar by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show toolbar</guilabel></term> +<listitem> +<para>Check to show the toolbar by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show frame</guilabel></term> +<listitem> +<para>Check to show the frame by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Scrollbar position</guilabel></term> +<listitem> +<para>Select the default position of the scrollbar: +<guilabel>Hide</guilabel> (no scrollbar), <guilabel>Left</guilabel>, or +<guilabel>Right</guilabel>.</para> +</listitem> +</varlistentry> +</variablelist> +--> +</sect2> + +</sect1> +</article>
\ No newline at end of file diff --git a/doc/kcontrol/kcmlaunch/CMakeLists.txt b/doc/kcontrol/kcmlaunch/CMakeLists.txt new file mode 100644 index 000000000..c0a06a2a7 --- /dev/null +++ b/doc/kcontrol/kcmlaunch/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmlaunch ) diff --git a/doc/kcontrol/kcmlaunch/Makefile.am b/doc/kcontrol/kcmlaunch/Makefile.am new file mode 100644 index 000000000..f6c3bce75 --- /dev/null +++ b/doc/kcontrol/kcmlaunch/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmlaunch diff --git a/doc/kcontrol/kcmlaunch/index.docbook b/doc/kcontrol/kcmlaunch/index.docbook new file mode 100644 index 000000000..dd629cae3 --- /dev/null +++ b/doc/kcontrol/kcmlaunch/index.docbook @@ -0,0 +1,70 @@ +<?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>2006-06-24</date> +<releaseinfo>3.5.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>launch feedback</keyword> +<keyword>cursor</keyword> +<keyword>busy</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="launch-feedback"> +<title><guilabel>Launch Feedback</guilabel></title> + +<para>Sometimes it is reassuring to know that your computer didn't just +ignore your command, and something is happening behind the scenes. In +this module you can configure visible feedback to help you know if you +really hit that icon or not.</para> + +<para>The traditional way to indicate that your computer is busy is to +modify the cursor, and you can turn this on by choosing a +<guilabel>Busy Cursor</guilabel>.</para> + +<para>With this option enabled, your cursor will have an icon attached +to it for a short time, when a new application is being launched. You +can configure how long this icon is displayed beside your cursor with the +<guilabel>Startup indication timeout:</guilabel> spinbox. The +default is 30 seconds.</para> + +<para>There are several variations of busy cursor available, including +a <guilabel>Blinking Cursor</guilabel>, a <guilabel>Bouncing Cursor</guilabel> +or a <guilabel>Passive Busy Cursor</guilabel> icon with no animation.</para> + +<para>Traditional &tde; launch notification has taken another form, +which you can also enable and disable here. Normally when you start an +application, it gets an immediate entry in the taskbar, with the icon +replaced by a spinning hourglass to let you know something is +happening. You can toggle this behavior on and off with the +<guilabel>Enable taskbar notification</guilabel> checkbox, and when it's +enabled, you can set a time in the <guilabel>Startup indication timeout +:</guilabel> spinbox.</para> + +<para>Not all applications that you start will eventually show a +window, or an entry in the taskbar. Some of them, for example, are +docked into the &tde; system tray. Alternatively, it might be that you +sent it off to a different virtual desktop, and <guilabel>Show windows +from all desktops</guilabel> is unchecked in the &kcontrolcenter; module +<guimenuitem>Taskbar</guimenuitem>. Setting a timeout ensures that, +even in these cases, you can still get launch feedback, but also that +it will go away when the job is done.</para> + +</sect1> +</article>
\ No newline at end of file diff --git a/doc/kcontrol/kcmnotify/CMakeLists.txt b/doc/kcontrol/kcmnotify/CMakeLists.txt new file mode 100644 index 000000000..7b75ad07e --- /dev/null +++ b/doc/kcontrol/kcmnotify/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmnotify ) diff --git a/doc/kcontrol/kcmnotify/Makefile.am b/doc/kcontrol/kcmnotify/Makefile.am new file mode 100644 index 000000000..40efdecdc --- /dev/null +++ b/doc/kcontrol/kcmnotify/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmnotify diff --git a/doc/kcontrol/kcmnotify/index.docbook b/doc/kcontrol/kcmnotify/index.docbook new file mode 100644 index 000000000..581db52dd --- /dev/null +++ b/doc/kcontrol/kcmnotify/index.docbook @@ -0,0 +1,151 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-03-04</date> +<releaseinfo>3.4.0</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>system notification</keyword> +<keyword>notification</keyword> +</keywordset> +</articleinfo> + +<sect1 id="sys-notify"> +<title>System Notification Settings</title> + +<para>&tde;, like all applications, needs to inform the user when a +problem occurs, a task is completed, or something has happened. &tde; +uses a set of <quote>System Notifications</quote> to keep the user +informed on what is happening.</para> + +<para>Using this module, you can determine what &tde; does to communicate +each event.</para> + +<para>The panel consists of a large list of specific events which need +to be communicated to the user. This list is organized into groups by applications.</para> + +<para>To configure a notification, simply select the application from the drop down box at the top +of the dialog labeled <guilabel>Event source:</guilabel>. This will lead to a list of +all configurable notifications for the application. The list of notifications includes 6 columns to +the left of the notification name. These columns (from left to right) are:</para> + +<variablelist> +<varlistentry> +<term><guiicon>Execute a program</guiicon></term> +<listitem><para>If an icon is present in this column, a seperate program will be executed when this notification is performed. This can be used to execute a program to help restore data, shutdown a potentially compromised system or email another user to alert them to a problem.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Print to standard error output</guiicon></term> +<listitem><para>If an icon is present in this column, &tde; will send a message to the computers standard output.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Display a message box</guiicon></term> +<listitem><para>If an icon is present in this column, &tde; will open a message box and inform the user of the notification. This is probably the most commonly selected option for alerting users to an error.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Log to a file</guiicon></term> +<listitem><para>If an icon is present in this column, &tde; will write certain information to a file on disk for later retrieval. This is useful for tracking problems or important system changes.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Play a sound</guiicon></term> +<listitem><para>This does exactly what you think it does. If an icon is present in this column, &tde; will play a specific sound over the speakers. This is commonly used by games in &tde; for starting a new game, or other action within the game.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guiicon>Flash the taskbar entry</guiicon></term> +<listitem><para>If an icon is present in this column, &tde; will cause the taskbar to flash until the user has clicked the taskbar entry. This is most useful when you want the user to look at the program (such as a new email message was received, or the users name was said on an IRC channel).</para></listitem> +</varlistentry> +</variablelist> + +<sect2><title>Change a single notification</title> +<para>To make a change to a notification, click on the name of the notification once with the &LMB;. The notification will be highlighted. +Now click on the button labeled +<guibutton>More options</guibutton> so you can see all the checkboxes.</para> + +<tip><para>You can have more than one event triggered by a single notification. As an example, it is easy to have a sound played and +a message box appear in response to a system notification. One notification does not prevent other notifications from operating.</para></tip> +<para>The following list details each of the notification types and how to use them.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Play a sound</guilabel></term> +<listitem><para>If a mark is in this checkbox, &tde; will play a sound everytime this notification is initiated. To specify the sound, use the text box to the right of the checkbox to enter the folder location of the sound file you want &tde; to play. You can use the folder button (located to the far right of the dialog box) to browse your directory tree. To hear a test of your sound, simply click on the play button (small button directly to the right of <guilabel>Play a sound</guilabel>.)</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Log to a file</guilabel></term> +<listitem><para>If a mark is in this checkbox, &tde; will write certain information to a file on disk for later retrieval. To specify the log file to use, enter the pathname in the text box to the right of the checkbox. You can use the folder button (located to the far right of the dialog box) to browse your directory tree.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Execute a program</guilabel></term> +<listitem><para>If a mark is in this checkbox, a separate program will be executed when this notification is performed. To specify the program to execute, enter the pathname in the text box to the right of the checkbox. You can use the folder button (located to the far right of the dialog box) to browse your directory tree.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show a message in a pop up window</guilabel></term> +<listitem><para>If a mark is in this checkbox, &tde; will open a message box and inform the user of the notification. The text of the box can not be changed from this dialog. If you place a mark in the checkbox labeled <guilabel>Use a passive window that does not interrupt other work</guilabel>, &tde; will open the message box, but it will not change desktops and the message box will not appear until the user returns to the program sending the notification. If that box is left empty, the user must respond to the message box even if it means they have to stop working on another program.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Print a message to standard error output</guilabel></term> +<listitem><para>If a mark is in this checkbox, &tde; will send a message to the computer's standard output.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mark taskbar entry</guilabel></term> +<listitem><para>If a mark is in this checkbox, &tde; will cause the taskbar of the program sending the notification to flash until the user has clicked the taskbar entry.</para></listitem> +</varlistentry> +</variablelist> + +<tip><para>You can use the icon columns (located to the left of the notifications) to quickly select or deselect the options. Clicking in the column with the &LMB; will toggle the notification on and off.</para></tip> + +</sect2> +<sect2><title>Change all notifications in all &tde; applications</title> +<para>You can alter more than one notification at a time by using the section of the dialog labeled <guilabel>Quick Controls</guilabel>.</para> +<para>The first item in this section is a checkbox labeled <guilabel>Apply to all applications</guilabel>. If there is a mark in this checkbox, any changes made in the <guilabel>Quick Controls</guilabel> area are applied to all applications (not just the selected application). If there is no mark in this checkbox, any changes are limited to the application selected at the top of the dialog.</para> +<para>The next line consists of a button and a drop down box. This is used to enable every notification of a single type. Simply select the notification type from the drop down box (on the right) and click the button labeled <guibutton>Turn On All</guibutton>. This will enable all notifications of that type.</para> +<para>The bottom line operates the same, but when you select the button labeled <guibutton>Turn Off All</guibutton>, all the notifications of the selected type will be disabled.</para> +</sect2> +<sect2><title>Change sound player options</title> +<para>If you click the button labeled <guibutton>Player settings</guibutton>, a small dialog box will appear with three radio buttons:</para> +<variablelist> +<varlistentry> +<term><guilabel>Use the &tde; sound system</guilabel></term> +<listitem><para>If a mark is in this radio button, &tde; will play all sound notifications through the &tde; sound system (&arts;). You can adjust the volume of system notifications using the slider.</para> +<note><para>The slider only affects &tde; system notifications. Changes to this slider will not affect other sounds on your computer.</para></note></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Use external player</guilabel></term> +<listitem><para>If a mark is in this radio button, &tde; will not use the &tde; sound system to play the sound. This is a good choice if the sound format you want to use is not supported by the &tde; notification system or if you don't use the &arts; sound daemon. After checking the radio box, enter the full path and name of the program you want to use into the text field. You can use the folder button (located along the right side) to browse the directory tree.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>No audio output</guilabel></term> +<listitem><para>Disables all sound notifications.</para></listitem> +</varlistentry> +</variablelist> +<para>When you have made your selection, click <guibutton>Apply</guibutton> to save changes but keep the dialog box open. Click +<guibutton>OK</guibutton> to save changes and close dialog box. Click <guibutton>Cancel</guibutton> to close the dialog box without +making any changes.</para> +</sect2> +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/kcmsmserver/CMakeLists.txt b/doc/kcontrol/kcmsmserver/CMakeLists.txt new file mode 100644 index 000000000..7b0ef8ec8 --- /dev/null +++ b/doc/kcontrol/kcmsmserver/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmsmserver ) diff --git a/doc/kcontrol/kcmsmserver/Makefile.am b/doc/kcontrol/kcmsmserver/Makefile.am new file mode 100644 index 000000000..cf4388a52 --- /dev/null +++ b/doc/kcontrol/kcmsmserver/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmsmserver diff --git a/doc/kcontrol/kcmsmserver/index.docbook b/doc/kcontrol/kcmsmserver/index.docbook new file mode 100644 index 000000000..ebd132346 --- /dev/null +++ b/doc/kcontrol/kcmsmserver/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>&Jost.Schenck; &Jost.Schenck.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-13</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>session</keyword> +</keywordset> +</articleinfo> + +<sect1 id="sessions"> +<title>Session Manager</title> + +<sect2 id="sessions-use"> +<title>Use</title> + +<para>In this control module you can configure &tde;'s session +manager.</para> + +<para>Session management refers to &tde;'s ability to save the state +of applications and windows when you log out of &tde; and restore them +when you log back in.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Confirm logout</guilabel></term> +<listitem> +<para>If this option is checked, when logging out, &tde; will display a +dialog asking for confirmation. In this dialog you can also choose +whether you want to restore your current session when you login the next +time.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Offer shutdown options</guilabel></term> +<listitem> +<para>If this option is checked, &tde; will offer a choice of actions during +logout. These include simply ending the current session (the +action performed if shutdown options are not enabled) turning off the +computer, or restarting the computer.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You may choose one of three options on what should happen when +you log into &tde;:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Restore previous session</guilabel></term> +<listitem><para>If this option is checked, &tde; will save your current +session's state when you logout. &tde; will restore your session on the +next login, so you can continue to work with a desktop just like you +left it.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Restore manually saved session</guilabel></term> +<listitem><para>Instead of restoring &tde; to the state it was when +you logged out last, it will be restored to a specific state that you +have saved manually. <!-- FIXME: How do you *save* the session in the +first place? --></para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Start with an empty session</guilabel></term> +<listitem> +<para>If you choose this option, &tde; will never restore sessions that it has saved.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>You can configure what should happen by default when you log out of +&tde;. These options are not possible on all operating systems, and some of +them may not appear unless you are using &tdm; as your login manager.</para> + +<para>The options available are self explanatory, if you are in doubt, +leave the default settings. They are:</para> + +<itemizedlist> +<listitem><para><guilabel>End current session</guilabel> (this is the default)</para></listitem> +<listitem><para><guilabel>Turn off computer</guilabel></para></listitem> +<listitem><para><guilabel>Restart computer</guilabel></para></listitem> +</itemizedlist> + +<para>Finally, you can enter a colon (<literal>:</literal>) +separated list of applications that should not be saved in sessions, +and therefore won't be started when restoring a session. For example +<userinput>xterm:konsole</userinput>.</para> + +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/kcmstyle/CMakeLists.txt b/doc/kcontrol/kcmstyle/CMakeLists.txt new file mode 100644 index 000000000..98077a743 --- /dev/null +++ b/doc/kcontrol/kcmstyle/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kcmstyle ) diff --git a/doc/kcontrol/kcmstyle/Makefile.am b/doc/kcontrol/kcmstyle/Makefile.am new file mode 100644 index 000000000..067f33e6c --- /dev/null +++ b/doc/kcontrol/kcmstyle/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmstyle diff --git a/doc/kcontrol/kcmstyle/index.docbook b/doc/kcontrol/kcmstyle/index.docbook new file mode 100644 index 000000000..f71599c97 --- /dev/null +++ b/doc/kcontrol/kcmstyle/index.docbook @@ -0,0 +1,189 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-20</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>style</keyword> +</keywordset> +</articleinfo> +<sect1 id="style"> +<title>Style</title> + +<sect2 id="style-intro"> +<title>Introduction</title> + +<para>This module is used to configure how the individual widgets are +drawn by &tde;.</para> + +<note><para>A <emphasis>Widget</emphasis> is a commonly-used +programmer's term for referring to User Interface elements such as +buttons, menus, and scroll bars. You can think of them as the +fundamental pieces that are assembled to make your +application.</para></note> + +<para>You can configure how the widgets are drawn with this module, +but to change the color of the widgets, you should refer to the +section entitled <ulink +url="help:/kcontrol/color/index.html">Colors</ulink>.</para> + +<para>This panel is divided into three tabs: <guilabel>Style</guilabel>, +<guilabel>Effects</guilabel>, <guilabel>Toolbar</guilabel>.</para> + +</sect2> + +<sect2 id="style-style"> +<title><guilabel>Style</guilabel> tab</title> + +<para>The top list box, labeled <guilabel>Widget Style</guilabel> +contains a list of the pre-defined styles. +Each style has a name, and a brief description.</para> + +<para>To change styles, simply click on the style name, and a preview +of the style will be displayed in the preview box below the style list.</para> + +<para>The other options available here are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Show icons on buttons</guilabel></term> +<listitem> +<para>If this option is selected, action buttons (like <guibutton>OK</guibutton> and +<guibutton>Apply</guibutton>) will have a small icon located within them to act +as a visual reference. If this option is not selected, then only text +will appear on the button.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable tooltips</guilabel></term> +<listitem> +<para>This will toggle tooltips off and on.</para> +</listitem> +</varlistentry> +</variablelist> +<!-- +<varlistentry> +<term><guilabel>Menubar on the top of +the screen in the style of MacOS</guilabel></term> +<listitem> +<para>This will turn on a menubar at the top of the screen. +This menubar will reflect the menu options of the active +application.</para> +</listitem> +</varlistentry> +</variablelist> +--> +</sect2> + +<sect2 id="style-effects"> +<title><guilabel>Effects</guilabel> tab</title> + +<para>If you click on the <guilabel>Effects</guilabel> tab, you will see the panel is divided +into two sections.</para> +<para>At the top of the first section, is a checkbox labeled <guilabel>Enable +GUI effects</guilabel>. If there is no mark in front of this checkbox, then all +visual effects of this panel are disabled. To edit any of these effects, simply +place a mark in this checkbox.</para> + +<para>Below that checkbox, are the following choices: </para> +<variablelist> +<varlistentry> +<term><guilabel>Combobox effect:</guilabel></term> +<listitem><para>This combobox has two options. If this option is set to <guilabel>Animate</guilabel> +then when a combo box is selected, it will appear to scroll down. If <guilabel>Disable</guilabel> +is selected, then the combobox list appears instantly.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Tool tip effect:</guilabel></term> +<listitem><para>This combobox has three options. If this option is set to <guilabel>Animate</guilabel> +then when a tool tip appears, it will have a short animation. If <guilabel>Fade</guilabel> is +selected, the tool tip appears to fade from the background. If <guilabel>Disable</guilabel> +is selected, then the tool tip appears instantly.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Menu effect:</guilabel></term> +<listitem><para>This combobox has four options. If this option is set to <guilabel>Animate</guilabel> +then when a menu list appears, it will appear to scroll downward. If <guilabel>Fade</guilabel> is +selected, the menu list appears to fade from the background. If <guilabel>Make Transparent</guilabel> +is selected, the menu list will have a transparent look to it. The details of that transparency is +configured in the next part of the dialog. If <guilabel>Disable</guilabel> +is selected, then the menu list appears instantly.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Menu tear-off handles:</guilabel></term> +<listitem><para>If this option is set to <guilabel>Disable</guilabel>, then no menus can be separated +from the application. If <guilabel>Application Level</guilabel> is selected, then it is left up +to each individual application to determine which menus can be torn separated from the application.</para> +<note><para>Many applications do not have tear off menus. You cannot tell &tde; to force an +application to allow tear off menus. This is determined by the authors of the application.</para></note></listitem> +</varlistentry> +</variablelist> + +<para>The next checkbox, labeled <guilabel>Menu drop shadow</guilabel> is used to toggle the drop shadow behind all +&tde; menus. A drop shadow is a dark, soft line on the bottom and right sides of the menu, which give the menus the +appearance that the menu is lifted off the application, and the menu is creating a shadow on the application.</para> + +<para>The next section only applies if the combobox labeled <guilabel>Menu Effect</guilabel> is set to +<guilabel>Make Transparent</guilabel>. You can use the combo box labeled <guilabel>Menu transparency type:</guilabel> +to select the method &tde; uses to generate the transparency. You can use the slider to determine the level of +transparency in menus. A preview is visible on the right side of this section.</para> + +</sect2> + +<sect2 id="style-misc"> +<title><guilabel>Toolbar</guilabel> tab</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Highlight buttons under mouse.</guilabel></term> +<listitem> +<para>If there is a mark in this checkbox, when the mouse pointer is above a toolbar +button, that button will be highlighted with a square around the button. This is a good visual +indicator of which button will be selected with a mouse click.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Transparent toolbars when moving</guilabel></term> +<listitem> +<para>As the title suggests, if this option is selected, the toolbars will be transparent when +you are moving them around on the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Text position</guilabel></term> +<listitem> +<para>This combo box lets you determine where on the button the text name of the button will appear as the default. +If <guilabel>Icon Only</guilabel> is selected, then there is no text on the toolbar buttons. If <guilabel>Text Only</guilabel> is selected, then the button's icon is replaced with a text name of the button. If <guilabel>Text Alongside Icons</guilabel> is selected, then the name of the button will be placed to the <emphasis>right</emphasis> of the icon. If <guilabel>Text Under Icons</guilabel> is selected, the default will be to have the text of the button <emphasis>below</emphasis> the icon.</para> +<tip><para>This option only specifies the <emphasis>default</emphasis> location. Each application can override the setting used in this panel.</para></tip> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/keyboard/CMakeLists.txt b/doc/kcontrol/keyboard/CMakeLists.txt new file mode 100644 index 000000000..08d08812d --- /dev/null +++ b/doc/kcontrol/keyboard/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/keyboard ) diff --git a/doc/kcontrol/keyboard/Makefile.am b/doc/kcontrol/keyboard/Makefile.am new file mode 100644 index 000000000..16b3221e1 --- /dev/null +++ b/doc/kcontrol/keyboard/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/keyboard diff --git a/doc/kcontrol/keyboard/index.docbook b/doc/kcontrol/keyboard/index.docbook new file mode 100644 index 000000000..5296e2b9d --- /dev/null +++ b/doc/kcontrol/keyboard/index.docbook @@ -0,0 +1,90 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>keyboard</keyword> +</keywordset> +</articleinfo> +<sect1 id="kbd"> +<title>Keyboard</title> + +<para>This module allows you to choose how your keyboard works.</para> + +<para>The actual effect of setting these options depends upon the +features provided by your keyboard hardware and the X server on which +&tde; is running. As an example, you may find that changing the key +click volume has no effect because that feature is not available on your +system.</para> + +<sect2 id="kbd-use"> +<title>Advanced</title> + +<variablelist> +<varlistentry> +<term><guilabel>Enable keyboard repeat</guilabel></term> +<listitem> +<para>When this option is selected, pressing and holding down a key +emits the same character repeatedly until the key is released. Pressing +and holding the key will have the same effect as pressing it multiple +times in succession.</para> +<tip><para> Almost all users will want to have this option enabled, because it +makes navigating through documents with the arrow keys significantly +easier.</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>NumLock on TDE Startup</guilabel></term> +<listitem> +<para>You can choose to either always <guilabel>Turn on</guilabel> or +<guilabel>Turn off</guilabel> the NumLock when &tde; starts, or you can +choose to have &tde; leave NumLock at whatever it was set to before TDE +started up.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guilabel>Key click volume:</guilabel></term> +<listitem> +<para>If supported, this option allows you to hear audible clicks from +your computer's speakers when you press the keys on your keyboard. In +essence, this simulates the <quote>click</quote> of a mechanical +type-writer. You can change the loudness of the key click feedback by +dragging the slider button or by clicking the up/down arrows on the +spin-button. Setting the volume to 0% turns off the key +click.</para> +<para>Many computers won't support this function.</para> +<tip><para>Very few people would choose to enable this option, since it +generally annoys everyone else in the room. However, if your heart +yearns for the pre-soft-key era, this may help you to re-experience the +warm sentimentality of days-gone-by.</para> +</tip> +</listitem> +</varlistentry> + + +</variablelist> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/keys/CMakeLists.txt b/doc/kcontrol/keys/CMakeLists.txt new file mode 100644 index 000000000..06cf76aae --- /dev/null +++ b/doc/kcontrol/keys/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/keys ) diff --git a/doc/kcontrol/keys/Makefile.am b/doc/kcontrol/keys/Makefile.am new file mode 100644 index 000000000..5b4b56825 --- /dev/null +++ b/doc/kcontrol/keys/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/keys diff --git a/doc/kcontrol/keys/index.docbook b/doc/kcontrol/keys/index.docbook new file mode 100644 index 000000000..3aa32d659 --- /dev/null +++ b/doc/kcontrol/keys/index.docbook @@ -0,0 +1,191 @@ +<?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-13</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>key bindings</keyword> +<keyword>bindings</keyword> +<keyword>shortcuts</keyword> +</keywordset> +</articleinfo> + +<sect1 id="key-bindings"> +<title>Shortcuts</title> + +<sect2 id="key-bindings-intro"> +<title>Introduction</title> + +<para>While most of the functionality offered by &tde; can be accessed +using a simple <quote>point and click</quote> interface, many people +prefer using the keyboard for some tasks. Pressing something like +<keycombo action="simul"> &Ctrl;<keycap>F</keycap></keycombo> is often +just faster than moving your hands off the keyboard to the mouse, +opening the <guimenu>Edit</guimenu> menu and selecting +<guimenuitem>Find</guimenuitem>.</para> + +<para> As different people have different preferences about keyboard +shortcuts, &tde; offers full customization of <quote>key +bindings.</quote> A key binding or shortcut is a combination of an +action with a key or a combination of keys.</para> + +</sect2> + +<sect2 id="key-bindings-use"> +<title>Use</title> + +<para>In the Shortcuts control module you'll see a list of <quote>key +schemes,</quote> a list of key bindings in the currently selected +scheme and a frame where you can customize the currently selected key +binding. Also, you'll see a tab for <guilabel>Global +shortcuts</guilabel> and one for <guilabel>Application +shortcuts</guilabel>.</para> + +<sect3 id="key-bindings-use-globapp"> +<title>Global Shortcuts and Application Shortcuts</title> + +<para><guilabel>Global shortcuts</guilabel> and <guilabel>application +shortcuts</guilabel> work just the same. Actually, in a certain way +application shortcuts are <quote>global</quote> as well. The only +difference is:</para> + +<itemizedlist> +<listitem><para><quote>Global shortcuts</quote> are shortcuts for +actions that make sense even when no application is opened. These +shortcuts usually refer to actions like switching desktops, manipulating +windows etc.</para></listitem> +<listitem><para><quote>Application shortcuts</quote> refer to actions +that are often available in applications, such as Save, Print, Copy +etc.</para></listitem> +</itemizedlist> + +<para>Please note, that the application shortcuts configured here are +<emphasis>only</emphasis> the standard actions often found in +applications. Most applications will define their own actions as well, +for which you have to customize key bindings using the application's +key bindings dialog.</para> + +</sect3> + +<sect3 id="key-bindings-use-confkeys"> +<title>Configuring Key Bindings</title> + +<para>Configuring key bindings is pretty easy. In the middle of the +key bindings control module you'll find a list of available +actions. If there's a key binding configured for that action you'll +find it right next to it. Just select the action you want to +configure.</para> + +<para>After you've selected an action you'll notice that most of the +controls below the action list are enabled. There you can configure a +combination of keys or maybe no key binding at all for the selected +action.</para> + +<itemizedlist> +<listitem><para><guilabel>No key</guilabel>: the selected action will not +be associated with any key.</para></listitem> + +<listitem><para><guilabel>Default key</guilabel>: the selected action +will be associated with &tde;'s default value. This is a good choice +for most actions, as &tde; comes with reasonable key bindings we have +thought about.</para></listitem> + +<listitem><para><guilabel>Custom key</guilabel>: if this option is +enabled, you can create a key combination for the selected +action. Just select any modifiers (&ie; &Shift;, &Ctrl;, or &Alt;) and +then select a key: just click on the key symbol and after that press +the key you want to assign to this key combination.</para></listitem> + +</itemizedlist> + +<para>As with all control modules, your changes won't take in effect +until you click <guibutton>OK</guibutton> or +<guibutton>Apply</guibutton>. Click <guibutton>Cancel</guibutton> to +discard all changes.</para> + +</sect3> + +<sect3 id="key-bindings-use-confschemes"> +<title>Configuring Schemes</title> + +<para>A key binding scheme is a set of key bindings that you can +select by name. &tde; comes with several pre-defined key binding +schemes. In addition to these bundled schemes, you will always see a scheme named +<guilabel>Current scheme</guilabel> that represents the set of key +bindings you are using right now (&ie; not the current settings you +are playing with, but what you've been using up to now).</para> + +<para>When you are playing with the key bindings for the first time +you don't have to be afraid of changing the default bindings: &tde; +won't let you overwrite the defaults, so you can always switch back to +the factory presets. By choosing <guilabel>Current scheme</guilabel> +you can return to the set of key bindings you've been using up to +now. However, be careful not to select a scheme when you've made +changes to the key bindings you don't want to lose.</para> + +<para>When you are satisfied with a set of key bindings you've +created, you may want to save them to a scheme of your own, so that +you can still experiment with the bindings and always return to a +certain scheme. You can always do this by clicking on the +<guibutton>Add</guibutton> button. You will be prompted for a name +and then the new scheme will appear in the key schemes listbox. You +can remove your own schemes again by selecting a scheme and clicking +the <guibutton>Remove</guibutton> button. Click the <guibutton>Save +changes</guibutton> button to save any changes you have made to the +currently selected scheme. Note that you can not remove or save +changes to <guilabel>KDE default</guilabel> or to <guilabel>Current +scheme</guilabel>.</para> + +<important><para>If you want to save your changes while a read-only +scheme is selected, you always have to add a new scheme first! If you +select one of your own schemes because you want to save the changes to +that one, the control module will switch to the key bindings of that +scheme, discarding your changes.</para></important> </sect3> + +</sect2> + +<sect2 id="key-bindings-modifiers"> +<title>Modifier Keys</title> + +<para>Different keyboards offer different sets of modifier keys. A +&Mac; keyboard, for example, does not have a &Ctrl; key, and instead +has an <keycap>Option</keycap> key. Here you can see what the +available modifier keys for the current keyboard are.</para> + +<para>If you enable <guilabel>Macintosh keyboard</guilabel> the list +of modifiers will change.</para> + +<para>If you have enabled the &Mac; keyboard, you can further enable +<guilabel>MacOS-style modifier usage</guilabel>, to make &tde; behave +more like &MacOS;.</para><!-- FIXME: well, that's rather non-explanatory, more here would be good --> + +<para>Finally, you can change what a keypress sends to the &X-Server; +in the <guilabel>X Modifier Mapping</guilabel> section. A common +example is to reconfigure the <keycap>Caps Lock</keycap> key, which is +rarely used, to be another &Ctrl; key. This is especially nice if you +are a touch typist, as <keycap>Caps Lock</keycap> is much easier to +reach than either of the &Ctrl; keys on a standard keyboard.</para> + +<!-- FIXME: what exactly is going on here... --> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/khotkeys/CMakeLists.txt b/doc/kcontrol/khotkeys/CMakeLists.txt new file mode 100644 index 000000000..794c8b9ca --- /dev/null +++ b/doc/kcontrol/khotkeys/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/khotkeys ) diff --git a/doc/kcontrol/khotkeys/Makefile.am b/doc/kcontrol/khotkeys/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/khotkeys/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/khotkeys/index.docbook b/doc/kcontrol/khotkeys/index.docbook new file mode 100644 index 000000000..8856aac71 --- /dev/null +++ b/doc/kcontrol/khotkeys/index.docbook @@ -0,0 +1,57 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>Input Actions</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the Input Actions module. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>storage</keyword> +<keyword>media</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/kthememanager/CMakeLists.txt b/doc/kcontrol/kthememanager/CMakeLists.txt new file mode 100644 index 000000000..957dcf820 --- /dev/null +++ b/doc/kcontrol/kthememanager/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/kthememanager ) diff --git a/doc/kcontrol/kthememanager/Makefile.am b/doc/kcontrol/kthememanager/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/kthememanager/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/kthememanager/index.docbook b/doc/kcontrol/kthememanager/index.docbook new file mode 100644 index 000000000..d9525a528 --- /dev/null +++ b/doc/kcontrol/kthememanager/index.docbook @@ -0,0 +1,128 @@ +<?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"> +]> + +<article lang="&language;"> + +<articleinfo> +<title>Theme Manager</title> + +<authorgroup> +<author> +<firstname>Andrew</firstname> +<surname>Lake</surname></author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2010</year> +<holder>Andrew Lake</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>System Settings</keyword> +<keyword>desktop</keyword> +<keyword>theme</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="thememanager"> +<title>Theme Manager</title> + +<sect2 id="thememanager-introduction"> +<title>Introduction</title> + +<para>Use this module to customize your desktop theme and to replace theme items +with items from other themes or from files.</para> + +<para>A &tde; desktop theme uses several components or items. Desktop theme components +include the background, colors, widget style, icons, fonts, and the screen saver.</para> + +<para>This module supports four basic functions: 1) applying themes, 2) installing themes, +3) creating new themes, and 4) removing themes.</para> + +</sect2> + +<sect2 id="thememanager-applytheme"> +<title>Apply A Theme</title> + +<para>In the <guibutton>Themes</guibutton> list box on the left is a list of premade +themes currently available on your computer. Use different themes by selecting themes +in the list and then selecting the <guibutton>Apply</guibutton> button.</para> + +<para>When selecting a theme, a preview image will appear to the right of the list.</para> + +<warning><para>Testing and creating new themes is fun but do know that themes are comprehensive +changes to the desktop. When applying a new theme, many related options are not restored +when reverting to the previous theme. Generally this is not important to many users who +accept all components of a theme, but to those who like to customize the desktop using +individual features, installing new themes will override many desktop customizations. +To avoid this result requires 1) saving the existing settings as a new theme, 2) manually +configuring and testing each setting one at a time, or 3) using a backup copy of your Trinity +profile directory ($TDEHOME, normally $HOME/.trinity).</para></warning> + +<para>Select the <guibutton>Apply</guibutton> button to make the selection permanent.</para> + +</sect2> + +<sect2 id="thememanager-installnewtheme"> +<title>Install A Theme</title> + +<para>Use the <guilabel>Get new themes...</guilabel> link in the top right corner to download +additional themes from the Internet.</para> + +<para>Use the <guibutton>Install New Theme...</guibutton> button to install new themes +downloaded or copied to your computer but not yet seen in the Themes list box. Using this +option installs themes to your user profile directory. After installing the theme then will +be listed in the <guibutton>Themes</guibutton> list box.</para> + +<note><para>Using the link only downloads the themes to your computer. Use the <guibutton>Install New Theme...</guibutton> button to install the themes to your user profile directory ($TDEHOME).</para></note> + +<para>When the new themes are in the <guibutton>Themes</guibutton> list box, select the theme and +then select the <guibutton>Apply</guibutton> button to make the selection permanent.</para> + +</sect2> + +<sect2 id="thememanager-createnewtheme"> +<title>Create A New Theme</title> + +<para>From the <guibutton>Themes</guibutton> list box, select a theme to be used as a base theme.</para> + +<para>Next use the <guibutton>Create New Theme...</guibutton> button to provide the new theme a name.</para> + +<para>Then use the big buttons at the bottom of the module to customize the items you want to change. +You can change the background, colors, widget style, icons, fonts, and the screen saver.</para> + +<para>After creating your new masterpiece, select the <guibutton>Apply</guibutton> +button to make the selection permanent.</para> + +</sect2> + +<sect2 id="thememanager-removetheme"> +<title>Remove A Theme</title> + +<para>From the <guibutton>Themes</guibutton> list box, select a custom theme to remove.</para> + +<note><para>The default system themes installed with &tde; cannot be removed.</para></note> + +<para>When the theme is selected the <guibutton>Remove Theme</guibutton> +button will be enabled. Select the <guibutton>Remove Theme</guibutton> button. A confirmation dialog appears. Select the <guibutton>OK</guibutton> button.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/language/CMakeLists.txt b/doc/kcontrol/language/CMakeLists.txt new file mode 100644 index 000000000..d0546b391 --- /dev/null +++ b/doc/kcontrol/language/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/language ) diff --git a/doc/kcontrol/language/Makefile.am b/doc/kcontrol/language/Makefile.am new file mode 100644 index 000000000..ab4abf365 --- /dev/null +++ b/doc/kcontrol/language/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/language diff --git a/doc/kcontrol/language/index.docbook b/doc/kcontrol/language/index.docbook new file mode 100644 index 000000000..3dd68a29f --- /dev/null +++ b/doc/kcontrol/language/index.docbook @@ -0,0 +1,218 @@ +<?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;"> +<sect1 id="locale"> + +<sect1info> +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + </authorgroup> + + <date>2003-10-14</date> + <releaseinfo>3.2</releaseinfo> + + <keywordset> + <keyword>KDE</keyword> + <keyword>KControl</keyword> + <keyword>locale</keyword> + <keyword>country</keyword> + <keyword>language</keyword> + </keywordset> + + </sect1info> + + +<title>Country and Language</title> + +<para>This module of the &tde; control center allows you select +customization options that depend on the region of the world that you +happen to live in. There are five different pages in this module, each +of which is described in detail in the following sections.</para> + +<para>In most cases, you can simply select the country you live in, and +the other options will be set in an appropriate manner.</para> + +<para>Below the pages of this module, you can see a preview of what the +settings look like. In addition to positive and negative numbers, you +can see how positive and negative currency values, long and short dates, +and times are displayed. When you change any of the settings, the +preview shows the effects of the changes before you apply them.</para> + +<sect2 id="locale-locale"> +<title>Locale</title> + +<para>On this page, there are two lists, from which you can +select the country and languages that you want +to use.</para> + +<para>When you click on the <guilabel>Country</guilabel> list, +a menu pops up showing major groups of countries. You can select +one of these regions and see a list of the countries that are +available for that region.</para> + +<para>If the language for the country you have selected is available on your +system, it will be selected automatically. For instance, choosing +<guilabel>Germany</guilabel> as the country will select +<guilabel>German</guilabel> as the language, if it is available.</para> + +</sect2> + +<sect2 id="locale-numbers"> +<title>Numbers</title> + +<para>On this page, you can select options for how numbers are +displayed. The defaults are selected automatically based on the country +which is currently selected.</para> + +<para>In the text box labeled <guilabel>Decimal symbol</guilabel>, you +can type the character that you want to use to separate the decimal +portion of numbers. You could put anything here you wanted to, but +really, <userinput>.</userinput> and <userinput>,</userinput> are the +two characters that make the most sense.</para> + +<para>Similarly, you can choose the character which is used to group +units of thousands in numbers. If no character, not even a space, is +present, then there will be no separator for thousands.</para> + +<para>Finally, you can choose what character should be prefixed to +positive and negative numbers respectively. For example, the default +for English is not to have any prefix for positive numbers, and a +<userinput>-</userinput> for negative numbers.</para> + +</sect2> + +<sect2 id="locale-money"> + +<title>Money</title> + +<para>Unlike the display of ordinary numbers, conventions for +currency values do vary from region to region. However, you will +find that the defaults are probably fine.</para> + +<para>The character or characters representing the currency symbol +are based on the country that is currently selected. The decimal +symbol and thousands separator work as they do for numbers. The +text box labeled <guilabel>Fract digits</guilabel> allows you +to specify the number of fractional digits used in displaying +currency values.</para> + +<para>For both positive and negative currency values, you can +control whether the currency symbol appears before or after the +numeric value, and how the sign of the value is distinguished +in the display. Note that the symbols used for the sign of +currency values are the same as those used for other numeric +values.</para> + +<para>If the checkbox labeled <guilabel>Prefix currency +symbol</guilabel> is selected, the currency symbol appears +before the numeric value. If this checkbox is cleared, then the +currency symbol appears after the numeric value.</para> + +<para>There are five choices for the way in which the sign of the +currency value is handled:</para> +<itemizedlist> +<listitem><para>The <guilabel>Parens around</guilabel> +option displays the numeric value within a pair of +parentheses.</para></listitem> +<listitem><para>The <guilabel>Before quantity money</guilabel> +option displays the sign before the numeric value, but after any +currency symbol that may be present.</para></listitem> +<listitem><para>The <guilabel>After quantity money</guilabel> +option displays the sign after the numeric value, but before any +currency symbol that may be present.</para></listitem> +<listitem><para>The <guilabel>Before money</guilabel> option +displays the sign before the numeric value as well as any +currency symbol that may be present.</para></listitem> +<listitem><para>The <guilabel>After money</guilabel> option +displays the sign after the numeric value as well as any +currency symbol that may be present.</para></listitem> +</itemizedlist> + +</sect2> + +<sect2 id="locale-datetime"> +<title>Time and Dates</title> + +<para>If you use a different calendar system than Gregorian, you can +choose this from the first dropdown box.</para> + +<para>On the rest of this page, there are text boxes for the time, long +date, and short date, in which you can type format strings to control +the way in which times and dates are displayed.</para> + +<para>Except for the special codes described below, any other characters in the +format strings are displayed literally. The special codes consist of a +<parameter>%</parameter> sign followed by a character, as shown in the list of +codes below:</para> + +<itemizedlist> +<listitem><para>Time format codes:</para> + <itemizedlist> + + <listitem><para><parameter>HH</parameter> - The hour according to a 24-hour + clock, using two digits (00 to 23).</para></listitem> + <listitem><para><parameter>hH</parameter> - The hour according to a 24-hour + clock, using one or two digits (0 to 23).</para></listitem> + <listitem><para><parameter>PH</parameter> (uppercase <quote>p</quote>) - The hour according + to a 12-hour clock, using two digits (01 to 12).</para></listitem> + <listitem><para><parameter>pH</parameter> (lowercase <quote>p</quote>) - The hour according + to a 12-hour clock, using one or two digits (1 to 12).</para></listitem> + <listitem><para><parameter>MM</parameter> - The current minute using two digits + (00 to 59).</para></listitem> + <listitem><para><parameter>SS</parameter> - The current second using two digits + (00 to 59).</para></listitem> + <listitem><para><parameter>AMPM</parameter> - Either <quote>am</quote> or <quote>pm</quote> depending on the hour. + Useful with <parameter>PH</parameter> or + <parameter>pH</parameter>.</para></listitem> + </itemizedlist> +</listitem> + +<listitem><para>Date format codes:</para> + <itemizedlist> + <listitem><para><parameter>YYYY</parameter> - The year, using 4 + digits.</para></listitem> + <listitem><para><parameter>YY</parameter> - The year, using 2 + digits.</para></listitem> + <listitem><para><parameter>MM</parameter> - The month, using 2 digits (01 to + 12).</para></listitem> + <listitem><para><parameter>mM</parameter> - The month, using 1 or 2 digits (1 + to 12).</para></listitem> + <listitem><para><parameter>MONTH</parameter> - The name of the + month.</para></listitem> + <listitem><para><parameter>SHORTMONTH</parameter> - The abbreviated name of the + month.</para></listitem> + <listitem><para><parameter>DD</parameter> - The day, using 2 digits (01 to + 31).</para></listitem> + <listitem><para><parameter>dD</parameter> - The day, using 1 or 2 digits (1 to + 31).</para></listitem> + <listitem><para><parameter>WEEKDAY</parameter> - The name of the + weekday.</para></listitem> + <listitem><para><parameter>SHORTWEEKDAY</parameter> - The abbreviated name of the + weekday.</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> + +<para>Finally, there's a combobox labeled <guilabel>First day +of the week</guilabel> which lets you select which day is the first +one of the week in your country.</para> + +</sect2> +<sect2 id="locale-other"> +<title>Other</title> +<para>You can select the default paper format with the combo box labeled <guilabel>Paper Format</guilabel>.</para> + +<para>Use the drop down box labeled <guilabel>Measure system</guilabel> to select Imperial or +Metric systems of measurement.</para> + +</sect2> + +</sect1> +</article> diff --git a/doc/kcontrol/media/CMakeLists.txt b/doc/kcontrol/media/CMakeLists.txt new file mode 100644 index 000000000..c74597dd6 --- /dev/null +++ b/doc/kcontrol/media/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/media ) diff --git a/doc/kcontrol/media/Makefile.am b/doc/kcontrol/media/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/media/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/media/index.docbook b/doc/kcontrol/media/index.docbook new file mode 100644 index 000000000..bb21236f4 --- /dev/null +++ b/doc/kcontrol/media/index.docbook @@ -0,0 +1,57 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>Storage Media</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the Storage Media module. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>storage</keyword> +<keyword>media</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for this module.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/memory/CMakeLists.txt b/doc/kcontrol/memory/CMakeLists.txt new file mode 100644 index 000000000..7b37cffb2 --- /dev/null +++ b/doc/kcontrol/memory/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/memory ) diff --git a/doc/kcontrol/memory/Makefile.am b/doc/kcontrol/memory/Makefile.am new file mode 100644 index 000000000..c63989f33 --- /dev/null +++ b/doc/kcontrol/memory/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/memory diff --git a/doc/kcontrol/memory/index.docbook b/doc/kcontrol/memory/index.docbook new file mode 100644 index 000000000..19d10fc57 --- /dev/null +++ b/doc/kcontrol/memory/index.docbook @@ -0,0 +1,108 @@ +<?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>Memory Information</title> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2002-02-13</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>memory</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Memory Information</title> + +<para>This module displays the current memory usage. It is updated +constantly, and can be very useful for pinpointing bottlenecks when certain +applications are executed.</para> + +<sect2 id="memory-intro"> +<title>Memory Types</title> + +<para>The first thing you must understand, is there are two types of +<quote>memory</quote>, available to the operating system and the programs +that run within it.</para> + +<para>The first type, is called physical memory. This is the memory located +within the memory chips, within your computer. This is the +<acronym>RAM</acronym> (for Random Access Memory) you bought when you +purchased your computer.</para> + +<para>The second type of memory, is called virtual or swap memory. This +block of memory, is actually space on the hard drive. The operating +system reserves a space on the hard drive for <quote>swap space</quote>. +The operating system can use this virtual memory (or swap space), if it +runs out of physical memory. The reason this is called +<quote>swap</quote> memory, is the operating system takes some data that +it doesn't think you will want for a while, and saves that to disk in +this reserved space. The operating system then loads the new data you +need right now. It has <quote>swapped</quote> the not needed data, for +the data you need right now. Virtual or swap memory is not as fast as +physical memory, so operating systems try to keep data (especially often +used data), in the physical memory.</para> + +<para>The total memory, is the combined total of physical memory and +virtual memory.</para> + +</sect2> + +<sect2 id="memory-use"> +<title>Memory Information Module</title> + +<para>This window is divided into a top and bottom section</para> + +<para>The top section shows you the total physical memory, total free + physical memory, shared memory, and buffered memory.</para> + +<para>All four values are represented as the total number of bytes, and + as the number of megabytes (1 megabyte = slightly more than 1,000,000 + bytes)</para> + +<para>The bottom section shows you three graphs: </para> + +<itemizedlist> +<listitem><para><guilabel>Total Memory</guilabel> (this is the combination of physical and virtual memory).</para></listitem> +<listitem><para><guilabel>Physical Memory</guilabel></para></listitem> +<listitem><para>Virtual memory, or <guilabel>Swap Space</guilabel>.</para></listitem> +</itemizedlist> + +<para>The green areas are free, and the red areas are used.</para> + +<tip><para>The exact values of each type of memory are not critical, and + they change regularly. When you evaluate this page, look at + trends.</para> + +<para>Does your computer have plenty of free space (green areas)? If + not, you can increase the swap size or increase the physical + memory.</para> + +<para>Also, if your computer seems sluggish: is your physical memory + full, and does the hard drive always seem to be running? This suggests + that you do not have enough physical memory, and your computer is + relying on the slower virtual memory for commonly used data. Increasing + your physical memory will improve the responsiveness of your + computer.</para></tip> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/mouse/CMakeLists.txt b/doc/kcontrol/mouse/CMakeLists.txt new file mode 100644 index 000000000..e32df12ee --- /dev/null +++ b/doc/kcontrol/mouse/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/mouse ) diff --git a/doc/kcontrol/mouse/Makefile.am b/doc/kcontrol/mouse/Makefile.am new file mode 100644 index 000000000..b0a8d6b17 --- /dev/null +++ b/doc/kcontrol/mouse/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/mouse diff --git a/doc/kcontrol/mouse/index.docbook b/doc/kcontrol/mouse/index.docbook new file mode 100644 index 000000000..439eaafff --- /dev/null +++ b/doc/kcontrol/mouse/index.docbook @@ -0,0 +1,493 @@ +<?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>&Brad.Hards; &Brad.Hards.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-10-09</date> +<releaseinfo>3.03.00</releaseinfo> + +<abstract> +<para>This is the documentation for the &tde; &kcontrol; module that configures mice and other pointing devices. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>mouse</keyword> +</keywordset> +</articleinfo> + +<sect1 id="mouse"> +<title>Mouse</title> + +<para>This module allows you to configure your pointing device. Your +pointing device may be a mouse, a track ball, a touch-pad, or another piece +of hardware that performs a similar function.</para> + +<para>This module is divided into several tabs: +<link linkend="mouse-general">General</link>, +<link linkend="cursor-theme">Cursor Theme</link>, +<link linkend="mouse-advanced">Advanced</link> and +<link linkend="mouse-navigation">Mouse Navigation</link>. +There may also be one or more additional tabs if you have a Logitech mouse +or trackball, providing access to special features. +</para> + +<sect2 id="mouse-general"> +<title><guilabel>General</guilabel></title> + +<variablelist> +<varlistentry> +<term><guilabel>Button Order</guilabel></term> +<listitem><para> +If you are left-handed, you may +prefer to swap the functions of the <mousebutton>left</mousebutton> and +<mousebutton>right</mousebutton> buttons on your pointing device by choosing the +<quote>Left handed</quote> option. If your pointing device has more than two +buttons, only those that function as the <mousebutton>left</mousebutton> and +<mousebutton>right</mousebutton> buttons are affected. For example, if you have +a three-button mouse, the <mousebutton>middle</mousebutton> button is +unaffected.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Reverse scroll direction</guilabel></term> +<listitem><para> +With this checkbox selected, the scroll wheel (if any) will work in the opposite direction (so that if rolling the top of the scroll wheel towards you previously causes a scroll down, then it will now cause a scroll up). This may be useful to handle a unusual setup of the X server. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Double-click to open files and folders (select icons on first click)</guilabel></term> +<listitem> +<para> If this option is not checked, icons/files will be opened with a +single click of the <mousebutton>left</mousebutton> mouse-button. This +default behavior is consistent with what you would expect when you click +links in most web browsers. If checked however, icons/files will be +opened with a double click, while a single click will only select the +icon or file. This is the behavior you may know from other desktops or +operating systems.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Single-click to open files and folders</guilabel></term> +<listitem> +<para>This is the default setting for &tde;. Clicking once on an icon +will open it. To select you can drag around the icon(s) or <keycombo +action="simul">&Ctrl;<mousebutton>Right</mousebutton></keycombo> click, +or simply click and hold to drag it. You can also enable automatic selection of icons using the <guilabel>Automatically select icons</guilabel> checkbox, discussed below.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Change pointer shape over icons</guilabel></term> +<listitem> +<para>When this option is checked, the shape of the mouse pointer +changes whenever it is over an icon.</para> + +<tip><para>This option should be checked in most situations. It gives +more visual feedback and says, in essence, if you click here, something +will happen.</para></tip> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Automatically select icons</guilabel></term> +<listitem> +<para> +As noted above, if you have <guilabel>Single-click to open files and folders</guilabel> selected, you can select icons by dragging around them, or by using <keycombo +action="simul">&Ctrl;<mousebutton>Right</mousebutton></keycombo> click. If you routinely need to select icons, you may want to enable this checkbox, which will allow icons to be selected automatically by pausing over the icon. The <guilabel>Delay:</guilabel> slider determines how long is required before the automatic selection takes effect. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Visual feedback on activation</guilabel></term> +<listitem> +<para>When this option is +checked, &tde; gives you visual feedback whenever you click on something and activate it.</para></listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="cursor-theme"> +<title><guilabel>Cursor Theme</guilabel></title> + +<para> +This tab allows you to select from a number of cursor themes. A preview of the cursor display is shown above the listbox. +</para> + +<note><para>The features provided by this tab may not be available on some systems. Your system may need to be updated to support cursor themes. +</para></note> + +<para> +If you have additional cursor themes available to you, you can install and remove them using the buttons below the listbox. Note that you cannot remove the default themes. +</para> + +</sect2> + +<sect2 id="mouse-advanced"> +<title>Advanced</title> + +<variablelist> +<varlistentry> +<term id="peripherals-mouse-acceleration"> +<guilabel>Pointer acceleration</guilabel></term> +<listitem> +<para>This option allows you to change the relationship +between the distance that the mouse pointer moves on the +screen and the relative movement of the physical device +itself (which may be a mouse, track-ball, or some other +pointing device.)</para> + +<para>A high value for the acceleration multiplier will lead to large +movements of the mouse pointer on the screen, even when +you only make a small movement with the physical device.</para> + +<tip><para>A multiplier between <guilabel>1x</guilabel> and +<guilabel>3x</guilabel> will works well for many systems. With a multiplier +over <guilabel>3x</guilabel> the mouse pointer may become difficult to +control.</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Pointer threshold</guilabel></term> +<listitem> +<para>The threshold is the smallest distance that the mouse pointer must +move on the screen before acceleration has any effect. If the movement +is within the threshold, the mouse pointer moves as if the acceleration +were set to <guilabel>1x</guilabel>.</para> + +<para>Thus, when you make small movements with the physical device (⪚ +mouse), you still have fine control of the mouse pointer on the screen, +whereas larger movements of the physical device will move the mouse +pointer rapidly to different areas on the screen.</para> + +<para>You can set the threshold value by dragging the slider button or +by clicking the up/down arrows on the spin-button to the left of the +slider.</para> + +<tip><para>In general, the higher you set the <guilabel>Pointer +acceleration</guilabel> value, the higher you will want to set the +<guilabel>Pointer threshold</guilabel> value. For example, A +<guilabel>Pointer threshold</guilabel> of 4 pixels may +be appropriate for a <guilabel>Pointer Acceleration</guilabel> of +2x, but 10 pixels might be +better for 3x.</para></tip> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Double click interval</guilabel></term> +<listitem> +<para>This is the maximum amount of time between clicks for &tde; to +register a double click. If you click twice, and the time between those +two clicks is less than this number, &tde; recognizes that as a double +click. If the time between these two clicks is greater than this +number, &tde; recognizes those as two <emphasis>separate</emphasis> +single clicks.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Drag start time</guilabel> and <guilabel>Drag start +distance</guilabel></term> + +<listitem> +<para>If you +<itemizedlist> +<listitem><para>click with the mouse</para></listitem> +<listitem><para>drag within the time specified in <guilabel>Drag start +time</guilabel>, and </para></listitem> +<listitem><para>move a distance equal to or greater than the number (of +pixels) specified in <guilabel>Drag start distance</guilabel></para> +</listitem> +</itemizedlist> + +&tde; will drag the selected item.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mouse wheel scrolls by</guilabel></term> +<listitem> +<para>If you have a wheel mouse, use the slider to determine how many +lines of text one <quote>step</quote> of the mouse wheel will +scroll.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="mouse-navigation"> +<title><guilabel>Mouse Navigation</guilabel></title> + +<para> +This tab allows you to configure the keyboard number pad keys as a mouse-type device. This may be useful when you are working on a device without another pointing device, or where you have no other use for the number pad. +</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Move pointer with keyboard (using the num pad)</guilabel></term> +<listitem> +<para> +To enable keyboard mouse mode, you need to select the checkbox labelled <guilabel>Move pointer with keyboard (using the num pad)</guilabel>. When you do this, the other settings will become enabled, and you can customize the keyboard pointer behavior further, if required. +</para> +<para> +The various keys on the number pad move in the direction you would expect. Note that you can move diagonally as well as up, down, left and right. The <keycap>5</keycap> key emulates a click to a pointer button, typically &LMB;. You change which button is emulated by using the <keycap>/</keycap> key (which makes it &LMB;), <keycap>*</keycap> key (which makes it &MMB;) and <keycap>-</keycap> (which makes it &RMB;). Using the <keycap>+</keycap> emulates a doubleclick to the selected pointer button. You can use the <keycap>0</keycap> key to emulate holding down the selected pointer button (for easy dragging), and then use the <keycap>.</keycap> to emulate releasing the selected pointer button. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Acceleration delay</guilabel></term> +<listitem> +<para> +This is the time (in milliseconds) between the initial key press and the first repeated motion event for mouse key acceleration. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Repeat interval</guilabel></term> +<listitem> +<para> +This is the time in milliseconds between repeated motion events for mouse key acceleration. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Acceleration time</guilabel></term> +<listitem> +<para> +This is the number of key events before the pointer reaches a maximum speed for mouse key acceleration. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Maximum speed</guilabel></term> +<listitem> +<para> +This is the maximum speed in pixels per key event the pointer can reach for mouse key acceleration. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Acceleration profile</guilabel></term> +<listitem> +<para> +This is the slope of the acceleration curve for mouse key acceleration. +</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect2> + +<sect2 id="logitech-mouse"> +<title><guilabel>Logitech Support</guilabel></title> + +<para> +Some Logitech USB mice support special features, such as switching to a higher resolution, or +providing cordless status. If KDE was built with libusb support, then you will get an additional +tab for each supported mouse that is plugged in. +</para> + +<para> +The supported devices are: +</para> +<orderedlist> +<listitem><para>Wheel Mouse Optical</para></listitem> +<listitem><para>MouseMan Traveler</para></listitem> +<listitem><para>MouseMan Dual Optical</para></listitem> +<listitem><para>MX310 Optical Mouse</para></listitem> +<listitem><para>MX510 Optical Mouse</para></listitem> +<listitem><para>MX300 Optical Mouse</para></listitem> +<listitem><para>MX500 Optical Mouse</para></listitem> +<listitem><para>iFeel Mouse</para></listitem> +<listitem><para>Mouse Receiver</para></listitem> +<listitem><para>Dual Receiver</para></listitem> +<listitem><para>Cordless Freedom Optical</para></listitem> +<listitem><para>Cordless Elite Duo</para></listitem> +<listitem><para>MX700 Optical Mouse</para></listitem> +<listitem><para>Cordless Optical Trackman</para></listitem> +<listitem><para>Cordless MX Duo Receiver</para></listitem> +<listitem><para>MX100 Laser Mouse</para></listitem> +<listitem><para>Receiver for Cordless Presenter</para></listitem> +</orderedlist> + +<para> +Not all devices support all capabilities (typically cordless devices do not +provide resolution switching, and of course only cordless devices support +cordless status reporting), so some parts of the tab will not be enabled for +some mouse types. +</para> + +<para> +If the mouse supports resolution switching, the <guilabel>Sensor Resolution</guilabel> +radio button group will be enabled, and you can switch from <guilabel>400 counts per +inch</guilabel> to <guilabel>800 counts per inch</guilabel> and back. If you use +<guilabel>800 counts per inch</guilabel>, the same physical movement of the mouse +will cause a greater (roughly double) amount of motion of the cursor. This tends +to be popular amongst gamers. +</para> + +<para> +If the mouse supports cordless reporting, the <guilabel>Battery Level</guilabel> +and <guilabel>RF Channel</guilabel> widgets will be enabled. You can only change +the <guilabel>RF Channel</guilabel> if your mouse has two channel support. +</para> + +<sect3 id="logitech-perms"> +<title>Fixing permission problems on Logitech mice</title> + +<para> +Because of the way USB devices work, the code that accesses the current +status on Logitech mice needs to be able to write to the mouse. This +should be handled by your distribution, but if not, you may need to do some +configuration yourself. +</para> + +<para> +On a Linux system, you should use the hotplug system to change the ownership +and permissions on the mouse entry in <filename>/proc/bus/usb</filename>. One +way to do this is to create a short script +(<filename>/etc/hotplug/usb/consoleUserPerms</filename>) that changes the ownership +and permissions, as shown below: +</para> + +<informalexample> +<programlisting> +<![CDATA[ +#!/bin/bash +# +# /etc/hotplug/usb/consoleUserPerms +# +# Sets up newly plugged in USB device so that the user who owns +# the console according to pam_console can access it from user space +# +# Note that for this script to work, you'll need all of the following: +# a) a line in the file /etc/hotplug/usb.usermap or another usermap file +# in /etc/hotplug/usb/ that corresponds to the device you are using. +# b) a setup using pam_console creates the respective lock files +# containing the name of the respective user. You can check for that +# by executing "echo `cat /var/{run,lock}/console.lock`" and +# verifying the appropriate user is mentioned somewhere there. +# c) a Linux kernel supporting hotplug and usbdevfs +# d) the hotplug package (http://linux-hotplug.sourceforge.net/) +# +# In the usermap file, the first field "usb module" should be named +# "consoleUserPerms" to invoke this script. +# + +if [ "${ACTION}" = "add" ] && [ -f "${DEVICE}" ] +then +# New code, using lock files instead of copying /dev/console permissions +# This also works with non-tdm logins (e.g. on a virtual terminal) +# Idea and code from Nalin Dahyabhai <[email protected]> + if [ -f /var/run/console.lock ] + then + CONSOLEOWNER=`cat /var/run/console.lock` + elif [ -f /var/lock/console.lock ] + then + CONSOLEOWNER=`cat /var/lock/console.lock` + else + CONSOLEOWNER= + fi + if [ -n "$CONSOLEOWNER" ] + then + chmod 0000 "${DEVICE}" + chown "$CONSOLEOWNER" "${DEVICE}" + chmod 0600 "${DEVICE}" + fi +fi +]]> +</programlisting> +</informalexample> + +<para> +The usermap file that goes with this is +<filename>/etc/hotplug/usb/logitechmouse.usermap</filename>, as +shown below: +</para> + +<informalexample> +<programlisting> +<![CDATA[ +# script match_flags idVendor idProduct bcdDevice_lo bcdDevice_hi bDeviceClass bDeviceSubClass bDeviceProtocol bInterfaceClass bInterfaceSubClass bInterfaceProtocol driver_info +# Wheel Mouse Optical +consoleUserPerms 0x0003 0x046d 0xc00e 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MouseMan Traveler +consoleUserPerms 0x0003 0x046d 0xc00f 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MouseMan Dual Optical +consoleUserPerms 0x0003 0x046d 0xc012 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX310 Optical Mouse +consoleUserPerms 0x0003 0x046d 0xc01b 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX510 Optical Mouse +consoleUserPerms 0x0003 0x046d 0xc01d 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX300 Optical Mouse +consoleUserPerms 0x0003 0x046d 0xc024 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX500 Optical Mouse +consoleUserPerms 0x0003 0x046d 0xc025 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# iFeel Mouse +consoleUserPerms 0x0003 0x046d 0xc031 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Mouse Receiver +consoleUserPerms 0x0003 0x046d 0xc501 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Dual Receiver +consoleUserPerms 0x0003 0x046d 0xc502 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Cordless Freedom Optical +consoleUserPerms 0x0003 0x046d 0xc504 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Cordless Elite Duo +consoleUserPerms 0x0003 0x046d 0xc505 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX700 Optical Mouse +consoleUserPerms 0x0003 0x046d 0xc506 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Cordless Optical Trackman +consoleUserPerms 0x0003 0x046d 0xc508 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Cordless MX Duo Receiver +consoleUserPerms 0x0003 0x046d 0xc50b 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# MX100 Laser Mouse +consoleUserPerms 0x0003 0x046d 0xc50e 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +# Receiver for Cordless Presenter +consoleUserPerms 0x0003 0x046d 0xc702 0x0000 0xffff 0x00 0x00 0x00 0x00 0x00 0x00 0x00000000 +]]> +</programlisting> +</informalexample> + +<para> +That should be all that is needed on Linux - just copy the files into +<filename>/etc/hotplug/usb/</filename>, and when the mouse is +plugged in, the ownership and permissions should be changed +so that the user at the console can access the mouse. +</para> +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/netpref/CMakeLists.txt b/doc/kcontrol/netpref/CMakeLists.txt new file mode 100644 index 000000000..18a8e506a --- /dev/null +++ b/doc/kcontrol/netpref/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/netpref ) diff --git a/doc/kcontrol/netpref/Makefile.am b/doc/kcontrol/netpref/Makefile.am new file mode 100644 index 000000000..8dacf4438 --- /dev/null +++ b/doc/kcontrol/netpref/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/netpref diff --git a/doc/kcontrol/netpref/index.docbook b/doc/kcontrol/netpref/index.docbook new file mode 100644 index 000000000..220429cb8 --- /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>tdebase</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 &tde; 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/nics/CMakeLists.txt b/doc/kcontrol/nics/CMakeLists.txt new file mode 100644 index 000000000..e30c40bf9 --- /dev/null +++ b/doc/kcontrol/nics/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/nics ) diff --git a/doc/kcontrol/nics/Makefile.am b/doc/kcontrol/nics/Makefile.am new file mode 100644 index 000000000..eb1c37098 --- /dev/null +++ b/doc/kcontrol/nics/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/nics diff --git a/doc/kcontrol/nics/index.docbook b/doc/kcontrol/nics/index.docbook new file mode 100644 index 000000000..f82552c28 --- /dev/null +++ b/doc/kcontrol/nics/index.docbook @@ -0,0 +1,45 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<title>Network Interfaces</title> +<articleinfo> + +<authorgroup> +<author>&Lauri.Watts;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-11</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Network</keyword> +<keyword>Interfaces</keyword> +</keywordset> +</articleinfo> + +<sect1> + +<title>Network Interfaces</title> + +<para> +This page displays information about the network interfaces +installed in your computer. +</para> + +<note><para>The exact information displayed is system-dependent. On +some systems, this information can not yet be displayed.</para></note> + +<para>The user cannot modify any settings on this page.</para> + + +</sect1> + +</article> diff --git a/doc/kcontrol/opengl/CMakeLists.txt b/doc/kcontrol/opengl/CMakeLists.txt new file mode 100644 index 000000000..aac8e4360 --- /dev/null +++ b/doc/kcontrol/opengl/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/opengl ) diff --git a/doc/kcontrol/opengl/Makefile.am b/doc/kcontrol/opengl/Makefile.am new file mode 100644 index 000000000..70f023492 --- /dev/null +++ b/doc/kcontrol/opengl/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG= en +KDE_DOCS = kcontrol/opengl diff --git a/doc/kcontrol/opengl/index.docbook b/doc/kcontrol/opengl/index.docbook new file mode 100644 index 000000000..2c972034a --- /dev/null +++ b/doc/kcontrol/opengl/index.docbook @@ -0,0 +1,47 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<title><acronym>OpenGL</acronym></title> +<articleinfo> + +<authorgroup> +<author><personname><firstname>Ilya</firstname><surname>Korniyko</surname></personname><email>[email protected]</email></author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date></date> +<releaseinfo></releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>OpenGL</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="opengl"> + +<title>OpenGL</title> + +<para>This page displays information about installed <acronym>OpenGL</acronym> implementation. +OpenGL (for "Open Graphics Library") is a cross-platform, +hardware independent interface for 3D graphics.</para> + +<para><acronym>GLX</acronym> is the binding for OpenGL to X Window system.</para> + +<para> <acronym>DRI</acronym> (Direct Rendering Infrastucture) provides hardware acceleration for OpenGL. +You must have a videocard with 3D accelerator and properly installed driver for this.</para> +<para> </para> + +<para>Read more at the official OpenGL site <ulink url="http://www.opengl.org">http://www.opengl.org</ulink> </para> + +</sect1> + +</article> diff --git a/doc/kcontrol/partitions/CMakeLists.txt b/doc/kcontrol/partitions/CMakeLists.txt new file mode 100644 index 000000000..a436214de --- /dev/null +++ b/doc/kcontrol/partitions/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/partitions ) diff --git a/doc/kcontrol/partitions/Makefile.am b/doc/kcontrol/partitions/Makefile.am new file mode 100644 index 000000000..fb019e7ee --- /dev/null +++ b/doc/kcontrol/partitions/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/partitions diff --git a/doc/kcontrol/partitions/index.docbook b/doc/kcontrol/partitions/index.docbook new file mode 100644 index 000000000..f3655a8cf --- /dev/null +++ b/doc/kcontrol/partitions/index.docbook @@ -0,0 +1,56 @@ +<?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>Partition Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>drive partition</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Partition Information</title> + +<para>This page displays information about partitions on your hard +drives.</para> + +<note><para>The exact information displayed is system-dependent. On +some systems, partition information cannot be displayed +yet.</para></note> + +<para>On &Linux;, this information is read from <filename +class="devicefile">/proc/partitions</filename>, which is only available +if the <filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the (2.1.x or later) kernel.</para> + +<para>The first two columns are the major and minor numbers +respectively. The third column is the number of blocks (usually 1 +block = 1024 bytes). The fourth column is a label for the +device.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> + diff --git a/doc/kcontrol/paths/CMakeLists.txt b/doc/kcontrol/paths/CMakeLists.txt new file mode 100644 index 000000000..f7f5e8607 --- /dev/null +++ b/doc/kcontrol/paths/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/paths ) diff --git a/doc/kcontrol/paths/Makefile.am b/doc/kcontrol/paths/Makefile.am new file mode 100644 index 000000000..545bc2d1d --- /dev/null +++ b/doc/kcontrol/paths/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/paths diff --git a/doc/kcontrol/paths/index.docbook b/doc/kcontrol/paths/index.docbook new file mode 100644 index 000000000..7b663b062 --- /dev/null +++ b/doc/kcontrol/paths/index.docbook @@ -0,0 +1,131 @@ +<?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>Paths</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Michael</firstname> +<surname>Anderson</surname> +</author> +<author> +<firstname>Anne-Marie</firstname> +<surname>Mahfouf</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2009</year> +<holder>Michael Anderson</holder> +<holder>Anne-Marie Mahfouf</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>System Settings</keyword> +<keyword>paths</keyword> +</keywordset> +</articleinfo> + +<sect1 id="paths"> +<title>Paths</title> + +<para>Use this module to configure essential paths for the &tde; desktop. These paths help &tde; +find specific types of files.</para> + +<para> +<screenshot> +<screeninfo>Configure some &tde; paths</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="paths.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure some &tde; paths</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Desktop path:</guilabel></term> +<listitem><para>The Desktop folder contains all the files that you see on your desktop. The default +path usually is <filename class="directory">~/Desktop</filename> but you can change here the location +of this folder. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Autostart path:</guilabel></term> +<listitem><para> +The Autostart folder contains applications or links to applications or scripts you want to start whenever +&tde; starts. You can change the location of this folder. There might exist other autostart directories +in your $HOME user directory, which &tde; supports, but this path affects &tde; apps only. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Documents path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save documents from or to.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Download path:</guilabel></term> +<listitem><para>This folder will be used by default to save your downloaded items.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Music path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save music from or to.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Pictures path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save pictures from or to.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Public Share path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save public shared files from or to. +Typically this is a directory that you have provided access permissions to other users to + view.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Templates path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save templates from or to. Template +files are used when creating new files and you want the new files to be just like the content and +format used in the template. Mostly this location is used by office suite applications.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Videos path:</guilabel></term> +<listitem><para>This folder will be used by default to load or save videos from or to.</para></listitem> +</varlistentry> + +</variablelist> + +<!--<para>When you change a path and select <guibutton>Apply</guibutton> a dialog appears where you can choose +to move the content to the new folder or use the new folder without moving the files.</para>--> + +</sect1> + +</article> diff --git a/doc/kcontrol/paths/paths.png b/doc/kcontrol/paths/paths.png Binary files differnew file mode 100644 index 000000000..a9103687f --- /dev/null +++ b/doc/kcontrol/paths/paths.png diff --git a/doc/kcontrol/pci/CMakeLists.txt b/doc/kcontrol/pci/CMakeLists.txt new file mode 100644 index 000000000..abe1d7856 --- /dev/null +++ b/doc/kcontrol/pci/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/pci ) diff --git a/doc/kcontrol/pci/Makefile.am b/doc/kcontrol/pci/Makefile.am new file mode 100644 index 000000000..45f7b2968 --- /dev/null +++ b/doc/kcontrol/pci/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/pci diff --git a/doc/kcontrol/pci/index.docbook b/doc/kcontrol/pci/index.docbook new file mode 100644 index 000000000..1d4d8b3f9 --- /dev/null +++ b/doc/kcontrol/pci/index.docbook @@ -0,0 +1,57 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<title><acronym>PCI</acronym>-bus and Installed <acronym>PCI</acronym> Cards</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>PCI</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="pci"> + +<title><acronym>PCI</acronym>-bus and Installed <acronym>PCI</acronym> +Cards</title> + +<para>This page displays information about the +<acronym>PCI</acronym>-bus and installed <acronym>PCI</acronym> cards, +and other devices that use the Peripheral Component Interconnect +(<acronym>PCI</acronym>) bus.</para> + +<note><para>The exact information displayed is system-dependent. On some +systems, <acronym>PCI</acronym>-information can not yet be +displayed.</para> </note> + +<para>On &Linux;, this information is read from <filename +class="devicefile">/proc/pci</filename> which is only available if the +<filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel. A listing of all <acronym>PCI</acronym> +devices found during kernel initialization, and their configuration, is +shown.</para> + +<para>Each entry begins with a bus, device and function number.</para> +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/pcmcia/CMakeLists.txt b/doc/kcontrol/pcmcia/CMakeLists.txt new file mode 100644 index 000000000..c956d5b11 --- /dev/null +++ b/doc/kcontrol/pcmcia/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/pcmcia ) diff --git a/doc/kcontrol/pcmcia/Makefile.am b/doc/kcontrol/pcmcia/Makefile.am new file mode 100644 index 000000000..b13b11f46 --- /dev/null +++ b/doc/kcontrol/pcmcia/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/pcmcia diff --git a/doc/kcontrol/pcmcia/index.docbook b/doc/kcontrol/pcmcia/index.docbook new file mode 100644 index 000000000..901fdf2e5 --- /dev/null +++ b/doc/kcontrol/pcmcia/index.docbook @@ -0,0 +1,38 @@ +<?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><acronym>PCMCIA</acronym></title> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Laptop</keyword> +<keyword>PCMCIA</keyword> +</keywordset> +</articleinfo> + +<sect1 id="pcmcia"> +<title><acronym>PCMCIA</acronym></title> + +<para>This module displays information about <acronym>PCMCIA</acronym> +Cards</para> + +<para>The exact information is system dependent. On most systems no +information is displayed at all.</para> + +</sect1> +</article> diff --git a/doc/kcontrol/performance/CMakeLists.txt b/doc/kcontrol/performance/CMakeLists.txt new file mode 100644 index 000000000..f43b74051 --- /dev/null +++ b/doc/kcontrol/performance/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/performance ) diff --git a/doc/kcontrol/performance/Makefile.am b/doc/kcontrol/performance/Makefile.am new file mode 100644 index 000000000..194fae838 --- /dev/null +++ b/doc/kcontrol/performance/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/performance diff --git a/doc/kcontrol/performance/index.docbook b/doc/kcontrol/performance/index.docbook new file mode 100644 index 000000000..8f8606a1d --- /dev/null +++ b/doc/kcontrol/performance/index.docbook @@ -0,0 +1,102 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-03-04</date> +<releaseinfo>3.4.0</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>system performance</keyword> +<keyword>performance</keyword> +<keyword>preload</keyword> +</keywordset> +</articleinfo> + +<sect1 id="sys-performance"> +<title>Performance Settings</title> + +<para>&tde;, is used on a wide variety of computers by a wide variety of users. Under the category of +performance, this dialog box allows each user to adjust options which may make the computer that &tde; is +installed on feel more responsive.</para> + +<para>This module is divided into two tabs.</para> + + +<sect2 id="konqueror-performance"><title>&konqueror; performance options</title> +<sect3><title>&konqueror; instances</title> +<para>The first section of this dialog is labeled <guilabel>Minimize Memory Usage</guilabel> and has three options which determine maximum number of instances of &konqueror; that can be open on one machine at any one time.</para> + +<note><para>Do not confuse &konqueror; instances, with &konqueror; windows or tabs. The number of konqueror instances is determined by &tde; not by the user. You can think of instances as the hidden data of your &konqueror; windows and tabs. One &konqueror; instance can contain the data for multiple windows or tabs. Your choice on the following radio buttons does not limit the number of windows you can open at one time, but rather, how many instances of &konqueror; you can have open.</para> +<para>The reason the choices you make in this dialog box are important is evident when something goes wrong and &konqueror; is forced to close an instance. <emphasis>All &konqueror; windows associated with a &konqueror; instance must be closed immediatly (without time to save data or bookmark locations).</emphasis> Therefore, the more instances you can have open at one time, the less likely a problem in one instance will affect all of your work. Each instance requires more memory which can be a problem on systems with less system memory.</para></note> + +<para>Your options are:</para> + +<variablelist> +<varlistentry> +<term>Never</term> +<listitem><para>There are no restraints. Any number of &konqueror; instances can be open at any one time. The advantage of this option is if any &konqueror; instance crashes the remaining will be unaffected. The disadvantage is that each &konqueror; instance uses more memory.</para></listitem> +</varlistentry> + +<varlistentry> +<term>For file browsing only (recommended)</term> +<listitem><para>If this option is selected, you can have as many as you want &konqueror; instances open that are browsing the web, but only one instance of &konqueror; for file management.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Always (use with care)</term> +<listitem><para>If this option is selected, you can only have one instance of &konqueror; running at any one time. This saves system memory, but if your &konqueror; window crashes, all your browsing windows close immediatly without warning. This should only be used for seriously memory limited systems.</para></listitem> +</varlistentry> +</variablelist> +</sect3> +<sect3><title>Preloading</title> +<para>The subsection labeled <guilabel>Preloading</guilabel> also makes a tradeoff between memory and performance.</para> + +<para><emphasis>Preloading</emphasis> refers to loading an instance of &konqueror; into memory before a user asks to start &konqueror;. The positive effect of this is that when a user asks &tde; to load &konqueror; the window appears instantly + because most of the application has been preloaded. The negative effect is that this instance of &konqueror; uses memory that +could be used by other programs. By default, when a user closes &konqueror;, &tde; does not close the instance. +This means that the next time a user wants &konqueror; loaded, it is nearly instantanous again.</para> +<para>The spinbox labeled <guilabel>Maximum number of instances kept preloaded:</guilabel> can be used to adjust the maximum number of preloaded instances. This option does not affect instances when they are loaded. It also does not limit the number of instances that can be used by active windows. It only affects the number of preloaded instances.</para> +<para>The checkbox labeled <guilabel>Preload an instance after &tde; startup</guilabel> does just what it says. It tells +&tde; to preload one instance of &konqueror; at the startup of &tde;.</para> +<note><para>This does extend the startup time for &tde;.</para></note> +<para>The final checkbox labeled <guilabel>Always try to have at least one preloaded instance</guilabel> signals to &tde; that you always want &tde; to have one preloaded, but not used, instance of &konqueror; available. This option will actually decrease performance on some machines (especially those with limited physical memory).</para> +</sect3> +</sect2> +<sect2 id="system-performance"><title>&tde; system performance options</title> +<para>Click on the tab labeled <guilabel>System</guilabel>.</para> +<para>Currently there is only one option labeled <guilabel>Disable system configuration startup check</guilabel>. +</para> +<para>When &tde; starts, it checks several directories for changes to configuration. Most of these changes relate to installation and uninstalling applications to the computer. This scan extends the startup time for &tde; and many times this scan is not needed as the configuration is current from the last time &tde; was started. When the configuration has changed &tde; uses this scan to update various datafiles to ensure a smooth user experience.</para> +<warning><para>You are given the option to skip this initial scan during startup. &tde; developers strongly suggest you do not disable this scan because of the potential to introduce instability into your system.</para> +<para>If you do select this option:</para> +<itemizedlist> +<listitem><para>&tde; will wait to perform the scan until after &tde; has started. This scan will be performed after the desktop is loaded.</para></listitem> +<listitem><para>In the event of a crash, &tde; will not perform a backtrace because your problem may be related to the delayed scan.</para></listitem> +<listitem><para>Switch this option off if any application is crashing as a delayed scan may be responsible for the crash.</para></listitem> +</itemizedlist> + + + + +</warning> + + + +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/privacy/CMakeLists.txt b/doc/kcontrol/privacy/CMakeLists.txt new file mode 100644 index 000000000..69d26f8a7 --- /dev/null +++ b/doc/kcontrol/privacy/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/privacy ) diff --git a/doc/kcontrol/privacy/Makefile.am b/doc/kcontrol/privacy/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/privacy/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/privacy/index.docbook b/doc/kcontrol/privacy/index.docbook new file mode 100644 index 000000000..5aef138e3 --- /dev/null +++ b/doc/kcontrol/privacy/index.docbook @@ -0,0 +1,57 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>Privacy</title> + +<articleinfo> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the Privacy module. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>privacy</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="privacy-settings"> +<title>Privacy Settings</title> + +<para>This module provides a quick way to delete files in your &tde; profile directory to +protect your privacy.</para> + +<para>Various file locations are listed that contain data related to your privacy. Each item +can be selected individually. All items can be selected using the <guilabel>Select All</guilabel> +button or none with the <guilabel>Select None</guilabel> button.</para> + +<para>After selecting the desired file locations, select the <guilabel>Clean Up</guilabel> button +To clean or scrub the contents of the affected files.</para> + +<para>The selection preferences can be saved by selecting the <guilabel>Apply</guilabel> button.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/processor/CMakeLists.txt b/doc/kcontrol/processor/CMakeLists.txt new file mode 100644 index 000000000..25f3ff798 --- /dev/null +++ b/doc/kcontrol/processor/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/processor ) diff --git a/doc/kcontrol/processor/Makefile.am b/doc/kcontrol/processor/Makefile.am new file mode 100644 index 000000000..d42fb2991 --- /dev/null +++ b/doc/kcontrol/processor/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/processor diff --git a/doc/kcontrol/processor/index.docbook b/doc/kcontrol/processor/index.docbook new file mode 100644 index 000000000..3794aca67 --- /dev/null +++ b/doc/kcontrol/processor/index.docbook @@ -0,0 +1,56 @@ +<?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>Processor Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>CPU</keyword> +<keyword>processor</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="processor"> +<title>Processor Information</title> + +<para>This page displays information about the system +Central Processing Unit (<acronym>CPU</acronym>).</para> + +<note><para>The exact information displayed is system-dependent. On +some systems, processor information cannot be displayed +yet.</para></note> + +<para>On &Linux;, this information is read from <filename +class="devicefile">/proc/cpuinfo</filename>, which is only available if +the <filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel.</para> + +<para>The exact contents of the window will depend on the +<acronym>CPU</acronym>(s) in your machine, but the window is organized +into two columns. The first column is the parameter, and the second +column is the value of that parameter.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/proxy/CMakeLists.txt b/doc/kcontrol/proxy/CMakeLists.txt new file mode 100644 index 000000000..261d516e0 --- /dev/null +++ b/doc/kcontrol/proxy/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/proxy ) 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..63a154eaa --- /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>TDEDIR</envar>/share/config/tdeionetrc</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..48a03253c --- /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 &tde; +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. &tde; 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 &tde; 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 &tde; 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/samba/CMakeLists.txt b/doc/kcontrol/samba/CMakeLists.txt new file mode 100644 index 000000000..568062e6c --- /dev/null +++ b/doc/kcontrol/samba/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/samba ) diff --git a/doc/kcontrol/samba/Makefile.am b/doc/kcontrol/samba/Makefile.am new file mode 100644 index 000000000..126a8b41b --- /dev/null +++ b/doc/kcontrol/samba/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/samba + diff --git a/doc/kcontrol/samba/index.docbook b/doc/kcontrol/samba/index.docbook new file mode 100644 index 000000000..69d7b91b9 --- /dev/null +++ b/doc/kcontrol/samba/index.docbook @@ -0,0 +1,207 @@ +<?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>Samba Status Information</title> +<articleinfo> +<authorgroup> +<author>&Alexander.Neundorf;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Samba</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="sambastatus"> + + +<title>Samba Status Information</title> + +<para>The Samba and <acronym>NFS</acronym> Status Monitor is a front end +to the programs <command>smbstatus</command> and +<command>showmount</command>. Smbstatus reports on current Samba +connections, and is part of the suite of Samba tools, which implements +the <acronym>SMB</acronym> (Session Message Block) protocol, also called +the NetBIOS or LanManager protocol.</para> + +<para>This protocol can be used to provide printer sharing or drive +sharing services on a network including machines running the various +flavors of &Microsoft; &Windows;.</para> + +<para><command>showmount</command> is part of the <acronym>NFS</acronym> +software package. <acronym>NFS</acronym> stands for Network File System +and is the traditional &UNIX; way to share folders over the +network. In this case the output of <command>showmount</command> +<option>-a localhost</option> is parsed. On some systems showmount is in +<filename class="directory">/usr/sbin</filename>, check if you have +showmount in your <envar>PATH</envar>.</para> + +<sect2 id="smb-exports"> +<title>Exports</title> + +<para>On this page you can see a big list which shows the currently +active connections to Samba shares and <acronym>NFS</acronym> exports of +your machine. The first column shows you whether the resource is a Samba +(<acronym>SMB</acronym>) share or a <acronym>NFS</acronym> export. The +second column contains the name of the share, the third the name of the +remote host, which accesses this share. The remaining columns have only +a meaning for Samba-shares.</para> + +<para>The fourth column contains the User <abbrev>ID</abbrev> of the +user, who accesses this share. Note that this does not have to be equal +to the &UNIX; user <abbrev>ID</abbrev> of this user. The same applies +for the next column, which displays the group <abbrev>ID</abbrev> of the +user.</para> + +<para>Each connection to one of your shares is handled by a single +process (<command>smbd</command>), the next column shows the process +<abbrev>ID</abbrev> (<acronym>pid</acronym>) of this +<command>smbd</command>. If you kill this process the connected user +will be disconnected. If the remote user works from &Windows;, as soon +as this process is killed a new one will be created, so he will almost +not notice it.</para> + +<para>The last column shows how many files this user has currently open. +Here you see only, how many files he has <emphasis>open</emphasis> just +now, you don't see how many he copied or formerly opened &etc;</para> + +</sect2> + +<sect2 id="smb-imports"> +<title>Imports</title> + +<para> Here you see which Samba- and <acronym>NFS</acronym>-shares from +other hosts are mounted on your local system. The first column shows +wether it is a Samba- or <acronym>NFS</acronym>-share, the second column +displays the name of the share, and the third shows where it is +mounted.</para> + +<para>The mounted <acronym>NFS</acronym>-shares you should see on +&Linux; (this has been tested), and it should also work on &Solaris; +(this has not been tested).</para> + +</sect2> + +<sect2 id="smb-log"> +<title>Log</title> + +<para>This page presents the contents of your local samba log file in a +nice way. If you open this page, the list will be empty. You have to +press the <guibutton>Update</guibutton> button, then the samba log file +will be read and the results displayed. Check whether the samba log file +on your system is really at the location as specified in the input +line. If it is somewhere else or if it has another name, correct +it. After changing the file name you have to press +<guibutton>Update</guibutton> again.</para> + +<para>Samba logs its actions according to the log level (see +<filename>smb.conf</filename>). If loglevel = 1, samba logs only when +somebody connects to your machine and when this connection is closed +again. If log level = 2, it logs also if somebody opens a file and if he +closes the file again. If the log level is higher than 2, yet more +stuff is logged.</para> + +<para>If you are interested in who accesses your machine, and which +files are accessed, you should set the log level to 2 and regularly +create a new samba log file (⪚ set up a <command>cron</command> task +which once a week moves your current samba log file into another +folder or something like that). Otherwise your samba log file may +become very big.</para> + +<para>With the four checkboxes below the big list you can decide, which +events are displayed in the list. You have to press +<guibutton>Update</guibutton> to see the results. If the log level of +your samba is too low, you won't see everything.</para> + +<para>By clicking on the header of one column you can sort the list by +this column.</para> + +</sect2> + + +<sect2 id="smb-statistics"> +<title>Statistics</title> + +<para>On this page you can filter the contents of the third page for +certain contents.</para> + +<para>Let's say the <guilabel>Event</guilabel> field (not the one in the +list) is set to <userinput>Connection</userinput>, +<guilabel>Service/File</guilabel> is set to <userinput>*</userinput>, +<guilabel>Host/User</guilabel> is set to <userinput>*</userinput>, +<guilabel>Show expanded service info</guilabel> is disabled and +<guilabel>Show expanded host info</guilabel> is disabled.</para> + +<para>If you press <guibutton>Update</guibutton> now, you will see how +often a connection was opened to share <literal>*</literal> (&ie; to any +share) from host <literal>*</literal> (&ie; from any host). Now enable +<guilabel>Show expanded host info</guilabel> and press +<guibutton>Update</guibutton> again. Now you will see for every host +which matches the wildcard <literal>*</literal>, how many connections +were opened by him.</para> + +<para>Now press <guibutton>clear</guibutton>.</para> + +<para>Now set the <guilabel>Event</guilabel> field to File Access and +enable <guilabel>Show expanded service info</guilabel> and press +<guibutton>Update</guibutton> again.</para> + +<para>Now you will see how often every single file was accessed. If you +enable <guilabel>Show expanded host info</guilabel> too, you will see +how often every single user opened each file.</para> + +<para>In the input lines <guilabel>Service/File</guilabel> and +<guilabel>Host/User</guilabel> you can use the wildcards +<literal>*</literal> and <literal>?</literal> in the same way you use +them at the command line. Regular expressions are not +recognized.</para> + +<para>By clicking on the header of a column you can sort the list by +this column. This way you can check out which file was opened most +often, or which user opened the most files or whatever.</para> + +</sect2> + + +<sect2 id="smb-stat-author"> +<title>Section Author</title> + +<para>Module copyright 2000: Michael Glauche and &Alexander.Neundorf; &Alexander.Neundorf.mail;</para> + +<para>Originally written by: Michael Glauche</para> + +<para>Currently maintained by: &Alexander.Neundorf; &Alexander.Neundorf.mail;</para> + +<itemizedlist> +<title>Contributors</title> +<listitem><para>Conversion to kcontrol applet:</para> +<para>&Matthias.Hoelzer-Kluepfel; &Matthias.Hoelzer-Kluepfel.mail;</para></listitem> +<listitem><para>Use of <classname>TDEProcess</classname> instead of popen, and more error checking:</para> +<para>&David.Faure; &David.Faure.mail;</para></listitem> +<listitem><para>Conversion to tdecmodule, added tab pages 2,3,4, bug +fixed:</para> +<para>&Alexander.Neundorf; &Alexander.Neundorf.mail;</para></listitem> +</itemizedlist> + +<para>Documentation copyright 2000 &Alexander.Neundorf; &Alexander.Neundorf.mail;</para> + +<para>Documentation translated to docbook by &Mike.McBride; &Mike.McBride.mail;</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect2> +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/screensaver/CMakeLists.txt b/doc/kcontrol/screensaver/CMakeLists.txt new file mode 100644 index 000000000..140ae6a1d --- /dev/null +++ b/doc/kcontrol/screensaver/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/screensaver ) diff --git a/doc/kcontrol/screensaver/Makefile.am b/doc/kcontrol/screensaver/Makefile.am new file mode 100644 index 000000000..d9412ca98 --- /dev/null +++ b/doc/kcontrol/screensaver/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/screensaver diff --git a/doc/kcontrol/screensaver/index.docbook b/doc/kcontrol/screensaver/index.docbook new file mode 100644 index 000000000..3d7d43cb5 --- /dev/null +++ b/doc/kcontrol/screensaver/index.docbook @@ -0,0 +1,203 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-20</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>screensaver</keyword> +<keyword>screen saver</keyword> +</keywordset> +</articleinfo> + +<sect1 id="screensaver"> + +<title>Screen Saver</title> + +<para>Using this module, you can choose your screen saver, determine +how much time must pass before the screen saver is activated, and add +or remove password protection to your screen saver.</para> + +<sect2 id="ss-choose"> +<title>Choosing the screen saver, and configuring its options</title> + +<para>In the <guilabel>Settings</guilabel> box is a check box +labeled <guilabel>Start screen saver automatically</guilabel>. This +box must have a mark in it, or &tde; will not launch any screen saver +and it will not allow you to adjust the settings of your screen +saver.</para> + +<para>Along the left side is a list of all available screen savers. You can +select a screen saver by simply clicking on its name. Once +you have selected a screen saver, you will see a small preview on the +monitor on the right.</para> + +<note><para>The preview monitor will often show the screen saver +larger than it is when the screen saver is activated. This is done on +purpose, since many of the details of the screen savers would be +unintelligible if actually scaled down to such a small +size.</para></note> + +<para>Each screen saver has a different set of setup options. By +clicking on <guilabel>Setup...</guilabel>, a dialog box will appear with +all available options. As you adjust the options, the preview box in +the dialog box will show you what effect you will achieve with the +current settings.</para> + +<para>When you are done setting up your screen saver, click +<guibutton>OK</guibutton>.</para> <para>Clicking <guibutton>Cancel</guibutton> +will erase any changes you made in this dialog box, and return you to the +screen saver module.</para> + +<para>Clicking the <guibutton>About</guibutton> button will give you +the Copyright and Author information if you are interested.</para> + +<para>When you think you have all the options set the way you want, +simply click on <guibutton>Test</guibutton> to immediately start the +screen saver <emphasis>exactly</emphasis> as it will appear.</para> + +</sect2> + +<sect2 id="ss-options"> +<title>Setting the time, priority and passwords for screen +savers.</title> + +<para>Below the screensaver list is a check box to have the screen saver <guilabel>Start automatically</guilabel> check box, and a spin box which determines the period of inactivity before the screen saver should be started. You can enter any postive number of minutes in this box.</para> + +<para>Below that is a check box labeled <guilabel>Require password to +stop screen saver</guilabel>. If it is checked, when you click a key +or click a mouse button to end the screen saver and return to your +work, you must enter a password. The password used is the same +password you used to login to your machine. If there is no mark in +the check box, no password is required to return to your +desktop.</para> + +<para>Enable the check box <guilabel>Make aware of +power management</guilabel> if you don't want the screensaver to start +while you watch TV or movies on your monitor.</para> + +</sect2> + +<sect2 id="ss-other"><title>Using a non-&tde; screen saver</title> + +<para>&tde; does not prevent another screen saver from working. To use a +different screen saver, such as <application>xscreensaver</application>, simply +disable the &tde; Screen Saver, and set up your other screen saver program +normally.</para> + +</sect2> + +<sect2 id="screensaver-remove"> +<title>Removing and restoring a screen saver from your system</title> + +<para>If you want to remove a screen saver from the list in this +Control Center Module, you will need to rename a file on your +system.</para> + +<caution><para>Working as a <systemitem +class="username">root</systemitem> user is a potentially dangerous +situation. While unlikely, it is entirely possible to do permanent +damage to your system while working as +<emphasis>root</emphasis>.</para> + +<para>Be very careful following the next set of +directions</para></caution> + +<para>To delete a screen saver, type the following commands:</para> + +<screen> +<prompt>bash$</prompt> <command>cd +$TDEDIR/share/applnk/System/ScreenSavers</command> +<prompt>bash$</prompt> <command>ls</command> +</screen> + +<para>This will give you a list of files. You will notice +similarities between some of the file names and that of the screen saver you +want to remove. Simply rename the file of similarly named desktop +file to a name which does not end in +<emphasis>desktop</emphasis>.</para> + +<para>Example:</para> +<screen> +<prompt>bash$</prompt> <command>cd +$TDEDIR/share/applnk/System/ScreenSavers</command> +<prompt>bash$</prompt> <command>mv KSpace.desktop KSpace.backup</command> +</screen> + +<para>Will remove Space (GL) from the list</para> + +<note><para>You must close the &kcontrolcenter; entirely and restart it before +the changes will be seen.</para></note> + +<para>To restore the disabled screen saver, simply rename the file back to its +original name:</para> + +<screen> +<prompt>bash$</prompt> <command>cd +$TDEDIR/share/applnk/System/ScreenSavers</command> +<prompt>bash$</prompt> <command>mv KSpace.backup KSpace.desktop</command> +</screen> + +<para>Restart the &kcontrolcenter;, and the screen saver is back in the +list.</para> + +</sect2> + +<sect2 id="grace"> +<title>Advanced Settings: Grace period</title> + +<para>There is a five second grace period after the screen saver +begins before a password is required even if <guilabel>Require +password</guilabel> is checked.</para> +<para>Locking the desktop manually, by clicking the lock icon +in the &tde; panel, causes the password protection to engage immediately with +no grace period.</para> +<para>To alter the grace period setting, you need to manually edit the +configuration file. To do so:</para> +<para> +<prompt>$</prompt> <command>cd <filename>~/.trinity/share/config</filename> +</command> +</para> +<para>Now, using a text editor (the example uses &kate;, the &tde; text editor), +load the <filename>kdesktoprc</filename>.</para> +<para> +<prompt>$</prompt> <command>kate <filename>kdesktoprc</filename> +</command> +</para> +<para>Search through the file for the section labeled +<emphasis>[Screensaver]</emphasis>.</para> +<para>Look through all lines in the section for an entry entitled +<emphasis>LockGrace</emphasis>.</para> +<para>If the entry exists, you can edit the value of the entry.</para> +<screen>[Screensaver] +LockGrace=3000</screen> +<para>The value of the entity represents the duration of the grace period +in milliseconds. An entry of 3000, would change the grace period to 3 seconds. +You can set the value of the entry to any number between zero (no grace period) +and 300000 (5 minutes). +</para> +<para>If the entry does not exist, simply add the entry to the end of the +section.</para> + +<para>Any changes to the configuration entry take effect +immediately.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/screenshot.png b/doc/kcontrol/screenshot.png Binary files differnew file mode 100644 index 000000000..3a275cdb3 --- /dev/null +++ b/doc/kcontrol/screenshot.png diff --git a/doc/kcontrol/scsi/CMakeLists.txt b/doc/kcontrol/scsi/CMakeLists.txt new file mode 100644 index 000000000..1ecefb528 --- /dev/null +++ b/doc/kcontrol/scsi/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/scsi) diff --git a/doc/kcontrol/scsi/Makefile.am b/doc/kcontrol/scsi/Makefile.am new file mode 100644 index 000000000..4a0b433e5 --- /dev/null +++ b/doc/kcontrol/scsi/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG = en +KDE_DOCS = kcontrol/scsi diff --git a/doc/kcontrol/scsi/index.docbook b/doc/kcontrol/scsi/index.docbook new file mode 100644 index 000000000..87ec0934f --- /dev/null +++ b/doc/kcontrol/scsi/index.docbook @@ -0,0 +1,56 @@ +<?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><acronym>SCSI</acronym> Interface Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>SCSI</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="scsi"> + +<title><acronym>SCSI</acronym> Interface Information</title> + +<para>This page displays information about Small Computer Systems +Interface (<acronym>SCSI</acronym>) Interfaces and the attached +<acronym>SCSI</acronym> devices.</para> + +<note><para>The exact information displayed is system-dependent. On +some systems <acronym>SCSI</acronym> information cannot be displayed +yet.</para></note> + +<para>On &Linux;, this information is read from <filename +class="devicefile">/proc/scsi/scsi</filename>, which is only available +if the <filename class="directory">/proc</filename> pseudo-filesystem is +compiled into the kernel. A listing of all <acronym>SCSI</acronym> +devices known to the kernel is shown.</para> + +<para>The devices are sorted numerically by their host, channel, and +<acronym>ID</acronym> numbers.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/smb/CMakeLists.txt b/doc/kcontrol/smb/CMakeLists.txt new file mode 100644 index 000000000..ea221f7b7 --- /dev/null +++ b/doc/kcontrol/smb/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/smb ) diff --git a/doc/kcontrol/smb/Makefile.am b/doc/kcontrol/smb/Makefile.am new file mode 100644 index 000000000..9f75f1d22 --- /dev/null +++ b/doc/kcontrol/smb/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/smb diff --git a/doc/kcontrol/smb/index.docbook b/doc/kcontrol/smb/index.docbook new file mode 100644 index 000000000..33b2da650 --- /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>&tde; comes with built-in support for the <acronym>SMB</acronym> +protocol. As &tde; 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 &tde; 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 tdenetwork/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, &tde; 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, &tde; 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 &tde; 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 &tde; +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/sound/CMakeLists.txt b/doc/kcontrol/sound/CMakeLists.txt new file mode 100644 index 000000000..18f11a032 --- /dev/null +++ b/doc/kcontrol/sound/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/sound ) diff --git a/doc/kcontrol/sound/Makefile.am b/doc/kcontrol/sound/Makefile.am new file mode 100644 index 000000000..a1a9b851c --- /dev/null +++ b/doc/kcontrol/sound/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/sound diff --git a/doc/kcontrol/sound/index.docbook b/doc/kcontrol/sound/index.docbook new file mode 100644 index 000000000..de1fd601d --- /dev/null +++ b/doc/kcontrol/sound/index.docbook @@ -0,0 +1,51 @@ +<?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>Soundcard Information</title> +<articleinfo> + +<authorgroup> +<author>&Matthias.Hoelzer-Kluepfel;</author> +<author>&Helge.Deller;</author> +<author>&Duncan.Haldane;</author> +<author>&Mike.McBride;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>soundcard</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="soundinfo"> + +<title>Soundcard Information</title> + +<para>This page displays information about any soundcards installed in the +system.</para> + +<note><para>The exact information displayed is system-dependent. On some +systems, soundcard information cannot be displayed yet.</para></note> + +<para>On &Linux;, this information is read either from <filename +class="devicefile">/dev/sndstat</filename>, if present, or from +<filename class="devicefile">/proc/sound</filename>, which is only +available if the <filename class="directory">/proc</filename> +pseudo-filesystem is compiled into the (2.1.x or later) kernel.</para> + +<para>The user cannot modify any settings on this page.</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/spellchecking/CMakeLists.txt b/doc/kcontrol/spellchecking/CMakeLists.txt new file mode 100644 index 000000000..af38913c8 --- /dev/null +++ b/doc/kcontrol/spellchecking/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/spellchecking ) diff --git a/doc/kcontrol/spellchecking/Makefile.am b/doc/kcontrol/spellchecking/Makefile.am new file mode 100644 index 000000000..7eb60d12b --- /dev/null +++ b/doc/kcontrol/spellchecking/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/spellchecking diff --git a/doc/kcontrol/spellchecking/index.docbook b/doc/kcontrol/spellchecking/index.docbook new file mode 100644 index 000000000..2893d750b --- /dev/null +++ b/doc/kcontrol/spellchecking/index.docbook @@ -0,0 +1,88 @@ +<?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>2003-10-13</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Spelling</keyword> +<keyword>dictionary</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="spell-checking"> + +<title>Spell Checker</title> + +<para>The configuration options available here are used by all &tde; +applications that use &tdespell;, which is a front end to +<command>ispell</command> or <command>aspell</command>.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Create root/affix combinations not in +dictionary</guilabel></term> +<listitem> +<para>Selecting this option allows the spell checker to register as <quote>correct</quote> combinations of root words with suffixes or prefixes even if the particular combination is not listed in its dictionary database of words.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Consider run-together words as spelling +errors</guilabel></term> +<listitem><para>If this is selected, then words that appear in the +dictionary separately, but have been run together, are considered to be +spelling errors. For example, even though <quote>alarm</quote> and +<quote>clock</quote> might be in your dictionary, if +<quote>alarmclock</quote> is not, it will be flagged as a spelling +error.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Dictionary:</guilabel></term> +<listitem> +<para>Choose from the available dictionaries, which one to use for +&tdespell;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Encoding:</guilabel></term> +<listitem> +<para>You should select the one that matches the character set you are +using. In some cases, dictionaries will support more than one encoding. +A dictionary might, for example, accept accented characters when +<emphasis>Latin1</emphasis> is selected, but accept email-style +character combinations (like <userinput>'a</userinput> for an accented +<emphasis>a</emphasis>) when <emphasis>7-Bit-ASCII</emphasis> is +selected. Please see your dictionary's distribution for more +information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Client:</guilabel></term> +<listitem> +<para>You can choose which of the installed client applications on your +system to use. For example, you can choose <command>ispell</command>.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> +</article>
\ No newline at end of file diff --git a/doc/kcontrol/tdehtml/CMakeLists.txt b/doc/kcontrol/tdehtml/CMakeLists.txt new file mode 100644 index 000000000..b7e6bb6b7 --- /dev/null +++ b/doc/kcontrol/tdehtml/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/tdehtml ) diff --git a/doc/kcontrol/tdehtml/Makefile.am b/doc/kcontrol/tdehtml/Makefile.am new file mode 100644 index 000000000..07d632f49 --- /dev/null +++ b/doc/kcontrol/tdehtml/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/tdehtml diff --git a/doc/kcontrol/tdehtml/index.docbook b/doc/kcontrol/tdehtml/index.docbook new file mode 100644 index 000000000..a07cceee9 --- /dev/null +++ b/doc/kcontrol/tdehtml/index.docbook @@ -0,0 +1,364 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY nsplugins-kcontrol SYSTEM "nsplugin.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>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>konqueror</keyword> +<keyword>browsing</keyword> +</keywordset> + +</articleinfo> +<sect1 id="konq-browsing"> +<title>Browsing With &konqueror;</title> + +<para>The &konqueror; Browser module of &kcontrol; allows you to select +various options for the appearance and behavior of &konqueror;, the +integrated web browser of &tde;.</para> + +<sect2 id="kbrowse-html"> + +<title>Web Behavior</title> + +<para>The first group of options control bookmarks. With <guilabel>Ask for +name and folder when adding bookmarks</guilabel>, you can change the title +of the bookmark and select a folder to store the bookmark. With +<guilabel>Show only marked bookmarks in bookmark folder</guilabel> you +can change the way &konqueror; shows bookmarks in the bookmark toolbar.</para> + +<para>The next group of options control form completion. The first option +is <guilabel>Enable completion of forms</guilabel>. If you check this box, +&konqueror; will try to remember what you answer to form questions, and will +try to fill in forms for you with the answers you previously used.</para> + +<para>You can configure the number of form items &konqueror; remembers +with the slider below labelled <guilabel>Maximum +completions</guilabel></para> + +<note><para>Of course, anything &konqueror; fills in a form with, you +can still edit before submitting the form!</para></note> + +<para>The next option is <guilabel>Change cursor over +links</guilabel>. If this option is selected, the shape of the cursor +will change (usually to a hand) whenever it moves over a +hyperlink. This makes it easy to identify links, especially when they +are in the form of images.</para> + +<para>As a convenience feature, if you enable <guilabel>Right click +goes back in history</guilabel>, then clicking an empty area (&ie; not +a link) in the &konqueror; window will act as if you pressed the +<guiicon>Back</guiicon> button on the toolbar.</para> + +<para>The checkbox labeled <guilabel>Automatically load +images</guilabel>, allows you to control whether images on web pages are +loaded by default. Unless you have a very slow connection, you will +probably want to leave this option selected, as there are many web pages +that are difficult to use without images. If you don't select the option +to automatically load images, you can still view the text on the page, +and then load the images if you need them.</para> + +<para>Enabling <guilabel>Allow automatic delayed +reloading/redirecting</guilabel> allows websites to send you to +another page without your interaction. In many cases, this is a +convenience. For example, the website has moved to a new +<acronym>URL</acronym>. Many webmasters in this situation will put up +a page on the old site, telling you that it has moved and you may like +to change your bookmark, and then automatically move you along to the +new website. However, such features can be confusing, or annoying, +when misused, and so you may wish to disable it.</para> + +<para>The next setting is <guilabel>Underline links:</guilabel>. You can +choose to underline links <guilabel>Always</guilabel>. If this option +is selected, any text on web pages that acts as a link will be shown in +an underlined font. While many web pages do use color to distinguish +text that acts as a link, underlining makes it very easy to spot +links.</para> + +<para>If you don't like underlined links, you can choose +<guilabel>Never</guilabel>, so that no links are underlined. Or you +can choose a middle ground, <guilabel>Hover</guilabel>, so that links +are underlined when the mouse cursor is resting over them, and not +underlined the rest of the time.</para> + +<para>Many web pages use animated gif images, and these can be very +annoying, and in some cases, quite a drain on your system resources. +The <guilabel>Animations</guilabel> option lets you choose when +animations are enabled. The default is enabled, but you can set this +to disabled, or to run the animation only once, even if the file +itself contains instructions that the animation should run more times, +or continuously.</para> + +</sect2> + +<sect2 id="userinterface"> + +<title>User Interface</title> + +<para>&konqueror; defaults to a single window per page, but has the +ability to open multiple <firstterm>tabs</firstterm> inside a +single window. By default, &konqueror; has a &MMB; shortcut to +open any link in a new window. If you enable <guilabel>Open links in +new tab instead of in new window</guilabel> you can &MMB; click on a +link to have it open in a new tab.</para> + +<para>If you are using tabbed browsing, you can choose if a newly +opened tab becomes the active (<quote>front</quote>) tab, or goes to +the back. On a slow internet connection, or while browsing a page +that has a list of headlines or other links in a list, you may like to +have the new tabs load in the background while you continue reading. +In this case, leave this setting disabled. If you prefer to go +straight to the new page, leaving the old one in the background to +return to later, enable it.</para> + +<para>If you close a window in &konqueror; that has multiple tabs +open, &konqueror; will ask you if you're sure that you meant to close +it. You can toggle on and off this behavior with the +<guilabel>Confirm when closing windows with multiple tabs</guilabel> +checkbox.</para> + +</sect2> + +<sect2 id="kbrowse-appearance"> + +<title>Fonts</title> + +<para>Under this tab, you can select various options related to the use +of fonts. Although the shapes and sizes of fonts are often part of the +design of a web page, you can select some default settings for +&konqueror; to use.</para> + +<para>The first thing you can set here is the font size. There are two +settings which work together to allow you a comfortable browsing +experience.</para> + +<para>Firstly, you can set a <guilabel>Minimum Font Size</guilabel>. +This means, even if the font size is set specifically in the page you +are viewing, &konqueror; will ignore that instruction and never show +smaller fonts than you set here.</para> + +<para>Next you can set a <guilabel>Medium Font Size</guilabel>. This is +not only the default size of text, used when the page doesn't specify +sizes, but it is also used as the base size that relative font sizes are +calculated against. That is, the <acronym>HTML</acronym> instruction +<quote>smaller</quote>, it means smaller than the size you set for this +option.</para> + +<para>For either option, you can select the exact font size in points by +using the up/down spin control (or just typing) next to the option +label.</para> + +<para>These options are independent of each other. Pages that do not +set a font size, or ask for the default, will display with the size +you set from <guilabel>Medium Font Size</guilabel>, while any pages +that ask for a size smaller than your <guilabel>Minimum Font +Size</guilabel> setting will instead show that size. The one does not +affect the other.</para> + +<para>The remaining options are for the fonts to be associated with +different types of markup used in <acronym>HTML</acronym> pages. Note +that many web pages may override these settings. If you click anywhere +on a control which shows a font name, a list of font names appears, and +you can select a different font if you like. (If there are a lot of +fonts, a vertical scrollbar appears in the list to allow you to scroll +through all of the fonts.)</para> +<!-- +<para>You can set a font for each <quote>type</quote> of markup, for +each <guilabel>Charset</guilabel>, by changing the character set in the +first drop down box, and then selecting a font for each category below. +This would take quite some time, so you may just want to set up the +fonts for your default character set. Most English speaking users will +use iso8859-1</para> +--> +<para>Below this, you can set a <guilabel>Font size adjustment for this +encoding</guilabel>. Sometimes the fonts you want to use for a +particular encoding or language are much larger or smaller than average, +so you can use this setting to bring them into line.</para> + +<para>You can set a default encoding that &konqueror; should assume +pages are when rendering them. The default setting is <guilabel>Use +language encoding</guilabel>, but you can change it to any encoding +available in the list.</para> + +</sect2> + +<sect2 id="kbrowse-java"> +<title>&Java; and JavaScript</title> + +<para>&Java; allows applications to be downloaded and run by a web +browser, provided you have the necessary software installed on your +machine. Many web sites make use of &Java; (for example, online +banking services or interactive gaming sites). You should be aware +that running programs from unknown sources could pose a threat to the +security of your computer, even if the potential extent of the damage +is not great.</para> + +<para>The checkboxes under <guilabel>Global Settings</guilabel> allows +you to turn &Java; support on for all web sites by default. You can +also select to turn &Java; on or off for specific hosts. To add a +policy for a specific host, click the <guilabel>Add...</guilabel> +button to bring up a dialog in which you can type the host name and +then choose to accept or reject &Java; code from that particular host, +which will add the domain to the list on the left of the page.</para> + +<para>You can select a host in the list, and click the +<guilabel>Change...</guilabel> button to choose a different policy for +that host. Clicking the <guilabel>Delete</guilabel> button removes the +policy for the selected host; after deletion, the global settings will +then apply to that host. You can import policies from a file by clicking +the <guilabel>Import...</guilabel> button. To save the current list to a +compressed archive file, click the <guilabel>Export...</guilabel> +button.</para> + +<para>Finally, the group of controls labeled <guilabel>Java Runtime +Settings</guilabel> allows you to set some options for the way in +which &Java; should run. These options are useful for diagnosing +problems, or if you are a &Java; developer, and should not normally +need adjusting.</para> + +<para>If you select the <guilabel>Show Java +Console</guilabel> option, &konqueror; will open a console window from +which &Java; applications can read and write text. While most &Java; +applications will not require such a console, it could be helpful in +diagnosing problems with &Java; applications.</para> + +<para><guilabel>Use TDEIO</guilabel> will cause the +<acronym>JVM</acronym>to use &tde;'s own <acronym>TDEIO</acronym> +transports for network connections.</para> + +<para><guilabel>Use security +manager</guilabel> is normally enabled by default. This setting will +cause the <acronym>JVM</acronym> to run with a Security Manager in place. This will keep +applets from being able to read and write to your file system, creating +arbitrary sockets, and other actions which could be used to compromise +your system. Disable this option at your own risk. You can modify your <filename>$<envar>HOME</envar>/.java.policy</filename> file with the +&Java; policytool utility to give code downloaded from certain sites +more permissions.</para> + +<para>The <guilabel>Shutdown Applet Server when inactive</guilabel> +checkbox allows you to save resources by closing the &Java; Applet +Server when it is not in use, rather than leaving it running in the +background. Leaving this disabled may make &Java; applets start up +faster, but it will use system resources when you are not using a +&Java; applet. If you enable this, you can set a timeout.</para> + +<para>You can either opt to have &konqueror; automatically detect the +&Java; installation on your system, or specify the path to the +installation yourself by selecting <guilabel>Use user-specified +Java</guilabel>. You may want to choose the latter method, for +instance, if you have multiple &Java; installations on your system, +and want to specify which one to use. If the &Java; Virtual Machine +you are using requires any special startup options, you can type them +in the text box labeled <guilabel>Additional Java +Arguments</guilabel>.</para> + +</sect2> + +<sect2 id="kbrowse-javascript"> +<title>JavaScript</title> + +<para>Despite the name, JavaScript is not related at all to +&Java;.</para> + +<para>The first part of this page works the same as the &Java; page +settings.</para> + +<para>The checkboxes under <guilabel>Global Settings</guilabel> allow +you to turn JavaScript support on for all web sites by default. You +can also select to turn JavaScript on or off for specific hosts. To +add a policy for a specific host, click the +<guilabel>Add...</guilabel> button to bring up a dialog in which you +can type the host name and then choose to accept or reject JavaScript +code from that particular host, which will add the domain to the list +on the left of the page.</para> + +<para>You can select a host in the list, and click the +<guilabel>Change...</guilabel> button to choose a different policy for +that host. Clicking the <guilabel>Delete</guilabel> button removes the +policy for the selected host; after deletion, the global settings will +then apply to that host. You can import policies from a file by +clicking the <guilabel>Import...</guilabel> button. To save the +current list to a compressed archive file, click the +<guilabel>Export...</guilabel> button.</para> + +<para>The final set of options on this page determine what happens +when a page uses JavaScript for specific actions.</para> + +<para>You can individually enable or disable the ability of JavaScript +to manipulate your windows by moving, resizing or changing focus. You +can also disable JavaScript from changing the status bar text, so that +for instance, you can always see where links will take you when +clicked.The choices for these options are <guilabel>Allow</guilabel> and +<guilabel>Ignore</guilabel>.</para> + +<para>For opening a new window, there is even more control. You can +set &konqueror; to <guilabel>Allow</guilabel> all such requests, +<guilabel>Ask</guilabel> each time a request is made, or +<guilabel>Deny</guilabel> all popup requests.</para> + +<para>The <guilabel>Smart</guilabel> setting will only allow +JavaScript popup windows when you have explicitly chosen a link that +creates one.</para> + +</sect2> + +<sect2 id="tdehtml-adblock"> +<title>AdBlocK</title> + +<para>&konqueror; AdBlocK can be configured to replace or remove +images or frames from web pages that match a series of filters.</para> + +<para>The setting <guilabel>Enable filters</guilabel> enables or +disables the use of list of URL filters.</para> +<para>If <guilabel>Hide filtered images</guilabel> is enabled then +blocked images are completely removed from the page and the space they +occupied is reclaimed. If the option is disabled then a placeholder +image is used in place of filtered images.</para> + +<para><guilabel>URL expressions to filter</guilabel> is a list of +URLs that will be compared against image and frame names to decide +on fitlering actions. The wildcards can be given as filename style +regular expressions.</para> + +<para>Each filter can either be expressed as a file style wildcard +string (e.g. http://www.site.com/ads/*) or as a full regular expression +by enclosing the filter with forward slashes (e.g. //(ads|dclk)\./).</para> + +<para>Import and export will save or read the current filter list to a +plain text file. Lines prefixed with an exclamation mark (!) are treated +as comments and can be used to clarify or label a set of filters.</para> +</sect2> + +<sect2 id="kbrowse-plugins"> +<title>Plugins</title> + +<para>The first setting here is <guilabel>Enable Plugins +globally</guilabel>. If you disable this checkbox, then &konqueror; +will not use any plugins. If you enable it, then any installed and +configured plugins that it can find will be used by &konqueror;</para> + +<para>You can also restrict &konqueror; to <guilabel>Only allow HTTP +and HTTPS URLs for plugins</guilabel> by checking the box.</para> + +</sect2> + +&nsplugins-kcontrol; + +</sect1> + +</article> diff --git a/doc/kcontrol/tdehtml/nsplugin.docbook b/doc/kcontrol/tdehtml/nsplugin.docbook new file mode 100644 index 000000000..958a8f1a1 --- /dev/null +++ b/doc/kcontrol/tdehtml/nsplugin.docbook @@ -0,0 +1,91 @@ +<sect2 id="nsplugins"> +<title>&Netscape; Plugins</title> + +<sect3 id="nsplugins-intro"> +<title>Introduction</title> + +<para>As &Netscape;'s <application>Navigator</application> has been a +web browsing standard for many years, so-called &Netscape; plugins have +appeared that allow rich web content. Using those plugins, web sites +can contain <acronym>PDF</acronym> files, flash animations, video, &etc; +With &konqueror;, you can still use these plugins to take advantage of +rich web content.</para> + +<note><para>&Netscape; plugins should not be confused with &konqueror; +plugins. The latter ones specifically extend &konqueror;'s +functionality; they are normally not used to display rich web +content.</para></note> + +</sect3> + +<sect3 id="nsplugins-scan"> +<title>Scan</title> + +<para>&konqueror; has to know where your &Netscape; plugins are +installed. This can be in several places, &ie; you might have +system-wide plugins in <filename +class="directory">/opt/netscape/plugins</filename> and your personal +plugins in <filename +class="directory">$<envar>HOME</envar>/.netscape/plugins</filename>. +However, &konqueror; will not automatically use the installed plugins: +it first has to scan a list of folders. You can initiate the scan +by clicking <guibutton>Scan for new plugins</guibutton>. Alternatively, +you can enable <guilabel>Scan for new plugins at &tde; startup</guilabel> +so &konqueror; will scan the appropriate folders every time &tde; +starts up, to see whether new plugins have been installed.</para> + +<note><para>Enabling <guilabel>Scan for new plugins at &tde; +startup</guilabel> can considerably slow down the startup procedure, +and is known to give difficulty on certain installations. Turn this +option off if you experience problems.</para></note> + +<para>To find plugins, &konqueror; will look in the folders +specified in the <guilabel>Scan Folders</guilabel> frame. When you +use this control module for the first time, this list will already be +filled with reasonable paths that should work on most operating systems. +If you need to provide a new path, click the <guibutton>New</guibutton> +button; then you can either enter the new path in the text edit box to +the left, or choose a folder using the file dialog by clicking the +<guibutton>New...</guibutton> button. As scanning the folders can take +a little time, you might want to remove folders from the list where +you know that no plugins are installed: do this by selecting a folder +and clicking <guibutton>Remove</guibutton>. Using the +<guibutton>Up</guibutton> and <guibutton>Down</guibutton> buttons you +can change the order in which folders will be scanned by moving the +selected folder up or down.</para> + +<para>As usual, click <guibutton>Apply</guibutton> to save your changes +permanently.</para> + +</sect3> + +<sect3 id="nsplugins-plugins"> +<title>Plugins</title> + +<para>In this tab, you can see a list of the &Netscape; plugins found by +&konqueror;, displayed as a tree. Double click on a plugin to fold it +out and you'll see that the different mime types this plugin can handle +will be displayed as branches. Fold out a mime type to see its +info.</para> + +<para>This tab is mostly for informational purposes. The only +configurable option is <guilabel>Use artsdsp to pipe plugin sound +through aRts</guilabel>, which is enabled by default. Disable this if +you wish plugins to use their own method for sounds, and you have +configured &arts; in such a way that third-party applications can do +so (for example, by having it exit when idle, or by having it use a +custom sound device on modern soundcards which allow this.)</para> + +</sect3> + +<sect3 id="nsplugins-author"> +<title>Section Author</title> + +<para>This section written by: Jost Schenck +<email>[email protected]</email></para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect3> + +</sect2> diff --git a/doc/kcontrol/tderandrtray/CMakeLists.txt b/doc/kcontrol/tderandrtray/CMakeLists.txt new file mode 100644 index 000000000..416cd1d88 --- /dev/null +++ b/doc/kcontrol/tderandrtray/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION tderandrtray ) diff --git a/doc/kcontrol/tderandrtray/Makefile.am b/doc/kcontrol/tderandrtray/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/tderandrtray/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/tderandrtray/index.docbook b/doc/kcontrol/tderandrtray/index.docbook new file mode 100644 index 000000000..cc85d364f --- /dev/null +++ b/doc/kcontrol/tderandrtray/index.docbook @@ -0,0 +1,63 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY tderandrtray "<application>tderandrtray</application>"> + <!ENTITY kappname "&tderandrtray;"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>The &kappname; Handbook</title> + +<articleinfo> +<title>The &kappname; Handbook</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<abstract> +<para> +&kappname; is a system tray frontend to xrandr (X resize and rotate). +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>randr</keyword> +<keyword>resize</keyword> +<keyword>rotate</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="apologies"> +<title>We Apologize</title> +<para>No documentation has yet been written for &kappname;.</para> + +<para>If you need help, please check <ulink url="http://www.trinitydesktop.org">The &tde; +web site</ulink>, submit questions to the <ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; mail lists</ulink>, or file a bug report at the <ulink url="http://bugs.trinitydesktop.org/"> +&tde; bug tracker</ulink>.</para> + +<para>If you are interested in helping, please consider writing the help file. +Submitting a basic text file is acceptable as the &tde-team; will convert the text.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +&underFDL; + +</sect1> + +</article> diff --git a/doc/kcontrol/tderesources/CMakeLists.txt b/doc/kcontrol/tderesources/CMakeLists.txt new file mode 100644 index 000000000..cf53bfff7 --- /dev/null +++ b/doc/kcontrol/tderesources/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/tderesources ) diff --git a/doc/kcontrol/tderesources/Makefile.am b/doc/kcontrol/tderesources/Makefile.am new file mode 100644 index 000000000..90dcdfc8d --- /dev/null +++ b/doc/kcontrol/tderesources/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/tderesources diff --git a/doc/kcontrol/tderesources/index.docbook b/doc/kcontrol/tderesources/index.docbook new file mode 100644 index 000000000..615347f8d --- /dev/null +++ b/doc/kcontrol/tderesources/index.docbook @@ -0,0 +1,103 @@ +<?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>&tde; Resources</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Burkhard</firstname><surname>Lück</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2010</year> +<holder>Burkhard Lück</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>System Settings</keyword> +<keyword>resources</keyword> +<keyword>address</keyword> +<keyword>alarm</keyword> +<keyword>calendar</keyword> +<keyword>notes</keyword> +</keywordset> +</articleinfo> + +<sect1 id="paths"> +<title>&tde; Resources</title> + +<para>This module is a configuration tool for managing the resources used by different &tde; applications. +The module allows adding, deleting or modifying the resources for <guilabel>Calendar</guilabel>, +<guilabel>Notes</guilabel> and <guilabel>Contacts</guilabel>.</para> + +<para>Select a resource type from the drop down box at the top of the <guilabel>Resources</guilabel> section. +The list box now displays names and types of available resources of this type. +One of these resources is marked as the standard resource.</para> + +<para>Use the buttons on the right side of the list box to add, remove, or edit resources.</para> + +<para>Detailed information about resource types and options you find in the links provided in the following +table:</para> + +<para> +<table> +<title>Available Resources</title> +<tgroup cols="3"> +<tbody> +<row> +<entry>Resource Type</entry> +<entry>Used by</entry> +<entry>Additional information</entry> +</row> +<row> +<entry>Calendar</entry> +<entry><simplelist type="inline"><member>&korganizer;</member> +<member>iCal invitation plugin in &kmail;</member></simplelist></entry> +<entry><ulink url="help:/korganizer/managing-data.html#managing-resources">&korganizer; resources</ulink></entry> +</row> +<row> +<entry>Notes</entry> +<entry><simplelist type="inline"><member>&knotes;</member></simplelist></entry> +</row> +<row> +<entry>Contacts</entry> +<entry><simplelist type="inline"> +<member>&kaddressbook;</member> +<member>address completion in &kmail;, &knode; and &korganizer;</member> +<member>address book integration in &kopete;</member> +<member>&konversation;</member> +<member>KonsoleKalendar</member></simplelist> </entry> +<entry></entry> +</row> +</tbody> +</tgroup> +</table> +</para> + +<para>Every resource type needs a standard resource, where all data should be +saved if no other resource is specified. Use the <guibutton>Use as Standard</guibutton> button +when you want to change the standard resource. You must have +both read and write permissions to the new standard resource to be able select the resource. +</para> + +</sect1> + +</article> diff --git a/doc/kcontrol/twindecoration/CMakeLists.txt b/doc/kcontrol/twindecoration/CMakeLists.txt new file mode 100644 index 000000000..a4fb05f50 --- /dev/null +++ b/doc/kcontrol/twindecoration/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/twindecoration ) diff --git a/doc/kcontrol/twindecoration/Makefile.am b/doc/kcontrol/twindecoration/Makefile.am new file mode 100644 index 000000000..6ee826f55 --- /dev/null +++ b/doc/kcontrol/twindecoration/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/twindecoration diff --git a/doc/kcontrol/twindecoration/index.docbook b/doc/kcontrol/twindecoration/index.docbook new file mode 100644 index 000000000..0efb5bb17 --- /dev/null +++ b/doc/kcontrol/twindecoration/index.docbook @@ -0,0 +1,98 @@ +<?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>&Rik.Hemsley; &Rik.Hemsley.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-09-28</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>twin</keyword> +<keyword>window</keyword> +<keyword>border</keyword> +<keyword>theme</keyword> +<keyword>style</keyword> +</keywordset> +</articleinfo> +<sect1 id="window-deco"> +<title>Window Decoration</title> + +<sect2 id="window-deco-general"> +<title>General</title> + +<para>This module allows you to select a style for the borders around +windows.</para> + +<para>Each style has a different look, but also a different +<quote>feel</quote>. Some have (sometimes invisible) +<quote>resize</quote> borders all around the edge, which make resizing +easier but moving more difficult. Some have no borders on certain +edges. One (<quote>BII</quote>) even has a dynamically sized and +positioned title element.</para> + +<para>You are encouraged to experiment with the different styles until +you find one which best suits your pattern of work.</para> + +<para>Choose a window decoration style from the drop down box at the +top of the screen to see a preview of it in the lower pane.</para> + +<para>If there are any configurable options for the theme you chose on +the first page, they will become available below the preview...</para> + +<!-- +<para>In particular, if you chose to use the IceWM theme, you can choose +here which of the many IceWM themes to use. The IceWM theme has +instructions on the page as to where you should copy the theme files, +and once this is done, you can simply select the theme you want to +use.</para> +--> + +</sect2> + +<sect2 id="window-deco-buttons"> +<title>Buttons</title> + +<para>This page has instructions directly on it - just drag around the +buttons until you have the order that makes you comfortable.</para> + +<note> +<para>Not all the window decorations are able to comply with your custom +set button order. The ones that cannot are being converted, but at the +time of this release they have not been all been changed.</para> +</note> + +<para>Apart from choosing the window decoration itself, you can choose +here two further options: If there should be a tooltip while you hover +your mouse over a window decoration button, and if the window +decoration should attempt to use a custom set button order.</para> + +<tip> +<para>The tooltips can be quite useful if you have set a custom button +order, and then changed to an unfamiliar window decoration.</para> +</tip> + +<tip> +<para>For accessibility purposes, some window decorations support +extra wide borders. If this is available, you can also choose a +border size here. These large borders are easier to see for low +vision users, and easier to grab for people with limited mobility or +difficulty using a mouse.</para> +</tip> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/usb/CMakeLists.txt b/doc/kcontrol/usb/CMakeLists.txt new file mode 100644 index 000000000..7be562cd5 --- /dev/null +++ b/doc/kcontrol/usb/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/usb ) diff --git a/doc/kcontrol/usb/Makefile.am b/doc/kcontrol/usb/Makefile.am new file mode 100644 index 000000000..2d7f2a44c --- /dev/null +++ b/doc/kcontrol/usb/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/usb diff --git a/doc/kcontrol/usb/index.docbook b/doc/kcontrol/usb/index.docbook new file mode 100644 index 000000000..8936fa796 --- /dev/null +++ b/doc/kcontrol/usb/index.docbook @@ -0,0 +1,43 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<title><acronym>USB</acronym></title> +<articleinfo> + +<authorgroup> +<author> +<firstname></firstname> +<surname></surname> +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KControl</keyword> +<keyword>USB</keyword> +<keyword>System Information</keyword> +</keywordset> +</articleinfo> + +<sect1 id="usb"> + +<title><acronym>USB</acronym></title> + +<para>This module allows you to see the devices attached to your +<acronym>USB</acronym> bus(es).</para> + +<para>This module is for information only, you cannot edit any +information you see here.</para> +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/useraccount/CMakeLists.txt b/doc/kcontrol/useraccount/CMakeLists.txt new file mode 100644 index 000000000..c05285927 --- /dev/null +++ b/doc/kcontrol/useraccount/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/useraccount ) diff --git a/doc/kcontrol/useraccount/Makefile.am b/doc/kcontrol/useraccount/Makefile.am new file mode 100644 index 000000000..416915575 --- /dev/null +++ b/doc/kcontrol/useraccount/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/useraccount/index.docbook b/doc/kcontrol/useraccount/index.docbook new file mode 100644 index 000000000..4b8c66d0f --- /dev/null +++ b/doc/kcontrol/useraccount/index.docbook @@ -0,0 +1,180 @@ +<?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"> +]> + +<article lang="&language;"> +<title>Password & User Account</title> + +<articleinfo> +<authorgroup> +<author> +<firstname>Michael</firstname> +<surname>Anderson</surname> +</author> +<author> +<firstname>Anne-Marie</firstname> +<surname>Mahfouf</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>Michael Anderson</holder> +<holder>Anne-Marie Mahfouf</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<abstract> +<para> +This handbook describes the Password & User Account module. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>System Settings</keyword> +<keyword>kcontrol</keyword> +<keyword>user</keyword> +<keyword>account</keyword> +<keyword>password</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="useraccount"> +<title>User Information</title> +<sect2 id="intro"> +<title>Introduction</title> + +<para> +<screenshot> +<screeninfo>Screenshot of the User Account Manager</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="useraccount.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>The User Account Manager</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + +<para>This is a module to enter user information and configure basic user settings such as +the password and icon. This information and these settings will be used by various &tde; +applications (mail programs and word processors for example) when they are completed. You can:</para> + +<itemizedlist> +<listitem><para>change your user icon</para></listitem> +<listitem><para>change your user login password</para></listitem> +<listitem><para>add personal information</para></listitem> +<listitem><para>configure the password prompt</para></listitem> +</itemizedlist> + +</sect2> + +<sect2 id="icons"> +<title>User Icon and Password</title> + +<variablelist> +<varlistentry><term>User Icon</term> +<listitem> +<para> +This icon is used when the user logs in using a login manager. When your administrator +has configured the login manager to allow this option, selecting the button allows you +to change the image, either by using a pre-installed icons or selecting one of your own images. +Select the <guibutton>Apply</guibutton> to make the changes permanent. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="user-info"> +<title>User Information</title> + +<variablelist> +<varlistentry><term><guilabel>Name:</guilabel></term> +<listitem> +<para> +Enter here the name of the user. +</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Organization</guilabel></term> +<listitem> +<para> +Add a business or group name the user would like to be associated with. +</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>Email address:</guilabel></term> +<listitem> +<para> +Enter here an email address that will be associated with this user. +</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>SMTP server:</guilabel></term> +<listitem> +<para> +Indicate here a local smtp server for sending mail within a network. +</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>User ID</guilabel></term> +<listitem> +<para> +This is an information only, providing you the User ID assigned to you. This number is +defined in <filename>/etc/passwd</filename> and was defined when your user account was created. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="password"> +<title>At Password Prompt</title> + +<para> +This section allows you to choose how you want to input your password when prompted. +The default is to have one bullet appear for each letter typed. That can be changed +to three bullets for each letter, which making guessing the length of the password +more difficult letters when somebody else is watching. Even more secure is to display +nothing while typing the password. +</para> + +</sect2> + +<sect2 id="change-password"> +<title>Change Password</title> + +<variablelist> +<varlistentry><term><guibutton>Change password...</guibutton></term> +<listitem> +<para> +Selecting this button displays a dialog to change your user password. Your user password +is the one you log in your system. You will be asked for your current password then twice +for your new password. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> +</article> diff --git a/doc/kcontrol/useraccount/useraccount.png b/doc/kcontrol/useraccount/useraccount.png Binary files differnew file mode 100644 index 000000000..812313f27 --- /dev/null +++ b/doc/kcontrol/useraccount/useraccount.png diff --git a/doc/kcontrol/useragent/CMakeLists.txt b/doc/kcontrol/useragent/CMakeLists.txt new file mode 100644 index 000000000..7a325cd12 --- /dev/null +++ b/doc/kcontrol/useragent/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/useragent ) diff --git a/doc/kcontrol/useragent/Makefile.am b/doc/kcontrol/useragent/Makefile.am new file mode 100644 index 000000000..c7efa77d7 --- /dev/null +++ b/doc/kcontrol/useragent/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/useragent diff --git a/doc/kcontrol/useragent/index.docbook b/doc/kcontrol/useragent/index.docbook new file mode 100644 index 000000000..1d70a0edd --- /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 diff --git a/doc/kcontrol/view1394/CMakeLists.txt b/doc/kcontrol/view1394/CMakeLists.txt new file mode 100644 index 000000000..e939755fa --- /dev/null +++ b/doc/kcontrol/view1394/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/view1394 ) diff --git a/doc/kcontrol/view1394/Makefile.am b/doc/kcontrol/view1394/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/view1394/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/view1394/index.docbook b/doc/kcontrol/view1394/index.docbook new file mode 100644 index 000000000..87701f25b --- /dev/null +++ b/doc/kcontrol/view1394/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"> +]> + +<article lang="&language;"> +<title><acronym>IEEE 1394</acronym> Devices</title> + +<articleinfo> + +<authorgroup> +<author> +<firstname>Michael</firstname> +<surname>McBride</surname> +</author> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>&Mike.McBride;</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<keywordset> +<keyword>TDE</keyword> +<keyword>IEEE</keyword> +<keyword>1394</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="kcmview1394"> +<title>IEEE 1394 Device Information Module</title> + +<para>The IEEE 1394 interface, also known as <trademark>FireWire</trademark>, +is a serial bus interface standard for high-speed +communications and isochronous real-time data transfer.</para> + +<para>The list in this module displays all devices attached to IEEE 1394 bus and +allows you to reset the bus by selecting the <guibutton>Generate 1394 Bus Reset</guibutton> +button.</para> + +<para>The meaning of the columns in this list:</para> +<itemizedlist> +<listitem><para><guilabel>Name</guilabel>: port or node name, the number can change with each bus reset</para></listitem> +<listitem><para><guilabel>GUID</guilabel>: the 64 bit GUID of the node</para></listitem> +<listitem><para><guilabel>Local</guilabel>: checked if the node is an IEEE 1394 port of your computer</para></listitem> +<listitem><para><guilabel>IRM</guilabel>: checked if the node is isochronous resource manager capable</para></listitem> +<listitem><para><guilabel>CRM</guilabel>: checked if the node is cycle master capable</para></listitem> +<listitem><para><guilabel>ISO</guilabel>: checked if the node supports isochronous transfers</para></listitem> +<listitem><para><guilabel>BM</guilabel>: checked if the node is bus manager capable</para></listitem> +<listitem><para><guilabel>PM</guilabel>: checked if the node is power management capable</para></listitem> +<listitem><para><guilabel>Acc</guilabel>: the cycle clock accuracy of the node, valid from 0 to 100</para></listitem> +<listitem><para><guilabel>Speed</guilabel>: the speed of the node</para></listitem> +<listitem><para><guilabel>Vendor</guilabel>: the vendor of the device</para></listitem> +</itemizedlist> + +</sect1> + +</article> diff --git a/doc/kcontrol/windowbehavior/CMakeLists.txt b/doc/kcontrol/windowbehavior/CMakeLists.txt new file mode 100644 index 000000000..cbbfb194a --- /dev/null +++ b/doc/kcontrol/windowbehavior/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/windowbehavior ) diff --git a/doc/kcontrol/windowbehavior/Makefile.am b/doc/kcontrol/windowbehavior/Makefile.am new file mode 100644 index 000000000..085981d9b --- /dev/null +++ b/doc/kcontrol/windowbehavior/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/windowbehavior/index.docbook b/doc/kcontrol/windowbehavior/index.docbook new file mode 100644 index 000000000..356e3ce0f --- /dev/null +++ b/doc/kcontrol/windowbehavior/index.docbook @@ -0,0 +1,792 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kompmgr "kompmgr"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<article lang="&language;"> +<title>Window Behavior</title> + +<articleinfo> + +<authorgroup> +<author>&Mike.McBride;</author> +<author>&Jost.Schenck;</author> +<author>&tde-authors;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<releaseinfo>&tde-release-version;</releaseinfo> +<date>Reviewed: &tde-release-date;</date> + +<copyright> +<year>2010</year> +<holder>Mike McBride</holder> +<holder>Jost Schenck</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<keywordset> +<keyword>TDE</keyword> +<keyword>KControl</keyword> +<keyword>system settings</keyword> +<keyword>window behavior</keyword> +<keyword>focus</keyword> +<keyword>actions</keyword> +<keyword>moving</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="window-behavior"> +<title>Window Behavior</title> + +<para> In the upper part of this control module you can see several +tabs: <guilabel>Focus</guilabel>, <guilabel>Titlebar Actions</guilabel>, +<guilabel>Window Actions</guilabel>, <guilabel>Moving</guilabel>, +<guilabel>Advanced</guilabel>, and <guilabel>Translucency</guilabel>. + +In the <guilabel>Focus</guilabel> panel you can configure how windows gain or +lose focus, &ie; become active or inactive. + +Using <guilabel>Titlebar Actions</guilabel> and <guilabel>Window Actions</guilabel> +you can configure how titlebars and windows react to +mouse clicks. + +<guilabel>Moving</guilabel> allows you to configure how +windows move and place themselves when started. + +The <guilabel>Advanced</guilabel> options cover some specialized options +involving moving windows between desktops and <quote>window +shading</quote>. + +The <guilabel>Translucency</guilabel> options support +window manager desktop effects through the kompmgr compositing manager. +</para> + +<note> +<para> +Please note the configuration options in this module will not take effect +when you do not use &tde;'s native window manager, &twin;. When you use a +different window manager, please refer to the respective documentation for +customizing window behavior. +</para> +</note> + +<sect2 id="focus"> +<title>Focus</title> + +<para> +The <quote>focus</quote> of the desktop refers to the window which the +user is currently working on. The window with focus is often referred to +as the <quote>active window</quote>. +</para> + +<para>Focus does not necessarily mean the window is the one at the +front — this is referred to as <quote>raised</quote>, and +although this is configured here as well, focus and raising of windows +are configured independently.</para> + +<sect3 id="focus-focus-policy"> +<title>Focus Policy</title> + +<para> +There are four methods &tde; can use to determine the current focus: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Click to Focus</guilabel></term> +<listitem> +<para> +A window becomes active when you click into it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Focus Follows Mouse</guilabel></term> +<listitem> +<para> +Moving the mouse pointer actively over a normal window activates it. New +windows such as the mini command line invoked with +<keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will receive the focus, +without you having to point the mouse at them explicitly. +</para> + +<para> +In other window managers, this is sometimes known as <quote>Sloppy focus +follows mouse.</quote> +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Focus Under Mouse</guilabel></term> +<listitem> +<para> +The window that happens to be under the mouse pointer becomes active. When +the mouse is not over a window (for instance, it's on the desktop) the last +window that was under the mouse has focus. New windows such as the mini +command line invoked with <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will +not receive the focus, you must move the mouse over them to type. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Focus Strictly Under Mouse</guilabel></term> +<listitem> +<para>Similar to <guilabel>Focus Under Mouse</guilabel>, but even more +strict with its interpretation. Only the window under the mouse pointer is +active. When the mouse pointer is not over a window, no window has focus. +New windows such as the mini command line invoked with +<keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo> will not receive the focus, +you must move the mouse over them to type. +</para> + +<note><para>Note that <guilabel>Focus Under Mouse</guilabel> and +<guilabel>Focus Strictly Under Mouse</guilabel> prevent certain +features from working properly, such as the +<keycombo action="simul">&Alt;	</keycombo> windows switching dialog.</para> +</note> + +</listitem> +</varlistentry> +</variablelist> + +<para> +After deciding the focus policy, there are window raising options. +</para> + +<para> +When enabling <guilabel>Auto raise</guilabel>, &tde; can +bring a window to the front when the mouse is over that window for a +specified period. When <guilabel>Delay focus</guilabel> is enabled, +there will be a delay after which the window the mouse pointer is over will become +active (receive focus). +This is very useful with the <guilabel>Focus Follows Mouse</guilabel> option. +You can determine the delay for both options by using the spin box controls. +</para> + +<tip> +<para> +Setting the delay too short will cause a rapid fire changing of +windows, which can be quite distracting. Most people will like a delay +of 100-300 milliseconds. This is responsive, but it will let you slide over the +corners of a window on your way to your destination without bringing +that window to the front. +</para> +</tip> + +<para> +When you do not use <guilabel>Auto raise</guilabel>, ensure the +<guilabel>Click raises active window</guilabel> option is enabled. You +will not be happy with both <guilabel>Auto raise</guilabel> and +<guilabel>Click raises active window</guilabel> disabled, the net effect is that +windows are not raised at all. +</para> + +</sect3> + +<sect3 id="focus-focus-stealing"> +<title>Focus stealing prevention level</title> + +<para>This option specifies how much TWin will try to prevent unwanted focus +stealing caused by unexpected activation of new windows.</para> +<note><para>This feature does not work with the <guilabel>Focus Under Mouse</guilabel> +or <guilabel>Focus Strictly Under Mouse</guilabel> focus policies.</para></note> +<variablelist> +<varlistentry> +<term><guilabel>None</guilabel></term> +<listitem><para>Prevention is turned off and new windows always become activated.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Low</guilabel></term> +<listitem><para>Prevention is enabled; when some window does not have support +for the underlying mechanism and TWin cannot reliably decide whether to activate +the window or not, it will be activated. This setting may have both worse and better +results than the medium level, depending on the applications.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Medium</guilabel></term> +<listitem><para>Prevention is enabled.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>High</guilabel></term> +<listitem><para>New windows get activated only +when no window is currently active or when they belong to the currently active +application. This setting is probably not really usable when not using mouse +focus policy.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Extreme</guilabel></term> +<listitem><para>All windows must be explicitly activated by the user.</para></listitem> +</varlistentry> +</variablelist> +<para>Windows that are prevented from stealing focus are marked as demanding +attention, which by default means their taskbar entry will be highlighted. +This can be changed in the Notifications control module.</para> +</sect3> + +<sect3 id="focus-navigation"> +<title><guilabel>Navigation</guilabel></title> + +<para> +In the <guilabel>Navigation</guilabel> frame you can configure the way +switching between applications or desktops using <keycombo +action="simul"> &Alt;	</keycombo> or <keycombo +action="simul"> &Ctrl;	</keycombo>. +</para> + +<para> +<guilabel>Show window list while switching windows</guilabel>. This option determines +the method used when switching applications using <keycombo action="simul">&Alt; +	</keycombo>. Pressing and holding &Alt; while +repeatedly pressing and releasing the 	 key, can take place in +&tde; mode or in &CDE; mode. In &tde; mode you will see +a window box in the middle of the screen showing the currently selected +application while still holding the &Alt; key. In +&CDE; mode there is no window box and the focus immediately goes to each +new application when selected by pressing the 	 key. +</para> + +<para> +<guilabel>Traverse windows on all desktops</guilabel>. With this option enabled, switching +windows with <keycombo action="simul"> +&Alt;	</keycombo> will show all applications on all +desktops and take you to the appropriate desktop for the application you +select. When disabled, only windows on your current desktop are +selectable with <keycombo action="simul"> +&Alt;	</keycombo> and you must use <keycombo +action="simul">&Ctrl;	</keycombo> or other methods to switch to other +desktops. +</para> + +<para> +<guilabel>Desktop navigation wraps around</guilabel>. With this option, you cycling +through to the <quote>last</quote> desktop, pressing 	 again will +select the first desktop.</para> + +<para> +<guilabel>Popup desktop name on desktop switch</guilabel>. Many people name their virtual +desktops according to their purpose or some other naming scheme. You might find this method +convenient to select the desired desktop to tell that you have switched to the right one.</para> +</sect3> + +</sect2> + +<sect2 id="titlebar-actions"> +<title>Titlebar Actions</title> + +<para> +In this panel you can configure what happens to windows when a mouse button is +clicked on their titlebars. +</para> + +<sect3 id="titlebar-actions-sec1"> +<title><guilabel>Titlebar double-click</guilabel></title> + +<para> +In this drop down box you can select either +<guilabel>Shade</guilabel>, several variations of +<guilabel>Maximize</guilabel> or <guilabel>Lower</guilabel>. +</para> + +<para> +Selecting <guilabel>Maximize</guilabel> causes &tde; to maximize the +window whenever you double click on the titlebar. You can further +choose to maximize windows only horizontally or only +vertically.</para> + +<para><guilabel>Shade</guilabel>, on the other hand, causes the window to be +reduced to simply the titlebar. Double clicking on the titlebar again, +restores the window to its normal size. +</para> + +</sect3> + +<sect3 id="titlebar-actions-sec2"> +<title><guilabel>Titlebar wheel event</guilabel></title> + +<para>This feature functions much the same as <guilabel>Titlebar double-click</guilabel> +except the mouse scroll wheel causes the events.</para> + +<tip> +<para> +You can have windows automatically unshade when you simply place the +mouse over their shaded titlebar. Just check the <guilabel>Enable +hover</guilabel> check box in the <guilabel>Advanced</guilabel> tab of +this module. This is a great way to reclaim desktop space when you are +cutting and pasting between a lot of windows, for example. +</para> +</tip> + +</sect3> + +<sect3 id="titlebar-actions-sec3"> +<title><guilabel>Titlebar & Frame</guilabel></title> + +<para> +This section allows you to determine what happens when you single click +on the titlebar or frame of a window. Notice that you can have +different actions associated with the same click depending on whether +the window is active or not. +</para> + +<para> For each combination of mouse buttons, modifiers, Active and +Inactive, you can select the most appropriate choice. The actions are +as follows: </para> + +<variablelist> +<varlistentry> +<term><guilabel>Activate</guilabel></term> +<listitem> +<para> +Make this window active. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Lower</guilabel></term> +<listitem> +<para> +Will move this window to the bottom of the display. This will get the +window out of the way. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Nothing</guilabel></term> +<listitem> +<para> +Just like it says. Nothing happens. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Operations Menu</guilabel></term> +<listitem> +<para> +Will bring up a small submenu, where you can choose window related +commands (&ie; Maximize, Minimize, Close, &etc;). +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Raise</guilabel></term> +<listitem> +<para> +Will bring the window to the top of the display. All other windows +which overlap with this one, will be hidden <quote>below</quote> it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Toggle Raise & Lower</term> +<listitem> +<para> +This will raise windows which are not on top, and lower windows which +are already on top. +</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> + +<sect3 id="titlebar-actions-maximize-button"> +<title><guilabel>Maximize Button</guilabel></title> +<para> +This section allows you to determine the behavior of the three mouse buttons +onto the maximize button. You have the choice between vertical only, horizontal +only or both directions. +</para> +</sect3> + +</sect2> + +<sect2 id="window-actions"> +<title>Window Actions</title> + +<sect3 id="window-actions-sec1"> +<title><guilabel>Inactive Inner Window</guilabel></title> + +<para> +This part of the module, allows you to configure what happens when you +click on an inactive window, with any of the three mouse buttons. +</para> + +<para> +Your choices are as follows: +</para> + +<variablelist> +<varlistentry> +<term><guilabel>Activate, Raise & Pass Click</guilabel></term> +<listitem> +<para> +This makes the clicked window active, raises it to the top of the +display, and passes a mouse click to the application within the window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Activate & Pass Click</guilabel></term> +<listitem> +<para> +This makes the clicked window active and passes a mouse click to the +application within the window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Activate</guilabel></term> +<listitem> +<para> +This simply makes the clicked window active. The mouse click is not +passed on to the application within the window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Activate & Raise</guilabel></term> +<listitem> +<para> +This makes the clicked window active and raises the window to the top of +the display. The mouse click is not passed on to the application within +the window. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="window-actions-sec2"> +<title><guilabel>Inner Window, Titlebar & Frame</guilabel></title> + +<para> +This bottom section, allows you to configure additional actions, when +a modifier key (by default &Alt;) is pressed, and a mouse click is +made on a window.</para> + +<para> +Once again, you can select different actions for +<mousebutton>Left</mousebutton>, <mousebutton>Middle</mousebutton> and +<mousebutton>Right</mousebutton> button clicks and the <guilabel>Mouse +wheel</guilabel>. +</para> + +<para>Your choices are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Lower</guilabel></term> +<listitem> +<para> +Will move this window to the bottom of the display. This will get the +window out of the way. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Move</guilabel></term> +<listitem> +<para> +Allows you to drag the selected window around the desktop. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Nothing</guilabel></term> +<listitem> +<para> +Just like it says. Nothing happens. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Raise</guilabel></term> +<listitem> +<para> +Will bring the window to the top of the display. All other windows +which overlap with this one, will be hidden <quote>below</quote> it. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Resize</guilabel></term> +<listitem> +<para> +Allows you to change the size of the selected window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Toggle Raise & Lower</guilabel></term> +<listitem> +<para> +This will raise windows which are not on top, and lower windows which +are already on top. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect3> + +</sect2> + +<sect2 id="moving"> +<title>Moving</title> + +<sect3> +<title><guilabel>Windows</guilabel></title> + +<para>The options here determine how windows appear on screen when you +are moving them. Most of these options mean a price in performance, +so when you want to streamline your desktop, you should turn them off. +However, when you have a fast computer, they may make your day a little +more pleasant, so leave them on.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Display content in moving windows</guilabel></term> +<listitem> +<para>Enable this option when you want a window's content to be fully +shown while moving it, instead of just showing a window +<quote>skeleton</quote>. The result may not be satisfying on slow +computers without graphic acceleration.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Display content in resizing windows</guilabel></term> +<listitem> +<para>Enable this option when you want a window's content to be shown +while resizing it, instead of just showing a window +<quote>skeleton</quote>. The result, again, may not be satisfying on +slower computers.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Display window geometry when moving or +resizing</guilabel></term> +<listitem> +<para>Enable this option when you want a popup tooltip to tell you the +size in pixels of a window as you resize it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Animate minimize and restore</guilabel></term> +<listitem> +<para>When enabled, this feature provides animation when +windows are minimized or restored. The effect is the window "shrinks" +while minimizing to the panel and "grows" when restoring.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow moving and resizing of maximizing windows</guilabel></term> +<listitem> +<para>When enabled, this feature activates the titlebar and border of maximized windows +to allow moving or resizing maximized windows.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Placement</guilabel></term> +<listitem> +<para>This feature determines where new windows are placed on the desktop.</para> + +<itemizedlist> + +<listitem> +<para><guilabel>Smart</guilabel> will try to achieve a minimum overlap of all windows. +Generally, placement begins at the upper left and continues to the right, then begins again +at the left but lower, something like the rasterization of CRT tubes in TVs. +</para> +</listitem> + +<listitem> +<para><guilabel>Maximizing</guilabel> will try to maximize every window to fill the whole screen. It might be +useful to selectively affect placement of some windows using the window-specific settings. +</para> +</listitem> + +<listitem> +<para><guilabel>Cascade</guilabel> will cascade the windows. +</para> +</listitem> + +<listitem> +<para><guilabel>Random</guilabel> will use a random position. +</para> +</listitem> + +<listitem> +<para><guilabel>Centered</guilabel> will place the window centered. +</para> +</listitem> + +<listitem> +<para><guilabel>Zero-Cornered</guilabel> will place the window in the top-left corner +</para> +</listitem> + +</itemizedlist> + +</listitem> +</varlistentry> + +</variablelist> + +</sect3> + +<sect3> +<title><guilabel>Snap Zones</guilabel></title> + +<para>The rest of this page allows you to configure the <guilabel>Snap +Zones</guilabel>. These are like a magnetic field along the side of +the desktop and each window, which will make windows snap alongside +when moved near.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Border snap zone:</guilabel></term> +<listitem> + +<para>Here you can set the snap zone for screen borders. Moving a +window within the configured distance will make it snap to the edge of +the desktop.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window snap zone:</guilabel></term> +<listitem> + +<para>Here you can set the snap zone for windows. As with screen +borders, moving a window near to another will make it snap to the edge +as when the windows were magnetized.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Snap windows only when overlapping</guilabel></term> +<listitem> + +<para>When checked, windows will not snap together when they are only near +each other, they must be overlapping, by the configured amount or +less.</para> +</listitem> +</varlistentry> +</variablelist> +</sect3> + +</sect2> + +<sect2 id="advanced"> +<title>Advanced</title> + +<para> +In the <guilabel>Advanced</guilabel> panel you can do more advanced fine +tuning to the window behavior. +</para> + +<variablelist> +<title>Shading</title> + +<varlistentry> +<term><guilabel>Animate</guilabel></term> +<listitem> +<para>When this option is enabled, shading, or rolling up a window until just +the title bar is shown, will be animated.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable hover</guilabel></term> +<listitem> +<para> +When this option is enabled, a shaded window will un-shade automatically +when the mouse pointer has been over the titlebar for the configured delay. +Use the slider widget to configure the delay. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<variablelist> +<title>Active Desktop Borders</title> + +<varlistentry> +<term><guilabel>Disabled</guilabel></term> +<listitem> +<para>When this option is enabled, moving the mouse pointer to a screen +border will change your desktop. This is useful when you want to drag +windows from one desktop to another.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Only when moving windows</guilabel></term> +<listitem> +<para>Moving your mouse pointer against the side of the screen will +switch to a new desktop only while moving a window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Always enabled</guilabel></term> +<listitem> +<para>Moving your mouse pointer against the side of the screen will +always switch to a new desktop.</para> +</listitem> +</varlistentry> + +</variablelist> + +<para> +<guilabel>Hide utility windows for inactive applications</guilabel>. When +enabled, utility windows (tool windows, torn-off menus) of +inactive applications will be hidden and will be shown only when the +application becomes active. Note that applications have to mark the windows +with the proper window type for this feature to work. +</para> + +</sect2> + +<sect2 id="translucency"> +<title>Translucency</title> + +<para>The options available in this module are explained in the +<ulink url="help:/kompmgr/index.html">&kompmgr; Handbook</ulink>.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/windowmanagement/CMakeLists.txt b/doc/kcontrol/windowmanagement/CMakeLists.txt new file mode 100644 index 000000000..856b2b475 --- /dev/null +++ b/doc/kcontrol/windowmanagement/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/windowmanagement ) diff --git a/doc/kcontrol/windowmanagement/Makefile.am b/doc/kcontrol/windowmanagement/Makefile.am new file mode 100644 index 000000000..3e5215103 --- /dev/null +++ b/doc/kcontrol/windowmanagement/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/windowmanagement diff --git a/doc/kcontrol/windowmanagement/index.docbook b/doc/kcontrol/windowmanagement/index.docbook new file mode 100644 index 000000000..7166d6764 --- /dev/null +++ b/doc/kcontrol/windowmanagement/index.docbook @@ -0,0 +1,63 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-21</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>window settings</keyword> +<keyword>window placement</keyword> +<keyword>window size</keyword> +</keywordset> +</articleinfo> +<sect1 id="window-specific"> +<title>Window Specific Settings</title> + +<para>Here you can customize window settings specifically only for +some windows.</para> + +<note> +<para>Please note that this configuration will not take effect if you +do not use &twin; as your window manager. If you do use a different +window manager, please refer to its documentation for how to customize +window behavior.</para> +</note> + +<para>Many of the settings you can configure here are those you can +configure on a global basis in the <guilabel>Window Behavior</guilabel> +&kcontrol; module, however some of them are even more detailed.</para> + +<para>They encompass geometry, placement, whether a window should be +kept above or below others, focus stealing prevention, and translucency +settings.</para> + +<para>You can access this module in two ways: from the titlebar of the +application you wish to configure, or from &kcontrol;. If you +start it from within &kcontrol; you can use the +<guibutton>New...</guibutton> to create a window profile, and the +<guibutton>Detect</guibutton> button on the resulting dialog to +partially fill in the required information for the application +you wish to configure.</para> + +<para>You can also at any time <guibutton>Modify...</guibutton> or +<guibutton>Delete</guibutton> any stored settings profile, and +reorder the list. Reordering the list is a convenience to help you sort +the profiles, and has no effect on how they are applied.</para> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/xserver/CMakeLists.txt b/doc/kcontrol/xserver/CMakeLists.txt new file mode 100644 index 000000000..e33cbe3ea --- /dev/null +++ b/doc/kcontrol/xserver/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kcontrol/xserver ) diff --git a/doc/kcontrol/xserver/Makefile.am b/doc/kcontrol/xserver/Makefile.am new file mode 100644 index 000000000..9d915d89f --- /dev/null +++ b/doc/kcontrol/xserver/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kcontrol/xserver diff --git a/doc/kcontrol/xserver/index.docbook b/doc/kcontrol/xserver/index.docbook new file mode 100644 index 000000000..a56e47fb3 --- /dev/null +++ b/doc/kcontrol/xserver/index.docbook @@ -0,0 +1,56 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;" id="xserver"> +<title>X Server Information</title> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>X server</keyword> +<keyword>system information</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>X Server Information</title> + +<para>This screen is useful for getting specific information about your +X server and the current session of X.</para> + +<para>When you open this module, you are presented with some +information. The left hand side of the window is organized into a +tree. Some of the elements have a plus sign in front of the label. +Clicking this sign opens a <quote>submenu</quote> related to the +label. Clicking on a minus sign in front of a label hides the +submenu.</para> + +<para>The right hand side of the window contains the individual +values for each of the parameters on the left.</para> + +<para>The information presented will vary depending on your +setup.</para> + +<note><para>Some setups may not be able to determine some or all of the +parameters.</para></note> + +<para>You can not change any values from this menu. It is for +information only.</para> + +</sect1> +</article> |
