diff options
Diffstat (limited to 'doc/kcontrol')
98 files changed, 8785 insertions, 0 deletions
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/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..4fbfa3bff --- /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 &kde; 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 &kde; 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..b92fdffb3 --- /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 +&kde; 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/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..5241462c0 --- /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>&kde; 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). &kde; 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). &kde; 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). &kde; 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). &kde; 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). &kde; 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 &kde; 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 &kde;, simply select <guilabel>Use the following program +for drawing the background</guilabel>. Available &kde; 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>KDEDIR</envar>/share/wallpapers</filename> +folder.</para> + +<para>A pattern is a picture file which &kde; uses as a template to +draw your background. The picture file provides the shapes, but &kde; +provides the colors. &kde; 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>KDEDIR</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>KDEHOME</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/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..2974c0707 --- /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>&kde; 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/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/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..88fd8c317 --- /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, &kde; 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/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..c47912da9 --- /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 &kde;, 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 &kde;-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 &kde;-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 &kde; to apply the color scheme even +to non-&kde; applications by enabling the <guilabel>Apply colors to +non-KDE applications</guilabel>. Not all applications will allow +this, but most do.</para> + +</sect3> +</sect2> + +</sect1> + +</article> 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..a1ea6fdd7 --- /dev/null +++ b/doc/kcontrol/cookies/index.docbook @@ -0,0 +1,211 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-12</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>cookie</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="cookie"> +<title>Cookies</title> + +<para>Cookies are a mechanism used by web sites to store and retrieve +information using your browser. For example, a web site may allow you +to customize the content and layout of the pages you see, so that your +choices are persistent across different visits to that web site.</para> + +<para>The web site is able to remember your preferences by storing a +cookie on your computer. Then, on future visits, the web site retrieves +the information stored in the cookie to format the content of the site +according to your previously specified preferences.</para> + +<para>Thus, cookies play a very useful role in web browsing. +Unfortunately, web sites often store and retrieve information in cookies +without your explicit knowledge or consent. Some of this information may +be quite useful to the web site owners, for example, by allowing them to +collect summary statistics on the number of visits different areas of +the web sites get, or to customize banner advertising.</para> + +<para>The cookies module of the &kcontrol; allows you to set policies +for the use of cookies when you are browsing the web with the +&konqueror; web browser. </para> + +<warning><para>Note that the policies that you set using this control +module will <emphasis>not</emphasis> apply to other web browsers such +as &Netscape;.</para></warning> + +<sect2 id="cookie-policy"> + +<title>Policy</title> + +<para>Using the <guilabel>Policy</guilabel> tab, you can configure the +&kde; applications that will handle cookies. You can do this by specifying a +general cookie policy as well as special cookie policies for certain +domains or hosts.</para> + +<para>The top of the policy tab has a checkbox labeled <guilabel>Enable +cookies</guilabel>. If you leave this unchecked, cookies will be +completely disabled. However, this may make browsing rather +inconvenient, especially as some web sites require the use of browsers +with cookies enabled.</para> + +<para>You will probably want to enable cookies and then set +specific policies on how you want them to be handled.</para> + +<para>The first group of options create settings that apply to all cookies.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Only accept cookies from originating server</guilabel></term> +<listitem> +<para>Some pages try to set cookies from servers other than the one +you are seeing the <acronym>HTML</acronym> page from. For example, +they show you advertisements, and the advertisements are from another +computer, often one that belongs to a large advertising group. These +advertisements may try to set a cookie which would allow them to +track the pages you view across multiple web sites.</para> +<para>Enabling this option will mean only cookies that come from the +same web server as you are explicitly connecting to will be +accepted.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Automatically accept session cookies</guilabel></term> +<listitem> + +<para>An increasingly common use for cookies is not to track your +movements across many visits to a web site, but to just follow what you +do during one single visit. Session cookies are saved as long as you +are looking at the site, and deleted when you leave it.</para> + +<para>Web sites can use this information for various things, most +commonly it is a convenience so that you do not have to keep logging in +to view pages. For example, on a webmail site, without some kind of +session <acronym>ID</acronym>, you would have to give your password +again for each email you want to read. There are other ways to +achieve this, but cookies are simple and very common.</para> + +<para>Enabling this option means that session cookies are always +accepted, even if you don't accept any other kind, and even if you +choose to reject cookies from a particular site, session cookies from +that site will be accepted.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Treat all cookies as session cookies</guilabel></term> +<listitem> +<para>If this option is enabled, all cookies are treated as session +cookies. That is, they are not kept when you leave the +web site.</para> +<note> +<para>The definition of <quote>leave the web site</quote> is vague. +Some cookies may hang around for a little while after you are no +longer viewing any pages on a particular web site. This is +normal.</para> +</note> +</listitem> +</varlistentry> +</variablelist> + +<para>The section for <guilabel>Default Policy</guilabel> sets some +further options that are mutually exclusive — you can choose only one +of these options as the default, but you are free to set a different +option for any specific web server.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Ask for confirmation</guilabel></term> +<listitem> +<para>If this option is selected, you will be asked for confirmation +every time a cookie is stored or retrieved. You can selectively accept +or reject each cookie. The confirmation dialog will also allow you to +set a domain specific policy, if you do not want to confirm each +cookie for that domain.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Accept all cookies</guilabel></term> +<listitem> +<para>If this option is selected, all cookies will be accepted without +asking for confirmation.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Reject all cookies</guilabel></term> +<listitem> +<para>If this option is selected, all cookies will be rejected without +asking for confirmation.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>In addition to the default policy for handling of cookies, which you can +set by selecting one of the three options described above, you can also set +policies for specific host domains using the controls in the <guilabel>Domain +Specific</guilabel> group.</para> + +<para>The Ask, Accept, or Reject policy can be applied to a specific +domain by clicking on the <guibutton>New...</guibutton> button, which +brings up a dialog. In this dialog, you can type the name of the +domain (with a leading dot), then select the policy you want to apply +to this domain. Note that entries may also get added while you are +browsing, if the default policy is to ask for confirmation, and you +choose a general policy for a specific host (for example, by selecting +<guilabel>Reject all cookies from this domain</guilabel> when asked to +confirm a cookie).</para> + +<para>You can also select a specific host domain from the list and click the +<guibutton>Change</guibutton> button to choose a different policy for that +domain than the one shown in the list.</para> + +<para>To delete a domain specific policy, choose a domain from the list, and +then click the <guibutton>Delete</guibutton> button. The default policy will +apply to domains which have been deleted from the list.</para> + +</sect2> + +<sect2 id="cookie-management"> +<title>Management</title> + +<para>In the <guilabel>Management</guilabel> tab you can browse and selectively +delete cookies that have been set in the past.</para> + +<para>In the upper part of this dialog, you can see a list of domains displayed +as a tree. Click on the little <guiicon>+</guiicon> next to a domain to see all +cookies that have been set for this particular target domain. If you select one +of these cookies, you will notice that its contents will show up in the frame +<guilabel>Cookie Details</guilabel> below.</para> + +<para>By clicking the <guibutton>Delete</guibutton> button you can now delete the selected +cookie. Click <guibutton>Delete All</guibutton> to delete all cookies stored.</para> + +<para>Choose <guibutton>Reload List</guibutton> to reload the list +from your hard disk. You might want to do this if you have had the +module open and are testing web sites, or have made many changes in the +module itself.</para> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/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..1d43131d1 --- /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 &kde; 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 &kde; 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 &kde;, 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 &kde; 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 &kde; +knows about. You can easily manage them from here.</para> + +</sect2> + +</sect1> + +</article> 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..070ae0d72 --- /dev/null +++ b/doc/kcontrol/desktop/index.docbook @@ -0,0 +1,84 @@ +<?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</title> + +<sect2 id="desktop-appearance"> +<title><guilabel>Appearance Tab</guilabel></title> + +<para>Here you can configure how icons on your desktop appear.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Standard font:</guilabel></term> +<listitem><para>This option can be used to change the typeface used on the +desktop. Simply select your typeface from the dropdown box.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Font size:</guilabel></term> +<listitem><para>You can change the relative size of the text on the Desktop. +</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Normal text color:</guilabel></term> +<listitem><para>This option lets you select the color of normal (or +unhighlighted) text.</para></listitem> +</varlistentry> +<varlistentry><term><guilabel>Text background color:</guilabel></term> +<listitem><para>This option lets you select the background color of +normal text. If left unchecked, the text has a transparent +background. If selected, you can choose the color by pressing the button. +</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Underline filenames:</guilabel></term> +<listitem><para>Determines if file names are underlined on the +Desktop.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2 id="desktop-number"> +<title><guilabel>Multiple Desktops</guilabel></title> + +<para>&kde; offers you the possibility to have several virtual +desktops. In this tab you can configure the number of desktops as well +as their names. Just use the slider to adjust the number of +desktops. You can assign names to the desktops by entering text into the +text fields below.</para> + +<para>If you enable <guilabel>Mouse wheel over desktop switches +desktop</guilabel> then scrolling the wheel over an empty space on the +desktop will change the the next virtual desktop numerically, in the +direction you scrolled (either up or down).</para> + +</sect2> + +</sect1> + +</article> 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..9011f265d --- /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 &kde; 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, &kde; 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 +&kde;. You can create icons, edit bookmarks, cut and paste, +run commands, configure &kde;, arrange icons, lock the session and log +out of &kde;. The exact content of the menu varies depending on the +current status of &kde;. </para></listitem> +</varlistentry> + +<varlistentry> +<term>Application Menu</term> +<listitem><para>This brings up the <guimenu>Application</guimenu> Menus +(also know as the <guimenu>K</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 K 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, &kde; 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 &kde; 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) &kde; 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/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..da9167f6e --- /dev/null +++ b/doc/kcontrol/ebrowsing/index.docbook @@ -0,0 +1,156 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<author>&Yves.Arrouye; &Yves.Arrouye.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>enhanced browsing</keyword> +<keyword>web shortcuts</keyword> +<keyword>browsing</keyword> +</keywordset> + +</articleinfo> +<sect1 id="ebrowse"> + +<title>Web Shortcuts</title> + +<sect2 id="ebrowse-intro"> + +<title>Introduction</title> + +<para>&konqueror; offers some features to enhance your browsing +experience. One such feature is <emphasis>Web Shortcuts</emphasis>.</para> + +<para>You may already have noticed that &kde; is very Internet friendly. +For example, you can click on the <guimenuitem>Run</guimenuitem> menu +item or type the keyboard shortcut assigned to that command (<keycombo +action="simul"><keycap>Alt</keycap><keycap>F2</keycap></keycombo>, +unless you have changed it) and type in a <acronym>URI</acronym>. +<footnote><para>Uniform Resource Identifier. A standardized way of +referring to a resource such as a file on your computer, a World Wide +Web address, an email address, +<abbrev>etc...</abbrev>.</para></footnote></para> + +<para>Web shortcuts, on the other hand, let you come up with new pseudo +<acronym>URL</acronym> schemes, or shortcuts, that basically let you +<emphasis>parameterize</emphasis> commonly used +<acronym>URI</acronym>s. For example, if you like the Google search +engine, you can configure KDE so that a pseudo <acronym>URL</acronym> +scheme like <emphasis>gg</emphasis> will trigger a search on +Google. This way, typing <userinput>gg:<replaceable>my +query</replaceable></userinput> will search for <replaceable>my +query</replaceable> on Google.</para> + +<note><para>One can see why we call these pseudo <acronym>URL</acronym> +schemes. They are used like a <acronym>URL</acronym> scheme, but the +input is not properly <acronym>URL</acronym> encoded, so one will type +<userinput>google:kde apps</userinput> and not +<userinput>google:kde+apps</userinput>.</para></note> + +<para>You can use web +shortcuts wherever you would normally use +<acronym>URI</acronym>s. Shortcuts for several search engines should +already be configured on your system, but you can add new keywords, and +change or delete existing ones in the enhanced browsing control +module. </para> + +</sect2> + +<sect2 id="ebrowse-use"> + +<title>Use</title> + +<para>There is a single tab in this control module. The title of the tab +is <guilabel>Keywords</guilabel>. This tab features two main boxes, one +for Internet Keywords and one for web shortcuts.</para> + +<sect3 id="ebrowse-srch-use"> + +<title>Web Shortcuts</title> + +<para>The descriptive names of defined web shortcuts are shown in a +listbox. As with other lists in &kde;, you can click on a column +heading to toggle the sort order between ascending and +descending, and you can resize the columns.</para> + +<para>If you double-click on a specific entry in the list of defined +search providers, the details for that entry are shown in a popup +dialog. In addition to the descriptive name for the item, you can +also see the <acronym>URI</acronym> which is used, as well as the +associated shortcuts which you can type anywhere in &kde; where +<acronym>URI</acronym>s are expected. A given search provider can have +multiple shortcuts, each separated by a comma.</para> + +<para> The text boxes are used not only for displaying information +about an item in the list of web shortcuts, but also for modifying or +adding new items.</para> + +<para>You can change the contents of either the <guilabel>Search +URI</guilabel> or the <guilabel>URI Shortcuts</guilabel> text box. +Click <guibutton>OK</guibutton> to save your changes or +<guibutton>Cancel</guibutton> to exit the dialog with no +changes.</para> + +<para>If you examine the contents of the <guilabel>Search +URI</guilabel> text box, you will find that most, if not all of the +entries have a <option>\{@}</option> in them. This sequence of two +characters acts as a parameter, which is to say that they are replaced +by whatever you happen to type after the colon character that is +between a shortcut and its parameter. Let's consider some examples to +clarify this idea.</para> + +<para>Suppose that the <acronym>URI</acronym> is +<userinput>http://www.google.com/search?q=\{@}</userinput>, and +<userinput>gg</userinput> is a shortcut to this +<acronym>URI</acronym>. Then, typing +<userinput>gg:<replaceable>alpha</replaceable></userinput> is +equivalent to +<userinput>http://www.google.com/search?q=<replaceable>alpha</replaceable></userinput>. +You could type anything after the <userinput>:</userinput> character; +whatever you have typed simply replaces the <option>\{@}</option> +characters, after being converted to the appropriate character set for +the search provider and then properly +<acronym>URL</acronym>-encoded. Only the <option>\{@}</option> part of +the search <acronym>URI</acronym> is touched, the rest of it is +supposed to be properly <acronym>URL</acronym>-encoded already and is +left as is.</para> + +<para>You can also have shortcuts without parameters. Suppose the +<acronym>URI</acronym> was +<emphasis>file:/home/me/mydocs/kofficefiles/kword</emphasis> and the +shortcut was <emphasis>mykword</emphasis>. Then, typing +<userinput>mykword:</userinput> is the same as typing the complete +<acronym>URI</acronym>. Note that there is nothing after the colon +when typing the shortcut, but the colon is still required in order for +the shortcut to be recognized as such.</para> + +<para>By now, you will have understood that even though these shortcuts +are called web shortcuts, they really are shortcuts to parameterized +<acronym>URI</acronym>s, which can point not only to web sites like +search engines but also to anything else that can be pointed to by a +<acronym>URI</acronym>. Web shortcuts are a very powerful feature of +navigation in &kde;.</para> + +</sect3> + +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/email/Makefile.am b/doc/kcontrol/email/Makefile.am new file mode 100644 index 000000000..137c9a103 --- /dev/null +++ b/doc/kcontrol/email/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/email diff --git a/doc/kcontrol/email/index.docbook b/doc/kcontrol/email/index.docbook new file mode 100644 index 000000000..b34e44b13 --- /dev/null +++ b/doc/kcontrol/email/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;"> +<articleinfo> + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-09-01</date> +<releaseinfo>3.1.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>email</keyword> +<keyword>e-mail</keyword> +</keywordset> + +</articleinfo> +<sect1 id="e-mail"> +<title>Email</title> + + +<sect2 id="email-intro"> +<title>Introduction</title> + +<para>The email module of the &kcontrol; allows you to enter and save some +basic email information. This information is used when performing functions +related to email within &kde;, for example, when sending bug reports from the +&kde; crash handler application.</para> + +<para>Programs such as &kmail;, which are used for reading and sending +email, may offer many more options for customizing the way in which +email is handled. These options depend upon the specific program being +used. &kmail;, for instance, offers its own configuration +facilities.</para> + +<para>Some of the information needed for configuring email should have +been provided by your internet service provider +(<acronym>ISP</acronym>). If you are connected to a local network, then +the system administrator of your network should be able to help +you.</para> + +</sect2> + +<sect2 id="email-use"> +<title>Use</title> + +<para>&kde; automatically establishes some of the information for this control module +using the +login information on the system. You will need to enter the remaining information.</para> +<para>Looking at the page from top to +bottom, the options are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Full name</guilabel></term> +<listitem><para>Type your full name as you would like it to appear in the email +messages that you send. </para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Organization</guilabel></term> +<listitem><para>If you work for a company or +organization, you can enter its name in this text box.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Email address</guilabel></term> +<listitem><para>To be able to use email, you must enter your email +address here.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Reply-to address</guilabel></term> +<listitem><para>If replies to your email messages should be sent to a different +address, you can enter that address in this text box.</para></listitem> +</varlistentry> +</variablelist> +</sect2> + +</sect1> + +</article> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-indent-step:0 +sgml-indent-data:nil +sgml-parent-document:index.docbook +End: +--> + 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..94d7a2745 --- /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 kdeutils, 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/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..be620a8cf --- /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/khtml/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="kfileman2.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="kfileman1.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 &kde; 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/kfileman1.png b/doc/kcontrol/filemanager/kfileman1.png Binary files differnew file mode 100644 index 000000000..0505d604d --- /dev/null +++ b/doc/kcontrol/filemanager/kfileman1.png diff --git a/doc/kcontrol/filemanager/kfileman2.png b/doc/kcontrol/filemanager/kfileman2.png Binary files differnew file mode 100644 index 000000000..6c8d17d75 --- /dev/null +++ b/doc/kcontrol/filemanager/kfileman2.png 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..a838156db --- /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 &kde;, 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;, &kde; +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 &kde;.</para> + +<para>When &kde; 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, &kde; 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 &kde; 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 &kde; 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 &kde; comes preconfigured with +hundreds of file associations. The reality is, each system that &kde; +is installed on has a different selection of applications. By +allowing multiple associations per &MIME; type, &kde; 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 &kde; +automatically starts the second application <application>Adobe Acrobat +Reader</application>. As you can see, this will help keep &kde; 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/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..cfe34bab7 --- /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 &kde; 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 +&kde; file manager)</para></listitem> --> + +<listitem><para><guilabel>Toolbar:</guilabel> Font used in &kde; application +toolbars</para></listitem> + +<listitem><para><guilabel>Menu:</guilabel> Font used in &kde; 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 &kde; 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 &kde; 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 &kde; mailing list, or check the +<acronym>FAQ</acronym>.</para></note> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/helpindex/Makefile.am b/doc/kcontrol/helpindex/Makefile.am new file mode 100644 index 000000000..0529b36f5 --- /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..ba7acdc80 --- /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 &kde; 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>&kde; 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, &kde; 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 &kde; 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, &kde; will ask for +a superuser password.</para> +<sect2 id="help-index-use"> + +<title>Use</title> + +<para>There are two important things to tell &kde; 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 &kde; 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 &kde; 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/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..199a35275 --- /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>&kde; comes with a full set of icons in several sizes. These icons +are being used all over &kde;: the desktop, the panel, the &konqueror; file +manager, in every toolbar of every &kde; application, etc. The icons +control module offers you very flexible ways of customizing the way &kde; +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. &kde; comes with two icon themes by default, +&kde;-Classic (HiColor) and Crystal SVG. There is also a low color theme +in the kdeartwork 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 &kde; default +Crystal SVG theme. There are others contained separately in the +kdeartwork 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 &kde; 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 &kde; 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 &kde;'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..cdaa3390f --- /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 &kde;'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 &kde; 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>K Button</guimenu><guimenuitem>Control +Center</guimenuitem></menuchoice> from the &kde; 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 &kde; 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 &kde; 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 &kde; 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 &kde; 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>kcmshell</command> from &konsole;. Type <userinput> <command>kcmshell</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 &kde;. 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/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..25ccf55c2 --- /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, &kde; 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>Del</keycap></keycombo> could be done with &Ctrl; then &Alt; +then <keycap>Del</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/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..106cc38d8 --- /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>&kde; can use its own stylesheet, based on simple defaults and +the color scheme you are using for your desktop. &kde; 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 &kde; application that renders HTML +with &kde;'s own renderer, which is called khtml. 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>&kde; 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>&kde; 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 &kde; 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 &kde; 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/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/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..0a4367115 --- /dev/null +++ b/doc/kcontrol/kcmkonsole/index.docbook @@ -0,0 +1,177 @@ +<?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 &kde; 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>Use Konsole as default terminal +application</guilabel></term> +<listitem> +<para>If you wish to have &kde; use another terminal application by +default, uncheck this box and enter the preferred application +(<application>wterm</application>, <application>rxvt</application>, +&etc;) in the text field below.</para> +</listitem> +</varlistentry> + +<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 with open sessions</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>Line Spacing</guilabel></term> +<listitem><para>Change the space between lines of text.</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/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..78bf7008f --- /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 &kde; 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 &kde; 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/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..cf77945f7 --- /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>&kde;, like all applications, needs to inform the user when a +problem occurs, a task is completed, or something has happened. &kde; +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 &kde; 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, &kde; 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, &kde; 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, &kde; 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, &kde; will play a specific sound over the speakers. This is commonly used by games in &kde; 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, &kde; 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, &kde; 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 &kde; 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, &kde; 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, &kde; 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>, &kde; 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, &kde; 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, &kde; 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 &kde; 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 &kde; sound system</guilabel></term> +<listitem><para>If a mark is in this radio button, &kde; will play all sound notifications through the &kde; sound system (&arts;). You can adjust the volume of system notifications using the slider.</para> +<note><para>The slider only affects &kde; 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, &kde; will not use the &kde; sound system to play the sound. This is a good choice if the sound format you want to use is not supported by the &kde; 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/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..65cb9423f --- /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 &kde;'s session +manager.</para> + +<para>Session management refers to &kde;'s ability to save the state +of applications and windows when you log out of &kde; 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, &kde; 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, &kde; 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 &kde;:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Restore previous session</guilabel></term> +<listitem><para>If this option is checked, &kde; will save your current +session's state when you logout. &kde; 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 &kde; 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, &kde; 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 +&kde;. These options are not possible on all operating systems, and some of +them may not appear unless you are using &kdm; 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/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..4d38cf2fc --- /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 &kde;.</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> + +<sect3 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> +--> +</sect3> + +<sect3 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 &kde; 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 +&kde; 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 &kde; 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> + +</sect3> + +<sect3 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> + +</sect3> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/kcmtaskbar/Makefile.am b/doc/kcontrol/kcmtaskbar/Makefile.am new file mode 100644 index 000000000..756585015 --- /dev/null +++ b/doc/kcontrol/kcmtaskbar/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kcmtaskbar diff --git a/doc/kcontrol/kcmtaskbar/index.docbook b/doc/kcontrol/kcmtaskbar/index.docbook new file mode 100644 index 000000000..3f73691a3 --- /dev/null +++ b/doc/kcontrol/kcmtaskbar/index.docbook @@ -0,0 +1,142 @@ +<?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>2006-06-24</date> +<releaseinfo>3.5.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>taskbar</keyword> +<keyword>configure</keyword> +</keywordset> +</articleinfo> + +<sect1 id="taskbar"> +<title>Taskbar</title> + +<sect2> +<title><guilabel>Taskbar</guilabel></title> + +<para>The taskbar is a quick way to switch between applications. The taskbar +can be located in the panel (default), or outside the panel on the +desktop.</para> + +<para>This module has options to control how the taskbar operates:</para> + +<para><guilabel>Show windows from all desktops</guilabel>, determines +if all open windows are included in the taskbar or not. By default, +the taskbar only shows the open windows <emphasis>on the current +desktop</emphasis>. If this option is enabled, the taskbar will show +all open windows <emphasis>on all desktops</emphasis>. +<guilabel>Sort windows by desktop</guilabel> changes the +sort order of the icons on the taskbar, so that windows on virtual +desktop 1 are shown first (to the left, or at the top of the taskbar), +followed by windows on virtual desktop 2, and so on.</para> + +<para><guilabel>Sort alphabetically by application name</guilabel> shows +the icons in an alphabetical sort order on the taskbar.</para> + +<para>You can have the taskbar <guilabel>Show only minimized +windows</guilabel>. In this case, when you minimize a window, it will +show up on the taskbar, and when you open it again, its taskbar entry +will disappear.</para> + +<para>You can disable <guilabel>Show application icons</guilabel>, and show just the +text. You might want to do this to save space on your taskbar, for +example.</para> + +<para>Using the <guilabel>Show window list button</guilabel> option, +you can enable a little button to be shown in the taskbar: this button +will open a popup menu offering access to applications on other desktops +as well as some useful actions, like <guilabel>Unclutter +Windows</guilabel> or <guilabel>Cascade Windows</guilabel>.</para> + +<para><guilabel>Group similar tasks</guilabel> allows +you to save some space on your taskbar, by only showing one icon for +each running application, no matter how many windows are shown. You can +click on the icon to display a menu of all the windows that are +available. This is most useful when you have enabled <guilabel>Show windows +from all desktops</guilabel>.</para> + +<para>The next option allows you to set the <guilabel>Appearance</guilabel> to <guilabel>Elegant</guilabel>, <guilabel>Classic</guilabel> or <guilabel>For Transparency</guilabel>.</para> + +</sect2> + +<sect2> +<title><guilabel>Actions</guilabel></title> + +<para>The next set of options allow you to customize the actions +performed with different mouse clicks on taskbar icons.</para> + +<para>You can select any action from the list for the <guilabel>Left button</guilabel>, +the <guilabel>Middle button</guilabel> and the <guilabel>Right button</guilabel>.</para> + +<para>The options available are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Show Task List</guilabel></term> +<listitem> +<para>Show the list of tasks grouped under the icon you have clicked +on. If there is only one task or window for that icon, it will become +the active window.</para> +<para>This is the default action for the &LMB;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Cycle Through Windows</guilabel></term> +<listitem> +<para>If there is more than one task grouped under the icon, switch +from one to the next, until you release the button (&ie; when you have +reached the window you are looking for). If there is only one task or +window for that icon, it will become the active window.</para> + +<para>This is the default action for the &MMB; if window grouping is +enabled.</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show Operations Menu</guilabel></term> +<listitem> +<para>Show the operations menu for the application. This allows you +to minimize, maximize, &etc;, move windows between desktops, and close +windows. You can perform these actions on all windows grouped under +that icon, or on any single window, by choosing it from the +submenu.</para> +<para>This is the default action for the &RMB;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Raise Task</guilabel>, <guilabel>Lower +Task</guilabel>, <guilabel>Minimize Task</guilabel></term> +<listitem> +<para>These three options make sense only if window grouping is +disabled. They are fairly self-explanatory. Raise means to make +active, bring to the front, and give focus. Lower means, send to the +back, and give focus to whichever window is now on top.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/kdm/Makefile.am b/doc/kcontrol/kdm/Makefile.am new file mode 100644 index 000000000..511936b0f --- /dev/null +++ b/doc/kcontrol/kdm/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kdm diff --git a/doc/kcontrol/kdm/index.docbook b/doc/kcontrol/kdm/index.docbook new file mode 100644 index 000000000..8f00db2f3 --- /dev/null +++ b/doc/kcontrol/kdm/index.docbook @@ -0,0 +1,518 @@ +<?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>&Thomas.Tanghus; &Thomas.Tanghus.mail;</author> +<author>&Steffen.Hansen; &Steffen.Hansen.mail;</author> +<author>&Mike.McBride; &Mike.McBride.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>KDM configuration</keyword> +<keyword>login manager</keyword> +<keyword>login</keyword> +</keywordset> +</articleinfo> + +<sect1 id="login-manager"> +<title>Login Manager</title> + +<para>Using this module, you can configure the &kde; graphical login +manager, &kdm;. You can change how the login screen looks, who has +access using the login manager and who can shutdown the +computer.</para> + +<para>In order to organize all of these options, this module is +divided into six sections: <link +linkend="kdmconfig-appearance"><guilabel>Appearance</guilabel></link>, +<link linkend="kdmconfig-font"><guilabel>Font</guilabel></link>, <link +linkend="kdmconfig-background"><guilabel>Background</guilabel></link>, +<link +linkend="kdmconfig-sessions"><guilabel>Sessions</guilabel></link>, +<link linkend="kdmconfig-users"><guilabel>Users</guilabel></link> and +<link +linkend="kdmconfig-convenience"><guilabel>Convenience</guilabel></link>.</para> + +<para>You can switch between the sections using the tabs at the top of +the window.</para> + +<note><para>If you are not currently logged in as a superuser, you +will need to click the <guibutton>Administrator Mode</guibutton> +Button. You will then be asked for a superuser password. Entering a +correct password will allow you to modify the settings of this +module.</para></note> + +<sect2 id="kdmconfig-appearance"> +<title>Appearance</title> + +<para>From this page you can change the visual appearance of &kdm;, +&kde;'s graphical login manager.</para> + +<para>The greeting string is the title of the login screen. If the +string contains the word <computeroutput>HOSTNAME</computeroutput> it +will be translated to the domainless name of the machine &kdm; is +installed on.</para> + +<para>You can then choose to show either the current system time, a logo +or nothing special in the login box. Make your choice in the radio +buttons labeled <guilabel>Logo area</guilabel>. Using the +<guilabel>Positions</guilabel> setting, you can choose to either center +the content of the logo area or to position it using fixed +coordinates.</para> + +<para>If you chose <guilabel>Show logo</guilabel> you can now choose a +logo:</para> + +<itemizedlist> +<listitem> +<para>Drop an image file on the image button.</para> +</listitem> +<listitem> +<para>Click on the image button and select a new image from the image chooser +dialog.</para> +</listitem> +</itemizedlist> + +<para>If you do not specify a logo the default +<filename>$<envar>KDEDIR</envar>/share/apps/kdm/pics/kdelogo.png</filename> +will be displayed.</para> + +<para>While &kde;'s style depends on the settings of the user logged in, +the style used by &kdm; can be configured using the <guilabel>GUI +Style</guilabel> option.</para> + +<para>Below that, you have two dropdown boxes to choose the language and the +country for your login box.</para> + +</sect2> + +<sect2 id="kdmconfig-font"> +<title>Font</title> + +<para>From this section of the module you can change the fonts used in +the login window.</para> + +<para>You can select three different font styles from the drop down box +(<guilabel>Greeting</guilabel>, <guilabel>Fail</guilabel>, +<guilabel>Standard</guilabel>). When you click on the <guibutton>Change +font</guibutton> button a dialog appears from which you can select the +new characteristics for the font style.</para> + +<itemizedlist> +<listitem> +<para>The <guilabel>Greeting</guilabel> font is the font used for the title +(Greeting String).</para> +</listitem> +<listitem> +<para>The <guilabel>Fail</guilabel> font is used when a login fails.</para> +</listitem> +<listitem> +<para>The <guilabel>Standard</guilabel> font is used in all other places in the +login window.</para> +</listitem> +</itemizedlist> + +<para>An example of each font can be seen in the +<guilabel>Example</guilabel> Box.</para> + +</sect2> + +<sect2 id="kdmconfig-background"> +<title>Background</title> + +<para>Here you can change the desktop background which will be displayed +when a user logs in. You can have a single color or an image as a +background. If you have an image as the background and select center, the +selected background color will be used around the image if it isn't +large enough to cover the entire desktop.</para> + +<para>The background colors and effects are controlled by the options on +the tab labeled <guilabel>Background</guilabel> and you select a +background image and its placement from the options on the tab labeled +<guilabel>Wallpaper</guilabel>.</para> + +<para>To change the default background color(s) simply click either of +the color buttons and select a new color.</para> + +<para>The dropdown box above the color buttons provides you with several +different blend effects. Choose one from the list, and it will be +previewed on the small monitor at the top of the window. Your choices +are:</para> + +<variablelist> +<varlistentry> +<term>Flat</term> +<listitem><para>By choosing this mode, you select one color (using the color +button labeled <guibutton>Color 1</guibutton>), and the entire background is +covered with this one color.</para></listitem> +</varlistentry> +<varlistentry> +<term>Pattern</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). </para> <para>You then select a pattern by clicking +<guilabel>Setup</guilabel>. This opens a new dialog window, which gives you +the opportunity to select a pattern. Simply click once on the pattern of your +choice, then click on <guilabel>OK</guilabel>, and &kde; will render the pattern +you selected using the two colors you selected. For more on patterns, see the +section <ulink url="help:/kcontrol/background/index.html#bkgnd-patterns">Background: Adding, Removing and Modifying +Patterns</ulink>.</para></listitem> +</varlistentry> +<varlistentry> +<term>Background Program</term> +<listitem><para>By selecting this option, you can have &kde; use an external +program to determine the background. This can be any program of your choosing. +For more information on this option, see the section entitled <ulink +url="help:/kcontrol/background/index.html#bkgnd-programs">Background: Using an external program</ulink>.</para></listitem> +</varlistentry> +<varlistentry> +<term>Horizontal Gradient</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &kde; will then start with the color selected by <guilabel>Color +1</guilabel> on the left edge of the screen, and slowly transform into the +color selected by <guilabel>Color 2</guilabel> by the time it gets to the +right edge of the screen.</para></listitem> +</varlistentry> +<varlistentry> +<term>Vertical Gradient</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &kde; will then start with the color selected by <guilabel>Color +1</guilabel> on the top edge of the screen, and slowly transform into the color +selected by <guilabel>Color 2</guilabel> as it moves to the bottom of the +screen.</para></listitem> +</varlistentry> +<varlistentry> +<term>Pyramid Gradient</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &kde; will then start with the color selected by <guilabel>Color +1</guilabel> in each corner of the screen, and slowly transform into the color +selected by <guilabel>Color 2</guilabel> as it moves to the center of the +screen.</para></listitem> +</varlistentry> +<varlistentry> +<term>Pipecross Gradient</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &kde; will then start with the color selected by <guilabel>Color +1</guilabel> in each corner of the screen, and slowly transform into the color +selected by <guilabel>Color 2</guilabel> as it moves to the center of the +screen. The <quote>shape</quote> of this gradient is different then the pyramid +gradient.</para></listitem> +</varlistentry> +<varlistentry> +<term>Elliptic Gradient</term> +<listitem><para>By choosing this mode, you select two colors (using both color +buttons). &kde; will then start with the color selected by <guilabel>Color +2</guilabel> in the center of the screen, and slowly transform into the color +selected by <guilabel>Color 1</guilabel> as it moves to the edges, in an +elliptical pattern.</para></listitem> +</varlistentry> +</variablelist> + +<para>The setup button is only needed for if you select <guilabel>Background +program</guilabel> or <guilabel>Patterns</guilabel>. In these instances, +another window will appear to configure the specifics.</para> +<para><emphasis>Wallpaper</emphasis></para> +<para>To select a new background image first, click on the +<guilabel>Wallpapers</guilabel> tab, then you can either select an image from the +drop-down list labeled <guilabel>Wallpaper</guilabel> or select +<guibutton>Browse...</guibutton> and select an image file from a file +selector.</para> + +<para>The image can be displayed in six different ways:</para> +<variablelist> +<varlistentry> +<term>No wallpaper</term> +<listitem><para>No image is displayed. Just the background colors.</para> +</listitem></varlistentry> +<varlistentry> +<term>Centered</term> +<listitem><para>The image will be centered on the screen. 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>Scaled</term> +<listitem><para>The image will be scaled to fit the desktop. It will be +stretched to fit all four corners.</para> </listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="kdmconfig-sessions"> +<title>Sessions</title> + +<para><guilabel>Allow to shutdown</guilabel></para> +<para>Use this dropdown box to choose who is allowed to shut down:</para> +<itemizedlist> +<listitem> +<para><guilabel>None</guilabel>: No one can shutdown the computer using &kdm;. +You must be logged in, and execute a command.</para> +</listitem> +<listitem> +<para><guilabel>All</guilabel>: Everyone can shutdown the computer using +&kdm;.</para> +</listitem> +<listitem><para><guilabel>Root only</guilabel>: &kdm; requires that the +<systemitem>root</systemitem> password be entered before shutting down the +computer.</para></listitem> +<listitem><para><guilabel>Console only</guilabel>: The user must be at this +console, to shut down the computer.</para></listitem> +</itemizedlist> + +<para><emphasis>Commands</emphasis></para> +<para>Use these 3 blanks to define the exact shutdown command.</para> +<para>The shutdown command defaults to:</para> + +<para><command>/sbin/shutdown</command></para> + +<para>The restart command defaults to:</para> + +<para><command>/sbin/reboot</command></para> + +<para>The Console mode (which restarts the computer as a console only terminal) +defaults to:</para> + +<para><command>/sbin/init <option>3</option></command></para> + +<para>When <guilabel>Show boot options</guilabel> is enabled, &kdm; will on reboot +offer you options for the lilo boot manager. For this feature to work, you will +need to supply the correct paths to your <command>lilo</command> command and to +lilo's map file.</para> + + +<sect3 id="kdmconfig-sess"> +<title>Session types</title> + +<para>Define which session types should be accessible from the login +window.</para> + +<para> For more information on this subject, look at <filename +class="directory">/etc/X11/xdm/Xsession</filename> to find your +<application>xdm</application> setup files. Also review the <ulink +url="man:xdm">xdm man pages</ulink>, especially under the SESSION +PROGRAM section.</para> + +<para>To add a session, type its name in the +blank entitled <guilabel>New types</guilabel>, and click +<guibutton>Add new</guibutton>. </para> + +<para>To remove a session, select the session from the list and click +<guibutton>Remove</guibutton>.</para> + +</sect3> + +</sect2> + + +<sect2 id="kdmconfig-users"> +<title>Users</title> + +<para>From here you can change the way users are represented in the +login window.</para> + +<para>As you look on this window, you will see three lists (All users, +selected users, and no-show users). You also see an image box, and a +set of options along the right side of the window.</para> + +<para>The first thing you must decide, is if you are going to show users +or not.</para> + + +<para>If you choose to show users, then the login window will show +images (which you select), of a list of users. When someone is ready to +login, they select their user name/image, enter their password, and they +are granted access. </para> + +<para>If you choose not to show users, then the login window will be +more traditional. Users will need to type their username, and password +to gain entrance. This is the preferred way if you have many users on +this terminal.</para> + +<sect3 id="kdmconfig-showusers"> +<title>To show (and sort) or not to show users</title> + +<para>Along the right edge of the window are two check boxes:</para> + +<para>If <guilabel>Show users</guilabel> is selected, you have chosen to +show images of users, instead of making them type their login +name.</para> + +<para>If <guilabel>Sort users</guilabel> is selected, then the list of +users will be sorted alphabetically in the login window. If unchecked, +users will be listed in the same order as they are on this page. If +<guilabel>Show users</guilabel> is not checked, this has no +effect.</para> + +</sect3> + +<sect3 id="kdmconfig-whichusers"> +<title>How to determine which users to show and which users to hide</title> + +<para>Below the user image box, and above the <guilabel>Show +users</guilabel> check box, is a set of two radio buttions:</para> + +<itemizedlist> +<listitem><para>Show only selected users: If this option is selected, only the +users contained in the list labelled <guilabel>Selected Users</guilabel>, will +be displayed in the login window. If <guilabel>Show users</guilabel> is not +checked, this has no effect.</para></listitem> +<listitem><para>Show all users but no-show users: If this option is selected, +all users will be listed, <emphasis>except</emphasis> those users contained in +the list entitled <guilabel>No show users</guilabel>. If <guilabel>Show +users</guilabel> is not checked, this has no effect. </para></listitem> +</itemizedlist> + +</sect3> + +<sect3 id="kdmconfig-select"> +<title>Select users</title> + +<para>This page contains three listboxes. The large listbox on the left +shows all the users on the system which might be a genuine user.</para> + +<para>The top rightmost listbox shows the selected users and the bottom +rightmost listbox shows the users we don't want displayed in the login +window.</para> + +<para>To move a user from one listbox to another you click on the +username in the listbox and click <guibutton>>></guibutton> to +move the user from the leftmost box the the rightmost box or +<guibutton><<</guibutton> to move the user from the rightmost box +to the leftmost box.</para> + +</sect3> + +<sect3 id="kdmconfig-image"> +<title>Images</title> + +<note><para>This section of the manual only applies if <guilabel>Show +users</guilabel> is selected. If it is not, this image box has no +effect.</para></note> + +<para>Every user on the system can be represented by a image. The image +for the user is kept in a file called +<filename>$<envar>KDEDIR</envar>/share/apps/kdm/pics/users/$<envar>USER</envar>.xpm.</filename> +If the user doesn't have such a file the file +<filename>$<envar>KDEDIR</envar>/share/apps/kdm/pics/users/default.xpm</filename> +will be used instead.</para> + +<para>To assign a new image to a user just select the user in one of the +listboxes and either drop an imagefile on the image button to the right +or click on the image button and select a new image from the image +selector.</para> + +<para>If no user is currently selected you will be asked if you want to change +the default image.</para> + +<para>The replacement is performed by a &konqueror; process so if the +image file already exists you will be prompted by &konqueror; if you +want to replace it. If you confirm the image will be replaced - you will +<emphasis>not</emphasis> have to press the <guibutton>Apply</guibutton> +button.</para> + +</sect3> +</sect2> + + +<sect2 id="kdmconfig-convenience"> +<title>Convenience</title> + +<para>In the <guilabel>convenience</guilabel> tab you can configure some +options that make life easier for lazy people, like auto login or +disabling passwords.</para> + +<important><para>Please think more than twice before using these +options. Every option in the <guilabel>convenience</guilabel> tab is +well-suited to seriously compromise your system security. Practically, +these options are only to be used in a completely non-critical +environment, ⪚ a private computer at home. </para></important> + +<sect3 id="loginmanager-convenience-autologin"> +<title>Automatic Login</title> + +<para>Automatic login will give anyone access to a certain account on +your system without doing any authentication. You can enable it using +the option <guilabel>Enable auto-login</guilabel>.</para> + +<para>Automatic login comes in two flavors: <guilabel>truly automatic +login</guilabel> acts like you would expect automatic login to, &ie; +&kdm; will automatically login without expecting any input from the +user. Enable this using the <guilabel>Truly automatic login</guilabel> +option. If this option is not enabled, &kdm; will start normally, +enabling you to login as any user, and will only perform automatic login +if you kill the X server, ⪚ by pressing <keycombo +action="simul">&Ctrl;&Alt;<keycap>Backspace</keycap></keycombo>.</para> + +<para>You can choose the account to be used for automatic login in the +list below.</para> + +</sect3> + +<sect3 id="loginmanager-convenience-nopasswd"> +<title>Password-less Login</title> + +<para>Using this feature, you can allow certain users to login without +having to provide their password. Enable this feature using the +<guilabel>Enable password-less logins</guilabel> option.</para> + +<para>Below this option you will see a list of users for which a password +is required, as well as a (by default, empty) list of users that do not +need to provide a password. When <guilabel>Enable password-less +logins</guilabel> is enabled, you can move users from one list into the +other, by selecting them and then clicking the +<guibutton>>></guibutton> and <guibutton><<</guibutton> +buttons.</para> + +<important><para>Again, this option should only be used in a safe +environment. If you enable it on a rather public system you should take +care that only users with heavy access restrictions are granted +password-less login, ⪚ +<systemitem>guest</systemitem>.</para></important> + +<para>The <guilabel>Automatically login after X server crash</guilabel> +option allows you to skip the authentication procedure when your X +server accidentally crashed. <guilabel>Show previous user</guilabel> +will show the name of the last login already entered into the login +field in &kdm;. Some site administrators would consider even this a +possible security weakness, because potential attackers then know at +least one valid login.</para> + + +</sect3> + +</sect2> + +</sect1> + +</article> 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..489443264 --- /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>KDE</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 +&kde; 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 KDE Startup</guilabel></term> +<listitem> +<para>You can choose to either always <guilabel>Turn on</guilabel> or +<guilabel>Turn off</guilabel> the NumLock when &kde; starts, or you can +choose to have &kde; leave NumLock at whatever it was set to before KDE +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/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..6b7d04a6e --- /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 &kde; 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, &kde; 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 &kde;'s default value. This is a good choice +for most actions, as &kde; 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. &kde; 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: &kde; +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> +<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 &kde; 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/khtml/Makefile.am b/doc/kcontrol/khtml/Makefile.am new file mode 100644 index 000000000..c54c99e96 --- /dev/null +++ b/doc/kcontrol/khtml/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/khtml diff --git a/doc/kcontrol/khtml/index.docbook b/doc/kcontrol/khtml/index.docbook new file mode 100644 index 000000000..9f204f075 --- /dev/null +++ b/doc/kcontrol/khtml/index.docbook @@ -0,0 +1,352 @@ +<?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 &kde;.</para> + +<sect2 id="kbrowse-html"> + +<title>Behavior</title> + +<para>The first option you can enable on this page 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>&konqueror; defaults to a single window per page, but has the +capability to open multiple <firstterm>tabs</firstterm> inside a +single window. &konqueror; also, by default, 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> + +<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="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 KIO</guilabel> will cause the +<acronym>JVM</acronym>to use &kde;'s own <acronym>KIO</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="khtml-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/khtml/nsplugin.docbook b/doc/kcontrol/khtml/nsplugin.docbook new file mode 100644 index 000000000..1f8547461 --- /dev/null +++ b/doc/kcontrol/khtml/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 &kde; startup</guilabel> +so &konqueror; will scan the appropriate folders every time &kde; +starts up, to see whether new plugins have been installed.</para> + +<note><para>Enabling <guilabel>Scan for new plugins at &kde; +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/kwindecoration/Makefile.am b/doc/kcontrol/kwindecoration/Makefile.am new file mode 100644 index 000000000..ad89ecd92 --- /dev/null +++ b/doc/kcontrol/kwindecoration/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/kwindecoration diff --git a/doc/kcontrol/kwindecoration/index.docbook b/doc/kcontrol/kwindecoration/index.docbook new file mode 100644 index 000000000..c6bfd5276 --- /dev/null +++ b/doc/kcontrol/kwindecoration/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>kwin</keyword> +<keyword>window</keyword> +<keyword>border</keyword> +<keyword>theme</keyword> +<keyword>style</keyword> +</keywordset> +</articleinfo> +<sect1 id="window-deco"> +<title>Window Decoration</title> + +<sect2> +<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> +<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/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..c93c16190 --- /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 &kde; 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/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..62d223de1 --- /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 &kde; &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 &kde;. 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, &kde; 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 &kde; to +register a double click. If you click twice, and the time between those +two clicks is less than this number, &kde; recognizes that as a double +click. If the time between these two clicks is greater than this +number, &kde; 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> + +&kde; 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-kdm 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/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..f97b30b36 --- /dev/null +++ b/doc/kcontrol/netpref/index.docbook @@ -0,0 +1,109 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Lauri.Watts; &Lauri.Watts.mail;</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdebase</keyword> +<keyword>kcontrol</keyword> +<keyword>network</keyword> +<keyword>timeouts</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="timeouts"> + +<title>Preferences</title> + +<para>Here you can set timeout values. You might want to tweak them +if your connection is very slow, but the default settings are +appropriate for most users.</para> + +<para>Here <guilabel>Timeout Values</guilabel> are the length of time +an application should wait for an answer from a network operation.</para> + +<para>You can configure the following timeouts:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Socket read:</guilabel></term> +<listitem> +<para> Some applications use <firstterm>sockets</firstterm> to +communicate. You can think of a socket as a water tap; while it is +open, water (or in our case, data) comes out, without any interaction. +If something stops this flow of data, the application will wait for +more to come. This could be a very long time, but you can configure a +maximum time for an application to wait with this option.</para> +<para>This setting will only apply to &kde; applications, of course.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Proxy connect:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a connection to a proxy server, if one is configured. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server connect:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a connection to a remote server. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server response:</guilabel></term> +<listitem> +<para> +Sets how long to wait for a reply from a remote server. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>You can configure <guilabel>FTP Options</guilabel> here. At +present there is just two options:</para> +<variablelist> +<varlistentry> +<term><guilabel>Enable passive mode (PASV)</guilabel></term> +<listitem><para>Passive &FTP; is often required when you are behind a firewall. +Many firewalls only permit connections that were initiated from +<quote>the inside</quote>. Passive &FTP; is controlled by the client, +which makes it usable through firewalls.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Mark partially uploaded files</guilabel></term> +<listitem><para>When a mark is placed in this box, partially uploaded files will +have a <literal role="extension">.part</literal> extension added to the end +of the file. This extension is removed once the file download is complete. </para></listitem> +</varlistentry> + +</variablelist> + + + +</sect1> +</article>
\ No newline at end of file diff --git a/doc/kcontrol/panel/Makefile.am b/doc/kcontrol/panel/Makefile.am new file mode 100644 index 000000000..06524aebe --- /dev/null +++ b/doc/kcontrol/panel/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/panel diff --git a/doc/kcontrol/panel/index.docbook b/doc/kcontrol/panel/index.docbook new file mode 100644 index 000000000..722c6ed9d --- /dev/null +++ b/doc/kcontrol/panel/index.docbook @@ -0,0 +1,244 @@ +<?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>&Lauri.Watts; &Lauri.Watts.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-02-20</date> +<releaseinfo>3.4</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>panel</keyword> +</keywordset> +</articleinfo> + +<sect1 id="panel"> +<title>Panel</title> + +<para> The &kde; panel (often referred to as &kicker;) is the bar that +you'll usually find at the bottom of the screen when you start up &kde; +for the first time. For detailed help on &kicker;'s usage you can type + <ulink url="help:/kicker">help:/kicker</ulink> in &konqueror; to read +the user manual.</para> + +<para>The panel gives you quick access to applications and makes it +easier for you to organize your desktop. Using the &kde; panel you +can:</para> + +<itemizedlist> +<listitem><para>launch applications using the <guimenu>K</guimenu> menu or +the application buttons</para></listitem> +<listitem><para>switch desktops using the panel's pager applet</para> +</listitem> +<listitem><para>switch active windows, and minimize or maximize them</para> +</listitem> +<listitem><para>browse folder using the browser menu functionality +</para></listitem> +<listitem><para>access panel applets that extend the panel's functionality, +offering for example mixers, clocks or a system monitor</para> </listitem> +</itemizedlist> + +<sect2 id="panel-position"> +<title><guilabel>Arrangement</guilabel></title> + +<para>In the <guilabel>Arrangement</guilabel> tab you can configure the size and +position of the panel.</para> + +<para>If you have more than one panel on screen, you can select at the +top of the window which panel you wish to configure.</para> + +<para>In the section labeled <guilabel>Position</guilabel> is a set of +12 small buttons arranged in a square. Each button corresponds to a +location for the panel. Click on a button and notice where the panel +is located on the preview monitor to the right.</para> + +<tip><para>Generally, the available space in kicker is used more +efficiently if the panel is aligned horizontally, &ie; attached to the +top or bottom screen border.</para></tip> + +<para>In the section labeled <guilabel>Length</guilabel>, you can use +the combo box and slider to adjust the <emphasis>minimum</emphasis> +length of the panel. If you place a mark in the checkbox labeled +<guilabel>Expand as required to fit contents</guilabel>, the panel +will become longer if more space is needed. When less space is +required on the panel, the panel will shrink down to the minimum size. +If there is no mark in the checkbox, then the panel is fixed to the +length specified in this section.</para> + +<para>The final section of this table is labeled +<guilabel>Size</guilabel>, and refers to the +<emphasis>height</emphasis> of the panel. The panel's size can be +<guilabel>Tiny</guilabel>, <guilabel>Small</guilabel>, +<guilabel>Medium</guilabel>, <guilabel>Large</guilabel> or +<guilabel>Custom</guilabel>. If you choose +<guilabel>Custom</guilabel> mode, you can resize &kicker; by +specifying a height in the combobox.</para> + +<para>If you have multiple monitors, you can configure the panel for +each screen entirely independently. If you are not sure which screen +is which, Press the <guibutton>Identify</guibutton> and a number will +appear centred on each screen.</para> +<!-- TODO: It's not centered on dual head non-xinerama, they both +appear on the primarey head, file a bug --> + +<para>Then simply choose the screen you wish to configure from the +drop down box labelled <guilabel>Xinerama screen</guilabel>, or choose +<guilabel>All Screens</guilabel> to have identical configurations on +each.</para> + +</sect2> + +<sect2 id="panel-hiding"> +<title>Hiding</title> + +<para>Depending on your screen resolution you may find that the panel +takes away too much of your precious screen real estate. To save +screen space, the panel offers manual hiding of the panel, an auto +hide feature, and the ability to allow other windows to lay on top of +the panel. These features are selected in the section entitled +<guilabel>Hide Mode</guilabel>.</para> + +<para>The <guilabel>Hide Mode</guilabel> section has three options:</para> +<variablelist> +<varlistentry> +<term><guilabel>Only hide when panel-hiding button is clicked</guilabel></term> +<listitem><para>When this option is selected, the panel will remain visible at +the location you defined unless you click on the button at the far right (for horizontally +oriented) or bottom (for vertically oriented) button. This button has an arrow on it pointed +to the edge of the screen.</para> + +<para>Once clicked, the panel will disappear. If the button is clicked again, the panel will re-appear +at the same location.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Hide automatically</guilabel></term> +<listitem><para>If this option is selected, then the panel will automatically disappear after +the number of seconds specified in the combo box below the option. To make the panel reappear, +simply move the mouse pointer to the edge of the screen where the panel is located, and the +panel will reappear immediately.</para> + +<para>If you place a mark in the checkbox labeled <guilabel>Show panel when switching +desktops</guilabel>, the panel will automatically reappear when you switch desktops. (The panel +will disappear again after the specified number of seconds.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Allow other windows to cover the panel</guilabel></term> +<listitem><para>As this option's label implies, the panel is always on the desktop when +this option is selected. It is now possible, however, for application windows to lay +on top of the panel.</para> + +<para>To restore the panel, simply move the mouse cursor to the screen +location specified in the drop box labeled <guilabel>Raise when the pointer touches +the screen's:</guilabel>. You can change this value by selecting one of the choices +provided in the drop down box.</para> + +<para>Once the panel has moved back on top of the application window, it will stay there +until an application window becomes active again.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>The next section down is labeled <guilabel>Panel-Hiding Buttons</guilabel>. It +consists of two check boxes: <guilabel>Show left panel-hiding button</guilabel> and +<guilabel>Show left panel-hiding button</guilabel>. Use these checkboxes to show and +hide the left and right manual panel hiding buttons.</para> + +<para>If there is no mark in the checkbox labeled <guilabel>Animate +panel hiding</guilabel>, then whenever the toolbar is hidden, is simply disappears. If there +is a mark in the check box, then the panel appears to slide off the edge of the screen.</para> + +<para>You can determine how quickly the panel appears to move by adjusting the slider from +<guilabel>Fast</guilabel> to <guilabel>Slow</guilabel>.</para> +</sect2> + +<sect2 id="panel-menus"> +<title>Menus</title> + +<para>In the <guilabel>Menus</guilabel> tab you can configure the panel +menu's behavior. This affects the K menu you will often use to launch +applications, the browser menus you can use to access folders and other +menus like the recent documents menu.</para> + +<para>The <guilabel>K Menu</guilabel> frame offers you some options to +configure the <guimenu>K</guimenu> menu's functionality. This frame consists +of 4 items:</para> + +<itemizedlist> +<listitem><para>The <guilabel>Menu item format:</guilabel> radio +buttons have three options. This determines how the application name +(&ie; &konqueror;, &kword;, &etc;) and the description (&ie; Web +Browser, Word Processor, &etc;) are displayed on the &kmenu;. +</para></listitem> + +<listitem><para>The <guilabel>Optional Menus</guilabel> checkboxes allow +you to +determine which special menu items appear in the &kmenu;.</para> +<para>The <guilabel>Bookmarks</guilabel> +menu allows you to quickly select from the same bookmarks that are available in &konqueror;. </para> +<para>The <guilabel>Find</guilabel> menu offers access to the &kfind; application to search for local files, and a quick link to a search engine to search for things on the Internet.</para> +<para>The <guilabel>Konqueror Profiles</guilabel> menu allows you to +launch &konqueror; with any of your configured profiles.</para> +<para>The <guilabel>Network Folders</guilabel> menu can launch a +&konqueror; file manager window displaying any of your configured +network folders.</para> +<para>The <guilabel>Preferences</guilabel> menu allows you to launch each &kcontrol; module +directly from the K menu.</para> +<para>The <guilabel>Print System</guilabel> menu provides several menu entries to help manage +the printer(s) attached to your system.</para> +<para>The <guilabel>Quick Browser</guilabel> menu gives you quick links to locations on your hard drive.</para> +<para>The <guilabel>Recent Documents</guilabel> menu lists the most recently edited documents and will automatically +launch the application to edit or view this document. </para> +<para>The <guilabel>System</guilabel> menu allows you quick access to +some commonly visited places, including your Home folder, and the +Trash. You may find this useful instead of having a separate entry for +each of these in the &kmenu;</para> +<para>The <guilabel>Terminal Sessions</guilabel> menu provides menu items to launch several different types of +terminal programs (command line interfaces).</para> +</listitem> + +<listitem><para><guilabel>Show side image</guilabel> will add a small +image to the side of the menu. This is purely decorative.</para></listitem> + +<listitem><para>The <guibutton>Edit K Menu</guibutton> button launches the &kde; +menu editor.</para></listitem> +</itemizedlist> + +<para> In the <guilabel>QuickBrowser Menus</guilabel> area you can configure +whether the panel's browser menus will show hidden files or not (hidden +files on &UNIX; systems are those whose filenames begin with a dot) as +well as how many files at most will be shown in a browser menu. The +latter option may be especially useful if you have a rather small screen +resolution, as then the browser menus will quickly fill up your screen +when you browse folders containing many files.</para> + +<para>The quick start section in the K menu offers quick access to +programs you have used often or recently. In the <guilabel>Quick Start Menu Items</guilabel> +frame you can choose whether +this section will show the most recently or the most frequently used +programs. Using the option <guilabel>Maximum number of entries</guilabel> +combo box, you can configure how many programs the quick start +section will remember.</para> + +</sect2> + + + +</sect1> + +</article> diff --git a/doc/kcontrol/panelappearance/Makefile.am b/doc/kcontrol/panelappearance/Makefile.am new file mode 100644 index 000000000..1a92a45e8 --- /dev/null +++ b/doc/kcontrol/panelappearance/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/panelappearance + diff --git a/doc/kcontrol/panelappearance/index.docbook b/doc/kcontrol/panelappearance/index.docbook new file mode 100644 index 000000000..1619c3f12 --- /dev/null +++ b/doc/kcontrol/panelappearance/index.docbook @@ -0,0 +1,122 @@ +<?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>Mike</firstname> +<surname>McBride</surname> +</author> +<author> +<firstname>Jost</firstname> +<surname>Schenck</surname> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-06</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>panel</keyword> +</keywordset> +</articleinfo> + +<sect1 id="panel"> +<title>Panel</title> + +<para>Here you can configure the panel's overall appearance.</para> + +<para>You can also have the icons themselves zoom out when the +mouse is over them, with the <guilabel>Enable icon zooming</guilabel> +option. You can choose to have tooltips appear when your mouse button is +over an icon, by enabling the <guilabel>Show tooltips</guilabel> +option.</para> + +<sect2 id="button-backgrounds"> +<title>Button Backgrounds</title> + +<para>The &kde; panel supports so-called <guilabel>Button +Backgrounds</guilabel>. This means that the buttons shown on the panel +will be drawn using configurable images. To enable button backgrounds, +simply choose the button type from the list, and change the drop down +box to the color image you would like to use. Choose +<guilabel>Default</guilabel> to return to an unstyled button. If you +choose <guilabel>Custom color</guilabel>, the color button next to the +drop down list will be enabled. Click on it to select a custom color +to use.</para> + +</sect2> + +<sect2 id="panel-background"> +<title><guilabel>Panel Background</guilabel></title> + +<para><guilabel>Enable transparency</guilabel> to turn the entire +panel transparent. The desktop background will show through instead +of a background image or color.</para> + +<para>There will still be small handles beside each applet, to allow +you to locate, move, and configure them. These can be turned off in +the <guilabel>Advanced Options</guilabel></para> + +<para>If you check <guilabel>Enable background image</guilabel> a +picture will be used to draw the panel's background, just as you +can use a picture for the desktop background. You can specify an image +file in the line edit box below or choose one by clicking on the +<guibutton>Browse</guibutton> button. You'll see a preview of the +selected picture on the right.</para> + +<para>The image can be tinted on-the-fly by enabling the option +<guilabel>Colorize to match the desktop color scheme</guilabel>. You +might use a grayscale texture that is tinted in this manner, to create +a particular effect.</para> +</sect2> + +<sect2 id="advanced-options"> +<title><guilabel>Advanced Options</guilabel></title> + +<para>The <guilabel>Hide button size:</guilabel> option allows you to +choose a width in pixels for the hide buttons, if they are +visible.</para> + +<para>The panel itself has several default sizes set, which you can +switch between by simply dragging the edge of it, or by &RMB; clicking +on an empty space in the panel, choosing <guisubmenu>Size</guisubmenu> +and selecting the desired size from the submenu. If you enable +<guilabel>Allow Drag and Drop resizing of panels</guilabel> then by +choosing <guimenuitem>Custom</guimenuitem> in the panel menu, you can +drag the panel edge to any size you like.</para> + +<para>Applet handles are normally visible beside each applet on the panel, so that it is clear where to click to configure them, or to get to the panel menu. You can instead have them <guilabel>Fade out</guilabel>, or hide unless you hover the mouse over them, or you can choose to <guilabel>Hide</guilabel> them completely.</para> + +<para>Finally, if the panel is transparent, you can tint it with a +color of your choice. The slider allows you to choose how opaque the +tint is. At the lowest end, there is no tint visible, while at the +highest, the panel is not transparent at all.</para> + +</sect2> + +<sect2 id="panel-author"> +<title>Section Author</title> +<para>This section written by: Jost Schenck <email>[email protected]</email></para> +<para>Minor update by Mike McBride +<email>[email protected]</email></para> + +<para>Some new options added by Lauri Watts +<email>[email protected]</email></para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect2> + +</sect1> + +</article> diff --git a/doc/kcontrol/passwords/Makefile.am b/doc/kcontrol/passwords/Makefile.am new file mode 100644 index 000000000..6c8d0b013 --- /dev/null +++ b/doc/kcontrol/passwords/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/passwords diff --git a/doc/kcontrol/passwords/index.docbook b/doc/kcontrol/passwords/index.docbook new file mode 100644 index 000000000..3aa2ed0bc --- /dev/null +++ b/doc/kcontrol/passwords/index.docbook @@ -0,0 +1,84 @@ +<?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> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2003-10-16</date> +<releaseinfo>3.2</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>password</keyword> +</keywordset> + +</articleinfo> +<sect1 id="passwords"> + +<title>Passwords</title> + +<sect2 id="passwords-intro"> +<title>Introduction</title> + +<para>This module of the &kcontrol; gives you options for configuring the way in +which the &kdesu; program treats passwords. &kdesu; will ask you for a password +when you try to carry out some privileged actions, such as changing the +date/time stored in your system clock, or adding new users on your +computer.</para> + +<para>Privileged actions such as those described above can only be +carried out by <systemitem class="username">root</systemitem> or a +user with administrator permissions on your system. You will need to +enter the password for the root account when you want to carry out +such actions.</para> + +<important><para>The options in this module do not affect the behavior of +passwords in other programs such as &kmail;.</para> +</important> + +</sect2> + +<sect2 id="passwords-use"> +<title>Use</title> + +<para>There are two configuration options for passwords. The first is +to control the visual feedback that you receive when you type a +password. The actual characters in the password are never shown on the +screen. You can choose to have each character represented by a +<token>*</token> character. If you want to make it harder for someone +who might be watching your screen to figure out how many characters +there are in the password, you can choose to have each character in +the password be represented by three asterisks rather than just +one. Still another option is not to have any visual feedback at all, +so nothing appears on the screen when you type a password.</para> + +<para>If you work in a reasonably secure environment, you can check +the option labeled <guilabel>Remember Passwords</guilabel>, and then +choose a time period in minutes using the spinner labeled +<guilabel>Timeout</guilabel>. (You can either type a number between 5 +and 1200 minutes, or use the arrows on the spinner.)</para> + +<para>If the <guilabel>Remember passwords</guilabel> option has been selected, +<application>kdesu</application> will not ask you for a password for the length +of time specified, after you have given the password once. Keep in mind, +however, that this makes your workstation less secure.</para> + +<important><para>You should avoid selecting the <guilabel>Remember +passwords</guilabel> option if you are working in an insecure area, such as a +publicly accessible workstation. Also, note that choosing a shorter timeout may +be better if you are in a less secure environment.</para></important> + +</sect2> + +</sect1> +</article>
\ No newline at end of file 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..b0acf0685 --- /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>&kde;, 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 &kde; is +installed on feel more responsive. </para> + +<para>This module is divided into two tabs.</para> + + +<sect2><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 &kde; 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 &kde; 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;, &kde; 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 &kde; startup</guilabel> does just what it says. It tells +&kde; to preload one instance of &konqueror; at the startup of &kde;.</para> +<note><para>This does extend the startup time for &kde;.</para></note> +<para>The final checkbox labeled <guilabel>Always try to have at least one preloaded instance</guilabel> signals to &kde; that you always want &kde; 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><title>&kde; 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 &kde; 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 &kde; and many times this scan is not needed as the configuration is current from the last time &kde; was started. When the configuration has changed &kde; 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. &kde; 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>&kde; will wait to perform the scan until after &kde; has started. This scan will be performed after the desktop is loaded.</para></listitem> +<listitem><para>In the event of a crash, &kde; 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/proxy/Makefile.am b/doc/kcontrol/proxy/Makefile.am new file mode 100644 index 000000000..ce9c3748a --- /dev/null +++ b/doc/kcontrol/proxy/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = kcontrol/proxy diff --git a/doc/kcontrol/proxy/index.docbook b/doc/kcontrol/proxy/index.docbook new file mode 100644 index 000000000..0a47cec36 --- /dev/null +++ b/doc/kcontrol/proxy/index.docbook @@ -0,0 +1,197 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY socks-kcontrol SYSTEM "socks.docbook"> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + + +<authorgroup> +<author>&Krishna.Tateneni; &Krishna.Tateneni.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-11</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>proxy</keyword> +<keyword>proxies</keyword> +</keywordset> + +</articleinfo> +<sect1 id="proxies"> +<title>Proxies</title> + +<sect2 id="proxies-intro"> + +<title>Introduction</title> + +<para>Proxies are programs running on a computer that acts a server on +the network you are connected to (whether by modem or other +means). These programs receive &HTTP; and &FTP; requests, retrieve the +relevant files from the internet, and pass them on to the client +computer that made the requests.</para> + +<para>When you have configured a proxy, &HTTP; and/or &FTP; requests +are re-routed through the computer that is acting as a proxy server. +However, you can also select specific hosts which should be contacted +directly, rather than through the proxy server. If you are on a local +network, for example, access to local hosts probably doesn't need to +go through a proxy server.</para> + +<para>You should only need to configure a proxy server if your network +administrator requires it (if you are a dial-up user, that would be +your internet service provider or <acronym>ISP</acronym>). Otherwise, +especially if you are feeling a bit confused about this proxy +business, but everything seems to be fine with your internet +connection, you don't need to change anything.</para> + +<para>Please note that using proxy servers is optional, but has the +benefit or advantage of giving you faster access to data on the +internet.</para> + +<para>If you are uncertain whether or not you need to use a proxy +server to connect to the internet, please consult with your internet +service provider's setup guide or your system administrator.</para> + +</sect2> + +<sect2 id="proxies-use"> + +<title>Use</title> + +<variablelist> +<varlistentry> +<term><guilabel>Connect to the Internet directly</guilabel></term> +<listitem> + +<para>Select this option if you do <emphasis>not</emphasis> want to use a proxy server.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>If you have decided to use a proxy, you have several methods to +configure the settings for it.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Automatically detected script file</guilabel></term> +<listitem> + +<para>Select this option if you want the proxy setup configuration +script file to be automatically detected and downloaded.</para> +<para>This option only differs from the next choice in that it +<emphasis>does not</emphasis> require you to supply the location of +the configuration script file. Instead, it will be automatically +downloaded using <quote>Web Access Protocol Discovery</quote> +(<acronym>WAPD</acronym>).</para> + +<note><para>If you have a problem using this setup, please consult the +<acronym>FAQ</acronym> section at <ulink +url="http://www.konqueror.org">http://www.konqueror.org</ulink> for +more information.</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Specified script file</guilabel></term> +<listitem> +<para>Select this option if your proxy support is provided through a +script file located at a specific address. You can then enter the +address in the location text box, or use the <guiicon>folder</guiicon> +icon to browse to it.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Preset environment variables</guilabel></term> +<listitem> +<para>Some systems are setup with $<envar>HTTP_PROXY</envar> to allow +graphical as well as non-graphical applications to share the same +proxy configuration information.</para> +<para>If you know this applies to you, select this option and click on +the <guibutton>Setup...</guibutton> button to provide the environment +variable names used to set the address of the proxy server(s).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Manually specified settings</guilabel></term> +<listitem> +<para>Select this option, and click on the +<guibutton>Setup...</guibutton> to manually setup the location of the +proxy servers to be used.</para> + +<para>If you choose this option, another dialog will pop up.</para> + +<para>The complete addressing information for the proxy includes both +the internet address and a port number. You should enter these into +the relevant text boxes. The <guiicon>arrow</guiicon> button copies +the information from the <guilabel>HTTP</guilabel> line to the +<guilabel>FTP</guilabel> line, in order to help save some +typing.</para> + +<para>If there are hosts which you can connect to without going +through the proxy server, you can press <guibutton>Add</guibutton> to +add the names of these hosts, separated by in the text box labeled +<guilabel>No Proxy For:</guilabel>. For example, hosts that are on +your local network can probably be contacted directly.</para> + +<para>You can also choose <guilabel>Only use proxy for entries in this +list</guilabel>.</para> + +<para>Check this box to reverse the use of the exception list, &ie; +the proxy servers will only be used when the requested &URL; matches +one of the addresses listed here.</para> + +<para>This features is useful if all you need is a proxy to access a +few specific sites, for example, an internal intranet. If you have +more complex requirements you might want to use a configuration +script.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="authorization"> +<title><guilabel>Authorization</guilabel></title> + +<para>Here you can choose between two types of authentication, if your +proxy requires it. You can have <guilabel>Prompt as +needed</guilabel>, the default, in which case &konqueror; will only +ask for a username or password if it needs to.</para> + +<para>The other option is <guilabel>Use automatic login</guilabel>. +Select this option if you have already set up a login entry for your +proxy server in the +<filename>$<envar>KDEDIR</envar>/share/config/kionetrc</filename> +file.</para> + +</sect2> + +<sect2 id="options"> +<title><guilabel>Options</guilabel></title> +<variablelist> +<varlistentry> +<term><guilabel>Use persistent connections to proxy</guilabel></term> +<listitem> +<para>Use persistent connection to your proxy server. Keeps connection to proxy open, helps lower bandwidth/speed up connection. Enabling this option will require the proxy server's cooperation, if the proxy server does not support this, it will bring your internet to a stop. </para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +&socks-kcontrol; + +</sect1> + +</article> diff --git a/doc/kcontrol/proxy/socks.docbook b/doc/kcontrol/proxy/socks.docbook new file mode 100644 index 000000000..73c5e2ec6 --- /dev/null +++ b/doc/kcontrol/proxy/socks.docbook @@ -0,0 +1,56 @@ +<sect2 id="socks"> +<sect2info> +<authorgroup> +<author>&Lauri.Watts;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> +</sect2info> + +<title>SOCKS</title> + +<para>SOCKS is a protocol to execute proxy requests for a client. SOCKS +is capable of authentication and encryption of traffic, and is often +found in corporate settings, as opposed to home users. For more +information about SOCKS, see the <ulink +url="http://www.socks.nec.com">NEC</ulink> website</para> + +<para>With this module you can enable most of the network aware &kde; +applications to transparently use SOCKS.</para> + +<para>Setting up of a SOCKS client is outside the scope of this +document, and the differences between the commonly used ones are very +large. If you already have a working SOCKS implementation, allowing you +to use commandline clients (for example, if <command>lynx</command> or +<command>ftp</command> are already working) then you can simply check +the <guilabel>Enable SOCKS support</guilabel> checkbox.</para> + +<para>When this box is checked, several further options become available +to you.</para> + +<para>First, you should select which of the various SOCKS clients you +have installed on your computer. &kde; will attempt to find this out by +itself, if you choose <guilabel>Auto detect</guilabel>. If you know the +client you have, you could choose either <guilabel>NEC +Socks</guilabel> or <guilabel>Dante</guilabel>. If you have a +custom built SOCKS library to use, you can select <guilabel>Use custom +library</guilabel> and then enter the path to it in the +<guilabel>Path</guilabel> field.</para> + +<para>If you want &kde; to auto detect the SOCKS library in use, but you +suspect it isn't looking in the right places or you have installed it in +a non-standard location, then you can add further paths to be searched in +the bottom of this panel. Use the <guibutton>Add</guibutton> and +<guibutton>Remove</guibutton> to add or remove paths.</para> + +<para>At any time while filling in this module, you can press the +<guibutton>Test</guibutton> button, and &kde; will report immediately +with a message box to tell you if it could find and initialize SOCKS or +not.</para> + +<para>Changes made here will not affect any applications that are +already open. You will need to close and restart them before they are +able to connect via SOCKS.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect2> 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..67cb99411 --- /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 &kde; 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-&kde; screen saver</title> + +<para>&kde; does not prevent another screen saver from working. To use a +different screen saver, such as <application>xscreensaver</application>, simply +disable the &kde; 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 +$KDEDIR/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 +$KDEDIR/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 +$KDEDIR/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 &kde; 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>~/.kde/share/config</filename> +</command> +</para> +<para>Now, using a text editor (the example uses &kate;, the &kde; 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..f73f380cf --- /dev/null +++ b/doc/kcontrol/screenshot.png 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..3d3a0ea6a --- /dev/null +++ b/doc/kcontrol/smb/index.docbook @@ -0,0 +1,106 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author>&Mike.McBride; &Mike.McBride.mail;</author> +<author>&Jost.Schenck; &Jost.Schenck.mail;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Windows shares</keyword> +</keywordset> +</articleinfo> +<sect1 id="windows-shares"> +<title>Windows Shares</title> + +<sect2 id="windows-shares-intro"> +<title>Introduction</title> + +<para>In many small local area networks, the <acronym>SMB</acronym> +protocol is used to offer network services. Names like +<quote>&Windows; Network</quote> or <quote>&Windows; for Workgroups +Network</quote> or <quote>LanManager</quote> are often used as +well. Using <acronym>SMB</acronym> you can access so-called +<quote>shares</quote> (&ie; folders made available by the server) +as well as printers. </para> + +<para>&kde; comes with built-in support for the <acronym>SMB</acronym> +protocol. As &kde; is network-transparent that means you can access +<acronym>SMB</acronym> shares from everywhere you can access your +local files, for example in the &konqueror; file manager and in the +file dialog. To make use of this you should provide &kde; with some +information on your <acronym>SMB</acronym> network. But don't worry, +this is normally pretty simple as, for example, all the Windows +clients in your network need and have the same information.</para> + +<!-- Don't know if the following info should go in the base +documentation --> + +<!-- this smb-ioslave doesn't support showing a list +of hosts (like e.g. smb:/), for this you need the lan or rlan-ioslave, +very cool thing (TM) btw. If you want to write some documentation for +this one too, have a look at kdenetwork/lanbrowsing/lisa/README and +contact me if you have questions. --> + +<note><para>For the <acronym>SMB</acronym> protocol to work, it is +required to have <application>Samba</application> correctly +installed. If you have an NT domain controller, you will need at least +<application>Samba</application> version 2.0 or higher. If you want to +access &Windows; 2000 shares, you will need +<application>Samba</application> version 2.0.7 or higher. Older +versions may work too, but have not been tested.</para></note> + +<!-- TODO: link to some place which explains USING SMB, i.e. konqueror +or file dialog manual --> + +</sect2> + +<sect2 id="windows-shares-use"> +<title>Use</title> + +<para>Although there are a lot of insecure <acronym>SMB</acronym> +networks out there which allow access to anyone, in principle you have +to authenticate yourself to access the services of an +<acronym>SMB</acronym> server. By default, &kde; will use the data +entered in the <guilabel>Default user name</guilabel> and +<guilabel>Default password</guilabel> fields to authenticate itself on +<acronym>SMB</acronym> hosts. If you leave the field <guilabel>Default +user name</guilabel> empty, &kde; will try to access +<acronym>SMB</acronym> hosts without a username. If you leave the +default password empty, it will try without a password. If &kde; is +unsuccessful accessing the host using these settings, you will be +asked for a username and a password.</para> + +<important><para>While it makes things more comfortable if &kde; +stores your <acronym>SMB</acronym> password, this may be a security +problem. If you are using <acronym>SMB</acronym> in a security +conscious environment, you should not store your password here but +rather enter it anew every time you need to access an +<acronym>SMB</acronym> host.</para></important> + +<para>In the <guilabel>Workgroup</guilabel> field, you can enter your +workgroup name. If you don't know it, ask your system administrator +or have a look at other already configured machines in your network. +However, in most cases providing the workgroup name is not required, +so you probably can also leave this empty.</para> + +<para>If the option <guilabel>Show hidden shares</guilabel> is +checked, shares ending with a <quote>$</quote> will be shown.</para> +</sect2> + +</sect1> + +</article>
\ No newline at end of file diff --git a/doc/kcontrol/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..87279d41b --- /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 &kde; +applications that use &kspell;, 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 +&kspell;.</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/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..14be0fcf2 --- /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/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..650b8d2aa --- /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 constomize window settings specifically only for +some windows.</para> + +<note> +<para>Please note that this configuration will not take effect if you +do not use &kwin; 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 |
