diff options
Diffstat (limited to 'doc/khelpcenter')
166 files changed, 20784 insertions, 0 deletions
diff --git a/doc/khelpcenter/CMakeL10n.txt b/doc/khelpcenter/CMakeL10n.txt new file mode 100644 index 000000000..6d5e285d8 --- /dev/null +++ b/doc/khelpcenter/CMakeL10n.txt @@ -0,0 +1,3 @@ +##### create translation templates ############## + +tde_l10n_auto_add_subdirectories() diff --git a/doc/khelpcenter/CMakeLists.txt b/doc/khelpcenter/CMakeLists.txt index 279f09d4d..83c417b7a 100644 --- a/doc/khelpcenter/CMakeLists.txt +++ b/doc/khelpcenter/CMakeLists.txt @@ -10,3 +10,5 @@ ################################################# tde_create_handbook( DESTINATION khelpcenter ) + +tde_auto_add_subdirectories() diff --git a/doc/khelpcenter/adminguide/CMakeLists.txt b/doc/khelpcenter/adminguide/CMakeLists.txt new file mode 100644 index 000000000..ec8d87dac --- /dev/null +++ b/doc/khelpcenter/adminguide/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/adminguide ) diff --git a/doc/khelpcenter/adminguide/Makefile.am b/doc/khelpcenter/adminguide/Makefile.am new file mode 100644 index 000000000..86108a74b --- /dev/null +++ b/doc/khelpcenter/adminguide/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = khelpcenter/adminguide + diff --git a/doc/khelpcenter/adminguide/groupware-kontact.docbook b/doc/khelpcenter/adminguide/groupware-kontact.docbook new file mode 100644 index 000000000..e1a8db623 --- /dev/null +++ b/doc/khelpcenter/adminguide/groupware-kontact.docbook @@ -0,0 +1,596 @@ +<chapter id="groupware-with-kontact"> + +<chapterinfo> +<authorgroup> +<author> +<personname> +<firstname>Marco</firstname> +<surname>Menardi</surname> +</personname> +<email>[email protected]</email> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</chapterinfo> +<title>Sharing data with &kontact; via <acronym>IMAP</acronym></title> + +<sect1 id="kontact-imap-intro"> +<title>Introduction</title> + +<para>For my small office, I was looking for a long time for a +<acronym>PIM</acronym> solution that let me share data, so my secretary and +I can share contacts, appointments and so on. Being a &tde; user, I've heard +about the Kroupware project and wait its completion. But when I saw how +complicated is the architecture and setup of the +<application>Kolab</application> server 1.0 (the server side of the +project), I gave up, waiting for an easier to deploy +<application>Kolab</application> 2.0. In any case, the +<application>Kolab</application> stuff was clearly too much for my +needs. Fortunately in the &tde; wiki I've found some piece of +<acronym>IRC</acronym> conversation where they were talking about sharing +data without the <application>Kolab</application> infrastructure... mmm so +interesting!</para> + +<para>For small offices and needs, you can have &kontact; use shared data +without the need of installing the <application>Kolab</application> server +or another groupware backend. It can work with just an +<acronym>IMAP</acronym> server, that can be easily set up.</para> + +<para>My scenario is a server with Debian unstable and &kde; 3.4. I access +&kontact; and other fabulous GNU/Linux apps from windows using Cygwin/X, +while waiting Wine project to be able to run the last Windows programs I +need (and that are not available under GNU/Linux). I want to share contacts, +events, todo, notes with my secretary.</para> + +</sect1> + +<sect1 id="kontact-imap-whatis"> +<title>What is <acronym>IMAP</acronym></title> + +<para>This definition is from the <ulink +url="http://computeruser.com">ComputerUser.com High-Tech Dictionary:</ulink> +<blockquote><para>Internet Message Access Protocol. A protocol that allows a +user to perform certain electronic mail functions on a remote server rather +than on a local computer. Through IMAP the user can create, delete, or +rename mailboxes; get new messages; delete messages; and perform search +functions on mail. A separate protocol is required for sending mail. Also +called Internet Mail Access Protocol.</para></blockquote> </para> + +<para>So it can be considered a data storage. To use it you you need an +<acronym>IMAP</acronym> server, such as <application>Cyrus</application>, +<application>Courier</application> or <application>UW</application>.</para> + +</sect1> + +<sect1 id="kontact-kolab-or-imap"> +<title><application>Kolab</application> or <acronym>IMAP</acronym>?</title> + +<para><application>Kolab</application> brings the ability to share data +between different clients. It makes possible for your secretary to use +<application>Outlook</application> and you use &kontact;, for +instance.</para> + +<para>You will have a configuration interface which does user management, mail +account setup, a central <acronym>LDAP</acronym> config data and addressbook +server, spam and virus filtering, vacation scripts, free busy list handling, +resource handling (rooms, cars), groups, distribution lists, automatic +invitation handling, &etc;</para> + +<para>But that can cause initial setup troubles. For a newbie like me it +means: a long long frustrating nightmare, and too much complexity to manage +once working. So no, thanks, I'll go to simple +<acronym>IMAP</acronym>.</para> + +</sect1> + +<sect1 id="kontact-imap-cyrus"> +<title>How to set up <acronym>IMAP</acronym> server <application>Cyrus</application></title> + +<para>My choice is <application>Cyrus</application>, that is part of the +<application>Kolab</application> set of software, so if l will go for +<application>Kolab</application> in the future, at least I'm acquainted with +it.</para> <para>Let's start the installation and the setup!</para> + +<para>Become <systemitem class="username">root</systemitem>.</para> + +<screen># <userinput><command>apt-get</command> <command>install</command> cyrus21-imapd cyrus21-common cyrus21-admin cyrus21-client sasl-bin sasl2-bin</userinput> +<computeroutput>Installing cyrus21-imapd...</computeroutput><lineannotation>The installer asks something I've not understood about an search address... I just pressed <keycap>Enter</keycap></lineannotation>.</screen> + +<para>The installer also created the user <systemitem +class="username">cyrus</systemitem> that is in the (automatically created) +group <systemitem class="groupname">sasl</systemitem>, that is the +<quote>owner</quote> of all cyrus files. At the end with <command>ps +<option>-A</option></command> you can find the new processes: +<command>cyrmaster</command> and <command>notifyd</command>.</para> + +<para>The real problem in setting up <application>Cyrus</application> is the +authentication, just because it's not trivial and I'm a newbie, with limited +knowledge about what I'm doing.</para> + +<para><application>Cyrus</application> can use different +<acronym>SASL</acronym> (Simple Authentication and Security Layer) +mechanisms, the default being sasldb (it stores usernames and passwords in +the SASL secrets file <filename>sasldb</filename>), but also getpwent, +kerberos4, kerberos5, PAM, rimap, shadow and LDAP are supported.</para> + +<para> Since I don't want to define users/passwords different than the ones +that access my &Linux; box I choose then <quote>shadow</quote> mechanism so +<application>Cyrus</application> will use &Linux; passwords for +authenticate.</para> + +<para>To do so we have to tell sasl to use <command>saslauthd</command> as +password authentication method, and then setup <command>saslauthd</command> +to use <quote>shadow</quote> (or <quote>getpwent</quote>) as the +authentication mechanism.</para> + +<para>OK, let's start!</para> + +<para>As <systemitem class="username">root</systemitem>, change the Linux +password of <systemitem class="username">cyrus</systemitem> user:</para> + +<screen># <userinput><command>passwd <option>cyrus</option></command></userinput></screen> + +<para>Enter the password you like (and you will remember) we will use for +this example <quote>cyrus</quote> as the <application>cyrus</application> +administrator password.</para> + +<screen># <command>vi</command> <filename>/etc/imapd.conf</filename></screen> + +<programlisting>sasl_pwcheck_method: <userinput>saslauthd</userinput> <lineannotation>instead of the default <literal>auxprop</literal></lineannotation></programlisting> + +<para>remove the <literal>#</literal> remark from the line:</para> + +<programlisting>#admins: cyrus</programlisting> + +<para>this way you can administer <application>cyrus</application> logging +in as <systemitem class="username">cyrus</systemitem> user (what a fantasy I +have!)</para> + +<screen># <userinput><command>vi</command> <filename>/etc/default/saslauthd</filename></userinput></screen> + +<para>Uncomment the line:</para> + +<programlisting># START=yes</programlisting> + +<para>(otherwise the <application>saslauthd</application> will not start at +boot time, even if referenced in some <filename +class="directory">/etc/rcx.d</filename>!)</para> + +<para>and instead of <literal>MECHANISMS="pam"</literal> put +<userinput>MECHANISMS="shadow"</userinput> this way at the boot a +<command>saslauthd</command> <option>-a +<parameter>shadow</parameter></option> will be executed.</para> + +<para>Once exited from your editor, restart <application>sasl</application> +and <application>cyrus</application>.</para> + +<para>To test <acronym>IMAP</acronym>:</para> + +<screen> <userinput><command>su</command> <option>cyrus</option></userinput> +$ <userinput><command>imtest</command> <option>-m login -p imap localhost</option></userinput></screen> + +<para>You are prompted for the <systemitem +class="username">cyrus</systemitem> (user) password, so enter it.</para> + +<para>If the user <systemitem class="username">cyrus</systemitem> is +correctly authenticated, the following lines will appear:</para> + +<screen><computeroutput>S: L01 OK User logged in +Authenticated.</computeroutput></screen> +<para>To exit type <userinput>. logout</userinput> (&ie; dot space <quote>logout</quote>)</para> + +<para>Now add a user named <systemitem +class="username">groupware</systemitem> and set a password for it, using +your usual system tools. It should be in an unprivileged group such as +<systemitem class="groupname">nobody</systemitem> and does not require a +login shell or a home directory.</para> + +<para>Now I have to create the user and an <acronym>IMAP</acronym> in +<application>cyrus</application> also:</para> + +<screen># <userinput><command>cyradm</command> <option>--user cyrus localhost</option></userinput> +after entering the password for the admin user <systemitem class="username">cyrus</systemitem>, you get the prompt <prompt>localhost></prompt> +<prompt>localhost></prompt> <userinput><command>cm</command> <option>user.groupware</option></userinput> +<prompt>localhost></prompt> <userinput><command>lm</command></userinput> <lineannotation>lists the mailbox only just created</lineannotation> +<computeroutput>user.groupware (\HasNoChildren))</computeroutput> +<prompt>localhost></prompt> <userinput><command>quit</command></userinput></screen> + +<para>You can type <userinput><command>help</command></userinput> for a list +of available commands.</para> + +<para>You can check what has happened with:</para> + +<screen># <userinput><command>ls</command> <option>-l</option> <filename class="directory">/var/spool/cyrus/mail/g/user/groupware</filename></userinput> +<computeroutput>total 12 +-rw------- 1 cyrus mail 4 Oct 29 20:55 cyrus.cache +-rw------- 1 cyrus mail 155 Oct 29 20:55 cyrus.header +-rw------- 1 cyrus mail 76 Oct 29 20:55 cyrus.index</computeroutput></screen> + +<para>Now you should be able to connect with an <acronym>IMAP</acronym> client +as the <systemitem class="username">groupware</systemitem> user and see the +<literal>INBOX</literal>.</para> +<note><para>In the <acronym>IMAP</acronym> protocol, selecting the mailbox +<literal>INBOX</literal> is a magic word, a sort of <quote>alias</quote> for +the above directory structure. The client sees <literal>INBOX</literal>, and +the <acronym>IMAP</acronym> server maps it in the <filename +class="directory">/var/spool/cyrus/mail/...</filename> folder and file +structure.</para></note> + +</sect1> + +<sect1 id="kontact-imap-clients"> +<title>How to setup &kontact; clients</title> + +<para>I connect to my GNU/Linux office server PC (a sort of "black box" +without monitor and keyboard) from 2 &Windows; 2000 PC with +<application>Cygwin/X</application>, using them as a X-Window server (in the +near future I hope to replace both with 2 mini-itx thin clients using the +LTSP). With this setup every user runs &kontact; on the same machine where +<application>Cyrus</application> is installed and running +(localhost).</para> + +<para>To have &kontact; work with <acronym>IMAP</acronym>, there are these +steps to complete:</para> + +<procedure> + +<step><para>Create an <acronym>IMAP</acronym> account on the +<application>Cyrus</application> for fake <systemitem +class="username">groupware</systemitem> user (already previously +done!)</para></step> + +<step><para>Create/configure an <acronym>IMAP</acronym> account in &kmail; +for login as that user</para></step> <step><para>Use tderesources to make +&kontact; components work with data taken from <acronym>IMAP</acronym> +source</para></step> + +<step><para>Enable groupware functionality and make related subfolders of +that <acronym>IMAP</acronym> <literal>INBOX</literal> (if not +already)</para></step> + +<step><para>Enjoy &kontact; and shared data through +<application>Cyrus</application> IMAP</para></step> + +</procedure> + +<para>So login to &tde; with the first <quote>real user</quote> account you +want to provide groupware functionality to.</para> + +<para>Let's create the IMAP account in &kmail;.</para> + +<para>Run &kontact; and select <guilabel>Mail</guilabel> (the &kmail; +component). From the menu choose +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KMail +</guimenuitem><guilabel>Accounts</guilabel><guilabel>Receiving</guilabel></menuchoice> tab, press the <guibutton>Add...</guibutton> button. You will then be +prompted for the type of your email account, and select +<guilabel>disconnected IMAP</guilabel> (not just +<guilabel>IMAP</guilabel>). Then in the <guilabel>General</guilabel> tab +enter the following data:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Account Name:</guilabel> <userinput>office_gwdata</userinput></term> +<listitem> +<para>A name that will be used for the <quote>local</quote> folder that +points to this <acronym>IMAP</acronym> account.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Login:</guilabel> <userinput>groupware</userinput></term> +<listitem> +<para>The <application>Cyrus</application> user we have chosen as +<quote>owner</quote> of all of the office data</para> +</listitem> +</varlistentry> +<varlistentry><term><guilabel>Password:</guilabel></term> +<listitem> +<para>The password of the <systemitem +class="username">groupware</systemitem> user.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Host:</guilabel> <userinput>localhost</userinput></term> +<listitem> +<para>Remember for our example, the &kontact; client runs on the same +computer as the <acronym>IMAP</acronym> server</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Port:</guilabel> <userinput>143</userinput></term> +<listitem> +<para>The default</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Check <guilabel>store IMAP password</guilabel> +so you will not be asked for it next time you run &kontact;. Check the +<guilabel>Enable interval mail checking</guilabel> and set a value in +minutes.</para> + +<para>Note that we have checked the <guilabel>disconnected IMAP</guilabel> +type account. This has the effect that a copy of the groupware data is +stored <quote>locally</quote> to the client (under the home folder), and it +is synchronized every time the client connects. This seems very inefficient, +since your data is duplicated many times (&ie; if you have 10 users that use +&kontact;, you have 10+1 times the data), but it is the only way to make +things run fast, because at every connection &kontact; has to fetch all data +and have &korganizer; and &kaddressbook; interpret it. If you use +<quote>disconnected IMAP</quote> data is cached locally, and only the +<quote>delta</quote> (&ie; the data that has changed) is sent.</para> + +<para>On the other end, if your users run &korganizer; on the same PC that +runs the <acronym>IMAP</acronym> server, it seems reasonable to use +<acronym>IMAP</acronym> (that is called <quote>online IMAP</quote>) to save +space, since transfer speed should not be an issue. But unfortunately this +does not work because &kontact; does not update automatically the +<guilabel>Calendar</guilabel> folder in <quote>online IMAP</quote>, so you +are not updated when someone adds events (you must manually switch to +&kmail; application and click on the <guilabel>Calendar</guilabel> +folder). In addition, at start up when it does read +<guilabel>Calendar</guilabel> folders, you may see a tremendous flicker and +slow data updates.</para> + +<para>Now we have to tell &kontact; to use <acronym>IMAP</acronym> as the +data source for it's various components. From the &kmenu;, choose +<guimenuitem>Run command</guimenuitem>, run <userinput><command>tdecmshell +tderesources</command></userinput>. In the combo box select +<guilabel>Contacts</guilabel>, then press the <guibutton>Add...</guibutton> +button, and choose <guilabel>Addressbook on IMAP Server via KMail</guilabel>. Then select that new line and +press <guibutton>Use as Standard</guibutton> button. Do the same for +<guilabel>Calendar</guilabel> and <guilabel>Notes</guilabel>.</para> + +<para>Now we have to enable the &kmail; (and as a consequence, the whole +&kontact;) groupware functionality:</para> + +<procedure> +<step> +<para>Choose from the menu +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +KMail</guimenuitem><guilabel>Misc</guilabel><guilabel>Groupware</guilabel></menuchoice></para> +</step> +<step> +<para>Check <guilabel>Enable IMAP resource functionality</guilabel></para> +</step> +<step> +<para>Choose <guilabel>English</guilabel> as <guilabel>Language of the +groupware folders</guilabel> (this is in case you already have the folders +in the <acronym>IMAP</acronym> server created by a different program in a +different language).</para> +</step> +<step> +<para>Now move to <guilabel>Resource folder are in account</guilabel> and +select the the <guilabel>Inbox</guilabel> subfolder of the +<guilabel>office_gwdata</guilabel> folder.</para> +<para>Leave <guilabel>Hide groupware folders</guilabel> unchecked for now, +so we can see that happens. You can return here and check it once everything +is clear.</para> +</step> +<step> +<para>When you press OK you are prompted with: +<computeroutput>&kmail; will now create the required folders for the IMAP +resource as subfolders of Inbox</computeroutput> </para> +<para>If you do not want this, press <guibutton>No</guibutton>, and the +<acronym>IMAP</acronym> resource will be disabled. Press +<guibutton>Yes</guibutton> (this happens only the first time with the first +<quote>real user</quote>). You will immediately see that in the &kmail; +folder tree, under +<menuchoice><guilabel>office_gwdata</guilabel><guilabel>Inbox</guilabel></menuchoice> +these subfolders are created:</para> +<simplelist> +<member>Calendar</member> +<member>Contacts</member> +<member>Notes</member> +<member>Tasks</member> +<member>Journal</member> +</simplelist> +<para>if you now do a:</para> +<screen># <command>ls</command> <option>-l /var/spool/cyrus/mail/g/user/groupware/</option> +<computeroutput>drwx------ 2 cyrus mail 144 Oct 31 16:36 Calendar +drwx------ 2 cyrus mail 144 Oct 31 16:36 Contacts +drwx------ 2 cyrus mail 144 Oct 31 16:36 Journal +drwx------ 2 cyrus mail 144 Oct 31 16:36 Notes +drwx------ 2 cyrus mail 144 Oct 31 16:36 Tasks +-rw------- 1 cyrus mail 4 Oct 31 15:28 cyrus.cache +-rw------- 1 cyrus mail 155 Oct 29 20:55 cyrus.header +-rw------- 1 cyrus mail 76 Oct 31 15:28 cyrus.index</computeroutput></screen> + +<para>As you see, the <guilabel>office_gwdata Inbox</guilabel> is stored not +local to the &kontact; current user home, but in the <acronym>IMAP</acronym> +<systemitem class="username">groupware</systemitem> user's folders.</para> +</step> +</procedure> + +<para>Now &kontact; is ready to work and store data there. In the calendar +application, if &kmail; <acronym>IMAP</acronym> account was of type +<quote>disconnected</quote>, the <guilabel>resource</guilabel> window should +display the item <guilabel>Imap resource</guilabel> with 3 subitems, that +are paths to local home files. Instead, the <guilabel>Contacts</guilabel> +application does not show subitems below the <guilabel>Imap +resource</guilabel>.</para> + +<para>You can now login to &tde; with a different username and set up +his/her &kontact; client in a very similar manner:</para> + +<procedure> +<step> +<para>Open &kontact; and in the <guilabel>Mail</guilabel> component add an +<acronym>IMAP</acronym> account specifying as <guilabel>host</guilabel> the +computer where <application>Cyrus</application> server runs (in my case: +<literal>192.168.1.3</literal>).</para> + +<para>Remember to check the <guilabel>Enable interval mail +checking</guilabel> and set a value in minutes. When you confirm, you are +not prompted for the subfolder creation (since they are found in the +<acronym>IMAP</acronym> server), and you see them in the folder tree.</para> +</step> +<step> +<para>Activate the groupware functionality to be able to save data in the +<acronym>IMAP</acronym> server.</para> +</step> +</procedure> +<para>Beware that in <quote>disconnected <acronym>IMAP</acronym></quote>, +data are transmitted from a client to <acronym>IMAP</acronym> server only +when the clients connects to check for new mail. So if you have your +&kontact; clients with an <guilabel>interval mail checking</guilabel> of, +for instance, 5 minutes, in the worst case you have a 10 minutes delay +between the event being written and it's appearance to the other +users.</para> +</sect1> +<sect1 id="kontact-imap-readonly"> +<title>How to have Read Only Access</title> + +<note><para>Beware that I've been confirmed that Notes +<acronym>IMAP</acronym> implementation in &kontact; prior to version 1.01 is +broken, so this setup will not work for them, so you want to use them, you +need to use the previous setup.</para></note> + +<para>In the previous setup, we have the same <quote>fake</quote> user, named +<systemitem class="username">groupware</systemitem>, that is used by all the +<quote>real</quote> &kontact; users (&ie; <systemitem +class="username">tony</systemitem>, <systemitem +class="username">rohn</systemitem>, <systemitem +class="username">amanda</systemitem>, &etc;) through the +<acronym>IMAP</acronym> account with it's login and password. But this way +every real user has the same read/write permissions of the others, since +everyone connects as the user <systemitem +class="username">groupware</systemitem> to the <acronym>IMAP</acronym> +server.</para> + +<para>To limit access to some users (typically, providing read-only access), +we can use the <acronym>ACL</acronym> (Access Control Lists).</para> + +<para>Select in &kmail; a subfolder of <guilabel>office_gwdata</guilabel> +inbox, for instance <guilabel>Calendar</guilabel>, and right click the +mouse. Select <guilabel>Properties</guilabel><guilabel>Access +Control</guilabel> tab. Here you can enter the users you want give access to +this folder and what they can do.</para> + +<para>Just to experiment trying to exchange events, we give +<quote>All</quote> permission to the user <systemitem +class="username">mary</systemitem></para> + +<para>At <application>cyrus</application> level (in the +<acronym>PC</acronym> that runs <acronym>IMAP</acronym> server cyrus, with +<application>cyrus</application> tools), we first need to add the user +<systemitem class="username">mary</systemitem>, so it's an +<acronym>IMAP</acronym> recognized user, and create an +<acronym>IMAP</acronym> folder for her.</para> + +<para>Then we login to GNU/Linux as <systemitem +class="username">mary</systemitem> and enter &kontact;. As previously shown, +we will setup an <acronym>IMAP</acronym> account in &kmail; with the same +data but the one of the user (instead of the fake user <systemitem +class="username">groupware</systemitem> and it's password, we will use +<systemitem class="username">mary</systemitem> and her password).</para> + +<para>In &kmail; folder tree, this time you will see this structure: +<menuchoice><guimenu>office_gwdata</guimenu><guisubmenu>user</guisubmenu> +<guisubmenu>groupware</guisubmenu><guimenuitem>Calendar and +Tasks</guimenuitem></menuchoice>. Check the mail +(<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>) and you will also have an +<quote>inbox</quote> folder under <quote>office_gwdata</quote>.</para> + +<para>Now enable &kmail; groupware functionality, and in <guilabel>Resource +folders are subfolders of</guilabel> put the +<guimenuitem>inbox</guimenuitem> that is subfolder of +<quote>office_gwdata</quote>.</para> + +<para>Now enable &kmail; groupware functionality, and in <guilabel>Resource +folders are subfolders of</guilabel> put the +<guimenuitem>inbox</guimenuitem> that is subfolder of +<guisubmenu>office_gwdata</guisubmenu>.</para> + +<para>Now you have two branches of folder under +<quote>office_gwdata</quote>:</para> + +<orderedlist> +<listitem> +<para><quote>inbox</quote> with Calendar, Contacts, Notes, Tasks and +Journal, that are saved on <systemitem class="username">mary</systemitem> +<acronym>IMAP</acronym> folders on the <acronym>IMAP</acronym> server</para> +</listitem> +<listitem> +<para><quote>user</quote>, with the subfolder <quote>groupware</quote> and +the subfolders to which <systemitem class="username">mary</systemitem> has +access to (in this example, Calendar and Tasks)</para> +</listitem> +</orderedlist> +<para>&RMB; click on the <quote>user</quote> <quote>Calendar</quote> and +check if it's of type Calendar (if not, set it to be), and also if +<quote>user</quote><quote>Tasks</quote> is of type Tasks.</para> +<para>Now in Calendar you have two available <acronym>IMAP</acronym> +resources to write against, so if you create a new event, you are prompted +which one use (or if you left the local resources available, you have +3!).</para> +<para>You have go to the lower left small window in Calendar, the one that +shows available resources, and uncheck the ones that don't point to +<guilabel>.groupware.directory</guilabel> path (see the tail part of each +resource path).</para> + +</sect1> + +<sect1 id="kontact-imap-credits"> +<title>Credits</title> + +<para>I'm a newbie, and for this howto I've only provided my time and my +will. For the knowledge I have really to thank some guys in freenode +channels for their competence, patience and helpfulness.</para> + +<itemizedlist> +<title>Special thanks to:</title> +<listitem> +<para>For the <application>Cyrus</application> <acronym>IMAP</acronym> part +in #cyrus channel:</para> +<itemizedlist> +<listitem> +<para>[protagonist] Andy Morgan <email>[email protected]</email></para> +</listitem> +<listitem> +<para>[plixed] Okke Timm <email>[email protected]</email></para> +</listitem> +</itemizedlist> +</listitem> +<listitem> +<para>For the &kontact; part in #kontact channel:</para> +<itemizedlist> +<listitem> +<para>[till] Till Adam <email>[email protected]</email></para> +</listitem> +<listitem> +<para>[dfaure] David Faure <email>[email protected]</email></para> +</listitem> +<listitem> +<para>[mdouhan] Matt Douhan <email>[email protected]</email></para> +</listitem> +</itemizedlist> +</listitem> +</itemizedlist> + +<para>Thank a lot guys!</para> + +<para>Ah, and there is also me, [markit] Marco Menardi +<email>[email protected]</email></para> + +</sect1> + +<sect1 id="kontact-imap-further-reading"> +<title>Further Reading</title> + +<itemizedlist> +<title>Reference</title> +<listitem><para>KDE: <ulink url="http://www.kde.org">http://www.kde.org</ulink></para></listitem> +<listitem><para>&kontact; website: <ulink url="http://www.kontact.org">http://www.kontact.org</ulink></para></listitem> +<listitem><para>Kroupware project: <ulink url="http://www.kroupware.org">http://www.kroupware.org</ulink></para></listitem> +<listitem><para>&kde; Community Wiki: <ulink url="http://wiki.kde.org">http://wiki.kde.org</ulink></para></listitem> +<listitem><para>Wine project: <ulink url="http://www.winehq.org">http://www.winehq.org</ulink></para></listitem> +<listitem><para>Cygwin/X project <ulink url="http://x.cygwin.com">http://x.cygwin.com</ulink></para></listitem> +<listitem><para>LTSP project: <ulink url="http://www.ltsp.org">http://www.ltsp.org</ulink></para></listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/adminguide/index.docbook b/doc/khelpcenter/adminguide/index.docbook new file mode 100644 index 000000000..dd24a1cdc --- /dev/null +++ b/doc/khelpcenter/adminguide/index.docbook @@ -0,0 +1,2733 @@ +<?xml version="1.0" ?> + <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % imageobjectco.module "INCLUDE"> + <!ENTITY groupware-with-kontact SYSTEM "groupware-kontact.docbook"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>The &tde; (Trinity Desktop Environment) Administrator Guide</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2004-2005</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para>A general administrator guide to the Trinity Desktop Environment. +</para> + +<para>Please report problems with this document to +<email>[email protected]</email>. +</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>administration</keyword> +<keyword>desktop</keyword> +<keyword>handbook</keyword> +<keyword>tutorial</keyword> +</keywordset> + +</bookinfo> + +<chapter id="tde-for-admins-introduction"> +<title>&tde; for Administrators</title> + +<sect1 id="tde-for-admins-overview"> +<title>Overview</title> + +<para>This handbook is a reference guide to +some &tde; features that are useful to administrators configuring +multi-user systems. This guide also has information useful +to &tde; users with single-user systems: where configuration files are +stored, what environment variables affect &tde;, and so on. The KIOSK +framework is the &tde; system that allows administrators to limit +what users can do in &tde;. That framework is useful in many +situations, but especially for running single-function kiosks with, +for example, only a web browser, hence the name.</para> + +</sect1> + +<sect1 id="directory-layout"> +<title>Directory Layout</title> + +<para>&tde; defines a filesystem hierarchy which is used by the &tde; +environment itself as well as all &tde; applications. In general &tde; +stores all its files in a directory tree with a fixed structure. +</para> + +<para>By default &tde; uses two directory trees:</para> + +<itemizedlist> +<listitem><para>One at the system level (for example <filename +class="directory">/opt/trinity</filename>).</para></listitem> +<listitem><para>One at the user level in the user's home directory +(usually <filename class="directory"> +~/.trinity</filename>)</para></listitem> +</itemizedlist> + +<para>As a system administrator you can create additional trees. Such +additional trees can be used for <link +linkend="user-profiles">profiles</link></para> + +<informalexample><para>For example:</para> + +<itemizedlist> +<listitem><para><filename +class="directory">$<envar>HOME</envar>/.trinity</filename></para></listitem> +<listitem><para><filename +class="directory">/opt/trinity</filename>. (This location is a +typical default. Some distributions might use +<filename class="directory">/usr</filename> or <filename +class="directory">/usr/trinity</filename>)</para></listitem> +<listitem><para><filename +class="directory">/etc/trinity</filename>.</para></listitem> +</itemizedlist> + +<para>If you have the KIOSK Admin tool installed you can +check which directory trees are used with the following command: +<userinput><command>kiosktool-tdedirs</command> +<option>--check</option></userinput></para> +</informalexample> + +<para>&tde; and &tde; applications look up files by scanning all the +&tde; directory trees. The directory trees are checked in order of +precedence. When a file is present in multiple directory trees, the +file from the last tree takes precedence. Normally, the tree +located in the user's home directory has the highest precedence. This +is also the directory tree to which changes are written.</para> + +<informalexample> +<para>For information about the <literal>text/plain</literal> &MIME; type +the following files are searched:</para> + +<itemizedlist> +<listitem><para><filename +class="directory">$<envar>HOME</envar>/.trinity/share/mimelnk/text/plain.desktop</filename></para></listitem> +<listitem><para><filename +class="directory">/opt/trinity/share/mimelnk/text/plain.desktop</filename></para></listitem> +<listitem><para><filename +class="directory">/etc/trinity/share/mimelnk/text/plain.desktop</filename></para></listitem> +</itemizedlist> + +<para>If a user makes a change, the change is written to <filename +class="directory">$<envar>HOME</envar>/.trinity/share/mimelnk/text/plain.desktop</filename></para> +</informalexample> + +<para>For configuration files the story is slightly different. If +there are multiple configuration files found in the directory trees +with the same name, their content is combined. The precedence order of +the directory trees plays a role here. When two files define the same +configuration key, the file with the highest precedence determines +which value is used for the key.</para> + +<informalexample><para> +For example, if the following two files exist, with these contents:</para> +<variablelist> +<varlistentry><term><filename>$<envar>HOME</envar>/.trinity/share/config/foobar</filename></term> +<listitem><programlisting> +Color=red +Shape=circle +</programlisting> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>/etc/trinity/share/config/foobar</filename></term> +<listitem><programlisting> +Color=blue +Position=10,10 +</programlisting> +</listitem> +</varlistentry> +</variablelist> + +<para>The files will be merged to result in:</para> + +<programlisting> +Color=red +Shape=circle +Position=10,10 +</programlisting> + +</informalexample> +</sect1> + +<sect1 id="specifying-directories"> +<title>Specifying Directories</title> + +<para> + +<segmentedlist> +<segtitle>Environment Variable</segtitle> +<segtitle>Example Setting(s)</segtitle> +<segtitle>Comment</segtitle> + +<seglistitem> +<seg><envar>TDEHOME</envar></seg> +<seg><filename class="directory">~/.trinity</filename></seg> +<seg></seg> +</seglistitem> + +<seglistitem> +<seg><envar>TDEROOTHOME</envar></seg> +<seg><filename class="directory">/root/.trinity</filename></seg> +<seg>Different variable to prevent +root writing to $TDEHOME of the user after running +<command>su</command>.</seg> +</seglistitem> + +<seglistitem> +<seg><envar>TDEDIR</envar></seg> +<seg><filename class="directory">/opt/trinity</filename>, <filename +class="directory">/usr</filename>, <filename +class="directory">/usr/trinity</filename></seg> +<seg>Vendor dependent. If not set, falls back to +compiled-in default.</seg> +</seglistitem> + +<seglistitem> +<seg><envar>TDEDIRS</envar></seg> +<seg><filename class="directory">/opt/trinity</filename>, <filename +class="directory">/usr</filename>, <filename +class="directory">/usr/trinity</filename></seg> +<seg>Can list multiple locations separated by a +colon. If not set, falls back to $<envar>TDEDIR</envar></seg> +</seglistitem> + +</segmentedlist> +</para> +<para>Don't <emphasis>need</emphasis> to be set, defaults work just fine.</para> + +<informalexample> +<para>A staff member at a university could have the following +settings:</para> +<programlisting> +TDEHOME='~/.trinity' +TDEROOTHOME='/root/.trinity' +TDEDIRS='/opt/tde_staff:/opt/trinity' +</programlisting> + +</informalexample> + +</sect1> + +<sect1 id="user-profiles"> +<title>User Profiles</title> + +<para>In the previous example <filename +class="directory">/opt/tde_staff</filename> contained additional settings +and applications for staff members. <quote>User Profiles</quote> allow you +to add this directory only for certain users and not for others. Add the +following to <filename>/etc/tderc</filename>:</para> + +<programlisting> +[Directories-staff] +prefixes=/opt/tde_staff +</programlisting> + +<para>This creates a profile named <quote>staff</quote> that adds the +<filename class="directory">/opt/tde_staff</filename> directory +tree. Now that we have a named profile it +can be assigned to users.</para> + +<para>To map profiles to users a mapping file needs to be specified in +<filename>/etc/tderc</filename>:</para> + +<programlisting> +[Directories] +userProfileMapFile=/etc/tde-user-profile +</programlisting> + +<para>It is now possible to assign a profile based on either the user name +or based on the &UNIX; group the user is part of.</para> + +<para>To assign the staff profile to all users that are a member of the +&UNIX; group staff_members add the following to +<filename>/etc/tde-user-profile</filename>:</para> + +<programlisting> +[General] +groups=staff_members +[Groups] +staff_members=staff +</programlisting> + +<para>It is also possible to assign a profile to a single user:</para> + +<programlisting> +[Users] +bastian=staff +</programlisting> + +</sect1> + +<sect1 id="directory-layout-revisited"> +<title>Directory Layout Revisited</title> + +<para>Each directory tree used by &tde; has a fixed directory structure. +Directories that are not relevant for a certain tree, or simply not used can +be left out though. For example, directories used for temporary files are +usually only found under <filename +class="directory">$<envar>TDEHOME</envar></filename> but not in any other +directory tree.</para> + +</sect1> + +<sect1 id="architecture-specific-directories"> +<title>Architecture-specific Directories</title> + +<para>Architecture (OS and CPU type) specific directories:</para> + +<variablelist> +<varlistentry> +<term><filename class="directory">bin</filename></term> +<listitem><para>Used for &tde; executables.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">lib</filename></term> +<listitem><para>Used for &tde; libraries.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">lib/trinity</filename></term> +<listitem><para>This directory contains components, plugins, and other +runtime loadable objects for use by &tde; applications.</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="shared-directories"> +<title>Shared Directories</title> + +<para>Shared: Not architecture specific, can be shared between different +archs.</para> + +<variablelist> +<varlistentry> +<term><filename class="directory">share/applnk</filename></term> +<listitem><para><literal role="extension">.desktop</literal> files for +&tde;-menu (legacy)</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/applications</filename></term> +<listitem><para><literal role="extension">.desktop</literal> files for +&tde;-menu</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/apps</filename></term> +<listitem><para>Contains application-specific data files. Each +application has a sub-directory here for storing additional data +files.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/config</filename></term> +<listitem><para>Configuration files. Configuration files are normally +named after the application they belong to plus the letters +<quote>rc</quote>. A special case is <filename>kdeglobals</filename>. +This file is read by all &tde; applications.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename +class="directory">share/config/session</filename></term> +<listitem><para>This directory is used by session management and is +normally only available under <filename +class="directory">$<envar>TDEHOME</envar></filename>. At the end of a +session &tde; applications store their state here. The file names +consist of the name of the application followed by a number. The +session manager <command>ksmserver</command> stores references to +these numbers when saving a session in +<filename>ksmserverrc</filename>.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/doc/tde/HTML</filename></term> +<listitem><para>This directory contains documentation for &tde; +applications. Documentation is categorized by language and the +application it belongs to. Normally at least two files can be found in +a directory: <filename>index.docbook</filename>, which contains the +documentation in the unformatted DocBook format, and +<filename>index.cache.bz2</filename>, which contains the same +documentation formatted as <command>bzip2</command>-compressed +&HTML;. The &HTML; version is used by &khelpcenter;. If the &HTML; +version is missing, &khelpcenter; will regenerate it from the DocBook +version but this is a time-consuming process.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/icons</filename></term> +<listitem><para>Under this directory icons are stored. Icons are +categorized by theme, dimension and usage category.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/mimelnk</filename></term> +<listitem><para>In this directory,<literal +role="extension">.desktop</literal> files that describe &MIME; types +are stored. &tde; uses &MIME; types to identify the type of a +file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/services</filename></term> +<listitem><para>This directory contains <literal +role="extension">.desktop</literal> files that describe services. Services +are like applications but are usually launched by other applications instead +of the user. Services do not appear in the &tde; menu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/servicetypes</filename></term> +<listitem><para>This directory contains <literal +role="extension">.desktop</literal> files that describe +servicetypes. A servicetype usually represents a certain programming +interface. Applications and Services include in their <literal +role="extension">>.desktop</literal> files the servicetypes that they +provide.</para> </listitem></varlistentry> + +<varlistentry> +<term><filename class="directory">share/sounds</filename></term> +<listitem><para>This directory contains sound files.</para></listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/templates</filename></term> +<listitem><para>This directory contains templates for creating files +of various types. A template consists of a <literal +role="extension">.desktop</literal> file that describes the file and +that includes a reference to a file in the <filename +class="directory">.source</filename> sub-directory. The templates in +this directory appear in the <guimenu>Create New</guimenu> menu +available on the desktop and in the file browser. When a user selects +a template from the menu its source file is copied.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename class="directory">share/wallpapers</filename></term> +<listitem><para>This directory contains images that can be used as +background picture</para></listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="host-specific-directories"> +<title>Host-specific Directories</title> + +<para>There are three host-specific directories that are usually +symlinked to other locations. If the directories do not already exist, +the following symlinks and directories will be created using the +<command>lnusertemp</command> utility:</para> + +<variablelist> + +<varlistentry> +<term><filename>$<envar>TDEHOME</envar>/socket-$<envar>HOSTNAME</envar></filename></term> +<listitem><para>Usually <filename +class="directory">/tmp/tdesocket-$<envar>USER</envar>/</filename>, this +is used for various &UNIX; sockets.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>$<envar>TDEHOME</envar>/tmp-$<envar>HOSTNAME</envar></filename></term> +<listitem><para>Usually <filename +class="directory">/tmp/tde-$<envar>USER</envar>/</filename>, this is used for temporary files.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>$<envar>TDEHOME</envar>/cache-$<envar>HOSTNAME</envar></filename></term> +<listitem><para>Usually <filename +class="directory">/var/tmp/tdecache-$<envar>USER</envar>/</filename>, +this is used for cached files.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Since both <filename class="directory">/tmp</filename> and +<filename class="directory">/var/tmp</filename> are world writable, +there is a possibility that one of the above directories already +exists but is owned by another user. In that case the +<command>lnusertemp</command> utility will create a new directory with +an alternative name and link to that instead.</para> + +</sect1> + +<sect1 id="configuration-files"> +<title>Configuration Files</title> <para>&tde; uses a simple +text-based file format for all its configuration files. It consists of +key-value pairs that are placed in groups. All &tde; configuration +files use <acronym>UTF</acronym>-8 encoding for text outside the +<acronym>ASCII</acronym> range.</para> + +<para>The start of a group is indicated by a group name that is placed +in square brackets. All the key-value entries that follow belong to +the group. The group ends when either another group starts or when the +end of the file is reached. Entries at the top of the +file that are not preceded by a group name belong to the default +group.</para> + +<informalexample><para>The following example shows a configuration +file that consists of two groups. The first group contains the keys +<varname>LargeCursor</varname> and <varname>SingleClick</varname>, the +second group contains the keys <varname>Show hidden files</varname> +and <varname>Sort by</varname>:</para> + +<programlisting> +[TDE] +LargeCursor=false +SingleClick=true +</programlisting> + +<programlisting> +[KFileDialog Settings] +Show hidden files=false +Sort by=Name +</programlisting> +</informalexample> + +<para>Entries in a group consist of a key and value separated by an equals +sign. The key can contain spaces and may be followed by options placed in +square brackets. The part after the equals sign is the value of the +entry. Any white space surrounding the equals sign is ignored, as is any +trailing white space. Put more concisely, the format is:</para> + +<programlisting> +<replaceable>entry</replaceable>=<replaceable>value</replaceable> +</programlisting> + +<para>If a value is supposed to include a space at the begin or end +then this can be achieved by using a backslash followed by an +<quote>s</quote>.</para> + +<para>There are several other backslash codes; here is a complete +list: +<itemizedlist> +<listitem><para><token>\s</token> can be used as space</para> +</listitem> +<listitem><para><token>\t</token> can be used to include a tab</para> +</listitem> +<listitem><para><token>\r</token> for a carriage return character</para> +</listitem> +<listitem><para><token>\n</token> for a linefeed character (new line)</para> +</listitem> +<listitem><para><token>\\</token> to include the backslash itself</para> +</listitem> +</itemizedlist></para> + +<informalexample><para>In the following example the value of the +<varname>Caption</varname> entry starts with two spaces while the +<varname>Description</varname> entry contains three lines of +text. Linefeeds in backslash notation are used to separate the +different lines.</para> + +<programlisting> +[Preview Image] +Caption=\s My Caption +Description=This is\na very long\ndescription. +</programlisting> +</informalexample> + +<para>Empty lines in configuration files are ignored, as are lines that +start with a hash mark (<quote>#</quote>). The hash mark can be used to add +comments to configuration files. It should be noted that when a &tde; +application updates a configuration file the comments are +<emphasis>not</emphasis> preserved.</para> + +<para>There can be multiple configuration files with the same name in the +<filename class="directory">share/config</filename> sub-directory of the +various &tde; directory trees. In this case the information of all these +configuration files is combined on a key-by-key basis. If the same key +within a certain group is defined in more than one place, the key value read +from the directory tree with the highest precedence will be used. +Configuration files under <filename +class="directory">$<envar>TDEHOME</envar></filename> always have the highest +precedence. If a key in a certain group is defined multiple times in a +single file, the value of the last entry is used.</para> + +<informalexample> +<para>If <filename>$<envar>HOME</envar>/.trinity/share/config/foobar</filename> +contains: +<programlisting> +[MyGroup] +Color=red +Shape=circle +</programlisting> +and <filename>/etc/trinity/share/config/foobar</filename> contains +<programlisting> +[MyGroup] +Color=blue +Position=10,10 +</programlisting> +the result will be: +<programlisting> +[MyGroup] +Color=red +Shape=circle +Position=10,10 +</programlisting> +</para> +</informalexample> + +<informalexample> +<para>If + <filename>$<envar>HOME</envar>/.trinity/share/config/foobar</filename> + contains +<programlisting> +[MyGroup] +Color=red +Shape=circle +[MyGroup] +Color=green +</programlisting> +and <filename>/opt/tde_staff/share/config/foobar</filename> contains +<programlisting> +[MyGroup] +Color=purple +Position=20,20 +</programlisting> +and <filename>/etc/trinity/share/config/foobar</filename> contains +<programlisting> +[MyGroup] +Color=blue +Position=10,10 +</programlisting> +the result will be: +<programlisting> +[MyGroup] +Color=green +Shape=circle +Position=20,20 +</programlisting> +</para> +</informalexample> + +<para>To prevent users being able to override default settings, +settings can be marked <emphasis>immutable</emphasis>. Settings can be made immutable +individually, per group or per file. An individual entry can be locked +down by adding <userinput>[$i]</userinput> behind the key, ⪚: +<programlisting> +Color[$i]=blue +</programlisting> +</para> +<para>A group of entries can be locked down by placing +<userinput>[$i]</userinput> behind the group name, ⪚: +<programlisting> +[MyGroup][$i] +</programlisting> +</para> +<para>To lock down the entire file, start the file with +<userinput>[$i]</userinput> on a single line, &ie;: +<programlisting> +[$i] +</programlisting> +</para> + +<informalexample> +<para>If + <filename>$<envar>HOME</envar>/.trinity/share/config/foobar</filename> + contains: +<programlisting> +[MyGroup] +Color=red +Shape=circle +</programlisting> +and <filename>/etc/trinity/share/config/foobar</filename> contains: +<programlisting> +[MyGroup][$i] +Color=blue +Position=10,10 +</programlisting> +the result will be: +<programlisting> +[MyGroup] +Color=blue +Position=10,10 +</programlisting> +</para> +</informalexample> + +<informalexample><para>If + <filename>$<envar>HOME</envar>/.trinity/share/config/foobar</filename> + contains: +<programlisting> +[MyGroup] +Color=red +Shape=circle +</programlisting> +and <filename>/opt/tde_staff/share/config/foobar</filename> contains +<programlisting> +[MyGroup] +Color=purple +Shape=rectangle +</programlisting> +and <filename>/etc/trinity/share/config/foobar</filename> contains +<programlisting> +[MyGroup][$i] +Color=blue +Position=10,10 +</programlisting> +the result will be +<programlisting> +[MyGroup] +Color=purple +Shape=rectangle +Position=10,10 +</programlisting> +</para> +</informalexample> + + +<para>So-called <quote>Shell Expansion</quote> can be used to provide more +dynamic default values. With shell expansion the value of a configuration +key can be constructed from the value of an environment variable or from the +output of a shell command. To enable shell expansion for a configuration +entry, the key must be followed by <token>[$e]</token>. Normally the +expanded form is written into the user's configuration file after first use. +To prevent that, it is recommend to lock the configuration entry down by +using <token>[$ie]</token>. The user can't change it then of course.</para> + +<informalexample> +<para>In the following example the value for the <varname>Host</varname> +entry is determined by the output of the <command>hostname</command> +program. This setting is also locked down to ensure that the value is always +determined dynamically.</para> + +<para>The value for the <varname>Email</varname> entry is determined by +filling in the values of the $<envar>USER</envar> and $<envar>HOST</envar> +environment variables. When <systemitem class="username">joe</systemitem> is +logged in on <systemitem class="systemname">joes_host</systemitem> this will +result in a value equal to <literal>joe@joes_host</literal>. The setting is +not locked down.</para> + +<programlisting> +[Mail Settings] +Host[$ie]=$(hostname) +Email[$e]=${USER}@${HOST} +</programlisting> +</informalexample> + +<para>Most configuration entries can be indexed with a language code. In +this case, the language that the user has selected for use on the desktop is +used to look up the key value. If the default language (American English) +has been selected or if there is no index that corresponds to the selected +language, the key entry without index is used.</para> + +<informalexample> +<para>In the following example the value of the <varname>Caption</varname> +entry depends on the language. If the user has selected French as language +(language code <literal>fr</literal>) the value of the entry will be +<quote>Ma Légende</quote>. In all other cases the value <quote>My +Caption</quote> will be used.</para> + +<programlisting> +[Preview Image] +Caption=My Caption +Caption[fr]=Ma Légende +</programlisting> +</informalexample> + +<informalexample> +<para>In this example the value of the <varname>Caption</varname> entry +depends on the language. If the user has selected French as language +(language code <literal>fr</literal>) the value of the entry will be +<quote>Ma Légende.</quote> In all other cases the value <quote>My +Caption</quote> will be used.</para> + +<programlisting> +[Preview Image] +Caption=My Caption +Caption[fr]=Ma Légende +</programlisting> +</informalexample> + +<para>In general the entries that can appear in a configuration file are not +documented. In <filename class="directory">$<envar>TDEDIR</envar>/share/config.kcfg</filename>, files +can be found that provide a formal description of the possible entries in a +configuration file. These are used by the new &tde; Configuration Editor +when available.</para> + +<informalexample> +<para>Here is an example &XML; configuration file: +<programlisting> +<markup> +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE kcfg SYSTEM "http://www.kde.org/standards/kcfg/1.0/kcfg.dtd"> +<kcfg> + <kcfgfile name="korganizerrc"/> + <group name="General"> + <entry type="Bool" key="Auto Save"> + <label>Enable automatic saving of calendar</label> + <default>true</default> + </entry> + <entry type="Int" key="Auto Save Interval"> + <default>10</default> + </entry> + </group> +</kcfg> +</markup> +</programlisting> +</para> +<para>It has the same effect as: +<programlisting> +[General] +Auto Save=false +Auto Save Interval=25 +</programlisting> +</para> +</informalexample> + +</sect1> + +<sect1 id="tde-startup-sequence"> +<title>&tde; Startup Sequence</title> + +<sect2 id="tdm"> +<title>&tdm;</title> + +<para>&tdm; always runs as <systemitem class="username">root</systemitem>. &tdm; uses +<filename>$<envar>TDEDIR</envar>/share/config/tdmrc</filename> and +<filename>/etc/X11/xdm/Xservers</filename>. The latter contains entries +like:</para> + +<programlisting> +:0 local /usr/X11R6/bin/X :0 vt07 +</programlisting> + +<para>Relevant startup files are also: </para> +<simplelist> +<member> +[X-*-Core] section in <filename>tdmrc</filename> +</member> +<member> +Setup - <filename>/etc/X11/xdm/Xsetup</filename> +</member> +<member> +User enters username & password +</member> +<member> +Startup - <filename>/etc/X11/xdm/Xstartup</filename> - prepare as root +</member> +<member> +Session - <filename>/etc/X11/xdm/Xsession</filename> - starts session as user +</member> +<member> += For a TDE session: <command>tde</command> or <command>starttde</command> +</member> +<member> += If present <filename>~/.xsession</filename> or <filename>~/.xinitrc</filename> +</member> +<member> +Reset - <filename>/etc/X11/xdm/Xreset</filename> - after session finished +</member> +</simplelist> + +</sect2> + +<sect2 id="starttde"> +<title>The &tde; Startup Script: <command>starttde</command></title> + +<para>The &tde; startup sequence starts with the +<filename>starttde</filename> script. In most cases this script gets called +from the display manager (&tdm;) once the user has been authenticated. Their +are two important lines in the <filename>starttde</filename> +script:</para> + +<programlisting> +LD_BIND_NOW=true $TDEDIR/bin/start_tdeinit_wrapper --new-startup +kcminit_startup +$TDEDIR/bin/tdeinit_phase1 +</programlisting> + +<para>The first line starts the <command>tdeinit</command> master process. +The <command>tdeinit</command> master process is used to start all other +&tde; processes. It shows up in the output of <command>ps +<option>aux</option></command> as <computeroutput>tdeinit: +Running...</computeroutput>. The arguments after <command>tdeinit</command> +are the names of additional processes to be started. The <token>+</token> +indicates that <command>tdeinit</command> needs to wait till the process has +finished. <command>tdeinit</command> also starts +<command>dcopserver</command>, <command>tdelauncher</command> and +<command>kded</command>.</para> + +<para>The second of the two lines asks <command>tdeinit</command> to start +the <command>ksmserver</command> session manager process. The session +manager determines the lifetime of the session. When this process exits, the +user is logged out.</para> + +</sect2> +</sect1> + +<sect1 id="background-processes"> +<title>Background Processes</title> + +<para>All &tde; background services are user-specific: unlike system daemons +they are not shared between users. As well as being unique per user they are +also unique per X-server display. The processes are:</para> + +<variablelist> +<varlistentry> +<term><command>dcopserver</command></term> +<listitem><para>Desktop communication</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kded</command></term> +<listitem><para>Generic service daemon.</para> +<para>Triggers <link linkend="tdesycoca">Sycoca</link> database updates when +needed</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kcminit</command></term> +<listitem><para>Initialization service</para> +<para>See <xref linkend="kcminit"/> for more information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>tdelauncher</command></term> +<listitem><para>Program launch (this is <emphasis>not</emphasis> the +<keycombo action="simul">&Alt;<keycap>F2</keycap> +</keycombo>dialog!)</para> +<para>See <xref linkend="tdelauncher"/> for more information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>knotify</command></term> +<listitem><para>User notifications.</para> +<para>See <xref linkend="knotify"/> for more information.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>ksmserver</command></term> +<listitem><para>Session management</para> +<para>See <xref linkend="ksmserver"/> for more information.</para> +</listitem> +</varlistentry> + +</variablelist> + +<sect2 id="tdeinit"> +<title><command>tdeinit</command></title> +<para><command>tdeinit</command> is used to start all other &tde; +programs. <command>tdeinit</command> can start normal binary program files +as well as <command>tdeinit</command> loadable modules. Loadable modules +work just like binary program files but can be started more efficiently. +Loadable modules live in <filename +class="directory">$<envar>TDEDIR</envar>/lib/trinity</filename></para> + +<para>The drawback is that programs started this way appear as +<computeroutput><command>tdeinit</command></computeroutput> in the output of +<command>top</command> and <command>ps</command>. Use <command>top +<option>-c</option></command> or <command>ps <option>aux</option></command> +to see the actual program name:</para> + +<screen> +<prompt>%</prompt><userinput><command>ps <option>aux</option></command></userinput> +<computeroutput> +waba 23184 0.2 2.1 23428 11124 ? S 21:41 0:00 tdeinit: Running... +waba 23187 0.1 2.1 23200 11124 ? S 21:41 0:00 tdeinit: dcopserver --nosid +waba 23189 0.2 2.4 25136 12496 ? S 21:41 0:00 tdeinit: tdelauncher +waba 23192 0.7 2.8 25596 14772 ? S 21:41 0:00 tdeinit: kded +waba 23203 0.8 3.4 31516 17892 ? S 21:41 0:00 tdeinit: +knotify +</computeroutput> +</screen> + +<para><computeroutput>tdeinit: Running...</computeroutput> indicates the +master <command>tdeinit</command> process. The other processes listed are +programs started as loadable modules.</para> + +<para>When <command>tdeinit</command> starts for the first time it will +launch <command>dcopserver</command>, <command>tdelauncher</command>, and +<command>kded</command>, as well as any additional programs specified on its +command line in the <command>starttde</command> script, normally +<command>kcminit</command> and <command>knotify</command>.</para> + +</sect2> + +<sect2 id="dcopserver"> +<title><command>dcopserver</command></title> + +<para><command>dcopserver</command> is a daemon which provides inter-process +communication (&DCOP;) facilities to all &tde; applications. The &DCOP; +facilities are accessible from the command shell via the +<command>dcop</command> command line tool. &DCOP; is essential for all &tde; +applications.</para> + +<para>Some related files:</para> + +<variablelist> +<varlistentry> +<term><filename>$<envar>HOME</envar>/.DCOPserver_$<envar>HOSTNAME</envar>_$<envar>DISPLAY</envar></filename></term> +<listitem><para>⪚ <filename>.DCOPserver_linux__0</filename>. Controlled by $<envar>DCOPAUTHORITY</envar></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>/tmp/.ICE-unix/dcop<replaceable>pid</replaceable>-<replaceable>number</replaceable></filename></term> +<listitem><para>⪚ <filename>dcop7634-1069677856</filename>. This is +the file that the <filename>DCOPserver</filename> file above points to.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>$<envar>HOME</envar>/.ICEauthority</filename></term> +<listitem><para>Authorization information controlled by +$<envar>ICEAUTHORITY</envar></para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="kcminit"> +<title>kcminit</title> + +<para><command>kcminit</command> executes initialization services during +startup. Initialization services are specified in the .desktop files of +applications or services via the <varname>X-TDE-Init</varname> line:</para> + +<programlisting> +[Desktop Entry] +Encoding=UTF-8 +Exec=tdecmshell energy +Icon=energy_star +Type=Application +X-TDE-Library=energy +X-TDE-Init=energy +</programlisting> + +<para>Initialization services are typically used for initializing +hardware based on user-specified settings.</para> + +<para><userinput><command>kcminit +<option>--list</option></command></userinput> can be used to show all +initialization services and <userinput><command>kcminit +<replaceable>service</replaceable></command></userinput> can be used to +execute a single service explicitly. This can be useful when investigating +startup problems.</para> + +</sect2> + +<sect2 id="tdelauncher"> +<title><command>tdelauncher</command></title> + +<para><command>tdelauncher</command> is a daemon which is responsible for +service activation within &tde;. It operates in close connection with the +<command>tdeinit</command> master process to start new processes. &tde; +applications communicate with <command>tdelauncher</command> over &DCOP; in +order to start new applications or services.</para> + +<para>Best known from the error message: <computeroutput><errortext> +TDELauncher could not be reached via DCOP </errortext></computeroutput> which +either indicates a serious problem with the <command>dcopserver</command> or +that <command>tdelauncher</command> crashed.</para> + +<para><command>tdelauncher</command> can be restarted by restarting +<command>tdeinit</command> from a console window. Make sure that +$<envar>HOME</envar>, $<envar>DISPLAY</envar> and the various +$<envar>TDEDIR(S)</envar> are set correctly when doing so!</para> + +</sect2> + +<sect2 id="knotify"> +<title><command>knotify</command></title> + +<para>The primary task of <command>knotify</command> is to relay sound +notifications to the sound server, it also provides alternative notification +methods.</para> + +</sect2> + + +</sect1> + +<sect1 id="ksmserver"> +<title>KSMServer</title> + +<para><command>ksmserver</command> is &tde;'s session manager. On startup +the session manager launches auto-start applications and restores +applications from the previous session. The applications to auto-start are +indicated by <literal role="extension">.desktop</literal> files in the +<filename +class="directory">$<envar>TDEDIR</envar>/share/autostart</filename> +directory. Whether or not to auto-start an application can be made +conditional upon some configuration entry determined by the +<varname>X-TDE-autostart-condition</varname> entry in the <literal +role="extension">.desktop</literal> file.</para> + +<informalexample> +<para>The <filename>ktip.desktop</filename> file for example +contains:</para> + +<programlisting> +X-TDE-autostart-condition=ktiprc:TipOfDay:RunOnStart:true +</programlisting> + +<para>This means that the <filename>ktiprc</filename> configuration +file is checked for a <varname>RunOnStart</varname> entry in the +<varname>[TipOfDay]</varname> section. If no such entry is found, +<literal>true</literal> is assumed, which means that +<application>ktip</application> is one of the applications that is +auto-started by default.</para> +</informalexample> + +<para>Some of the applications auto-started by <command>ksmserver</command> +are:</para> + +<variablelist> + +<varlistentry> +<term><command>kdesktop</command></term> +<listitem><para>The &tde; desktop</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>&kicker;</command></term> +<listitem><para>The &tde; panel</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>ktip</command></term> +<listitem><para>A tip of the day program</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kwrited</command></term> +<listitem><para>A utility to receive system messages sent to the user</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>&klipper;</command></term> +<listitem><para>A clipboard utility that docks in the panel</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kalarm</command></term> +<listitem><para>A utility that warns about upcoming events and appointments</para> +</listitem> + +</varlistentry> +</variablelist> + +<para><command>kdesktop</command> in its turn automatically starts +applications stored in <filename +class="directory">$<envar>TDEHOME</envar>/Autostart</filename>. <command>kdesktop</command> +will automatically open any files stored in this directory including +documents, binary files or applications in the form of <literal +role="extension">.desktop</literal> files.</para> + +<para>The &tde; session manager also restores one of the previous +sessions. A session contains a collection of applications as well as +application-specific information that reflects the state of the applications +at the time the session was saved. Sessions are stored in the +<filename>ksmserverrc</filename> configuration file which contains +references to application-specific state information. The +application-specific state information is saved in <filename +class="directory">$<envar>TDEHOME</envar>/share/config/session</filename>. +The state information of &twin; contains the location of the application +windows of all the other applications in the session. +</para> + +</sect1> + +<sect1 id="environment-variables"> +<title>Environment variables</title> + +<para>Some important environment variables used by &tde;:</para> + +<variablelist> + +<varlistentry> +<term>$<envar>TDEDIR</envar></term> +<listitem><para>Has to be set if +<envar>TDEDIRS</envar> is not set and has to point to the root of the +&tde; installation tree. Allows &tde; to find its data like icons, +menus and libraries.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDEDIRS</envar></term> +<listitem><para>Overrides <envar>TDEDIR</envar> and allows you to specify +multiple directories where &tde; searches for its data. Useful if you want +or have to install some programs to a different prefix than the rest of +&tde;.</para> +</listitem> +</varlistentry> + +<varlistentry><term><envar>$TDEHOME</envar></term><listitem><para>If +not set, &tde; uses <filename class="directory">~/.trinity</filename> as +the directory where personal data is stored.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDEROOTHOME</envar></term><listitem><para>If +not set, &tde; uses <filename class="directory">~root/.trinity</filename> +as the directory for <systemitem class="username">root</systemitem>'s +personal data. Was introduced to prevent &tde; from accidently +overwriting user data with root permissions when the user runs a &tde; +program after switching with <command>su</command> to <systemitem +class="username">root</systemitem>.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDEWM</envar></term><listitem><para>If the +<envar>TDEWM</envar> environment variable has been set, then it will +be used as &tde;'s window manager within the +<command>starttde</command> script instead of &twin;.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_LANG</envar></term><listitem><para>Overrides +the &tde; language configuration, ⪚ <userinput>TDE_LANG=fr kprogram +&</userinput> starts a program with French translation if the +necessary files are installed.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_MULTIHEAD</envar></term><listitem><para>Set +this variable to <literal>true</literal> to indicate that &tde; is running +on a multi-head system.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_FORK_SLAVES</envar></term> +<listitem><para>Set this variable to spawn +<acronym>TDEIO</acronym>-slaves directly from the application process +itself. By default <acronym>TDEIO</acronym>-slaves are spawned using +<command>tdelauncher</command>/<command>tdeinit</command>. This option is +useful if the <acronym>TDEIO</acronym>-slave should run in the same +environment as the application. This can be the case with +<application>Clearcase</application>.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_HOME_READONLY</envar></term> +<listitem><para>Set this variable to indicate that your home directory is +mounted as read-only.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_NO_IPV6</envar></term><listitem><para> +Set this variable to disable <acronym>IPv6</acronym> +support and <acronym>IPv6</acronym> <acronym>DNS</acronym> +lookups.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_IS_PRELINKED</envar></term><listitem><para> +Set this variable to indicate that you have prelinked +your &tde; binaries and libraries. This will turn off +<command>tdeinit</command>.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_UTF8_FILENAMES</envar></term><listitem><para>If +this environment variable is set, &tde; assumes all filenames are in +<acronym>UTF-8</acronym> encoding regardless of the current C +locale.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDE_FULL_SESSION</envar></term><listitem><para> +Automatically set to true by &tde; startup, it is used +by ⪚ &konqueror; to know if it should consider remaining in memory +for future re-use when being closed. If not set, &konqueror; will exit +after being closed (⪚ &tdesu; does that, it's also useful for +debugging).</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDESYCOCA</envar></term><listitem><para>Allows +you to specify the path and the name of the generated &tde; system +configuration cache file.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDETMP</envar></term><listitem><para>Allows +to specify another path than <filename +class="directory">/tmp</filename> where &tde; stores its temporary +files.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>TDEVARTMP</envar></term><listitem><para>Allows +to specify another path than <filename +class="directory">/var/tmp</filename> where &tde; stores its variable +files.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>XDG_DATA_HOME</envar></term><listitem><para> +Defines the base directory relative to which user-specific +data files should be stored. Default is <filename +class="directory">$<envar>HOME</envar>/.local/share</filename></para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>XDG_DATA_DIRS</envar></term><listitem><para> +Defines the preference-ordered set of base directories to +search for data files in addition to the <filename +class="directory">$<envar>XDG_DATA_HOME</envar></filename> base +directory. Default is +<literal>/usr/local/share/:/usr/share/</literal></para> + +<para>&tde; adds locations from $<envar>TDEDIRS</envar> and profiles +as well. Used for <literal role="extension">.desktop</literal> and +<literal role="extension">.directory</literal> menu files. <literal +role="extension">.desktop</literal> files under <filename +class="directory">$<envar>XDG_DATA_DIRS</envar>/applications</filename>. +<literal +role="extension">.directory</literal> files under +$XDG_DATA_DIRS/desktop-directories +</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>XDG_CONFIG_HOME</envar></term><listitem><para> + - Defines the base directory relative to which user +specific configuration files should be stored. Default is +<filename class="directory">$<envar>HOME</envar>/.config</filename>.</para> +</listitem> +</varlistentry> + +<varlistentry><term>$<envar>XDG_CONFIG_DIRS</envar></term><listitem><para> +- Defines the preference-ordered set of base directories +to search for configuration files in addition to the $<envar>XDG_CONFIG_HOME</envar> +base directory. The default is <filename class="directory">/etc/xdg</filename> &tde; adds locations from +$<envar>TDEDIRS</envar> and profiles as well. Used by <literal role="extension">.menu</literal> descriptions in +<filename class="directory">$<envar>XDG_CONFIG_DIRS</envar>/menus</filename>. +</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="the-tdeinit-mystery"> +<title>The tdeinit Mystery</title> + +<!-- FIXME: Add more words. Fix markup --> + +<para><command>tdeinit</command> is used to start all other &tde; +programs. <command>tdeinit</command> can start normal binary program f iles +as well as <command>tdeinit</command> loadable modules. Loadable modules work just like binary +program files but can be started more efficiently. Loadable modules +live in <filename +class="directory">$<envar>TDEDIR</envar>/lib/trinity</filename></para> + +<para>The drawback is that programs started this way appear as +<computeroutput><command>tdeinit</command></computeroutput> in the +output of <command>top</command> and <command>ps</command>. Use +<command>top <option>-c</option></command> or <command>ps +<option>aux</option></command> to see the actual program name:</para> + +<screen> +<prompt>%</prompt> <userinput><command>ps aux | grep bastian</command></userinput> +<computeroutput> +bastian 26061 0.0 2.2 24284 11492 ? S 21:27 0:00 tdeinit: Running... +bastian 26064 0.0 2.2 24036 11524 ? S 21:27 0:00 tdeinit: dcopserver +bastian 26066 0.1 2.5 26056 12988 ? S 21:27 0:00 tdeinit: tdelauncher +bastian 26069 0.4 3.2 27356 16744 ? S 21:27 0:00 tdeinit: kded +bastian 26161 0.2 2.7 25344 14096 ? S 21:27 0:00 tdeinit: ksmserver +bastian 26179 1.1 3.4 29716 17812 ? S 21:27 0:00 tdeinit: kicker +bastian 26192 0.4 3.0 26776 15452 ? S 21:27 0:00 tdeinit: klipper +bastian 26195 1.0 3.5 29200 18368 ? S 21:27 0:00 tdeinit: kdesktop +</computeroutput> +</screen> +<para>As you might have noticed, this has another side effect, making it +difficult to kill a process that is causing trouble:</para> + +<screen><prompt>%</prompt> <userinput><command>killall kdesktop</command></userinput> +<computeroutput>kdesktop: no process killed</computeroutput></screen> + +<para>You might be tempted to try <userinput><command>killall +tdeinit</command></userinput>, but killing all tdeinit processes will have +the effect of shutting down all of &tde;. In effect, total +destruction!</para> + +<para>There are two simple solutions to this:</para> + +<screen><prompt>%</prompt> <userinput><command>tdekillall kdesktop</command></userinput> +or good old +<prompt>%</prompt> <userinput><command>kill 26195</command></userinput></screen> +<para><command>tdekillall</command> is part of the &tde; <acronym>SDK</acronym> +package.</para> + +</sect1> + +</chapter> + +<chapter id="customizing-tde"> +<title>Customizing &tde;</title> + + +<sect1 id="desktop-icons"> +<title>Desktop Icons</title> + +<para>&tde; uses several types of icons:</para> +<itemizedlist> +<listitem><para>Documents</para> +</listitem> +<listitem><para>Links to Websites (using <literal role="extension">.desktop</literal> file)</para> +</listitem> +<listitem><para>Links to Applications (using <literal role="extension">.desktop</literal> file)</para> +</listitem> +<listitem><para>Devices - Disks, Partitions & Peripherals: +<itemizedlist> +<listitem><para>Explicit using <literal role="extension">.desktop</literal> file</para> +</listitem> +<listitem><para>Automatic via devices:// io-slave</para> +</listitem> +</itemizedlist> +</para> +</listitem> +<listitem><para>Vendor-specific</para> +</listitem> +</itemizedlist> + +<sect2 id="desktop-icons-websites"> +<title>Websites</title> +<para> +Links to Websites using <literal role="extension">.desktop</literal> +file: <menuchoice><guimenu>Create +New</guimenu><guisubmenu>File</guisubmenu><guimenuitem>Link to +Location (URL)</guimenuitem></menuchoice>. Change Icon using +<guilabel>Properties</guilabel> dialogs. The resulting <literal +role="extension">.desktop</literal> file: +<programlisting> +[Desktop Entry] +Encoding=UTF-8 +Icon=/opt/trinity/share/apps/kdesktop/pics/ksslogo.png +Type=Link +URL=http://www.trinitydesktop.org/ +</programlisting> +</para> +</sect2> + +<sect2 id="desktop-icons-applications"> +<title>Applications</title> + +<para>Links to Applications using <literal +role="extension">.desktop</literal> file: <menuchoice><guimenu>Create +New</guimenu><guisubmenu>File</guisubmenu><guimenuitem>Link to +Application</guimenuitem></menuchoice>. You must provide details +yourself. Drag from &tde; Menu: Either copy or link (creates symlink), +much easier</para> + +<!-- Perhaps legacy and translated should be the other way around, but --> +<!-- this is how it appears in Waldo's presentation. Need to check --> +<!-- this --> + +<programlisting> +[Desktop Entry]<co id="boilerplate"/> +Encoding=UTF-8 +GenericName=IRC Client<co id="generic-desc"/> +GenericName[af]=Irc Kliët +GenericName[de]=IRC Programm +... +GenericName[zu]=Umthengi we IRC<co id="legacy"/> +SwallowExec=<co id="translated"/> +Name=KSirc +Name[af]=Ksirc +Name[de]=KSirc +... +</programlisting> + +<calloutlist> +<callout arearefs="boilerplate"><para>Boiler plate</para> +</callout> +<callout arearefs="generic-desc"><para>Translated generic description, not used on desktop</para> +</callout> +<callout arearefs="legacy"><para>Legacy, can be removed</para> +</callout> +<callout arearefs="translated"><para>Translated name as it appears on desktop</para> +</callout> +</calloutlist> + +<para>Desktop Icons</para> +<programlisting> +... +Name[zu]=Ksirc +MimeType=<co id="co-mimetype"/> +Exec=ksirc %i %m<co id="co-exec"/> +Icon=ksirc<co id="co-icon"/> +TerminalOptions=<co id="co-terminaloptions"/> +Path=<co id="co-path"/> +Type=Application<co id="co-type"/> +Terminal=0<co id="co-terminal"/> +X-TDE-StartupNotify=true<co id="co-x-tde-startupnotify"/> +X-DCOP-ServiceType=Multi<co id="co-x-dcop-servicetype"/> +Categories=Qt;TDE;Network<co id="co-categories"/> +</programlisting> + +<calloutlist> +<callout arearefs="co-mimetype"><para>Supported &MIME; types, not used on +desktop</para> +</callout> +<callout arearefs="co-exec"><para>The command line to execute</para> +</callout> +<callout arearefs="co-icon"><para>The icon, from icon theme or full path</para> +</callout> +<callout arearefs="co-terminaloptions"><para>Only used if terminal is +needed</para> +</callout> +<callout arearefs="co-path"><para>Working directory for command</para> +</callout> +<callout arearefs="co-type"><para>More boiler plate</para> +</callout> +<callout arearefs="co-terminal"><para>Use true if terminal is needed, +text application</para> +</callout> +<callout arearefs="co-x-tde-startupnotify"><para>Show bouncy cursor, +disable if it doesn't work.</para> +</callout> +<callout arearefs="co-x-dcop-servicetype"><para>Has app started ok? +Remove if it doesn't work</para> +</callout> +<callout arearefs="co-categories"><para>Categories for &tde; Menu, not +used on desktop</para> +</callout> +</calloutlist> + + + +</sect2> + +<sect2 id="desktop-icons-exec"> +<title>The <varname>Exec</varname> option in <literal +role="extension">.desktop</literal> files</title> + +<para>Following the command, you can have several place holders which will +be replaced with the actual values when the actual program is run: +<variablelist> +<varlistentry> +<term>%f</term> <listitem><para>A single file name; used when dropping +file on icon, or with file associations.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%F</term> +<listitem><para>A list of files; use for applications that can +open several local files at once.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%u</term> +<listitem><para>A single &URL;: if the app can +handle ⪚ &FTP; or &HTTP; &URL;s itself, otherwise &tde;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%U</term> +<listitem><para>A list of +&URL;s; will download the file first and pass a local file to the app +(!!)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%d</term> +<listitem><para>The folder of the file to open; useful if app needs to +have file in current working directory.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%D</term> +<listitem><para>A list of folders, not very practical.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%i</term> +<listitem><para>The icon; <option>--icon</option> option; &tde; app +will use icon from <varname>Icon</varname>= line in taskbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%m</term> +<listitem><para>The mini-icon; legacy.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>%c</term> +<listitem><para>The caption; <option>--caption</option> option; &tde; +app will use name from <varname>Name</varname>= line in +taskbar.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<informalexample> +<para>Examples: +<segmentedlist> +<segtitle><varname>Exec</varname> line</segtitle> +<segtitle>Command executed</segtitle> +<seglistitem><seg>ksirc %i</seg><seg><command>ksirc --icon ksirc</command></seg> +</seglistitem> +<seglistitem><seg>cd %d; kedit $(basename %f)</seg><seg><command>cd /tmp; kedit file.txt</command></seg> +</seglistitem> +</segmentedlist> +</para> +</informalexample> + +<!--Dont' know what this refers to: --> +<!--See What's This (Shift-F1) in Properties Dialog--> + +</sect2> + +<sect2 id="desktop-icons-devices"> +<title>Devices</title> +<para> +Links to Devices using <literal role="extension">.desktop</literal> file: +o Create New -> Device + +</para> +</sect2> + +<sect2 id="where-to-define"> +<title>Where to Define</title> + +<para>Many places to define Desktop Icons: +<itemizedlist> + +<listitem><para><filename class="directory">~/Desktop</filename>: +copied from <filename +class="directory">/etc/skel/Desktop</filename></para></listitem> + +<listitem><para><filename +class="directory">$<envar>TDEDIR</envar>/share/apps/kdesktop/Desktop</filename> +(merged)</para></listitem> + +<listitem><para><filename +class="directory">$<envar>TDEDIR</envar>/share/apps/kdesktop/DesktopLinks</filename> +(copied)</para></listitem> + +<listitem><para>Device Icons (dynamically +merged)</para></listitem> + +<listitem><para>Distribution Specific</para></listitem> + +</itemizedlist> +</para> +</sect2> +</sect1> + +<sect1 id="tde-menu"> +<title>&tde; Menu</title> + +<sect2 id="how-it-works"> +<title>How it Works</title> + +<para>A common menu format is used as defined at +<ulink +url="http://freedesktop.org/Standards/menu-spec/">http://freedesktop.org/Standards/menu-spec/</ulink></para> + +<para>The menu format: +<itemizedlist> +<listitem><para>Defines structure in a single .menu file</para></listitem> +<listitem><para>Is based on categories</para></listitem> +<listitem><para>is shared between &tde;, &kde;, <acronym>GNOME</acronym>, and Xfce</para></listitem> +<listitem><para>Supports applnk style menus as well</para></listitem> +</itemizedlist> +</para> + +<informalexample> +<para>Example from <filename>tde-applications.menu</filename>: +<programlisting> +<markup> + <Menu> + <Name>Office</Name> + <Directory>suse-office.directory</Directory> + <Include> + <Filename>Acrobat Reader.desktop</Filename> + <Filename>tde-kpresenter.desktop</Filename> + <Filename>tde-kword.desktop</Filename> + </Include> + <Menu> +</markup> +</programlisting> +</para> +<para>Menu entry with 3 applications: +<itemizedlist> + +<listitem><para><filename>/usr/share/applications/Acrobat +Reader.desktop</filename></para></listitem> + +<listitem><para><filename>/opt/trinity/share/applications/tde/kpresenter.desktop</filename></para></listitem> + +<listitem><para><filename>/opt/trinity/share/applications/tde/kword.desktop</filename></para></listitem> + +</itemizedlist> +</para> +</informalexample> +</sect2> + +<sect2 id="stored-where"> +<title>Stored Where?</title> + +<para><literal role="extension">.menu</literal> files describing the +menu structure. The files are stored in <filename +class="directory">$<envar>TDEDIR</envar>/xdg/menus</filename> and +<filename class="directory">/etc/xdg/menus</filename>. These store the +system-wide menu structure and are controlled by +$<envar>XDG_CONFIG_DIRS</envar>. <filename +class="directory">$<envar>HOME</envar>/.config/menus</filename> stores +user-specific changes to the menu structure and is controlled by +$<envar>XDG_CONFIG_HOME</envar>. For more information, see <ulink +url="http://www.freedesktop.org/Standards/basedir-spec">http://www.freedesktop.org/Standards/basedir-spec</ulink>.</para> + +<para><literal role="extension">.desktop</literal> files describe the +applications and are stored in: <filename +class="directory">$<envar>TDEDIR</envar>/share/applications</filename>, +<filename class="directory">/usr/share/applications</filename>, +<filename +class="directory">/usr/local/share/applications</filename>. These are +the system-wide application <literal +role="extension">.desktop</literal> files which are controlled by +$<envar>XDG_DATA_DIRS</envar>.</para> + +<para><filename +class="directory">$<envar>HOME</envar>/.local/applications</filename> +contains user-specific <literal role="extension">.desktop</literal> +files and user-specific changes. It is controlled by +$<envar>XDG_DATA_HOME</envar>. For more information, see <ulink +url="http://www.freedesktop.org/Standards/basedir-spec">http://www.freedesktop.org/Standards/basedir-spec</ulink></para> + + +<para><literal role="extension">.directory</literal> files describing +the sub-menus are stored in: <filename +class="directory">$<envar>TDEDIR</envar>/share/desktop-directories</filename>, +<filename class="directory">/usr/share/desktop-directories</filename>, <filename +class="directory">/usr/local/share/desktop-directories</filename>. +These are the system-wide menu <literal +role="extension">.directory</literal> files, controlled by +$<envar>XDG_DATA_DIRS</envar>. The user-specific changes are stored in <filename class="directory">$<envar>HOME</envar>/.local/desktop-directories</filename>. +These are controlled by $<envar>XDG_DATA_HOME</envar>. For more +information, see <ulink url="http://www.freedesktop.org/Standards/basedir-spec">http://www.freedesktop.org/Standards/basedir-spec</ulink></para> + +<informalexample> +<para>Example from <filename>tde-applications.menu</filename>: +<programlisting> +<markup> + <Menu> + <Name>Art</Name> + <Directory>suse-edutainment-art.directory</Directory> + <Include> + <Category>X-SuSE-Art</Category> + </Include> + </Menu> +</markup> +</programlisting> +</para> + +<para><literal>Art</literal> is the internal name for this +menu. <filename>suse-edutainment-art.directory</filename> defines the +name and icon for this menu, and the menu includes all applications +that have <literal>X-SuSE-Art</literal> listed as a category, ⪚: +<programlisting> +Categories=Qt;TDE;Education;X-SuSE-Art +</programlisting></para> + +<para><filename>suse-edutainment-art.directory</filename> defines the +name and icon for this menu: +<programlisting> +[Desktop Entry] +Name=Art and Culture +Icon=kcmsystem +</programlisting> +</para> +</informalexample> +</sect2> + +<sect2 id="common-pitfalls"> +<title>Common Pitfalls</title> + +<para>Applications <emphasis>not</emphasis> in the menu do +<emphasis>not</emphasis> exist with regard to other applications or +file associations: If you remove an application from the menu, &tde; assumes you don't want to use it.</para> + +<para>When applications are unwanted in the menu, either place them in +<filename>.hidden</filename> menu or a dedicated menu with +<programlisting> +NoDisplay=true +</programlisting> in the <literal +role="extension">.directory</literal> file</para> +</sect2> + +<sect2 id="essential-menus"> +<title>Essential Menus</title> + +<para><filename +class="directory">/etc/trinity/xdg/menus/applications-merged/</filename> +contains <filename>tde-essential.menu</filename> which includes some +essential menus that are normally not shown in the &tde; menu itself: +<itemizedlist> +<listitem><para>Control Center has a hidden Settings menu whose +contents are defined by <filename>tde-settings.menu</filename> and +whose icon and name are defined by <filename>tde-settings.directory</filename></para> +</listitem> +<listitem><para>Screensavers contains a hidden System/Screensavers menu, +whose contents are defined by +<filename>tde-screensavers.menu</filename> and whose icon and name +are defined by +<filename>tde-system-screensavers.directory</filename>. +<filename>$<envar>TDEDIR</envar>/share/desktop-directories/tde-system-screensavers.directory</filename> +contains: +<programlisting> +NoDisplay=true +</programlisting> +</para> +</listitem> +</itemizedlist></para> +</sect2> + +<sect2 id="old-style-menus"> +<title>Old-Style Menus</title> + +<para>&tde; continues to support old-style menus that are defined by +the directory structures in <filename +class="directory">$<envar>TDEDIR</envar>/share/applnk</filename> +(system wide) and <filename +class="directory">$<envar>HOME</envar>/.trinity/share/applnk</filename> +(user specific). This is observed unless the <literal role="extension">.desktop</literal> file has a <varname>Categories</varname>= line. In that case the categories determine the location in the menu.</para> +</sect2> + +<sect2 id="tdesycoca"> +<title><application>TDESycoca</application></title> +<para><application>TDESycoca</application> caches menu structure and +information about all available applications. You can rebuild the +database with +<userinput><command>tdebuildsycoca</command></userinput>. The database +which is built lives in <filename +class="directory">/var/tmp/tdecache-${<envar>USER</envar>}/tdesycoca</filename>. +It is automatically updated by <application>KDED</application>, +checked during &tde; login, and <application>KDED</application> +watches for changes while logged in.</para> + +<para>To disable watching for changes (since it may hurt over NFS) add +the following to <filename>tdedrc</filename>: +<programlisting> +[General] +CheckSycoca=false +</programlisting> +</para> + +<para>To force regeneration, run <userinput><command>touch $<envar>TDEDIR</envar>/share/services/update_tdesycoca</command></userinput>.</para> + +</sect2> + +<sect2 id="kmenuedit"> +<title>&kmenuedit;</title> + +<para>&kmenuedit; is aimed at a single user setup. Changes to menu +structure are saved to +<filename>~/.config/menus/applications-tdemenuedit.menu</filename>, +changes to applications are saved in <filename +class="directory">~/.local/share/applications/</filename> and changes +to sub-menus (icon, name) are saved in <filename +class="directory">~/.local/share/desktop-directories/</filename>. The +KIOSK Admin Tool uses &kmenuedit; and copies the above changes to +profile- or system-wide locations. +</para> + +</sect2> + +</sect1> + +<!-- This section might be redundant. If it isn't, it needs some screenies --> +<sect1 id="tde-panel"> +<title>&tde; Panel</title> + +<para>The &tde; panel is also known as &kicker;. It is modular and +consists of the following components: +<itemizedlist> +<listitem><para>Applets</para></listitem> +<listitem><para>Application buttons</para></listitem> +<listitem><para>Special Buttons</para></listitem> +</itemizedlist> +</para> + +<para>By default, the panel contains the following applets: +<itemizedlist> +<listitem><para>Pager - shows the virtual desktops</para></listitem> +<listitem><para>Taskbar</para></listitem> +<listitem><para>System Tray</para></listitem> +<listitem><para>Clock</para></listitem> +</itemizedlist> +and the following special buttons: +<itemizedlist> +<listitem><para>&tde; menu</para></listitem> +<listitem><para>Desktop Button</para></listitem> +</itemizedlist> +</para> + +<para>Various application buttons are also added, space permitting: +<itemizedlist> +<listitem><para>Home Button</para></listitem> +<listitem><para>Browser Button</para></listitem> +<listitem><para>KMail Button</para></listitem> +</itemizedlist> +</para> +</sect1> + +<sect1 id="file-associations"> +<title>File Associations</title> + +<para>File associations associate a file type with an application or +applications. The type of a file is established by determining its +&MIME; type. &MIME; types known by &tde; are stored in <filename +class="directory">$<envar>TDEDIR</envar>/share/mimelnk</filename> and +each application's <literal role="extension">.desktop</literal> file +contains a list of &MIME; types supported by that application.</para> + +<informalexample> +<para><filename>kview.desktop</filename>: +<programlisting> +MimeType=image/gif;image/x-xpm;image/x-xbm;image/jpeg; +image/x-bmp;image/png;image/x-ico;image/x-portable-bitmap; +image/x-portable-pixmap;image/x-portable-greymap; +image/tiff;image/jp2 +</programlisting> +</para> + +<para><filename>kuickshow.desktop</filename>: +<programlisting> +MimeType=image/gif;image/x-xpm;image/x-xbm;image/jpeg; +image/png;image/tiff;image/x-bmp;image/x-psd;image/x-eim; +image/x-portable-bitmap;image/x-portable-pixmap; +image/x-portable-greymap +</programlisting> +</para> + +<para>Both can open image/gif Which one is used to open a <literal role="extension">.gif</literal> file?</para> + +<para>The application with highest +preference!. <filename>kview.desktop</filename> contains +<programlisting> +InitialPreference=3 +</programlisting> +whereas <filename>kuickshow.desktop</filename> contains +<programlisting> +InitialPreference=6 +</programlisting> +Therefore, &kuickshow; will be used to open <literal +role="extension">.gif</literal> files. +</para> + +<para>How can we make &kview; default?</para> + +<para>A user can change file association in the +&kcontrolcenter;. These changes are stored in +<filename>$<envar>HOME</envar>/.trinity/share/config/profilerc</filename>. +To use the same settings for multiple users, store these settings in +user profile directory or the global &tde; config directory to use as +default for multiple users.</para> + +</informalexample> + +</sect1> + +</chapter> + +<chapter id="locking-down-tde"> +<title>Locking Down &tde;</title> + +<sect1 id="how-it-works-the-basics"> +<title>How It Works - The Basics</title> + +<para>&tde;'s lock down features are centered around the following +options:</para> + +<itemizedlist> +<listitem><para><link linkend="immutable-configuration-options">Make +configuration options immutable</link></para></listitem> +<listitem><para><link linkend="action-restrictions">Restriction of specific +actions</link></para></listitem> +<listitem><para><link linkend="url-restrictions">Restrict access to certain +&URL;s</link></para></listitem> +<listitem><para><link linkend="configuration-modules">Restrict access to +certain configuration modules</link></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="immutable-configuration-options"> +<title>Immutable Configuration Options</title> +<subtitle>Locking Down &tde;</subtitle> + +<para>Immutable options allow system administrator to provide default +settings that can not be changed by the user.</para> + +<para>Pre-existing configuration options of the user will be ignored once a +configuration option is made immutable.</para> + +<para>Options can be controlled either on a per entry basis, per group of +entries or on a file by file basis.</para> + +<para>If a file or group is immutable, all configuration options for that +file or group are immutable, even those options for which the system +administrator has no default provided.</para> + +<note><para>The support in applications for immutable options may vary from +application to application. Although the user will not be able to make +permanent changes to immutable configuration options, the user may still be +presented with an user interface option to make such change.</para></note> + +</sect1> + +<sect1 id="action-restrictions"> +<title>Action Restrictions</title> + +<para>&tde; applications are built around the action-concept. Actions can be +activated in various ways, typically via the menu-bar, one of the toolbars +or a keyboard shortcut. <action>Save Document</action> is an example of an +action. If you know the internal action name it is possible to restrict an +action. When an action is restricted it will no longer appear in the +menu-bar or toolbar. The internal name for the <action>Save +Document</action> action is <option>action/file_save</option>. The lock +down framework also provides a set of more abstract restrictions which can +be used to disable functionality not covered by a single action. An example +is the <option>shell_access</option> restriction which disables all +functionality that would offer the user access to a &UNIX; shell.</para> + +<example> +<title>Restrict User Access to Shells</title> + +<para>In order to prevent the user access to a command shell we can restrict +the <option>shell_access</option> action by adding the following to +<filename>kdeglobals</filename>: +</para> + +<screen>[TDE Action Restrictions] +shell_access=false</screen> + +<para>Since this affects the &tde; menu and the available applications, we +must force an update of the sycoca database:</para> + +<screen><userinput><command>touch</command> <filename>$<envar>TDEDIR</envar>/share/services/update_tdesycoca</filename></userinput></screen> + +<para>Now re-login to &tde; and check the following points:</para> + +<itemizedlist> +<listitem><para>The &kmenu;</para></listitem> +<listitem><para>In &konqueror;, +<menuchoice><guimenu>Tools</guimenu><guimenuitem>Open +Terminal</guimenuitem></menuchoice></para></listitem> +<listitem><para>The <keycombo +action="simul">&Alt;<keycap>F2</keycap></keycombo> run +command</para></listitem> +</itemizedlist> +</example> +<!--<para>Full documentation about available actions can be found on <ulink +url="http://techbase.kde.org/KDE_System_Administration/Kiosk/Keys"> +http://techbase.kde.org/KDE_System_Administration/Kiosk/Keys</ulink>.</para>--> + +<para>A few of the more interesting actions are listed below:</para> + +<variablelist> +<varlistentry> +<term><option>action/options_configure</option></term> +<listitem><para>The <guimenuitem>Configure</guimenuitem> option form the +<guimenu>Settings</guimenu> menu</para></listitem> +</varlistentry> +<varlistentry> +<term><option>action/help_report_bug</option></term> +<listitem><para>The <guimenuitem>Report Bug/Request Enhancement...</guimenuitem> option from the +<guimenu>Help</guimenu> menu.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>action/kdesktop_rmb</option></term> +<listitem><para>&RMB; mouse button menu on the desktop.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>action/kicker_rmb</option></term> +<listitem><para>&RMB; mouse button menu on the panel.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>user/root</option></term> +<listitem><para>Hide all actions or applications that require <systemitem +class="username">root</systemitem> access.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>shell_access</option></term> +<listitem><para>Hides all actions or applications that provide shell +access.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>print/system</option></term> +<listitem><para>Disables the option to select the printing system +(backend).</para></listitem> +</varlistentry> +<varlistentry> +<term><option>lock_screen</option></term> +<listitem><para>Whether the user will be able to lock the +screen</para></listitem> +</varlistentry> +<varlistentry> +<term><option>start_new_session</option></term> +<listitem><para>Whether the user may start a second X session (see also +&tdm;)</para></listitem> +</varlistentry> +<varlistentry> +<term><option>opengl_screensavers</option></term> +<listitem><para>Whether OpenGL screensavers are allowed to be +used.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>manipulatescreen_screensavers</option></term> +<listitem><para>Permit screensavers that do not hide the entire +screen</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="url-restrictions"> +<title>&URL; Restrictions</title> + +<para>There are three types of restrictions that can be applied to +&URL;s:</para> + +<variablelist> +<varlistentry> +<term>list</term> +<listitem><para>To control whether a directory listing is +allowed.</para></listitem> +</varlistentry> +<varlistentry> +<term>open</term> +<listitem><para>To control whether certain &URL;s can be +opened</para></listitem> +</varlistentry> +<varlistentry> +<term>Redirect</term> +<listitem><para>To control whether one &URL; can open another &URL;, either +automatically or via a hyperlink.</para></listitem> +</varlistentry> +</variablelist> + +<para>Rules are checked in the order in which they are defined. The last +rule that is applicable to a &URL; defines whether the &URL; may be +accessed.</para> + +<para>The following rules disable opening http and https &URL;s outside +<systemitem class="domainname">.ourcompany.com</systemitem>:</para> + +<screenco><areaspec> +<area id="url_commas" coords="3"/> +<area id="url_rule1" coords="3"/> +<area id="url_rule2" coords="4"/> +</areaspec> +<screen>[TDE URL Restrictions] +rule_count=2 +rule_1=open,,,,http,,,false +rule_2=open,,,,http,*.ourcompany.com,,true</screen></screenco> + +<calloutlist> +<callout arearefs="url_commas"> +<para>The first four commas skip over the selection criteria with respect to +the originating &URL;. This part is only needed with redirect type +rules.</para> +</callout> +<callout arearefs="url_rule1"><para><option>rule_1</option> forbids the +opening of any http or https &URL;</para></callout> +<callout arearefs="url_rule2"><para><option>rule_2</option> allows the +opening of any http and https &URL; in the <systemitem +class="domainname">.ourcompany.com</systemitem> domain. Note the wildcard +<token>*</token> is only allowed at the start of a domain.</para></callout> +</calloutlist> + +<para>The following rules makes that the user can no longer browse +directories on the local file system that are outside his +$<envar>HOME</envar> directory:</para> + +<screenco><areaspec> +<area id="home_rule1" coords="3"/> +<area id="home_rule2" coords="4"/> +</areaspec> +<screen>[TDE URL Restrictions] +rule_count=2 +rule_1=list,,,,file,,,false +rule_2=list,,,,file,,$HOME,true</screen></screenco> + +<calloutlist> +<callout arearefs="home_rule1"><para><option>rule_1</option> forbids the +listing of any local directory</para></callout> +<callout arearefs="home_rule2"><para><option>rule_2</option> allows listing +directories under the users own $<envar>HOME</envar> +directory.</para></callout> +</calloutlist> + +<para>$<envar>HOME</envar> and $<envar>TMP</envar> are special values to +indicate the users home directory and the &tde; temporary directory of the +user, ⪚ <filename class="directory">/tmp/tde-bastian</filename></para> + +<para>The following rules makes that the user can no longer open local files +that are outside his $<envar>HOME</envar> directory:</para> + +<screenco><areaspec> +<area id="local_rule1" coords="3"/> +<area id="local_rule2" coords="4"/> +<area id="local_rule3" coords="5"/> +</areaspec> +<screen>[TDE URL Restrictions] +rule_count=3 +rule_1=open,,,,file,,,false +rule_2=open,,,,file,,$HOME,true +rule_3=open,,,,file,,$TMP,true</screen></screenco> + +<calloutlist> +<callout arearefs="local_rule1"><para><option>rule_1</option> forbids the +opening of any local file</para></callout> +<callout arearefs="local_rule2"><para><option>rule_2</option> allows opening +files under the users own $<envar>HOME</envar> directory.</para></callout> +<callout arearefs="local_rule3"><para><option>rule_3</option> allows opening +files in the &tde; temporary directory of the user. This is needed by +certain &tde; applications that first download a file or document to the +temporary directory and then open it in an application.</para></callout> +</calloutlist> + + +<para>The redirection option controls whether documents from a certain +location can refer, either automatically or manually via a hyperlink, to a +certain other location. A set of default rules is present as a general +security measure. For example documents located on the Internet may not +refer to locally stored documents.</para> + +<para>For example, if we want to give the intranet-server <systemitem +class="systemname">www.mycompany.com</systemitem> the possibility to refer +to local files we could add the following rule:</para> + +<screen>[TDE URL Restrictions] +rule_count=1 +rule_1=redirect,http,www.mycompany.com,,file,,,true</screen> + +<para>Instead of listing a protocol by name, it is also possible to specify +a whole group of protocols. For that the following groups have been +defined:</para> + +<variablelist> +<varlistentry> +<term>:local</term> +<listitem><para>Protocols that access locally stored information, examples +are file:/, man:/, fonts:/, floppy:/</para></listitem> +</varlistentry> +<varlistentry> +<term>:internet</term> +<listitem><para>Common internet protocols such as http and +ftp</para></listitem> +</varlistentry> +</variablelist> + +<para>Information about protocols is stored in <literal +role="extension">*.protocol</literal> files stored in +<filename +class="directory">$<envar>TDEDIR</envar>/share/services</filename>.</para> + +<para>The <option>Class</option>= entry defines the group a protocol is part +of: +<userinput><command>grep</command> <option>Class=</option> +<filename>$<envar>TDEDIR</envar>/share/services/*.protocol</filename></userinput></para> + +<para>General rules:</para> + +<itemizedlist> +<listitem><para>The :local protocols may refer to any other +protocol</para></listitem> +<listitem><para>It's always allowed to refer to an :internet +protocol</para></listitem> +<listitem><para>Not all protocols are part of a group, fish:/ for +example.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="configuration-modules"> +<title>Configuration Modules</title> + +<para>&tde; has configuration modules to configure various aspects of the +&tde; environment. Configuration modules appear in the Control Center, in the +Configuration dialog of an application or in both.</para> + +<informalexample> +<para>The proxy configuration module appears in the Control Center but also +as part of the <guilabel>Configure Konqueror</guilabel> dialog in +&konqueror;</para> + +<para>Individual configuration modules can be started with +<command>tdecmshell</command> <replaceable>module</replaceable></para> + +<para>To start the Proxy module use:</para> +<itemizedlist> +<listitem><para><command>tdecmshell</command> +<filename>tde-proxy.desktop</filename></para></listitem> +<listitem><para><command>tdecmshell</command> +<filename>tde-proxy</filename></para></listitem> +<listitem><para><command>tdecmshell</command> proxy</para></listitem> +</itemizedlist> + +<para><note><para>Not all applications use configuration modules, often the +configuration dialog is an integral part of the application +itself.</para></note></para> +</informalexample> + +<para>All configuration modules are strictly speaking part of the &tde; +menu.</para> + +<itemizedlist> +<listitem> +<para>The modules that are visible in the Control Center normally +have a <literal role="extension">.desktop</literal> file in <filename +class="directory">$<envar>TDEDIR</envar>/share/applications/tde</filename> +and are sorted under the hidden <guimenu>Settings-Modules</guimenu> menu by +the <filename>tde-settings.menu</filename>, included from +<filename>tde-essential.menu</filename></para> +<screen><userinput><command>tdebuildsycoca</command> <option>--menutest</option> 2> /dev/null | <command>grep</command> Settings-Modules</userinput></screen> +</listitem> +<listitem> +<para>Application specific modules normally have a <literal role="extension">.desktop</literal> file under +<filename>$<envar>TDEDIR</envar>/share/applnk/.hidden</filename> which +corresponds to the hidden .hidden menu, included as a result of +<markup><KDELegacyDirs/></markup></para> +<screen><userinput><command>tdebuildsycoca</command> <option>--menutest</option> 2> /dev/null | <command>grep</command> .hidden</userinput></screen> +</listitem> +<listitem><para>It is possible to edit the Control Center with +<application>kcontroledit</application>. +<application>kcontroledit</application> works like +<application>kmenuedit</application>, changes for current user only. Use +<application>kiosktool</application> to make changes for +everyone.</para></listitem> +</itemizedlist> + +<para>Individual configuration modules can be disabled by adding the +following to <filename>kdeglobals</filename>:</para> + +<screen>[TDE Control Module Restrictions] +<replaceable>module-id</replaceable>=false</screen> +<para>For example, to disable the proxy module use</para> +<screen>[TDE Control Module Restrictions] +tde-proxy.desktop=false</screen> +<para>Check the Control Center and the <guilabel>Configure +Konqueror</guilabel> dialog if the proxy configuration is still +there.</para> + +</sect1> + +</chapter> + +<chapter id="the-lazy-admin"> +<title>The Lazy Admin</title> + +<!-- This section appears to need quite a lot of additional words to --> +<!-- make sense. Perhaps it would be better to comment it out if it --> +<!-- can't be updated before the next release (Phil) --> +<!-- FIXME: Commented it out until it's got some more content fleshing it --> +<!-- out (Lauri) + +<sect1 id="lazy-admin-overview"> +<title>Overview</title> + +<para> +The Lazy Admin +Overview +Deployment + How to get &tde; available on many clients +Remote Desktop Sharing +Take a look at someone else desktop +DCOP + The DCOP command line tool makes it possible to control &tde; applications from the command line +KDialog + A versatile tool to use standard &tde; dialogs in your own scripts + + + +Deployment +Thin Clients +Installing Software += AutoYaST += KickStart +Maintaining Settings += /etc/tderc, other settings += Use rsync to copy files around += Shared filesystem such as NFS +o store profiles themselves on NFS + + + +http://www.suse.de/~nashif/autoinstall/index.html + +</para> +</sect1> +--> +<sect1 id="remote-desktop-sharing"> +<title>Remote Desktop Sharing</title> + +<para>Remote desktop sharing allows remote users to view and optionally +control the desktop of the current user. The remote user needs to be sent +an invitation, and it is possible to create a password protected standing +invitation. This is ideal for tech support teams or administrators to gain +access to users desktops in order to troubleshoot or remedy a problem or +guide a user through a procedure.</para> + +<para>Remote desktop sharing involves two applications: &krfb; (&tde; remote +frame buffer, a VNC server) and &krdc; (&tde; remote desktop connection; a +VNC client.)</para> + +<para>&krfb; can be used by any user to create and manage invitations. +Invitations create a one time password that allows the recipient to connect +to your desktop. By default it is valid for only one successful connection, +and expires after one hour if not used.</para> + +<para>Incoming connections are handled by the kinetd kded module. You can +use the command <userinput><command>dcop</command> kded kinetd +services</userinput> to see if it is running. &krfb; waits for connections +on port 5900 by default. When an incoming connection is made, a dialog will +appear to ask for confirmation by the current user.</para> + +<!-- TODO: Write a bit more here, with a walk through maybe? --> + +</sect1> + +<sect1 id="tde-diy"> +<title>&tde; DIY - Building Your Own Tools</title> + +<sect2 id="dcop"> +<title>DCOP</title> + +<para> +Desktop COmmunication Protocol, <acronym>DCOP</acronym>, is a lightweight mechanism for inter-process communication. +<acronym>DCOP</acronym> allows the user to interact with programs that are currently running. +&tde; supplies two programs to utilitize <acronym>DCOP</acronym>: +<application>dcop</application>, a command-line program, and +<application>kdcop</application>, a <acronym>GUI</acronym> program. +</para> +<para> +A few notes about using <command>dcop</command>: +</para> + +<para> +<itemizedlist> +<listitem> +<para> +<command>dcop</command> [options] [application [object [function [arg1] [arg2] ... ] ] ] +</para> +</listitem> +<listitem> +<para> +Applications that can open more than one window at a time will be listed as +<application>-<acronym>PID</acronym> +</para> +</listitem> +<listitem> +<para> +All the arguments are case-sensitve. setFullScreen and setfullscreen are two different functions. +</para> +</listitem> +<listitem> +<para> +The regular expression token * can be used in the application and object arguments. +<screen><prompt>% </prompt><userinput><command>dcop</command><option> kon*</option></userinput> +konqueror-16006 +konsole-8954 +</screen> +</para> +</listitem> + +</itemizedlist> + +</para> + +<para>Some example commands and their output are below: +</para> + +<informalexample> +<screen><prompt>% </prompt><userinput><command>dcop</command><option> konsole*</option></userinput> +konsole-8954 +</screen> +<para>One &konsole; is running with a <acronym>PID</acronym> of 8954.</para> + +<screen><prompt>% </prompt><userinput><command>dcop</command><option> konsole-8954</option></userinput> +KBookmarkManager-.../share/apps/tdefile/bookmarks.xml +KBookmarkManager-.../share/apps/konqueror/bookmarks.xml +KBookmarkNotifier +KDebug +MainApplication-Interface +konsole (default) +konsole-mainwindow#1 +tdesycoca +session-1 +session-2 +session-3 +session-4 +</screen> +<para>Here you see that there are four sessions running.</para> + +<screen><prompt>% </prompt><userinput><command>dcop</command><option> konsole-8954</option><option> konsole</option></userinput> +QCStringList interfaces() +QCStringList functions() +int sessionCount() +QString currentSession() +QString newSession() +QString newSession(QString type) +QString sessionId(int position) +void activateSession(QString sessionId) +void nextSession() +void prevSession() +void moveSessionLeft() +void moveSessionRight() +bool fullScreen() +void setFullScreen(bool on) +ASYNC reparseConfiguration() +</screen> +<para>Here are the options for the main &konsole; program. +</para> + +<screen><prompt>% </prompt><userinput><command>dcop</command><option> konsole-8954</option><option> session-1</option></userinput> +QCStringList interfaces() +QCStringList functions() +bool closeSession() +bool sendSignal(int signal) +void clearHistory() +void renameSession(QString name) +QString sessionName() +int sessionPID() +QString schema() +void setSchema(QString schema) +QString encoding() +void setEncoding(QString encoding) +QString keytab() +void setKeytab(QString keyboard) +QSize size() +void setSize(QSize size) +</screen> +<para>Here are the options for the first session, session-1.</para> + +<screen><prompt>% </prompt><userinput><command>dcop</command><option> konsole-8954</option><option> konsole</option><option> setFullScreen</option><parameter> true</parameter></userinput> +</screen> +<para>This sets &konsole; to full screen.</para> + +</informalexample> + +<para> +When there is more than one application/object, which one should you use? + Got a reference? +</para> +<screen><prompt>% </prompt><userinput><command>echo</command><option> $KONSOLE_DCOP</option></userinput> +DCOPRef(konsole-7547,konsole) + +<prompt>% </prompt><userinput><command>dcop</command><option> $KONSOLE_DCOP</option><option> newSession</option></userinput> +session-6 + +<prompt>% </prompt><userinput><command>dcopstart</command><option> konsole</option></userinput> +konsole-9058 + + +#!/bin/sh +konsole=$(dcopstart konsole-script) +session=$(dcop $konsole konsole currentSession) +dcop $konsole $session renameSession Local + +session=$(dcop $konsole konsole newSession) +dcop $konsole $session renameSession Remote + +session=$(dcop $konsole konsole newSession) +dcop $konsole $session renameSession Code +dcop $konsole $session sendSession 'cd /my/work/directory' + +</screen> + +</sect2> + +<sect2 id="kdialog"> +<title>KDialog</title> +<subtitle>&tde; DIY - Building Your Own Tools</subtitle> + +<para>You can use &tde; dialogs from your own scripts, to combine the power +of &UNIX; shell scripting with the ease of use of &tde;.</para> + +<screen><userinput><command>kdialog</command> <option>--msgbox 'You have new mail!'</option></userinput></screen> + +<screen><userinput><command>kdialog</command> <option>--title 'New Mail'</option> <option>--msgbox 'You have new mail!'</option></userinput></screen> + +<para>The <application>KDialog</application> part can be replaced via +<option>--caption</option> option</para> + +<screen><userinput><command>kdialog</command> <option>--title 'New Mail'</option> <option>--msgbox 'You have new mail!'</option> <option>--dontagain myfile:mykey</option></userinput></screen> + +<para>Saves whether to show again in +<filename>$<envar>TDEHOME</envar>/share/config/myfile</filename> (by writing +into this file the following lines:</para> + +<screen>[Notification Messages] +mykey=false</screen> + +<para>Instead of <option>--msgbox</option> you can also use +<option>--sorry</option> and <option>--error</option>, as appropriate. For +instance, you might use <command>kdialog</command> <option>--sorry 'The +network can not be reached'</option> or <command>kdialog</command> +<option>--error 'Mail box can not be opened'</option>.</para> + +<para>It is also possible to create message boxes that accept a yes or no +answer.</para> + +<screen><command>kdialog</command> <option>--yesno 'Do you want to connect +to the Internet?'</option> <command>echo</command> <returnvalue>$?</returnvalue></screen> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Return Value</entry> +<entry>Meaning</entry> +</row> +</thead> +<tbody> +<row><entry>0</entry><entry>Yes, OK, Continue</entry></row> +<row><entry>1</entry><entry>No</entry></row> +<row><entry>2</entry><entry>Cancel</entry></row> +</tbody> +</tgroup> +</informaltable> + +<para>Make sure to store the result in a variable if you do not use it +directly, the next command will fill $? with a new value You can use +<option>--dontagain</option> here as well, it will remember the users choice +and returns it the next times without showing the dialog any more.</para> + +<para>Further variations are:</para> + +<variablelist> +<varlistentry> +<term><option>--warningyesno</option></term> +<listitem> +<para>like <option>--yesno</option> but with a different +icon</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--warningcontinuecancel</option></term> +<listitem><para>With <guibutton>Continue</guibutton> and +<guibutton>Cancel</guibutton> buttons.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--warningyesnocancel</option></term> +<listitem><para>With <guibutton>Yes</guibutton>, <guibutton>No</guibutton> +and <guibutton>Cancel</guibutton> button. For example:</para> +<screen><command>kdialog</command> <option>--warningyesnocancel 'Do you want +to save the changes?'</option></screen> +</listitem> +</varlistentry> +</variablelist> + +<screen><command>kdialog</command> <option>--inputbox "Enter your name:" "YourName"</option></screen> + +<para>The result is printed to stdout, to put it in a variable you can use +<userinput>name=$(kdialog --inputbox "Enter your name:" +"YourName")</userinput>. The last argument is optional, it is used to +pre-fill the dialog.</para> + +<screen><userinput><varname>password</varname>=$(<command>kdialog</command> <option>--password "Enter your password:"</option>)</userinput></screen> + +<para>The <option>--dontagain</option> option does not work with +<option>--inputbox</option> or <option>--password</option></para> + +<para>There are two dialogs that let the user make a choice from a +list:</para> + +<variablelist> +<varlistentry> +<term><option>--menu</option></term> +<listitem> +<para>Lets the user select a single item from a list.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--checklist</option></term> +<listitem> +<para>Lets the user select one or more items from a list.</para> +</listitem> +</varlistentry> +</variablelist> + +<screen><userinput><varname>city</varname>=$(<command>kdialog</command> <option>--menu "Select a city" a London b Madrid c Paris d Berlin</option>)</userinput></screen> + +<para><varname>$city</varname> will <returnvalue>a</returnvalue>, <returnvalue>b</returnvalue>, <returnvalue>c</returnvalue> or <returnvalue>d</returnvalue>.</para> + +<screen><userinput><varname>city</varname>=$(<command>kdialog</command> <option>--checklist "Select cities" a London off b Madrid on c Paris on d Berlin off</option>)</userinput></screen> + +<para>Madrid and Paris will be pre-selected. The result with Madrid and +Paris selected will be <returnvalue>"b"</returnvalue> +<returnvalue>"c"</returnvalue>.</para> + +<para>If you add the <option>--separate-output</option> option, it will put +<returnvalue>b</returnvalue> and <returnvalue>c</returnvalue> each on a line +of its own, making the result easier to process.</para> + +<screen>file=$(kdialog --getopenfilename $HOME) +file=$(kdialog --getopenfilename $HOME "*.png *.jpg|Image Files") +file=$(kdialog --getsavefilename $HOME/SaveMe.png) +file=$(kdialog --getexistingdirectory $HOME)</screen> + +</sect2> + +</sect1> + +</chapter> + +&groupware-with-kontact; + +</book> diff --git a/doc/khelpcenter/faq/CMakeLists.txt b/doc/khelpcenter/faq/CMakeLists.txt new file mode 100644 index 000000000..606220074 --- /dev/null +++ b/doc/khelpcenter/faq/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/faq ) diff --git a/doc/khelpcenter/faq/Makefile.am b/doc/khelpcenter/faq/Makefile.am new file mode 100644 index 000000000..9c7a6607a --- /dev/null +++ b/doc/khelpcenter/faq/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/faq + diff --git a/doc/khelpcenter/faq/TODO b/doc/khelpcenter/faq/TODO new file mode 100644 index 000000000..a91707552 --- /dev/null +++ b/doc/khelpcenter/faq/TODO @@ -0,0 +1,35 @@ +TODO: + +- Cull any questions that are specific to KDE =< 3.4 +- Look into reorganising sections to make finding things much easier. + + + +I'm keeping this in here for the amusement factor. Every time I look at it I rememeber that while I'm not a very good FAQ maintainer, physos wasn't much better ;) + +Last modified by physos 2002-12-27 + +Before 3.2 release +_________________________________________________ + +- Split up the monolith docbook (done) +- Get rid of 1.1.2 stuff (confusion) +- check if things are still working + * compile tutorials for the various OS's + * workarounds still needed? + * workarounds still working? + * answers are still valid? + * easier solutions? +- complete revision ? +- New structure ? +- Find maintiners for single parts +- what needs to be added ? + +[22:15:47] <lauri> 1: move the faq (and other tdebase docs) up to tdebase/doc/<subdir> +so that docs.kde.org will pick them up and generate them +[22:16:05] <lauri> then remove the copies on www.kde.org, put in redirects to the new +location, and have one, autogenerated and searchable copy all the time +[22:16:17] <physos> sounds nice +[22:16:24] <physos> will look into it + + diff --git a/doc/khelpcenter/faq/about.docbook b/doc/khelpcenter/faq/about.docbook new file mode 100644 index 000000000..76967f78a --- /dev/null +++ b/doc/khelpcenter/faq/about.docbook @@ -0,0 +1,47 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="about"> +<title>About this <acronym>FAQ</acronym></title> + +<qandaset> +<qandaentry> +<question> +<para>What can I do to help with this <acronym>FAQ</acronym>?</para> +</question> + +<answer> + +<para>Notify us about any errors you find. Suggestions you have are +appreciated. Send us everything that you think is unclear. When possible send us what +you think would be a clearer solution.</para> + +<para>Send us your solutions of those frequently-asked +questions which are still not in this <acronym>FAQ</acronym>. We will +add them as soon as practical.</para> + +<para>Please make full use of this <acronym>FAQ</acronym>. +Read this <acronym>FAQ</acronym> (and other +relevant documentation) well before asking questions on the various +&tde; mailing lists or newsgroups.</para> + +</answer> +</qandaentry> + +<qandaentry> +<question id="FAQ-maintainer-HOWTO"> +<para>How do I become an <acronym>FAQ</acronym> maintainer?</para> +</question> + +<answer> +<para>Becoming an <acronym>FAQ</acronym> maintainer is easy +and we are always grateful for help. :-) Send +us an email at <email>[email protected]</email>. +</para> +</answer> +</qandaentry> +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/configtde.docbook b/doc/khelpcenter/faq/configtde.docbook new file mode 100644 index 000000000..dd5c45686 --- /dev/null +++ b/doc/khelpcenter/faq/configtde.docbook @@ -0,0 +1,243 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd"> +--> +<chapter id="configure"> +<title>Configuring &tde;</title> + +<qandaset> +<qandaentry> +<question> +<para>How do I set the language used by &tde;?</para> +</question> +<answer> +<para>First ensure the appropriate tde-i18n language package is installed.</para> +<para>Thereafter there are two ways to set the language &tde; uses in the +messages it will display:</para> +<variablelist> +<varlistentry><term>Using the <application>&tde; Control Center</application></term> +<listitem><para>Open the <application>&tde; Control Center</application> and select +<guimenu>Regional & Accessibility</guimenu> then +<guimenuitem>Country/Region & Language</guimenuitem>. You can select your language and location +here. If &tde; cannot find a translation in the first language +chosen, it will fall back on the default language. This is usually +(American) English by default.</para> +<note><para>Using the <application>&tde; Control Center</application> is the preferred way of choosing +languages in &tde;.</para></note></listitem> +</varlistentry> +<varlistentry><term>Using the <envar>LANG</envar> environment variable</term> +<listitem><para>The second method uses the standard locale setting on +your system. To change the language, simply set the environment +variable <envar>LANG</envar> accordingly. For example, if your shell +is <application>bash</application>, execute +<userinput><command>export</command> <envar>LANG</envar>=de</userinput> +to set German as the language used.</para></listitem> +</varlistentry> +</variablelist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is there any keyboard switcher for international keyboards for +&tde;?</para> +</question> +<answer> +<para> +Yes, configure the switcher using the <application>&tde; Control Center</application> +<menuchoice><guimenu>Regional & Accessibility</guimenu><guimenuitem> +Keyboard Layout</guimenuitem></menuchoice> configuration page. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I replace the standard text login screen with the +&tde; login screen?</para> +</question> +<answer> +<note><para>Your &UNIX; distribution might have its own setup tools to +change this (⪚ <application>YaST</application> on &SuSE; &Linux;). This will +be the safest way to enable the &tde; login screen. However, if for some reason +you do not wish to use these tools, the following instructions might be useful.</para></note> +<para>First, ychange to the <quote>xdm runlevel</quote> (runlevel 5 on +&RedHat; and &SuSE; systems) by editing your +<filename>/etc/inittab</filename> file. In the file, there should be +a line saying <userinput>id:3:initdefault:</userinput>. Change it to +<userinput>id:5:initdefault:</userinput>. At the end of the file, +comment out the following line: +<literal>x:5:respawn:/usr/bin/X11/xdm -nodaemon</literal> and +replace it with +<userinput>x:5:respawn:<replaceable>/opt/trinity/</replaceable>bin/tdm +-nodaemon</userinput>. +<note><para>The location of &tdm; might differ on your +system.</para></note></para> +<para>For changes to take effect immediately, type <command>init +5</command> (for &RedHat; systems) at the shell prompt. +<caution><para>It is risky to initiate a graphical login without +checking beforehand whether it works. If it fails to work, you would +be in for a hard time getting back.</para></caution></para> +</answer> +<answer> +<para> +For FreeBSD, you should edit the file <filename>/etc/ttys</filename> +and change one of the lines that look like +<programlisting>ttyv8 "/usr/X11R6/bin/xdm -nodaemon" xterm off secure</programlisting> +to instead say <userinput>ttyv8 "/usr/local/bin/tdm -nodaemon" xterm +off secure</userinput>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>I would like to click the &LMB; anywhere on the +desktop and have the <guimenu>TDE</guimenu> menu displayed.</para> +</question> +<answer> +<para>Use the &RMB; to select the desktop. From the popup menu, select +<guisubmenu>Configure Desktop</guisubmenu>. From the icon list +select the Behavior icon. Choose the behavior of mouse clicks on the desktop. To have +the <guimenu>TDE</guimenu> menu open from a single &LMB; click, change +the entry labeled <guilabel>Left button</guilabel> to say +<guilabel>Application Menu</guilabel>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Where do I find additional &tde; themes?</para> +</question> +<answer> +<para>Go to <ulink url="http://www.kde-look.org">http://www.kde-look.org</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I change &MIME; Types?</para> +</question> +<answer> +<para>When using &konqueror;, open a &konqueror; window and choose +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Konqueror</guimenuitem></menuchoice>. From the icon list select +<guilabel>File Associations</guilabel>. Find the mime type you want to change +(⪚ <literal>text/english</literal> or +<literal>image/gif</literal>), and set the application preference order +to whatever you want.</para> +<para>The same thing can be accomplished by using the <application>&tde; Control Center +</application>. Select <menuchoice><guimenu>TDE Components</guimenu><guimenuitem>File Associations</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>&tde; (&tdm;) does not read my <filename>.bash_profile</filename>.</para> +</question> +<answer> +<para>The login managers<application>xdm</application> and &tdm; do +not run a login shell, so <filename>.profile</filename>, +<filename>.bash_profile</filename>, &etc; are not +sourced. When the user logs in, <application>xdm</application> runs +<command>Xstartup</command> as root and then +<command>Xsession</command> as user. The normal practice is to add +statements in <filename>Xsession</filename> to source the user +profile. Please edit your <filename>Xsession</filename> and +<filename>.xsession</filename> files.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I use &TrueType; fonts in &tde;?</para> +</question> +<answer> +<para>Install &TrueType; font support into your &X-Window; configuration. +<!--Please take a look at <ulink +url="http://x.themes.org/">x.themes.org</ulink> for the fonts, and +<ulink url="http://www.dcs.ed.ac.uk/home/jec/programs/xfsft/">xfsft: +&TrueType; Font Support For X11</ulink> or <ulink +url="http://X-TT.dsl.gr.jp/">X-&TrueType; Server Project Home +Page</ulink> for the font servers.--> +</para> +<para>If you have a bunch of &TrueType; fonts from &Microsoft; +&Windows;, edit the <filename>xorg.conf</filename> file to get the +fonts from the font folder. Then configure &tde; to use these new +fonts with the <filename>Font Administrator</filename> utility.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is it possible to enter, show, and work with the Euro Symbol in +&tde;?</para> +</question> +<answer> +<para>Yes. Open the <application>&tde; Control Center</application> and select +<guimenu>Regional & Accessibility</guimenu>, then +<guimenuitem>Keyboard Layout</guimenuitem>. Select the <guimenuitem>Xkb Options</guimenuitem> +tab and enable the <guilabel>Enable xkb options</guilabel> check box. Choose a compose key. +Enable <guilabel>Adding Eurosign to certain keys</guilabel> and select the desired key.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I run a program at &tde; startup?</para></question> +<answer><para>There are several ways to do that. If you want to +run some scripts that set environment variables (for +example, to start <command>gpg-agent</command>, <command>ssh-agent</command> and others), place the +scripts into <filename class="directory">$<envar>TDEHOME</envar>/env/</filename>. Make sure their names end in +<literal role="extension">.sh</literal>. $<envar>TDEHOME</envar> is +usually a folder named <filename class="directory">.trinity</filename> +(notice the period at the beginning) in your home +folder. If you want scripts to be executed for all &tde; users, you can +put them under <filename class="directory">$<envar>TDEDIR</envar>/env/</filename>, where $<envar>TDEDIR</envar> is the prefix &tde; is installed (you can find this out using the command +<userinput><command>tde-config --prefix</command></userinput>).</para> +<para>If you wish to start a program after &tde; has started, you may want to use the +<filename class="directory">Autostart</filename> folder. To add +entries to the <filename class="directory">Autostart</filename> folder: +<orderedlist> +<listitem><para>Open &konqueror;.</para> +</listitem> +<listitem><para>Select <menuchoice><guimenu>Go</guimenu><guimenuitem>Autostart</guimenuitem> +</menuchoice> from the menubar.</para> +</listitem> +<listitem><para>Right-click in the window view area and select <menuchoice><guisubmenu>Create New</guisubmenu><guisubmenu>File</guisubmenu><guimenuitem>Link to +Application</guimenuitem> +</menuchoice></para> +</listitem> +<listitem><para>Click on the <guilabel>Application</guilabel> tab in +the window that appears and enter the name of the command to run in +the <guilabel>Command</guilabel> text box.</para> +</listitem> +</orderedlist> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How can I allow more than one user to be logged in a at a time? Can &tde; do <quote>fast user switching</quote>?</para> +</question> +<answer> +<para>Yes, when starting &tde; through the graphical login mode. When starting &tde; +from the command line using <filename>startx</filename>, then toggle to a different console +to login in.</para> +<para>To enable more than one user to log in at one time on the same +computer (sometimes referred to as <quote>fast user switching</quote>) +configure the program that logs you in to allow more than one +session (or, in &X-Window; terms, <quote>display</quote>) at a time.</para> +<para>In &tde;, this program is called &tdm; which stands for <quote>&tde; +Display Manager</quote>. If you are not using &tdm; as your login screen +then you will need to consult the documentation for the software you are using on how to +accomplish multiple sessions.</para> +<para>By default, this will be configured at installation time automatically +if &tdm; supports virtual terminals on your system (currently Linux only). +If it was not configured automatically, consult the &tdm; manual, section +<ulink url="help:/tdm/tdmrc-xservers.html">Specifying permanent &X-Server;s</ulink>. +After modifying tdmrc, you will have to restart &tdm;; just +invoke <command>killall -HUP tdm</command>.</para> +</answer> +</qandaentry> +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/contrib.docbook b/doc/khelpcenter/faq/contrib.docbook new file mode 100644 index 000000000..6bb716f62 --- /dev/null +++ b/doc/khelpcenter/faq/contrib.docbook @@ -0,0 +1,163 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + + +<chapter id="contribute"> +<title>Contributing</title> + +<qandaset> +<qandaentry> +<question> +<para>How can I contribute to &tde;?</para> +</question> +<answer> +<para>&tde; is a free/libre software project that lives from voluntary +contributions. Everybody is encouraged to contribute to &tde;. Not +only programmers are welcome. There are many ways in which you can +help to improve &tde;:</para> +<itemizedlist> +<listitem><para>Test the software.</para></listitem> +<listitem><para>Send in bug reports. For more information, +refer to <link linkend="bug-report">How do I submit a bug +report?</link>.</para></listitem> +<listitem><para>Write or edit documentation and help files.</para></listitem> +<listitem><para>Translate programs, documentation, and help files. +</para></listitem> +<listitem><para>Draw icons, wallpaper, or compose sound effects.</para></listitem> +<listitem><para>Write articles and books about &tde;. If you want to +help spread the word about &tde;, send an email to +<email>[email protected]</email>. This will get you in touch +with the &tde; developers and packagers.</para></listitem> +<listitem><para>Program new &tde; applications. Please refer to <xref +linkend="programming"/> for more information.</para></listitem> +<listitem><para> Of course, sponsors are also +welcome. :-)</para></listitem> +</itemizedlist> +<para>There are several places to look for more information if you +want to get involved in the development. The first step is to +subscribe to some of the <ulink url="http://www.trinitydesktop.org/mailinglist.php">mailing +lists</ulink>. You will soon see something +that can be improved or added.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="bug-report"> +<para>How do I submit a bug report?</para> +</question> +<answer> +<para>There is a bug tracking system available at <ulink +url="http://bugs.trinitydesktop.org/">http://bugs.trinitydesktop.org/</ulink> +and thanks for helping! The system features several query types and a +list of all known bugs.</para> +<para>The easiest way to submit a bug is to select +<menuchoice><guimenu>Help</guimenu><guimenuitem>Report +Bug/Request Enhancement...</guimenuitem></menuchoice> from the menu bar of the application +with the bug. This will open a dialog box with a link +to the bug tracking system. Please follow the +instructions of the bug reporting wizard.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>May I join the development team?</para> +</question> +<answer> +<para>Please! Join our discussion list at +<ulink url="http://www.trinitydesktop.org/mailinglist.php"> +http://www.trinitydesktop.org/mailinglist.php</ulink>. Join +Internet Relay Chat (IRC) sessions at chat.freenode.net, channel: #trinity-desktop</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="programming"> +<para>I want to program for &tde;. What should I do first?</para> +</question> +<answer> +<para>Everybody is encouraged to develop software for &tde;. What you +should do first depends strongly on your experience, ⪚ whether you have +already learned C++ or have experience with the &Qt; toolkit and so +on.</para> +<para>To get into &tde; programming, you will need some basic tools: +<application>automake</application>, +<application>autoconf</application>, and +<application>cmake</application>.</para> +<para>An excellent resource for learning &tde; +programming is the &Qt; tutorials. These are installed along with &Qt;. To view them, +open <filename>$<envar>TQTDIR</envar>/doc/html/index.html</filename> in +&konqueror; and bookmark the locatio. The tutorials +can be found under "Using Qt". The source code for each lesson can be found in the <filename +class="directory">$<envar>TQTDIR</envar>/tutorial</filename> +directory.</para> +<para>There is one thing everybody interested in +programming for &tde; should do: please <emphasis>subscribe to the developers +mailing list</emphasis>. To subscribe, you have to send an email to +<ulink +url="mailto:[email protected]">[email protected]</ulink> +with an empty email. +<important><para>Please read<ulink url="http://www.trinitydesktop.org/mailinglist.php"> +http://www.trinitydesktop.org/mailinglist.php</ulink>. Everything +written there applies to the development list as well.</para></important></para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I get access to &tde; <acronym>GIT</acronym>?</para> +</question> +<answer> +<para>The &tde; project uses <acronym>GIT</acronym> to develop the +core parts of the software. Usually, when you have changed one of the +parts (⪚ fixed a bug), and you want to commit this change, the best +way is to create a patch against a current snapshot and send this +patch to the developer/maintainer of the respective program.</para> +<para>If you are doing this more or less regularly, then contact the developers +to obtain write access to the <acronym>GIT</acronym> repository: +<ulink url="[email protected]"> [email protected]</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Can I have read-only access to the <acronym>GIT</acronym> repository?</para> +</question> +<answer> +<para>Yes. Instructions on how to get anonymous, read-only <acronym>GIT</acronym> +access are here: <ulink url="http://www.trinitydesktop.org/wiki/bin/view/Developers/GIT"> +http://www.trinitydesktop.org/wiki/bin/view/Developers/GIT</ulink> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Are there any <acronym>GIT</acronym> mirror sites for &tde;?</para> +</question> +<answer> +<para>No, currently there are no anonymous <acronym>GIT</acronym> mirror sites for &tde;. +</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>How do I go about translating &tde; programs into my native +language?</para> +</question> +<answer> +<para>Look at the <ulink url="http://i18n.kde.org">The &tde; +Translators' and Documenters' Web Site</ulink> to see whether your +program is already translated (most are). Otherwise you will find +information there on how to do it yourself.</para> +</answer> +</qandaentry>--> +</qandaset> +</chapter> + + diff --git a/doc/khelpcenter/faq/desktop.docbook b/doc/khelpcenter/faq/desktop.docbook new file mode 100644 index 000000000..cd5e8c1c5 --- /dev/null +++ b/doc/khelpcenter/faq/desktop.docbook @@ -0,0 +1,96 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="desktop"> +<title>The desktop</title> + +<qandaset> +<qandaentry> +<question> +<para>How do I add an application to the desktop?</para> +</question> +<answer> + +<para>Just choose the desired application from the <guimenu>TDE</guimenu> menu and drag and drop it to the Desktop. +</para> +<para>For applications not listed in the <guimenu>TDE</guimenu> menu, +use the &RMB; on the desktop and choose <menuchoice><guimenuitem>Create New</guimenuitem><guisubmenu>File</guisubmenu> +<guimenuitem>Link to Application...</guimenuitem></menuchoice> and fill in the configuration for the application you want to link to. +</para> + +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I mount/unmount a device from the desktop?</para> +</question> +<answer> + +<para>First, make sure you are allowed to <command>mount</command>/<command>umount</command> the relevant device as a user. +</para> +<para>Then you can add any device via &RMB; on the desktop and then choosing <menuchoice><guimenu>Create New</guimenu><guimenuitem>Link to Device</guimenuitem></menuchoice> and then selecting the device of the type you wish to control from the desktop. Fill in the settings for the device in the dialog that appears and click <guilabel>OK</guilabel>. You can use the resulting desktop icon to mount/unmount the device from the desktop. +</para> + +</answer> +</qandaentry> + + +<qandaentry> +<question> +<para>Where are the icons kept?</para> +</question> +<answer> +<para>The icons can be found only in <filename +class="directory">$<envar>TDEDIRS</envar>/share/icons</filename> or <filename +class="directory">$<envar>HOME</envar>/.trinity/share/icons</filename>. To use icons +stored in other locations, you must either copy them into one of the +above-mentioned fixed &tde; locations or make symlinks.</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>How do I use the mouse scroll wheel in &tde;?</para> +</question> +<answer> +<para>Mouse wheel support comes with &Qt; 2.0 and above, so &tde; based on +that will automatically support the use of the mouse scroll wheel if your system is configured correctly. Check your &X-Server; settings support the use of a scrollwheel if it is not working.</para> +</answer> +</qandaentry>--> + +<qandaentry> +<question> +<para>How do I launch applications in a particular desktop?</para> +</question> +<answer> +<para>&tde; comes with a program called &kstart;. +To start an <application>xterm</application> on the second desktop and then activate it use: + +<userinput><command>kstart</command> <option>--desktop +2 --activate --window "xterm" </option>xterm</userinput>.</para> +<para>Note that the <option>--window</option> option is important. It takes an +argument which is a regular expression matching the title of the window to +apply the settings to.</para> +<para>Please read <command>kstart</command> <option>--help-all</option> for more magic +available with &kstart; (and there is an abundance). +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Where do I save my files if I want them to appear directly on +the desktop?</para> +</question> +<answer> +<para><filename +class="directory">$<envar>HOME</envar>/Desktop</filename>. You might +need to refresh your desktop after you have saved your files.</para> +</answer> +</qandaentry> +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/filemng.docbook b/doc/khelpcenter/faq/filemng.docbook new file mode 100644 index 000000000..7620b0f00 --- /dev/null +++ b/doc/khelpcenter/faq/filemng.docbook @@ -0,0 +1,186 @@ +<!-- <?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> --> + +<chapter id="filemanager"> +<title>The File Manager</title> + +<para>The default file manager in &tde; is &konqueror;. Please refer to +the <ulink url="help:/konqueror/index.html"> +Konqueror Handbook</ulink> for detailed information.</para> + +<qandaset> + + +<qandaentry> +<question> +<para>How can I change the appearance of a folder in +&konqueror;?</para> +</question> +<answer> +<para>Right-click the folder, select <guimenuitem>Properties</guimenuitem>, +click on the large icon in the dialog which appears, and choose another +icon.</para> <para>To change the icon displayed for entries in the +<guimenu>TDE Menu</guimenu>, use the <application>Menu Editor</application>, +located at <menuchoice><guisubmenu>Settings</guisubmenu><guimenuitem>Menu +Editor</guimenuitem></menuchoice>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How can I do non-anonymous &FTP; transfers with &konqueror;?</para> +</question> +<answer> +<para>Normally, if you enter a &URL; like +<userinput>ftp://<replaceable>ftp.somehost.com</replaceable></userinput>, +&konqueror; will attempt an anonymous login to the &FTP; server. If you +want to login as a particular user, enter a &URL; like +<userinput>ftp://<replaceable>[email protected]</replaceable></userinput> +instead. &konqueror; will ask for your password and connect to the +server.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I specify the startup folder for &konqueror;?</para> +</question> +<answer> +<para>With the desktop Home icon, using the &RMB;, select the icon and choose +<guimenuitem>Properties</guimenuitem>. Select the +<guilabel>URL</guilabel> tab. Type <filename class="directory">/whereever/you/want</filename> +with the folder you would like &konqueror; to start in.</para> +<para>From within &konqueror; the process is similar. Ensure the Navigation Panel is active +(press <keycap>F9</keycap>). From the Navigation Panel tabs, select the Home icon. +In the Navigation Panel directory, use the &RMB; to select the top level <filename class="directory">Home Folder</filename> and select <guimenuitem>Properties</guimenuitem>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I rename files?</para> +</question> +<answer> +<para>Simply <mousebutton>right</mousebutton> click on the file and select +<guimenuitem>Rename</guimenuitem> or press the keyboard shortcut <keycap>F2</keycap> with a file selected.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Where did the delete entry from my right-click context menu go?</para> +</question> +<answer> +<para>The Delete context menu entry that bypasses the +Trash can is not displayed by default. To enable that menu option, go to +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&konqueror;</guimenuitem></menuchoice > and select +<guilabel>Behaviour</guilabel> in the iconbar to the left. Enable the checkbox +<guilabel>Show 'Delete' context menu entries which bypass the +trashcan</guilabel>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I configure the programs that &konqueror; uses to +open different types of files?</para></question> +<answer> +<para>In order to configure file associations, you should go to the +&kcontrolcenter; and choose the item <guimenuitem>File +Associations</guimenuitem> under the category <guimenu>TDE +Components</guimenu>.</para> +<para> +Suppose the default <acronym>PDF</acronym> viewer is now &kghostview; and +you would prefer to use <application>KPDF</application> as a viewer. You +would simply type <userinput>pdf</userinput> in the search box at the top of +the dialog, choose <guimenuitem>pdf</guimenuitem> in the +<guimenu>application</guimenu> group and move +<application>KPDF</application> up. In the <guilabel>Embedding</guilabel> +tab you can also choose which component other applications will use to +display files (for example, when viewing files in &konqueror; or using +&ark;'s embedded viewer). +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>When I try to click on a folder in &konqueror;, I get the +message: <quote>There appears to be a configuration error. You have +associated Konqueror with inode/directory, but it cannot handle this file +type.</quote></para> +</question> +<answer> +<para>Make sure the embedding settings for inode/directory +are correct: +<orderedlist> +<listitem><para>In &konqueror;, go to +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Konqueror</guimenuitem></menuchoice> and then to the <guilabel>File +Associations</guilabel> page.</para></listitem> <listitem><para>Open +inode->directory in the tree view.</para></listitem> <listitem><para>Click on +the +<guilabel>Embedding</guilabel> tab. Make sure that <guilabel>Left Click +Action</guilabel> is set to <guilabel>Show file in embedded +viewer</guilabel>, and by default <guilabel>Icon View (konq_iconview)</guilabel> +is at the top +of <guilabel>Services Preference Order.</guilabel></para></listitem> +</orderedlist> +</para> +</answer> +</qandaentry> + +<qandaentry> <question> <para>What are <option>%i</option> and +<option>%m</option> parameters in a file's Properties Command line?</para> +</question> +<answer> +<para>They are used by all &tde; applications (since they are implemented in +<classname>TDEApplication</classname> and all good &tde; programs create a +<classname>TDEApplication</classname> object before they even look at the +command line arguments).</para> <para>A standard line for a &tde; +application looks like this: <userinput><command>foo</command> +<option>... %i %m -caption \"%c\"</option></userinput>. Pretty confusing, +-but it has been designed in that way so that it can integrate legacy, +non-&tde; applications as smoothly as possible. &konqueror;, when executing +the line above, will extend the command to +<userinput><command><replaceable>foo</replaceable></command> <option>-icon +something.png -miniicon something_mini.png -caption \"The +Foo\"</option></userinput>. Both the icon and the mini-icon as well as "The +Foo" are properties defined in the <filename>.desktop</filename> file. If +the icons are not defined, they simply default to the executable name +<replaceable>foo</replaceable>.</para> + +<para>This way a user can change these things in &kmenuedit; for his or her +applications. The <option>-caption</option> option is important, because no +user will accept that the menu item <guimenuitem>Editor</guimenuitem> starts +something called <guilabel>kedit-0.9pl4-build47</guilabel>. Instead, users +expect a window called <guilabel>Editor</guilabel>. Furthermore these +names are localized, &ie; an American English user launches +<guimenuitem>CD-Player</guimenuitem> and gets a window called +<guilabel>CD-Player</guilabel> while a German user launches +<guimenuitem>CD-Spieler</guimenuitem> and gets a window called +<guilabel>CD-Spieler</guilabel>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I make &konqueror; start up without a menu bar? +I can't save a view profile when the menu bar is invisible!</para> +</question> + +<answer><para>The easiest way to do this is to edit &konqueror;'s +configuration file manually. Add the following lines to +<filename>~/.trinity/share/config/konquerorrc</filename>: +<programlisting> +[KonqMainWindow] +MenuBar=Disabled +</programlisting> +</para> +<para>On restarting &konqueror;, the menubar should be hidden.</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/gettde.docbook b/doc/khelpcenter/faq/gettde.docbook new file mode 100644 index 000000000..73911e92d --- /dev/null +++ b/doc/khelpcenter/faq/gettde.docbook @@ -0,0 +1,86 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="getting-tde"> +<title>Getting &tde;</title> + +<qandaset> +<qandaentry> +<question id="where-to-get-tde"> +<para>Where do I get &tde;?</para> +</question> +<answer> +<!-- This needs a rewrite including informations about the latest version (link to the info page?)--> +<para>The easiest way to get &tde; is to install a &Linux; based distribution or another &UNIX; operating system +that includes &tde;. +You can find an up-to-date list of distributions that ship +with &tde; <ulink url="http://www.trinitydesktop.org/">here</ulink>.</para> + +<para>The main distribution site for &tde; is +<ulink url="http://www.trinitydesktop.org/">http://www.trinitydesktop.org/</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What is the current version?</para> +</question> +<answer> +<para>TDE is developed continually. Find the latest stable version number <ulink url="http://www.trinitydesktop.org/releases.php">here</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Binary packages are not available for my distro. What do I do?</para> +</question> +<answer> +<para>That is always a challenging situation. Are there skilled packagers who +might help? If you are skilled in compiling software from sources, source +tarballs are available for each TDE release (http://www.trinitydesktop.org/releases.php). +The development version can also be built from our GIT source tree. Use the forums +or mailing lists to contact packagers to obtain copies of their build scripts +that can be massaged to fit your distro.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Where do I find &tde; snapshots?</para> +</question> +<answer> +<para>Learn more about the latest development snapshots at <ulink +url="http://www.trinitydesktop.org/development.php">http://www.trinitydesktop.org/development.php</ulink>. +You might want to consider setting up your own <acronym>GIT</acronym> account to +maintain the latest snapshot at all times. Please refer to <ulink +url="http://www.trinitydesktop.org/development.php">http://www.trinitydesktop.org/development.php</ulink> for further +information. +</para> + +</answer> +</qandaentry> + +<qandaentry> +<question id="where-to-get-qt"> +<para>Where do I get &Qt;?</para> +</question> +<answer> +<para>&Qt; is a product of the Norwegian company Trolltech. The version +upon which TDE is based no longer is actively maintained by Trolltech. +Maintenance is handled by the TDE developers. Get the latest &Qt; version +from the TDE GIT repository at +<ulink url="http://git.trinitydesktop.org/">http://git.trinitydesktop.org/</ulink>.</para> +<para> +With most &Linux; distributions, this version of &Qt; no longer is +included or maintained and must be obtained from the TDE repositories. Because +this version of &Qt; is now maintained exclusively to support TDE, the version supported +by TDE developers is not backwards compatible with the original version from Trolltech.</para> +</answer> +</qandaentry> + + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/index.docbook b/doc/khelpcenter/faq/index.docbook new file mode 100644 index 000000000..478588411 --- /dev/null +++ b/doc/khelpcenter/faq/index.docbook @@ -0,0 +1,115 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&tde; Frequently Asked Questions"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY faq-about SYSTEM "about.docbook"> + <!ENTITY faq-intro SYSTEM "intro.docbook"> + <!ENTITY faq-gettde SYSTEM "gettde.docbook"> + <!ENTITY faq-install SYSTEM "install.docbook"> + <!ENTITY faq-panel SYSTEM "panel.docbook"> + <!ENTITY faq-desktop SYSTEM "desktop.docbook"> + <!ENTITY faq-winmng SYSTEM "winmng.docbook"> + <!ENTITY faq-filemng SYSTEM "filemng.docbook"> + <!ENTITY faq-webbrowse SYSTEM "webbrowse.docbook"> + <!ENTITY faq-configtde SYSTEM "configtde.docbook"> + <!ENTITY faq-tdeapps SYSTEM "tdeapps.docbook"> + <!ENTITY faq-nontdeapps SYSTEM "nontdeapps.docbook"> + <!ENTITY faq-tips SYSTEM "tips.docbook"> + <!ENTITY faq-misc SYSTEM "misc.docbook"> + <!ENTITY faq-notrelated SYSTEM "notrelated.docbook"> + <!ENTITY faq-moreinfo SYSTEM "moreinfo.docbook"> + <!ENTITY faq-contrib SYSTEM "contrib.docbook"> + <!ENTITY faq-questions SYSTEM "questions.docbook" > + <!ENTITY faq-credits SYSTEM "credits.docbook"> + <!ENTITY faq-sound SYSTEM "sound.docbook"> + <!ENTITY faq-qt SYSTEM "qt.docbook"> + +]> +<!--Time-stamp: "2001-09-03 00:10:00 endres"--> +<book lang="&language;"> + +<bookinfo> +<title>&tde; Frequently Asked Questions</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1997-2005</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> <para>This is a collection of frequently asked +questions about the Trinity Desktop Environment. Please report any bugs, +inconsistencies, or omissions you find in this &FAQ; to +<email>[email protected]</email>. Please post +questions to the &tde; mailing lists. Questions are monitored to help +maintain this &FAQ;.</para> </abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>FAQ</keyword> +<keyword>question</keyword> +<keyword>answer</keyword> +</keywordset> +</bookinfo> + +&faq-about; +&faq-intro; +&faq-gettde; +&faq-install; +&faq-panel; +&faq-desktop; +&faq-winmng; +&faq-filemng; +&faq-webbrowse; +&faq-configtde; +&faq-tdeapps; +&faq-sound; +&faq-nontdeapps; +&faq-tips; +&faq-misc; +&faq-qt; +&faq-moreinfo; +&faq-questions; +&faq-contrib; + +<chapter id="credits"> +<title>Credits and License</title> + +<!--<para>The current &FAQ; maintainers are:</para> + +<itemizedlist> +<listitem><para>J Hall +<email>[email protected]</email></para></listitem> +</itemizedlist>--> + +<para>Many of the answers in this &FAQ; are taken +from various mailing lists and newsgroups. Here is a +<emphasis>big</emphasis> thank you to all of you who have contributed +answers that eventually appear in this &FAQ;.</para> + +<para>Special thanks go to the former &FAQ; +maintainers, Rainer Endres, Mr. Lee Wee Tiong, and J. Hall.</para> + + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +</chapter> + +&documentation.index; +</book> diff --git a/doc/khelpcenter/faq/install.docbook b/doc/khelpcenter/faq/install.docbook new file mode 100644 index 000000000..91ebbbb5c --- /dev/null +++ b/doc/khelpcenter/faq/install.docbook @@ -0,0 +1,648 @@ +<!-- <?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="install"> +<title>Installation instructions</title> + +<para>These are the generic installation instructions for the Trinity +Desktop Environment. Please complement your reading with the +<filename>README</filename> and <filename>INSTALL</filename> text files that +come along with the package. Please read them carefully and try to +help yourself if anything goes wrong. If you need further +assistance, consider joining the &tde; mailing lists +(see our web site instructions for joining the &tde; +<ulink url="http://www.trinitydesktop.org/mailinglist.php">mailing +lists</ulink>).</para> + + +<qandaset> + + +<qandaentry> +<question> +<para>To the would-be converts</para> +</question> +<answer> + +<para>You have heard rumors about &tde;. Or you have seen screenshots. +You want test &tde;. Yet you know next to nothing +about this whole <quote>alternate operating system</quote> business. Don't worry! +You only need to do some (well, maybe not some) reading, that's all!</para> + +<para>&tde; does not run on any version of &Microsoft; &Windows;. To run +&tde;, you need to have a &UNIX; operating system. Please refer to <xref +linkend="platform"/> for more details.</para> + +<para>Decide on a platform and set it up for your system. This +<acronym>FAQ</acronym> can not help you with this, since &tde; is intended +to run on many &UNIX; platforms.</para> + +<para>To obtain &tde;, please refer to <xref linkend="where-to-get-tde"/>. If +you encounter problems while installing &tde;, please do not +hesitate to make use of the &tde; <link +linkend="mailing-lists">mailing lists</link>. No question is too silly to ask, but +remember to first look for answers in this <acronym>FAQ</acronym>.</para> +<para>Good luck and have fun!</para> + +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What kind of hardware do I need to run &tde; ?</para> +</question> +<answer> +<para>To run &tde; consider at least a Pentium III processor, 512MB of memory, and 500MB of free disk space for a basic installation. A full installation will require about 3GB of hard drive storage space. While &tde; will run on slower hardware, performance likely will require some patience. Generally, if your computer runs other desktop environments then the hardware probably is capable of running &tde;.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Available package formats</para> +</question> +<answer> + + +<para>You can find binary and source packages for +different distributions and operating systems on the +<ulink url="http://www.trinitydesktop.org/installation.php">Trinity web site</ulink>. +The binary packages are made by dedicated members of the &tde; community. +The only <quote>official</quote> release is the source tarball +packages. Please refer to the <filename>README</filename>s and +<filename>INSTALL</filename>s in the several binaries folders. +Find the latest stable release +<ulink url="http://www.trinitydesktop.org/releases.php">here</ulink>.</para> + +</answer> +</qandaentry> + +<qandaentry> +<question id="prerequisites"> +<para>Prerequisites</para> +</question> +<answer> + +<!-- rewrite to make it more general, pointing to the according webpages? --> + +<para>You need the &Qt; library as provided by the &tde; developers. Previous +versions of &Qt; will not work with the latest &tde;. +Please ensure you download the correct &Qt;. You will +also need the header files, if you want to compile &tde; +yourself. They are all available, at no cost, from the <ulink +url="http://www.trinitydesktop.org/">&tde; repository</ulink>. +There are optional libraries that might improve &tde; if +installed on your system. An example is OpenSSL which will enable +&konqueror; to browse web pages securely. These additional packages +should be provided by your distributor.</para> + +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Description of the base packages</para> +</question> +<answer> +<para>The base distribution currently consists of several +packages. Some are required, while others are optional. Each package +is available in each of the aforementioned package formats.</para> + +<variablelist> +<varlistentry> +<term>tqt3</term> +<listitem> +<para>Required</para> +<para>This package contains the foundational widget support needed by all +&tde; applications.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tqtinterface</term> +<listitem> +<para>Required</para> +<para>Necessary for supporting subsequent versions of Qt.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>arts</term> +<listitem> +<para>Required</para> +<para>The core sound system for &tde;</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdelibs</term> +<listitem> +<para>Required</para> +<para>This package contains shared libraries that are needed by all +&tde; applications.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdebase</term> +<listitem> +<para>Required</para> +<para>This package contains the base applications that form the core +of the Trinity Desktop Environment like the window manager, the terminal +emulator, the control center, the file manager, and the panel.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>&arts;</term> +<listitem> +<para>Required</para> +<para>The &arts; sound server. A powerful, network transparent sound +server.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeaddons</term> +<listitem> +<para>Optional but recommended</para> +<para>Various plugins for &kate;, &kicker;, &knewsticker;, &konqueror; and &noatun; </para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeartwork</term> +<listitem> +<para>Optional</para> +<para>Additional wallpapers, themes, styles, sounds ...</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdebindings</term> +<listitem> +<para>Optional</para> +<para>Various bindings for other languages, including &Java;, Perl, Python, ...</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdegames</term> +<listitem> +<para>Optional</para> +<para>Various games like &kmahjongg;, &ksnake;, &kasteroids;, and +&kpatience;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdegraphics</term> +<listitem> +<para>Optional but recommended</para> +<para>Various graphics-related programs like &PostScript; previewer, +&DVI; previewer, and a drawing program.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeutils</term> +<listitem> +<para>Optional but recommended</para> +<para>Various desktop tools like a calculator, an editor and other +nifty stuff.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdemultimedia</term> +<listitem> +<para>Optional but recommended</para> +<para>Multimedia applications like a &CD; player and a mixer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdenetwork</term> +<listitem> +<para>Optional</para> +<para>Network applications. Currently contains the instant messaging client &kopete;, the +download manager &kget;, and several other network-related programs.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdepim</term> +<listitem> +<para>Optional but recommended</para> +<para>Personal information management tools. Contains the email client &kmail;, the newsreader &knode; and other related programs.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeadmin</term> +<listitem> +<para>Optional but recommended</para> +<para>System administration programs.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeedu</term> +<listitem> +<para>Optional</para> +<para> +Educational and entertaining applications for &tde;'s younger users. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdeaccessibility</term> +<listitem> +<para>Optional but recommended</para> +<para> +&tde; accessibility programs such as a screen magnifier and speech synthesizer front end. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdetoys</term> +<listitem> +<para>Optional</para> +<para>Toys!</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdevelop</term> +<listitem> +<para>Optional</para> +<para>A complete Integrated Development Environment for &tde; and &Qt;</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdewebdev</term> +<listitem> +<para>Optional</para> +<para>Web development applications. Contains such applications as &quanta;, an integrated web development environment and other applications useful in web development</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tdesdk</term> +<listitem> +<para>Optional</para> +<para>&tde; Software Development Kit. Contains a collection of applications and tools used by &tde; Developers.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Information about compiling all packages is available at the +<ulink url="http://www.trinitydesktop.org/wiki/bin/view/Developers/HowToBuild"> +Trinity wiki</ulink>.</para> + +<para>Most package management tools will let you put all these +packages in one folder and install them all at once, figuring out +the dependencies as they go.</para> + +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Installation instructions for the different package formats</para> +</question> +<answer> +<para>As &tde; is intended for many &UNIX; systems, please consult the installtion +procedures and package management document for the system being used.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Post-installation procedures</para> +</question> +<answer> +<para>There should be nothing to do after installing the packages except use them! +Nonetheless, should problems arise, there are some common problems to consider:</para> + +<variablelist> + +<varlistentry> +<term>System search path</term> +<listitem> +<para>Be sure all &tde; binary files are installed +in a location listed in your system's <envar>PATH</envar>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Library files</term> +<listitem> +<para>Be sure the &tde; library files are installed in the expected locations for your +system.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><envar>TDEDIR</envar> environment variable</term> +<listitem> +<para>Be sure the <envar>TDEDIR</envar> environment variable is correctly set.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>starttde</filename> script installation</term> +<listitem> +<para>Verify the <filename>starttde</filename> script is installed to <filename +class="directory">$<envar>TDEDIR</envar>/bin</filename> and therefore in your +system's search path.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><filename>starttde</filename> script is run correctly</term> +<listitem> +<para>Be sure the <filename>starttde</filename> script is being run from within the appropriate +xinitrc or xsession script.</para> +</listitem> +</varlistentry> + +</variablelist> + +<para>This should present you with a new &tde; desktop. You +can now start to explore the wonderful world of &tde;. In case you +want to read some documentation first, there is a recommended +<ulink url="help:/khelpcenter/quickstart">A Quick Start Guide to the Desktop</ulink> +available. Furthermore, every application has an online +help that is available via the <guimenu>Help</guimenu> menu.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Should I remove old version xyz before installing a new +one?</para> +</question> +<answer> +<para>In principle, this is not necessary. The various distro package managers +should handle all dependencies.</para> +<para>If you compile the source code yourself, you should take more care.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="starttde"> +<para>How do I start &tde;?</para> +</question> +<answer> +<para>There are only two methods of starting &tde;: using a login +manager such as &tdm; or from the command line, using <command>startx</command>. +The respective startup scripts should contain a reference to the +<filename>starttde</filename> script.</para> +</answer> +</qandaentry> +<!-- Still needed? +<qandaentry> +<question> +<para>Whenever I start &tde;, it complains about "shadow passwords". +Why?</para> +</question> +<answer> +<para>When your system uses shadow passwords, the screensaver can only +run properly if the suid bit is set. This bit gives the screensavers +root privileges, which are needed to access the shadow passwords. +<caution><para>The screensavers might be configured to secure the +machine until the password is entered.</para></caution></para> +<procedure> +<title>Setting the suid bit on the screensavers</title> +<step performance="required"><para>become root</para></step> +<step performance="required"><para><command>chown root +$<envar>TDEDIR</envar>/bin/*.kss</command></para></step> +<step performance="required"><para><command>chmod u+s +$<envar>TDEDIR</envar>/bin/*.kss</command></para></step> +</procedure> +<para>Alternatively, if you compile &tde; from source, you can use +<command>./configure <option>with-shadow</option></command> to +configure tdebase. Then the suid bit is set automatically during +<command>make install</command>.</para> +</answer> +</qandaentry> +--> + +<qandaentry> +<question> +<para><command>starttde</command> fails with <errorname>can not connect to X +server</errorname>. What is wrong?</para> +</question> +<answer> +<para>You probably tried to start &tde; directly with <command>starttde</command> rather +than letting the login manager or startx process run that script. From the command +line the X server is started with <command>startx</command>. +<command>starttde</command> is the +script that should be run from your <filename>.xinitrc</filename>, <filename>.xsession</filename>, or +<filename>.Xclients</filename> to activate the window manager and the necessary server +daemons for &tde;. See also <xref linkend="starttde"/>.</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>&tde; on &AIX;?</para> +</question> +<answer> +<para> +<acronym>IBM</acronym> now officially support &tde; on &AIX;. You can find +details at <ulink +url="http://www.ibm.com/servers/aix/products/aixos/linux/index.html">http://www.ibm.com/servers/aix/products/aixos/linux/index.html</ulink>. +There is also some older information at <ulink url="http://space.twc.de/~stefan/kde/aix.html">http://space.twc.de/~stefan/kde/aix.html</ulink>.</para> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question> +<para>&tde; on a laptop?</para> +</question> +<answer> +<para>If you can get &X-Window; to run on your laptop, you should not have any problem +getting &tde; to run on it. In addition, you might find the following +links helpful:</para> +<itemizedlist> +<listitem> +<para><ulink url="http://www.linux-laptop.net/">http://www.linux-laptop.net/</ulink></para> +</listitem> +<listitem> +<para><ulink url="http://www.sanpei.org/Laptop-X/note-list.html">http://www.sanpei.org/Laptop-X/note-list.html</ulink></para> +</listitem> +</itemizedlist> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question> +<para>I do not like the default &tde; folder after installation. How +do I move it without breaking anything?</para> +</question> +<answer> +<para>Assuming the default is <filename +class="directory">/opt/kde</filename> and you want to move it to +<filename class="directory">/usr/local/kde</filename>, here's what +you have to do:</para> +<procedure> +<step performance="required"><para>change to superuser if you aren't already</para></step> +<step performance="required"><para><command>mv /opt/kde /usr/local/kde</command></para></step> +<step performance="required"><para><command>ln -s /usr/local/kde +/opt/kde</command></para></step> +</procedure> +<para>This will put all your &tde; files in <filename +class="directory">/usr/local/kde</filename> but everything is +still accessible from <filename +class="directory">/opt/kde</filename>.</para> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question> +<para>What files can I delete from my &tde; install folder? Can all the +<filename>*.h</filename>, <filename>*.c</filename> and <filename>*.o</filename> +files be safely removed?</para> +</question> +<answer> +<para>There should not be any need to keep the <filename>.c</filename> and +<filename>.o</filename> files, but you might want to keep the +<filename>.h</filename> files, as they are used by includes if you ever want to +compile your own &tde; programs. But if you wish to add patches to the source +programs as they become available (rather than downloading everything again), +then they should stay.</para> +</answer> +</qandaentry>--> + +<qandaentry> +<question> +<para>Will I lose my current settings when I update &tde;?</para> +</question> +<answer> +<para>You shouldn't. &tde; should transport your settings +intact. All settings should be safe.</para> +</answer> +</qandaentry> + +<qandaentry id="greyscreen"> +<question> +<para>I updated &tde; and all seemed to go fine, but when I start &tde;, +I get a blank gray screen, and nothing happens. There are errors in +the console about DCOPserver. What's going on?</para> +</question> + +<answer> +<para> +&tde; uses several temporary files during its operation. +Usually these directories and files are found in the following locations:</para> +<itemizedlist> +<listitem><para><filename>$HOME/.DCOPserver-*</filename> (there are usually two of these; one is a symlink to the other)</para></listitem> +<listitem><para><filename>$HOME/.trinity/socket-<replaceable>hostname</replaceable></filename></para></listitem> +<listitem><para><filename>$HOME/.trinity/tmp-<replaceable>hostname</replaceable></filename>, which normally is a symlink to the next file:</para></listitem> +<listitem><para><filename>$TMP/tde-<replaceable>USER</replaceable></filename></para></listitem> +<listitem><para><filename>$HOME/.trinity/socket-<replaceable>hostname</replaceable></filename>, which normally is a symlink to:</para></listitem> +<listitem><para><filename>$TMP/tdesocket-<replaceable>USER</replaceable></filename></para></listitem> +</itemizedlist> + +<para>If the symlinks get broken, such as when +<command>cron</command> or a shutdown script is emptying the +<filename class="directory">/tmp</filename> folder, then strange +things will happen. These files, and the symlinks, will all be +created automatically at the start of &tde; so you can safely remove +them <emphasis>while &tde; is not running</emphasis>.</para> + +<para>If you are only getting a gray screen when you start &tde;, or if you get an error message telling you to <errorname>Check your installation</errorname>, then shut down X and delete all the files listed above, then try to restart X.</para> + +<para>Normally (&ie; when not updating between &tde; versions) it's +quite safe to leave these files intact, and you may shave a few +seconds off your &tde; startup time by doing so.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is &tde; backwards or binary compatible with KDE 3?</para> +</question> +<answer> +<para>While many programs originally designed for KDE 3 will compile on Trinity, binary +compatibility with KDE 3 is not a goal of &tde; developers.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is &tde; backwards or binary compatible with previous releases of &tde;?</para> +</question> +<answer> +<para>Possibly, but binary compatibility is not a project goal with major point +releases. A package that built on a previous version of &tde; but no longer builds +on the current release should be brought to the attention of the developers.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is my KDE 3 profile directory compatible with Trinity?</para> +</question> +<answer> +<para>Not quite but don't worry. Some "scrubbing" cleanup is required to migrate +a KDE 3 profile. For new users or those with little customization we recommend +creating a fresh profile. For those long-time users who cringe at the thought +of recreating their desktop, we provide a migratekde3 shell script. That script +copies a $HOME/.kde3 profile directory to $HOME/.trinity and performs the required +"scrubbing" cleanup. Although the script has been tested we provide the tool "as is" +with no warranties or guarantees. (The script works really well, actually. :-))</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>Compiling tdebase gives me a <errorname>bin/sh: msgfmt: command +not found</errorname> error!</para> +</question> +<answer> +<para>You need the &GNU; <application>msgfmt</application> which is +part of the &GNU; i18n package <application>gettext</application>. +You should be able to download it from any +&GNU; mirror.</para> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question> +<para>How do I uninstall &tde; applications compiled from +source?</para> +</question> +<answer> +<para>You can uninstall your programs by typing <command>make +uninstall</command> in the folder where you did <command>make +install</command>. If you have already deleted that folder, +then there is only one way, and it is not good: go to <filename +class="directory">$<envar>TDEDIR</envar>/bin</filename> and start deleting files +one by one.</para> +<para>If you expect to find yourself in this situation, you might want to +consider a program such as &GNU; <application>stow</application>, found at +<ulink url="http://www.gnu.org/software/stow/stow.html">http://www.gnu.org/software/stow/stow.html</ulink>.</para> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question id="gif"> +<para>What is up with &GIF; support?</para> +</question> +<answer> +<para>This has to do with issues with Unisys' &LZW; patent. &GIF; +support is turned off from &Qt; 1.44 onwards by default. When you want to use +&GIF;s and have the relevant license, recompile &Qt; with &GIF; support. +<command>./configure <option>-gif</option></command>.</para> +</answer> +</qandaentry>--> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/intro.docbook b/doc/khelpcenter/faq/intro.docbook new file mode 100644 index 000000000..720b2bc61 --- /dev/null +++ b/doc/khelpcenter/faq/intro.docbook @@ -0,0 +1,218 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="introduction"> +<title>Introduction</title> + +<qandaset> +<qandaentry> +<question> +<para>What is &tde;?</para> +</question> +<answer> +<para>&tde; is the Trinity Desktop Environment. The project was initiated +by Matthias Ettrich in 1996 and originally called the K Desktop Environment. +The aim of the &tde; project is to connect the power of the &UNIX; operating +systems with the comfort of a modern user interface.</para> +<para>For additional information about &tde;, check the Trinity web site at +<ulink url="http://www.trinitydesktop.org/about.php">About Trinity</ulink></para> +</answer> +</qandaentry> + +<qandaentry> +<question id="platform"> +<para>On which platforms can I expect &tde; to work?</para> +</question> +<answer> +<para>&tde; is a Desktop Environment for all flavors of &UNIX; systems. +While most &tde; developers use &Linux; based systems, &tde; should run +on a wide range of systems. You might need to tweak the +source code a bit to get &tde; to compile on different variant +of &UNIX; systems, or when not using the &GNU; development tools, in +particular the &gcc; compiler.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why should I use TDE?</para> +</question> +<answer> +<para>TDE provides a traditional computer desktop that is snappy and +responsive. A project goal is to provide a highly customizable +desktop without forcing any particular feature or effect on users. +TDE comes with many software tools to provide a productive and enjoyable +computer desktop system.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is &tde; a window manager?</para> +</question> +<answer> +<para>No, &tde; is not a window manager. While &tde; includes a +sophisticated window manager (&twin;), &tde; is much more, providing +a full integrated desktop environment. &tde; includes a web browser, +a file manager, a window manager, a help system, a +configuration system, many tools and utilities, and many +applications, including but not limited to mail +and news clients, drawing programs, a PDF and a &DVI; viewer +and so forth.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is &tde; a <acronym>CDE</acronym>, &Windows; or &Mac; +<acronym>OS</acronym> clone?</para> +</question> +<answer> +<para>&tde; is not a clone. Specifically &tde; is not a +Common Desktop Environment (<acronym>CDE</acronym>) or &Windows; clone. +While developers have and will continue to glean the best features from existing +desktop environments, &tde; is a unique environment that has and +will continue to go its own way.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>On what platform is TDE based?</para> +</question> +<answer> +<para>TDE uses C++ and the <link linkend="qt">&Qt; C++ crossplatform toolkit</link>. +The TDE development team now maintains the Qt3 toolkit, renamed TQt3.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is &tde; free software?</para> +</question> +<answer> +<para>Yes, &tde; is free software according to the &GNU; General +Public License. All &tde; libraries are available under the +<acronym>LGPL</acronym> making commercial software development for the +&tde; desktop possible, but all &tde; applications are licensed under +the <acronym>GPL</acronym>.</para> +<para>&tde; uses the <link linkend="qt">&Qt; C++ crossplatform +toolkit</link>, which, since version 2.2, is released under the +<acronym>GPL</acronym>.</para> +<para>Both &tde; and &Qt; can be made available on +&CD-ROM; free of charge. No runtime fees of any kind are +incurred.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why the rebranding and renaming efforts? Why not continue calling the software KDE?</para> +</question> +<answer> +<para>The "KDE" name, various logos, and related efforts are trademarked by the KDE +Foundation. Since the Trinity project is not affiliated with the KDE Foundation, +legally we can't use their trademarks.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why the change in version numbers?</para> +</question> +<answer> +<para>Trinity evolved from the last KDE 3.5 release, 3.5.10. Subsequent Trinity releases +followed that numbering scheme. Release R14.0.0 marks a turning point in Trinity history +because a great deal of the code infrastructure was changed. While those changes do not +effect the usability or look-and-feel of the desktop that users enjoy, Trinity developers +believe a change in the version scheme distinguishes when those changes occurred. An +original project goal by users was to retain the flavor of the original KDE 3.5 desktop. +That goal remains intact. To reflect that original goal, the last number in the original +version scheme is retained in the new version scheme but is now the primary version number. +While the infrastructure has changed, the desktop itself remains the same as the original +KDE 3.5. This new version scheme indicates a modest divergence from the original KDE 3.5 +series and that Trinity is now its own desktop environment. The new version scheme reminds +users that Trinity retains the original KDE 3.5 design, but is moving forward as a separate +desktop project.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="trinity-vs-kde4"> +<para>How is Trinity different from KDE4?</para> +</question> +<answer> +<para>Both desktop environments share common roots to KDE 3.5.10, which was the last +official release of KDE in the 3.x series. Many KDE developers wanted to break +from that code chain and tool sets to start afresh. Thus was born KDE4. In +addition to moving to the Qt4 tool set, the KDE developers revamped the +underlying KDE code set.</para> + +<para>KDE4 and Trinity have different philosophies about work flow preferences. +KDE4 developers want to support certain work flow concepts and techniques. +Trinity developers want to maintain a "traditional" desktop environment.</para> + +<para>For example, KDE4 offers the following tools:</para> + +<itemizedlist> + +<listitem> +<para>Semantic desktop through Nepomuk</para> +</listitem> + +<listitem> +<para>PIM (Personal Information Management) data caching through Akonadi</para> +</listitem> + +<listitem> +<para>Desktop file searching through Strigi</para> +</listitem> + +<listitem> +<para>Activities, a computer desktop metaphor for managing tasks and activities</para> +</listitem> + +</itemizedlist> + +<para>Whereas TDE offers the following:</para> + +<itemizedlist> + +<listitem> +<para>Desktop search through the locate:/ tdeio-slave</para> +</listitem> + +<listitem> +<para>Integrated PIM suite with plugins</para> +</listitem> + +<listitem> +<para>Related task management using multiple desktops</para> +</listitem> + +</itemizedlist> + +<para>The KDE developers support alternate desktop interfaces, such as those used +with netbooks, tablets, and smart phones. TDE provides a single interface that is +optimized for the mouse/keyboard HCI (Human-computer interaction) model.</para> + +<para>Both desktop environments provide an excellent choice for various work +flows but differ in approach. Trinity leans toward user expectations of how +desktop environments have functioned traditionally. There is a sense of +familiarity with that environment many people like. Similarly other users prefer +the work flow features offered by KDE4 because those features match their +expectations of how they want their computer to behave. The difference between the +two environments does not mean one is better, buggier, or slower -- mdash; only that +they are different and appeal to different types of people. Although sharing a +common heritage, both desktops appeal to different groups of people. As always +with free/libre software, there is a choice.</para> +</answer> +</qandaentry> + + +</qandaset> +</chapter> + diff --git a/doc/khelpcenter/faq/misc.docbook b/doc/khelpcenter/faq/misc.docbook new file mode 100644 index 000000000..0dd2c4556 --- /dev/null +++ b/doc/khelpcenter/faq/misc.docbook @@ -0,0 +1,243 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="misc"> +<title>Miscellaneous questions</title> + +<qandaset> + + +<qandaentry> +<question> +<para>Does &tde; support transparency and other visual effects provided by the new composite extension to X.org?</para> +</question> +<answer> +<para>Yes. &tde; supports for the X composite extension and provides its own compositor. This allows for effects such as translucency and drop shadows for all windows, easily configurable through &twin;'s configuration dialog. For those using an xorg.conf file, be sure the following is included: + +<screen> +Section "Extensions" +Option "Composite" "Enable" +EndSection +</screen> + +<!-- This option is enabled by default --> +<!--Those users with an Nvidia graphics card and driver can improve the performance of these effects by adding the RenderAccel option to the Device section for the graphics card: + +<screen> +Section "Device" + Identifier "nvidia-fx5200" + Driver "nvidia" + Option "RenderAccel" "true" +</screen>--> +After correctly configuring xorg.conf, transparency and other effects can be enabled through the <menuchoice><guimenu>Desktop</guimenu><guimenuitem>Window Behavior</guimenuitem></menuchoice> &kcontrolcenter; module, under the <guilabel>Translucency</guilabel> tab. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What about &tde; programs that do not have icons? How do I get +them into the menu?</para> +</question> +<answer> +<para>Use &kmenuedit;. To access it use the &RMB; on the +<guibutton>T</guibutton> button and select <guimenu>Menu Editor</guimenu>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Does &tde; have a graphical &FTP; client?</para> +</question> +<answer> +<para>Yes, and it is none other than your favorite file +manager, &konqueror;. You can drag and drop remote files into local +folders.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I exit &tde;?</para> +</question> +<answer> +<para>On the panel (kicker) use the &LMB; to select the <guibutton>T</guibutton> +button and select <guimenu>Log Out...</guimenu>. Another method is to use the &RMB; +to select an empty area of the desktop, which opens a popup menu, +containing <guimenu>Log Out...</guimenu> as one of the options. +Another option is to use a keyboard shortcut, which on many systems is +<keycombo action="simul">&Ctrl;&Alt;<keycap>Delete</keycap></keycombo>. +A fourth option is to add the <application>Lock/Logout</application> button applet. +<note><para>Depending on your configuration of the &X-Window;, <keycombo +action="simul">&Ctrl;&Alt;&Backspace;</keycombo> +might also exit &tde; by killing the X server, but using that shortcut prevents +session management and is recommended only for emergencies.</para></note></para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is there a program that checks for new mails at my +<acronym>ISP</acronym> if and only if I am online?</para> +</question> +<answer> +<para>&korn; will do the job. If you are not +connected, it will just sit there (idling).</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is it really necessary to update to the latest version?</para> +</question> +<answer> +<para>We recommend updating to the latest stable release, or at least to stay within +a release version. Otherwise, getting answers to questions might be challenging. +Each release always contains bug fixes and enhancements. Often a problem with an old version +has been fixed in a more recent release. Newer versions also fix security problems. Only seldom are bug and security fixes backported to older releases.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I copy and paste in &tde;?</para> +</question> +<answer> +<para>The simplest method is to use your mouse:</para> +<procedure> +<step performance="required"><para>Highlight the text you want to copy by holding down the +&LMB; and dragging across the text. This adds the selected text to the clipboard.</para></step> +<step performance="required"><para>Go to the destination area; depending on your configuration, +you might need to click it using the &LMB; to give it +focus.</para></step> +<step performance="required"><para>Click the &MMB; to paste. If you have a two +button mouse and are emulating a three button mouse, push both buttons +simultaneously.</para></step> +</procedure> +<para>The standard keyboard shortcuts for copying is <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>, to cut is <keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>, and to paste is <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>.</para> +<para>&tde; provides a multiple layer clipboard called &klipper;. Refer to the <ulink +url="help:/klipper">&klipper; handbook</ulink> for further information.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I convert the default &RedHat; menus into a menu in the +<guimenu>TDE</guimenu> menu?</para> +</question> +<answer> +<para>Click on the <guibutton>T</guibutton> button and select +<menuchoice><guimenu>System</guimenu><guimenuitem>Appfinder</guimenuitem></menuchoice>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="GIT"> +<para>What is <acronym>GIT</acronym>?</para> +</question> +<answer> +<para>GIT is a distributed version control and source code management system. +GIT is used to maintain source code under development. The &tde; developers use GIT. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Does &tde; support dual screen (Xinerama)?</para> +</question> +<answer> +<para>Yes, you need to have a multi-headed X server. +</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>Why does Drag and Drop not work with Xinerama?</para> +</question> +<answer> +<para>You should update to XFree86 4.2.0 for this to work properly.</para> +</answer> +</qandaentry>--> + +<qandaentry> +<question> +<para>How do I check which version of &tde; I am using?</para> +</question> +<answer> +<para>Start any Trinity app. Each app has a Help menu providing +related information in the <guimenuitem>About</guimenuitem> dialog. +</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>How do I create themes and icons?</para> +</question> +<answer> +<para>Go see <ulink +url="http://artist.kde.org">http://artist.kde.org</ulink>. +There is also a more informal community of &tde; related artists and +artwork at <ulink url="http://kde-look.org">http://kde-look.org</ulink>. +</para> +</answer> +</qandaentry>--> + +<qandaentry> +<question> +<para>How do I learn about development updates?</para> +</question> +<answer> +<para>You might want to subscribe to the +<ulink url="http://www.trinitydesktop.org/mailinglist.php"> +&tde; developer's mail list</ulink>. +Refer to <ulink url="http://trinity-devel.pearsoncomputing.net/">http://trinity-devel.pearsoncomputing.net/</ulink> +if you want to read without subscribing.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is there a release schedule?</para> +</question> +<answer> +<para>The Trinity developers strive for a six to nine month schedule but that is not rigid or set in stone.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Are there plans to support semantic desktops?</para> +</question> +<answer> +<para>Not at this time.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Are there plans to support tablet-like or special netbook desktop modes?</para> +</question> +<answer> +<para>No. The TDE team suggests a tablet-centric interface such as Unity, KDE4, or GNOME 3 for those devices.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do the developers propose to transition away from HAL (hardware abstraction layer)?</para> +</question> +<answer> +<para>The Trinity team developed a new native hardware support layer that is under testing. +That new system will be enabled by default in a future release, but is available now +in the development sources.</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/moreinfo.docbook b/doc/khelpcenter/faq/moreinfo.docbook new file mode 100644 index 000000000..f9d619456 --- /dev/null +++ b/doc/khelpcenter/faq/moreinfo.docbook @@ -0,0 +1,137 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="more-info"> +<title>Getting more information</title> + +<qandaset> +<qandaentry> +<question> +<para>Where is the &tde; homepage?</para> +</question> +<answer> +<para>The &tde; homepage is located at <ulink +url="http://www.trinitydesktop.org/">http://www.trinitydesktop.org/</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="mailing-lists"> +<para>Is there a &tde; mailing list?</para> +</question> +<answer> +<para>There are several &tde; mailing lists. Each focuses on a different +aspect of &tde;. Some are for developers, so they are not +discussed in detail. Some of the more important lists that users +might be interested in are:</para> + +<variablelist> +<varlistentry> +<term><ulink url="http://www.trinitydesktop.org/mailinglist.php">tde-users</ulink></term> +<listitem><para>For general discussion, users helping each other.</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="http://www.trinitydesktop.org/mailinglist.php">tde-announce</ulink></term> +<listitem><para>Announcements of &tde; news</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="http://www.trinitydesktop.org/mailinglist.php">tde-devel</ulink></term> +<listitem><para>For developers, artists, documentation writers.</para></listitem> +</varlistentry> +</variablelist> + +<para>For the complete list of mailing lists available, please refer +to <ulink +url="http://www.trinitydesktop.org/mailinglist.php">http://www.trinitydesktop.org/mailinglist.php</ulink>.</para> +<para>Please note that it is not a good idea to ask questions that are +already answered in this &FAQ;.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="subscribe"> +<para>How do I subscribe/unsubscribe to these lists?</para> +</question> +<answer> +<para>To subscribe, follow the directions here: +<ulink url="http://www.trinitydesktop.org/mailinglist.php">Official Mailing Lists</ulink> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is there a mailing list archive?</para> +</question> +<answer> +<para>Yes, each list has a searchable archive: + +<variablelist> +<varlistentry> +<term><ulink url="http://trinity-users.pearsoncomputing.net/">tde-users</ulink></term> +<listitem><para>General discussion archives.</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="http://trinity-announce.pearsoncomputing.net/">tde-announce</ulink></term> +<listitem><para>Announcement archives.</para></listitem> +</varlistentry> + +<varlistentry> +<term><ulink url="http://trinity-devel.pearsoncomputing.net/">tde-devel</ulink></term> +<listitem><para>Developers, artists, documentation writer archives.</para></listitem> +</varlistentry> +</variablelist> + +</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question id="newsgroups"> +<para>Is there a newsgroup about &tde;?</para> +</question> +<answer> +<para>Yes, there is! It is at <literal>comp.windows.x.kde</literal>. +In addition, there is also a German newsgroup at +<literal>de.alt.comp.kde</literal>. Please note that it is not a good +idea to ask questions which are already answered in this +&FAQ;.</para> +</answer> +</qandaentry>--> + +<!--<qandaentry> +<question> +<para>Are there any other &tde;-related &FAQ;s?</para> +</question> +<answer> +<para>Yes. Here is a list of them:</para> +<itemizedlist> +<listitem><para><ulink +url="http://www.kde.org/info/faq.php">&tde; &FAQ;</ulink></para></listitem> +<listitem><para><ulink +url="http://konqueror.org/faq/">&konqueror; +&FAQ;</ulink></para></listitem> +<listitem><para><ulink +url="http://www.arts-project.org/doc/manual/index.html">aRts +sound server documentation</ulink></para></listitem>--> + +<!-- Removed because the kmail FAQ is part of the KMail manual and not a --> +<!-- separate document +<listitem><para><ulink +url="http://kmail.kde.org/manual/faq.html">&kmail; +&FAQ;</ulink></para></listitem> +--> + +<!--</itemizedlist> +</answer> +</qandaentry>--> + +</qandaset> +</chapter> + diff --git a/doc/khelpcenter/faq/nontdeapps.docbook b/doc/khelpcenter/faq/nontdeapps.docbook new file mode 100644 index 000000000..9fc3d70ad --- /dev/null +++ b/doc/khelpcenter/faq/nontdeapps.docbook @@ -0,0 +1,84 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="non-tde-apps"> +<title>&tde; with non-&tde; applications</title> + +<!-- FIXME: This seems to be obsolete. The only similar option is "Apply +*colors* to --> + +<!-- non-tde apps" --> +<qandaset> +<qandaentry> +<question> +<para>My non-&tde; applications like &Emacs; and +<application>kterm</application> are running amok with strange +colors!</para> +</question> +<answer> +<para>Start the <application>&tde; Control Center</application> and in +<menuchoice><guimenu>Appearance & Themes</guimenu><guimenuitem> +Colors</guimenuitem></menuchoice> uncheck the <guilabel>Apply colors to +non-TDE applications</guilabel> checkbox and click +<guibutton>Apply</guibutton>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I set my default web browser to be something other +than &konqueror;?</para></question> +<answer> +<para>Open the &kcontrolcenter; and +navigate to the <menuchoice><guimenu>TDE Components</guimenu><guimenuitem>Component +Chooser</guimenuitem></menuchoice> panel. Select <guilabel>Web +Browser</guilabel> from the list on the left, then select <guilabel>Open +http and https URLs in the following browser:</guilabel> and type in the +name of the browser (⪚ <application>mozilla</application>, +<application>firefox</application>, <application>opera</application>, &etc;) +in the textbox.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How can I configure the style and fonts of <acronym>GTK</acronym> +applications within &tde; ? +</para> +</question> +<answer> +<para> +Install the <application>qt-gtk-engine</application> package, which is available as part of &tde;. This +theme engine makes <acronym>GTK</acronym> applications look like your &tde; widget style +by calling functions from &Qt; instead of drawing the styles itself. Once +the theme engine has been installed, there will be a &kcontrolcenter; module +under <menuchoice><guimenu>Appearance & Themes</guimenu><guimenuitem>GTK +Styles and Fonts</guimenuitem></menuchoice>. +</para> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>I have been hearing about this gecko kpart or &Qt; Mozilla, how do I +get these?</para> +</question> +<answer> +<para> +Good luck! The &Qt; Mozilla code is in Mozilla cvs, and not very stable as +of yet. In order to use it, you'll have to check out Mozilla from cvs +according to these instructions: +<ulink url="http://www.mozilla.org/cvs.html"> +http://www.mozilla.org/cvs.html</ulink>. Then, configure either the Mozilla +suite or the Firefox browser with the option +<command>- -enable-default-toolkit=qt</command> in addition to any other +options you would like to enable. More instructions on building Mozilla can +be found <ulink url="http://www.mozilla.org/build">here</ulink>. +</para> +</answer> +</qandaentry>--> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/notrelated.docbook b/doc/khelpcenter/faq/notrelated.docbook new file mode 100644 index 000000000..5440341c1 --- /dev/null +++ b/doc/khelpcenter/faq/notrelated.docbook @@ -0,0 +1,232 @@ +<!-- if you want to validate this file separately, uncomment this prolog: + +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> + +--> + +<chapter id="not-kde"> +<title>Not really &tde;-related, but frequently asked nevertheless.</title> + +<qandaset> +<qandaentry> +<question> +<para>How do I change the screen resolution?</para> +</question> +<answer> +<para>Use <keycombo +action="simul">&Ctrl;&Alt;<keycap>+</keycap></keycombo> and <keycombo +action="simul">&Ctrl;&Alt;<keycap>-</keycap></keycombo> to cycle through +the resolutions you have defined in <filename>XF86Config</filename> (maybe under +<filename class="directory">/etc/X11</filename>; poke around first). +If you prefer to get your hands dirty, you can always edit the file +directly. By placing your favorite resolution at the beginning (or +making it the only one listed), &X-Window; will always start up with that +resolution. +<caution><para>Always make a backup copy of your <filename>XF86Config</filename> file +<emphasis>before</emphasis> you start editing it. Errors in this file +can render &X-Window; unusable.</para></caution> +<note><para>These instructions are only valid if you are running +version 3.3.x of the XFree86 server. If you are running XFree86 4.x, +you must consult with the <ulink url="http://xfree.org">XFree86(TM): +Home Page</ulink>.</para></note></para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I change the color depth?</para> +</question> +<answer> +<para>There is no way you can do this on the fly. You can either +start &X-Window; using <command>startx <option> -bpp +<replaceable>number</replaceable></option></command> where +<replaceable>number</replaceable> can be 8, 16, 24 or 32, depending on +the depth you want. Alternatively, if you are using +<application>xdm</application>/&tdm;, you +need to edit +<filename>/etc/X11/xdm/Xservers</filename> (may vary) and enter +<userinput>:0 local /usr/X11R6/bin/X -bpp 16</userinput> for 16 bit color +depth.</para> +<para>You can also edit the <filename>XF86Config</filename> file and add a line +like <userinput>DefaultColorDepth +<replaceable>number</replaceable></userinput> to Section "Screen". +The next time you start X, it will run with the newly-configured color +depth.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What can I do if I am using a 2-button mouse?</para> +</question> +<answer> +<para>Go buy a 3-button one, or use third button emulation. The third +button is emulated by pressing both the &LMB; and the &RMB; +together. You would need to enable <option>Emulate3Buttons</option> +in your <filename>XF86Config</filename> file.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What is a "sticky" window?</para> +</question> +<answer> +<para>In a virtual desktop environment with multiple virtual desktops, a +"sticky" window will stay put on the screen when you switch between +desktops, as if sticking to the glass of the screen. +<application>Xclock</application> is a typical candidate for sticking, +as you need to run only one instance of it, and it always stays with +you.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I replace the "X" mouse pointer with an arrow?</para> +</question> +<answer> +<para>The various types of cursor available in X are defined in +<filename class="headerfile">X11/cursorfont.h</filename>. You can +change it using <command>xsetroot -cursor_name +<replaceable>name_of_cursor</replaceable></command>. For example, I +have the following in my <filename>.Xclients</filename>:</para> +<screen> +xsetroot -cursor_name left_ptr +</screen> +<para>This will create the common left-angled pointer. To see other +alternatives, type <command>xfd -fn cursor</command>. And of course, +do not forget that <command>man xsetroot</command> is your +friend.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I extract/install diff files?</para> +</question> +<answer> +<para>To generate a context-diff suitable for patching, use +<command>diff -u <replaceable>old-file new-file</replaceable> > +<replaceable>patchfile</replaceable></command>. To apply the diff to +a file (<abbrev>i.e.</abbrev> "patch the file"), execute +<command>patch < <replaceable>patchfile</replaceable></command>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I get &Linux; to mount the floppy device for use with both +DOS and ext2 formatted floppies?</para> +</question> +<answer> +<para>Just specify the filesystem type as auto in +<filename>/etc/fstab</filename>. Auto detection works fine for DOS and +ext2.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I start &tde; with the <keycap>Num Lock</keycap> on?</para> +</question> +<answer> +<para>Have you tried <command>man setleds</command>? In addition, you +might want to edit your +<filename>$<envar>HOME</envar>/.Xmodmap</filename> and put the +following lines in:</para> +<screen> +! redefines numeric keypad to be used without NumLock +keycode 79 = 7 +keycode 80 = 8 +keycode 81 = 9 + +keycode 83 = 4 +keycode 84 = 5 +keycode 85 = 6 + +keycode 87 = 1 +keycode 88 = 2 +keycode 89 = 3 + +keycode 90 = 0 +keycode 91 = comma +keycode 86 = plus + +! deactivates NumLock key +keycode 77 = +</screen> +<para>Other possible alternatives:</para> +<itemizedlist> +<listitem><para><application>xkeycaps</application>: +<mousebutton>right</mousebutton> clicking should allow edits. You may +have to do this as root.</para></listitem> +<listitem><para><command>man XF86Config</command> and look under +section Keyboard.</para></listitem> +<listitem><para>Install <application>NumLockX</application>, which is +available from <ulink +url="http://dforce.sh.cvut.cz/~seli/en/numlockx">http://dforce.sh.cvut.cz/~seli/en/numlockx</ulink>.</para></listitem> +</itemizedlist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I take window or desktop screenshots?</para> +</question> +<answer> +<para>Use &ksnapshot;.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Is there a tool to make webpages?</para> +</question> +<answer> +<para>Yes, and there are a lot of them out there, including +<application>StarOffice</application>, <application>&Netscape; Composer</application>, and +<application>XEmacs</application>. +There are also many &tde; applications. To find the most current +list, go to <ulink url="http://kde-apps.org">kde-apps.org: The +Latest in &tde; Applications</ulink> and search for <emphasis>web +development</emphasis>. Try as many as possible and choose the one +most suitable to your needs.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What do all those acronyms like AFAIK mean?</para> +</question> +<answer> +<para><screen> +AAMOF: as a matter of fact +AFAIK: as far as I know +AISE: as I see it +BFN: bye for now +BION: believe it or not +BRB: be right back +BTW: by the way +CMIIW: correct me if I am wrong +FUD: fear, uncertainty, and doubt +FWIW: for what it's worth +FYI: for your information +HTH: hope this helps +IIRC: if I recall correctly +IMHO: in my humble opinion +LOL: laughing out loud +MYOB: mind your own business +PITA: pain in the ass +ROTFL: rolling on the floor laughing +RTFM: read the fine manual +SOP: standard operating procedure +TIA: thanks in advance +YMMV: your mileage may vary +</screen></para> +</answer> +</qandaentry> +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/panel.docbook b/doc/khelpcenter/faq/panel.docbook new file mode 100644 index 000000000..68330ac9a --- /dev/null +++ b/doc/khelpcenter/faq/panel.docbook @@ -0,0 +1,155 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="panel"> +<title>The panel</title> + +<qandaset> +<qandaentry> +<question> +<para>How do I add applications to the &tde; panel (&kicker;)?</para> +</question> +<answer> +<para>There are several ways to add an application to the panel. +The easiest is to right-click on the panel, and from the context +menu that appears, select <guimenu>Add Application to +Panel</guimenu>.</para> +<para>For more ways of adding buttons to the panel, refer to the +<ulink url="help:/kicker">Kicker</ulink> Handbook.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I change the menu <guibutton>T</guibutton> button of +the panel to another picture?</para> +</question> +<answer> +<para>The simplest way is to right-click on the panel, from the context menu +select <guimenu>Configure Panel</guimenu>, from the icon list on the left side, +select Menus, then inside the TDE Menu grouping, select the TDE Menu button icon. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>After updating &tde;, my &kmenu; appears to be empty! How can I get my menu back? +</para> +</question> +<answer> +<para> +User modifications to the &kmenu; are stored in +<filename>$<envar>HOME</envar>/.config/menus/applications-tdemenuedit.menu</filename>. +Try moving this file out of the way and then issuing the +command <userinput><command>tdebuildsycoca</command> +<option>--noincremental</option></userinput>. This should restore you to the +default system menus. If that is the case you'll have to recreate your customized menu. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>My desktop panel has disappeared. How can I get it +back?</para> +</question> +<answer> +<para>The panel disappearing is usually due to a crash. This might be +caused by loading an applet that has a fatal bug or a bad installation +of &tde; and/or the panel.</para> +<para>The easiest way to get the panel back is to launch the +<guilabel>Run Command</guilabel> window by pressing <keycombo +action="simul">&Alt;<keycap>F2</keycap></keycombo> and entering +<userinput><command>kicker</command></userinput>, and then pressing the +<guibutton>OK</guibutton> button.</para> +<para>If the panel continues to disappear, you may wish to either +remove or edit by hand your +<filename>$<envar>TDEHOME</envar>/share/config/kickerrc</filename> +file, where <filename +class="directory">$<envar>TDEHOME</envar></filename> is usually +<filename class="directory">~/.trinity</filename>. If you choose to edit +by hand, start by removing the applet entry groups.</para> +</answer> +</qandaentry> + +<!--<qandaentry><question> +<para>Where did the Icon Zooming option that used to be in &kicker; go? +</para></question> +<answer><para> +Icon zooming was not actively maintained and had caused severe bugs and usability issues. It was replaced in &tde; 3.4 by the new mouse over effects, which combine esthetics with useful information. +</para></answer> +</qandaentry>--> + +<qandaentry> +<question><para>How can I start an application minimized to the system +tray?</para> +</question> +<answer> +<para>Use <command>ksystraycmd</command>. For example, to start a &konsole; hidden +in the system tray, run <userinput><command>ksystraycmd </command> +<option>--hidden</option> <command>konsole</command></userinput>. For +more information about <command>ksystraycmd</command>, see the section +<quote>Advanced Window Management</quote> in the &tde; +<ulink url="help:/khelpcenter/userguide/windows-how-to-work.html#advanced-window-management"> +User Guide</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I use the &Windows; key to open the &kmenu;?</para> +</question> +<answer><para>Previous versions of &tde; provided a trick to allow you to +use the &Windows; key both as a modifier (so you could have shortcuts +like <keycombo action="simul"><keysym>Win</keysym><keycap>R</keycap> +</keycombo>), and as a regular key (so that pressing +<keysym>Win</keysym> on its own could open the &kmenu;). This feature +was removed for reasons of usability and accessibility, as well as +keeping the code clean. For current versions of &tde;, you have two +options: either use a different shortcut to open the &kmenu; (the +default is <keycombo action="simul">&Alt;<keycap>F1</keycap> +</keycombo>), or remap the <keysym>Win</keysym> key to be a regular +key, rather than a modifier.</para> + +<para>If you choose to do the second, here's one way: + +<orderedlist> +<listitem><para>Find the keycode for your <keysym>Win</keysym> key +using <command>xev</command>: Run the command +<userinput><command>xev</command></userinput> in a &konsole;, and +press the <keysym>Win</keysym> key. Look in the output of +<command>xev</command> for +<computeroutput>keycode <replaceable>n</replaceable></computeroutput>, +where <replaceable>n</replaceable> is the keycode of the +<keysym>Win</keysym> key.</para> +</listitem> + +<listitem><para>Use <command>xmodmap</command> to remap the +<keysym>Win</keysym> key. An appropriate command is <userinput><command>xmodmap +<option>-e</option> 'keycode +<replaceable>n</replaceable>=Menu'</command></userinput>.</para> +</listitem> + +<listitem><para>In the &kcontrolcenter;, go to +<menuchoice><guimenu>Regional & +Accessibility</guimenu><guimenuitem>Keyboard Shortcuts</guimenuitem> +</menuchoice> and set the shortcut for <guilabel>Popup Launch +Menu</guilabel> to the <keysym>Win</keysym> key. You should now be +able to popup the &kmenu; by pressing the <keysym>Win</keysym> key.</para> +</listitem> + +<listitem><para>One more step is required to save the changes across +settings: Create a file <filename>~/.trinity/env/win-key.sh</filename> +(create the directory if it doesn't exist), and add the +<command>xmodmap</command> command you used previously to it. The +change should now be applied every time you start &tde;.</para> +</listitem> +</orderedlist> +</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/qt.docbook b/doc/khelpcenter/faq/qt.docbook new file mode 100644 index 000000000..1254ec77e --- /dev/null +++ b/doc/khelpcenter/faq/qt.docbook @@ -0,0 +1,105 @@ +<chapter id="licensing"> +<title>&Qt; and Licensing questions</title> + +<qandaset> + +<qandaentry> +<question id="qt"> +<para>What is &Qt;, by the way?</para> +</question> +<answer> +<para>&Qt; is a C++-based class library to build user interfaces. It +also includes many utility classes like string classes and classes +to handle input and output. It +provides most of the widgets you will see in a &tde; application: +menus, buttons, sliders, &etc; &Qt; is a cross-platform library that +allows developers to write code that will compile on &UNIX; systems as well as +&Windows; and embedded devices. Learn more about &Qt; at <ulink +url="http://www.trolltech.com">http://www.trolltech.com</ulink>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why does &tde; use &Qt;?</para> +</question> +<answer> +<para>&Qt; is a sophisticated toolkit that provides everything that +needed to build a modern user interface. &Qt; is written in C++, thus +allowing object-oriented development which ensures efficiency and +code reuse in a project the size and scope of &tde;. In our opinion +there is no better toolkit available for &UNIX; systems and that it +would have been a grave mistake to try to build &tde; on anything but +the best.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why does &tde; not use gtk, xforms, xlib, whatever?</para> +</question> +<answer> +<para>There are a number of toolkits available. To provide a +consistent user interface and to keep used resources such as memory to +a minimum, &tde; can use only one of them. &Qt; was selected for the +reasons mentioned above.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>But &Qt; isn't free, is it?</para> +</question> +<answer> +<para>&Qt; is free/libre. Since September 4, 2000, version 2.2 of the &Qt; +libraries are licensed under the <acronym>GPL</acronym>, thereby +fulfiling all aspects of <quote>free/libre software</quote>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Can I write commercial software for &tde;?</para> +</question> +<answer> +<para>You can use the &tde; libraries to write <quote>commercial and +closed source</quote> as well as <quote>commercial and open +source</quote> software. If you write open source software you can +use the &Qt; free edition. If you write closed source software +you may not use the &Qt; free edition; you need to obtain the &Qt; +professional edition from Troll Tech. For more information, please +contact <ulink url="http://www.trolltech.com">Troll Tech</ulink> directly.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Isn't Qt3 obsolete and "dead" technology?</para> +</question> +<answer> +<para>The definition for "obsolete" varies based upon who applies the term. +Generally the term "obsolete" means something no longer is useful or no longer +needed. In software circles the term often means antiquated or no longer shiny. +Usefulness often is not part of the intended meaning of the word. The term is +used as an emotional wedge more than a factual observation.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Are there plans to migrate &tde; to Qt4 or Qt5?</para> +</question> +<answer> +<para>There are no such plans. Porting Trinity to Qt4 is 5 to 10 years of solid work with current project manpower. Indeed, the KDE4 team of developers needed several years to port KDE and they have many more developers.</para> + +<para>A fundamental project goal for maintaining Trinity is to keep alive the spirit and functionality of the original KDE3 concepts. Porting to Qt4 does not support that goal. Qt4 functionality is different from Qt3 (now TQt). Those differences conflict with how users want Trinity to function. The Qt4 environment is too different in focus and functionality to be used as the base toolkit of Trinity.</para> + +<para>The idea of integrating certain portions of the Qt4 code has not been abandoned. One of the original reasons for the TQt interface layer was to keep open the possibility of adapting portions of Trinity to Qt4. That has already been done. For example, with the qt4-tqt-theme-engine package for Trinity.</para> + +<para>More information about the philosophical and design differences between Trinity and KDE4 are available in <xref linkend="trinity-vs-kde4"/> of the FAQ introduction.</para> +</answer> +</qandaentry> + + +</qandaset> +</chapter>
\ No newline at end of file diff --git a/doc/khelpcenter/faq/questions.docbook b/doc/khelpcenter/faq/questions.docbook new file mode 100644 index 000000000..b24bfa320 --- /dev/null +++ b/doc/khelpcenter/faq/questions.docbook @@ -0,0 +1,137 @@ + +<chapter id="questions"> + +<title>Asking Questions</title> + +<para>To get an appropriate answer to questions requires asking a clear +question in a manner that motivates people to help. Writing questions that +appear to be rude, lazy, or uses bad or unclear language likely will result +in your question being ignored.</para> + +<qandaset> +<qandaentry> + +<question><para>What do I do before I ask?</para></question> + +<answer><para>Read the documentation and &FAQ; for the application. There is +a wealth of &tde; documentation availible both in the help center and +online. A lot of time and effort has gone into this documentation, and +often the answer to your question is there. The general &tde; userguide +can be found by typing <userinput><command>help:/khelpcenter/userguide</command></userinput> +into the &konqueror; address bar or <userinput><command> +khelpcenter help:/khelpcenter/userguide with the minicli</command></userinput>.</para> + +<para>Search the web: Usually searching for a specific error message or +searching mailing list archives will find a solution.</para> + +<para>Try it and see! Look through all the application options, read the +What's this? and tooltips for the ones you're not sure about. If you're +really unsure about an option save your data and then try. As long as you +use common sense you are unlikely to break anything by experimenting.</para> + +<para>Don't be lazy. If you show the people who you are asking +that you are able to troubleshoot and research in a logical manner, you're +showing them you're a reasonable person who is worth their time to +help. It's your problem and not theirs so the legwork is yours to do. Save +your helpers as much time as you can.</para> </answer> +</qandaentry> + +<qandaentry> +<question><para>Where do I ask?</para></question> + +<answer><para>Usually the best place to ask a question is on the +<acronym>IRC</acronym> channels and mailing lists devoted to user +questions. Don't post simple questions about using &tde; to the devel +channels and mailing lists, these are for technical discussions. Some good +places are chat.freenode.net, channel: #trinity-desktop, and the &tde; <ulink +url="http://www.trinitydesktop.org/mailinglist.php">mailing +lists</ulink>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How do I ask?</para></question> + +<answer><para>Try to word your questions in a manner that gives the most +information possible and is polite and courteous. Don't ask to ask, just +ask!</para> + +<para>Q: &tde; sucks, it's slow</para> + +<para>Is not a question that is likely to get you a useful answer. It does +not give any useful information about troubleshooting the problem, and it +starts out attacking the software in a way that isn't productive.</para> + +<para>Q: Since updating &tde; on Slackware &Linux; using sources, I have +noticed it's being really slow — sometimes +applications take up to 20 seconds to launch. I am using the same user +configuration as I had with the previous version. I have tried as a new +user. I can't find anything about this on the mailing lists or by a web +search. Could anyone point me to some information that could help?</para> + +<para>This question is polite, contains information to help people +troubleshoot the problem and shows your helpers what avenues you have +already tried.</para> + +<para>Don't presume automatically that the problem is the fault of +&tde;. Otherwise you likely will annoy people.</para> + +<para>Use clear language with correct spelling. Watch out for any +ambiguities and make sure you think about what you say before you write +it. If you are asked for clarification, give it as best you can. &tde; is a +project where many of the users and developers are not native english +speakers and if you don't use correct english, misunderstandings might +ensue. Be patient. Use the language appropriate to the channel or mailing list you are +in — if you don't, people who might have been able to help you might +ignore your message because it is not in a language they understand.</para> + +<para>Include all information that could be relevant, even when you're not +sure. Have you updated other software or hardware on your system, +particularly system libraries or a new kernel? These things could affect how +&tde; performs. Even when you cannot see a connecting cause, someone else might.</para> + +<para>Don't paraphrase error messages. Paste in the exact error, and if it's +more than a line or two don't paste them directly into an +<acronym>IRC</acronym> channel. Use an online paste service. If you +must type the messages by hand, be sure you are accurate. When you provide +faulty information, your helpers cannot help you as easily.</para> + +<para>Follow through on your solution! Tell people when the solution worked, or when you have +solved the problem yourself. This helps everybody involved know when +solutions work and helps other users who might be searching for a similar +solution to the problem.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>What do I do when told to look elsewhere?</para></question> + +<answer><para>Possibly you have not followed the above +advice. You've not done your research, and the solution probably is one the +helper knows very well to be easy to find. When provided a web link to an +<acronym>FAQ</acronym> or documentation don't say, <quote>No, I don't +want to have to read this I want you to just tell me</quote>. That response +is considered bad manners. People who don't provide effort to learn often +find others have little incentive to help.</para> +</answer> +</qandaentry> +</qandaset> + +<para>Use common courtesy. &tde; users and developers volunteer their time +out of an already very busy schedule, and like to +know that you are appreciating they are helping you for free. Be +polite, say please and thank you, be constructive, and try to be pleasant and +friendly.</para> + +<para> Does this seem like a lot of trouble to ask a question? If you want +to be able to feel that people owe you an answer or support, then you're +quite welcome to pay for commercial support from companies that support +&tde; on &UNIX; platforms. If you don't want to pay money, then pay the +people who do this for free with your politeness and appreciation. :-)</para> + +<para>If you think the answer to your question should be included in the +&tde; &FAQ; please feel free to submit any patches or suggestions to the +&tde; &FAQ; Maintainer, at <email>[email protected]</email></para> + +</chapter> diff --git a/doc/khelpcenter/faq/sound.docbook b/doc/khelpcenter/faq/sound.docbook new file mode 100644 index 000000000..feaaf6651 --- /dev/null +++ b/doc/khelpcenter/faq/sound.docbook @@ -0,0 +1,53 @@ +<chapter id="sound"> +<title>Troubleshooting sound problems</title> + +<para>&tde; uses the &arts; sound system which is complex and powerful, +making it difficult for some users to troubleshoot when things go +wrong. Here are some tips to help you diagnose what it's doing when your +sound misbehaves :</para> + +<qandaset> +<qandaentry> +<question> +<para>How can I troubleshoot sound related problems in &tde;?</para> +</question> + +<answer><para> To check that sound is working independently of &arts;, make +sure that <command>artsd</command> isn't running and then try playing sound +through <application>XMMS</application> or another multimedia application +that isn't a part of &tde;. If that application doesn't play sound, then +your general sound setup is probably broken and it's not a &tde; +problem.</para> + +<para>Try playing sound with +<userinput><command>artsplay</command><option><replaceable> +/path/to/some/soundfile</replaceable></option></userinput>. Try various +formats, ogg, mp3 and wav. Any error messages there might be useful in +pointing you in the right direction.</para> + +<para>Try setting the &arts; output method to <acronym>OSS</acronym>. In the +&kcontrolcenter; go to <menuchoice><guimenu>Sound & Multimedia</guimenu> +<guimenuitem>Sound System</guimenuitem></menuchoice>. On the +<guilabel>Hardware</guilabel> tab, under <guilabel>Select the audio +device</guilabel> choose <guilabel>Open Sound System</guilabel>. If you are +running <acronym>alsa</acronym> this will use the <acronym>OSS</acronym> +emulation, which may give better or worse results.</para> + +<para>Running <userinput><command>artsd</command><option> -l +0</option></userinput> from a terminal will give you a lot of debug output, +some of which might help you to diagnose the problem. Trying this in +conjunction with using <command>artsplay</command> in a second terminal can give a wealth of information. If an <application>artsd</application> instance is already running, exit it with <userinput><command>artsshell +</command><parameter>terminate</parameter></userinput></para> +</answer> +</qandaentry> +<qandaentry> +<question><para> +I've updated to the latest version of &tde; keeping my previous configuration and my system sounds don't work anymore!</para></question> +<answer><para> +Assuming you've installed &arts; correctly and you still have the codecs installed your previous &tde; installation needed, possibly there is a problem with your <filename>knotifyrc</filename>. To confirm this, try temporarily +renaming the file. A new one will be created when starting &tde;. +</para></answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/tdeapps.docbook b/doc/khelpcenter/faq/tdeapps.docbook new file mode 100644 index 000000000..441759054 --- /dev/null +++ b/doc/khelpcenter/faq/tdeapps.docbook @@ -0,0 +1,158 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="applications"> +<title>&tde; applications</title> + +<qandaset> +<qandaentry> +<question> +<para>&kppp;</para> +</question> +<answer> + +<para>Many &tde; users report problems using &kppp;. Make sure you have already checked the +following:</para> + +<itemizedlist> +<listitem><para>Can you dialup to your <acronym>ISP</acronym> without using &kppp;? If you cannot, then perhaps &kppp; is not the culprit after +all.</para></listitem> +<listitem><para>Have you gone through the &kppp; documentation +and followed the instructions and troubleshooting +suggestions?</para></listitem> +</itemizedlist> +<para>The <ulink url="help:/kppp">&kppp; handbook</ulink> is available through the +<application>&tde; Help Center</application>.</para> +<para>If you still encounter problems, then the following might help:</para> +<variablelist> +<varlistentry><term>How do I change the &MTU; setting in &kppp;?</term> +<listitem><para>Open up the &kppp; dialog box and select +<guibutton>Setup</guibutton>. Choose an existing account and click +<guibutton>Edit</guibutton>, or <guibutton>New</guibutton> to create a +new dialup account. Select the <guilabel>Dial</guilabel> tab and +click <guibutton>Arguments</guibutton>. Type what you want to change +in the Argument textbox (⪚ <userinput>mtu 296</userinput>) and +click <guibutton>Add</guibutton>. When you are satisfied, click +<guibutton>Close</guibutton>.</para> +<para>To check whether the options <quote>took</quote>, do one of the following:</para> +<itemizedlist> +<listitem> +<para>In a terminal window, run +<userinput><command>/sbin/ifconfig</command> ppp0</userinput> and look +at the reported &MTU; in the output. It should match your +request.</para> +</listitem> +<listitem><para>Add <option>debug</option> and <option>kdebug</option> +(each on a separate line) to your +<filename>/etc/ppp/options</filename> file and restart your +&PPP; session. You will find debugging messages in +<filename>/var/log/messages</filename>, including &MRU; and &MTU; +settings.</para></listitem> +</itemizedlist> +<para>If you want, the &MRU; and &MTU; settings can be added to the +<filename>options</filename> file, one complete setting per line, no +quotes or dashes.</para></listitem> +</varlistentry> +<varlistentry> +<term>&kppp; connects at a slower speed than +normal.</term> +<listitem><para>The following might do the trick:</para> +<itemizedlist> +<listitem><para>Try executing <command>setserial +spd_hi</command>.</para></listitem> +<listitem><para>The default &MTU; value is 1500, +which maybe too large +for a dialup connection. Try changing it to a smaller value like +<userinput>296</userinput> +or <userinput>576</userinput>.</para></listitem> +<listitem><para>Check in your <filename +class="directory">$<envar>HOME</envar>/.trinity/share/config</filename> for the +<filename>kppprc</filename>. Ensure the correct modem speed is +actually defined there.</para></listitem> +</itemizedlist></listitem> +</varlistentry> +</variablelist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>&konsole;</para> +</question> +<answer> +<variablelist> + +<varlistentry> +<term>How do I page-up or page-down?</term> +<listitem><para>Use <keycombo action="simul"> +<keycap>Shift</keycap><keycap>Page Up</keycap></keycombo> +and <keycombo action="simul"><keycap>Shift</keycap><keycap>Pg +Dn</keycap></keycombo>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term>How do I copy text from &konsole; to +anything else?</term> +<listitem><para>Use the mouse to select the desired text. From the +<guimenu>Edit</guimenu> menu, select <guimenuitem>Copy</guimenuitem>, or press +<keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo>. This places +the text in the &tde; clipboard, &klipper;. Next select +the target application, place the mouse pointer to the +desired location and press <keycombo +action="simul">&Ctrl;<keycap>V</keycap></keycombo>. +Alternately, highlight the text by dragging with the &LMB; down and +paste by clicking with the &MMB; (or both buttons if you are using a +2 button mouse with 3 button emulation). +</para><note><para>Note that the copying and pasting keyboard shortcuts use the +<keycap>&Shift;</keycap> key. That is because in traditional Unix terminals, +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> is used to break or stop +a process from running.</para></note></listitem> +</varlistentry> + +<varlistentry> +<term>Why can't &konsole; find the <quote>9x15</quote> and the 2 +<quote>console</quote> bitmap fonts installed with &tde;?</term> +<listitem> + +<para><application>FontConfig</application> must find the three fonts +installed in: <filename +class="directory">$<envar>TDEDIR</envar>/share/fonts</filename>. + If +the &tde; install does not install these fonts in a directory that +already exists (⪚ <filename +class="directory">/usr/share/fonts</filename>) then you must add this +directory to the configuration file <filename +class="directory">/etc/fonts/local.conf</filename>. This should be +the first line after <quote><fontconfig></quote>. For example: +<programlisting> +<fontconfig> +<dir>/usr/trinity/share/fonts</dir> +</fontconfig> +</programlisting> +After adding the directory, run (as root): +<userinput><command>fc-cache</command> -v</userinput> and check that +it found the directory.</para> +</listitem> +</varlistentry> + +</variablelist> +</answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>&kmail;</para> +</question> +<answer> +<para>&kmail; has its own home page at <ulink +url="http://kmail.kde.org">http://kmail.kde.org</ulink> where an +<acronym>FAQ</acronym> is available.</para> +</answer> +</qandaentry>--> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/tips.docbook b/doc/khelpcenter/faq/tips.docbook new file mode 100644 index 000000000..89c324be3 --- /dev/null +++ b/doc/khelpcenter/faq/tips.docbook @@ -0,0 +1,131 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="tips"> +<title>Useful tips</title> + +<qandaset> +<qandaentry> +<question> +<para>Reading documentation in &tde;</para> +</question> +<answer> +<para>Pop up the <guilabel>Run Command</guilabel> window (<keycombo +action="simul">&Alt;<keycap>F2</keycap></keycombo> by +default) and type: +<itemizedlist> +<listitem> +<para><command>man:<replaceable>command</replaceable></command> for man pages. It +even unpacks on the fly if the man pages are gzipped.</para> +</listitem> + +<listitem> +<para><command>info:<replaceable>command</replaceable></command> for info +pages.</para> +</listitem> + +<listitem> +<para><command>help:<replaceable>kdeappname</replaceable></command> for &tde; +application help pages.</para> +</listitem> + +</itemizedlist> +</para> + +<para>You can enter any of these in the <guilabel>Location</guilabel> text +box in &konqueror;.</para> +<para>Uou can use the <application>&tde; Help Center</application>. Start the <application>&tde; Help Center</application> by selecting <guimenuitem>Help</guimenuitem> from the <guimenu>TDE menu</guimenu>. Once the <application>&tde; Help Center</application> has loaded, the window on the left will contain an entry called +<guilabel>Unix manual pages</guilabel>. Select that entry to browse through all the installed manual pages on your +system.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Move or resize windows quickly</para> +</question> +<answer> +<para>To move a window, use <keycombo +action="simul">&Alt;<mousebutton>left</mousebutton></keycombo> mouse +button. <keycombo +action="simul">&Alt;<mousebutton>right</mousebutton></keycombo> mouse +button will resize the window. Last but not least, <keycombo +action="simul">&Alt;<mousebutton>middle</mousebutton></keycombo> mouse button +raises/lowers the window. The <application>&tde; Control Center</application> +allows you to change these mouse bindings. Please refer to <ulink url="help:/khelpcenter/userguide/windows-how-to-work.html"> +Windows, How To Work Them</ulink> in the Trinity user guide for more information.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Killing windows in &tde;</para> +</question> +<answer> +<para>There is a standard keybinding (<keycombo +action="simul">&Ctrl;&Alt;&Esc;</keycombo>) +that changes the mouse pointer to a skull & crossbones cursor. Click that cursor on a +window to kill it. The keybindings are viewable/changeable from the +<application>&tde; Control Center</application>. + +<caution><para>Using this option kills the program forcibly. Data might be lost, +and some processes related to the program might remain active. Use only as a +last resort.</para></caution> +<!-- fixme: use only if necessary; processes might remain --></para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What if something is so wrong that I can't even get the skull +& crossbones cursor? How do I get out of a total lockup?</para> +</question> +<answer> +<para>These kind of locks tend to occur when an application locks up +while it has a so called <quote>mouse/keyboard grab</quote>. When that +happens you can try to select a virtual text console with <keycombo +action="simul">&Ctrl;&Alt;<keycap>F1</keycap></keycombo> and login. With the +following command you will get a list of all running processes:</para> + +<screen><userinput> <command>ps</command> <option>-aux</option> | <command>more</command></userinput></screen> + +<para>By killing the process that has the mousegrab, your desktop will +come to life again. Unfortunately you can't see which process that is, +so you will have to find out through trial and error. To kill a process +use:</para> + +<screen><userinput> <command>kill</command> <option>-9</option> <replaceable>pid</replaceable></userinput></screen> + +<para>Here <replaceable>pid</replaceable> is the process id of the +process, which is the first number on each line reported by +<command>ps</command> <option>-aux</option>.</para> + +<para>You can switch back to the desktop with <keycombo +action="simul">&Ctrl;&Alt;<keycap>F7</keycap></keycombo> (or +<keycap>F8</keycap> through <keycap>F9</keycap> depending on your +operating system) to see if things work again. When you press +<keycombo action="simul">&Alt;<keycap>Tab</keycap></keycombo> you should get a +response from the window manager. If not, you need to get back to the +text console and try to kill another process.</para> +</answer> +</qandaentry> + +<!-- fixme: how to do in KDE2.x +<qandaentry> +<question> +<para>Switching window managers on the fly in &tde; 1.x</para> +</question> +<answer> +<para>If you want to switch your window manager on the fly, type the +following into a terminal window: <command>kwmcom +go:<replaceable>blackbox</replaceable></command>. This switches to +Blackbox, but you can substitute any window manager you like.</para> +</answer> +</qandaentry> +--> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/webbrowse.docbook b/doc/khelpcenter/faq/webbrowse.docbook new file mode 100644 index 000000000..b466eb0d8 --- /dev/null +++ b/doc/khelpcenter/faq/webbrowse.docbook @@ -0,0 +1,217 @@ +<!-- <?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> --> + +<chapter id="webbrowser"> +<title>Webbrowsing with &konqueror;</title> +<para>&konqueror; is &tde;'s default web browser. Please refer to +the <ulink url="help:/konqueror/index.html"> +Konqueror Handbook</ulink> for detailed information.</para> + +<qandaset> + +<qandaentry> +<question><para>Where does the name &konqueror; come from?</para></question> +<answer><para>It's a word play on the other browsers' names. After the Navigator +and the Explorer comes the Conqueror.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Can I run &konqueror; without running &tde;?</para></question> +<answer><para>Yes. Install &Qt;, tdelibs, and tdebase. From your window manager launch &konqueror;. It should work just fine, but if it doesn't (&tde; developers don't often test that use case), report the problem to <ulink +url="http://bugs.trinitydesktop.org/">http://bugs.trinitydesktop.org/</ulink>. Before reporting a bug, try running "tdeinit" before running &konqueror;. This is of course the same for any other &tde; application running in +a non &tde; setup.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>Why doesn't &konqueror; show the contents of an image's <sgmltag class="attribute">ALT</sgmltag> attribute in a tooltip?</para></question> +<answer><para> +There is no standard that states the <sgmltag class="attribute">ALT</sgmltag> attribute should appear as a tooltip. The specification calls for <sgmltag class="attribute">ALT</sgmltag> to be displayed in place of the image, as in text-mode only browsers such at lynx or w3m. Abusing the <sgmltag class="attribute">ALT</sgmltag> attribute is bad for accessibility. Tooltips are supposed to come from the <sgmltag class="attribute">TITLE</sgmltag> attribute and this is implemented in &konqueror;. +</para></answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I use &konqueror; as a web browser with a proxy?</para> +</question> +<answer> +<para>&konqueror; can be used with &HTTP; and &FTP; proxies. To set +up the proxy server in &konqueror;, select +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice> from the &konqueror; menu and +select the <guilabel>Proxy</guilabel> option.</para> +</answer> +</qandaentry> + +<qandaentry> +<question id="nsbookmark"> +<para>How do I import bookmarks from another browser into &konqueror; ?</para> +</question> +<answer> +<para>To import bookmarks from another browser into &konqueror;, from the menu +bar select <guimenu>Bookmarks</guimenu>, then select <guimenuitem>Edit Bookmarks</guimenuitem>. +In the <application>Bookmark Editor</application>, select +<guimenu>File</guimenu> then select <guimenuitem>Import</guimenuitem>. Select +the browser from which you would like to import bookmarks. In the Open dialog, +navigate to the location of the folder or file your bookmarks are +located. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para>How can I make &konqueror; only show certain bookmarks in the bookmarks toolbar?</para></question> +<answer><para>In &konqueror; select <menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice>. Then select <guilabel>Web Behaviour</guilabel> from the icon list. Under the <guilabel>Bookmarks</guilabel> heading, place a check in the box next to <guilabel>Show only marked bookmarks in bookmark toolbar</guilabel>.</para> +<para>In the <application>Bookmark Editor</application> an option to <guilabel>Show in Toolbar</guilabel> appears on clicking with the &RMB; on any bookmark entry or in the <guimenu>Edit</guimenu> menu when the entry is highlighted. Folders can also be shown in the bookmarks toolbar in much the same way.</para></answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I fool a site into believing &konqueror; is &Netscape; or +some other browser?</para> +</question> +<answer> +<para>That is called setting the user agent. In &konqueror;, select +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice>. In the icon list, select +<guilabel>Browser Identification</guilabel>. Default +and site-specific browser identifications can be set there.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>&konqueror; is taking a really long time to load web pages -- mdash; what +could cause this?</para></question> +<answer> +<para>Quite often &konqueror; loading web pages slowly is caused by +<acronym>DNS</acronym> servers with broken <acronym>IPV6</acronym> +support. Adding the following to <filename>/etc/profile</filename> or any +other script that is sourced on login should solve this problem: +<screen> +export TDE_NO_IPV6=true +</screen> +for bourne compatible shells, and for C-style shells: +<screen> +setenv TDE_NO_IPV6 true +</screen> +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I configure &konqueror; to run &Java; applets?</para> +</question> +<answer> +<para>From &konqueror;'s menubar choose +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice>. +From the icon list select <guilabel>Java & Javascript</guilabel>. Set the +<guilabel>Path to Java executable</guilabel>.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I block unrequested popup windows in &konqueror;?</para> +</question> +<answer> +<para>&konqueror; provides a 'smart' policy for JavaScript popups. From the +&konqueror; main window, select<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice>. Then +<guilabel>Java & JavaScript</guilabel>. On the +<guilabel>JavaScript</guilabel> tab, under <guilabel>Global JavaScript +Policies</guilabel>, set the radio button beside <guilabel>Open new +windows:</guilabel> to <guilabel>Smart</guilabel>. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Why doesn't my banking site work with &konqueror;? It pops up a new +window with the login screen in other browsers, but not in +&konqueror;.</para> +</question> +<answer> +<para> +Make sure you have Javascript enabled, and the default JavaScript web popups +policy set to <guilabel>Ask</guilabel> or <guilabel>Allow</guilabel>. The +<guilabel>Smart</guilabel> policy is not always sufficient for some banks. +Many banks also require &Java; support. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Can &konqueror; use user-specified stylesheets, like those in the +Firefox adblock extension?</para> +</question> +<answer> +<para>Yes, you can set &konqueror; to use any kind of valid +<acronym>css</acronym> stylesheet to filter webcontent or improve accessibility. +From the &konqueror; main window simply click +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice> and select +<guilabel>Stylesheets</guilabel>. Set the radio button to +<guilabel>Use user-defined stylesheet</guilabel> and browse to where the +stylesheet you want to use is located. Alternately, select +<guilabel>Use accessibility stylesheet defined in "Customize" +tab</guilabel> and then set your own options.</para> +</answer> +</qandaentry> + +<qandaentry> +<question><para> +Why does &konqueror; display a plain grey square when I try to view flash animations, even though the flash plugin is installed? +</para></question> +<answer><para> +Under the latest versions of X.org, having the composite extension loaded can cause problems with the flash plugin. Try disabling the composite extension and see whether normal flash operation is restored. +</para></answer> +</qandaentry> + +<!--<qandaentry> +<question> +<para>Why can't &konqueror; render &GIF; images?</para> +</question> +<answer> +<para>It is because you did not enable &GIF; support in &Qt;. Please see +<xref linkend="gif"/> for more details.</para> +</answer> +</qandaentry>--> + +<qandaentry> +<question><para>When I try to open a web page with &konqueror;, I get the +message: <quote>There appears to be a configuration error. You have +associated Konqueror with text/html, but it cannot handle this file +type.</quote></para> +</question> +<answer> +<para>Make sure the embedding settings for the text/html +<acronym>MIME</acronym> type are correct: +<orderedlist> +<listitem><para>In &konqueror;, go to +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Configure +&konqueror;...</guisubmenu></menuchoice>. In the icon list select <guilabel>File +Associations</guilabel>.</para> +</listitem> +<listitem><para>Open +text->html in the tree view.</para> +</listitem> +<listitem><para>Click on the +<guilabel>Embedding</guilabel> tab. Make sure that <guilabel>Left Click +Action</guilabel> is set to <guilabel>Show file in embedded +viewer</guilabel>, and that <guilabel>TDEHTML (tdehtml)</guilabel> is at the top +of <guilabel>Services Preference Order</guilabel>.</para></listitem> +</orderedlist> +</para> +</answer> +</qandaentry> + +</qandaset> +</chapter> diff --git a/doc/khelpcenter/faq/winmng.docbook b/doc/khelpcenter/faq/winmng.docbook new file mode 100644 index 000000000..dd79018bc --- /dev/null +++ b/doc/khelpcenter/faq/winmng.docbook @@ -0,0 +1,133 @@ +<!-- +<?xml version="1.0" ?> +<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" + "dtd/kdex.dtd"> +--> + +<chapter id="windowmanager"> +<title>The window manager</title> + +<para>The default window manager provided by &tde; is the Trinity Window +Manager (&twin;). Please refer to <ulink url="help:/khelpcenter/userguide/windows-how-to-work.html"> +Windows, How To Work Them</ulink> in the Trinity user guide for more information.</para> + +<qandaset> +<qandaentry> +<question> +<para>Are there keyboard shortcuts for &twin; operations?</para> +</question> +<answer> +<para>Yes. Please use to the Trinity Control Center (&kcontrol;), +<menuchoice><guimenu>Regional & Accessibility</guimenu><guimenuitem> +Keyboard Shortcuts</guimenuitem></menuchoice>, for the +list of available shortcuts.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>Can I define my own set of keyboard shortcuts?</para> +</question> +<answer> +<para>Yes. Launch the +<application>&tde; Control Center</application> and select +<menuchoice><guimenu>Regional & Accessibility</guimenu><guimenuitem>Keyboard Shortcuts</guimenuitem></menuchoice> to +configure window manager bindings like maximizing windows, &etc;. +</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>When I "iconify" a window, it disappears. Where does it +go?</para> +</question> +<answer> +<para>With many &X-Window; &GUI;s, the minimize button (a little dot) will +erase the window that the program is running in and create, instead, +an icon on the desktop. &tde; does not do this. Instead, when a +window is iconified it is simply hidden (but the program is still +running).</para> +<para>There are a few ways to access <quote>disappeared</quote> windows:</para> +<itemizedlist> +<listitem> +<para>If you are running the taskbar part of &kicker;, +you can choose to have a list of tasks displayed on your desktop. +Iconified tasks will have their names displayed in gray.</para> +</listitem> +<listitem> +<para>If you click the &MMB; on the root window (&ie;, +the background of the desktop), &twin; will give you a list +of all available tasks.</para> +</listitem> +</itemizedlist> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>How do I maximize windows only vertically or horizontally?</para> +</question> +<answer> +<para>Provided your window is not already maximized, clicking on the +maximize button with the &LMB;/&MMB;/&RMB; will +maximize fully/vertically/horizontally respectively.</para> +</answer> +</qandaentry> + +<qandaentry> +<question> +<para>What is <quote>shading</quote> a window?</para> +</question> +<answer> +<para>By <quote>shading</quote> a window we mean <quote>rolling up</quote> the window leaving just +the title bar visible. You can do this by double clicking on the +window title bar.</para> +</answer> +</qandaentry> + +<!-- This is kinda covered in desktop.docbook, but the question here --> +<!-- is different, even if the answer is nearly the same --> +<qandaentry> +<question> +<para>How can I start an application with special window options, like +maximized/minimized/to stay on top?</para> +</question> +<answer> +<para>Use the <command>kstart</command> command. As an example, to +open &kcalc; with the <quote>Stay on Top</quote> option, use: +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--ontop</option> <option>kcalc</option></userinput></screen> +</para> +<para>For maximized windows, use the <option>--maximize</option> +option, for minimized windows, use <option>--iconify</option>. You can +see a full list of <command>kstart</command> options with +<userinput><command>kstart</command> +<option>--help-all</option></userinput>.</para> + +<warning><para>If you're using <command>kstart</command> to start +applications at &tde; startup, you should use the +<option>--window</option> option. See the &tde; User Guide, section +<quote>Advanced Window Management</quote> for more information about +this feature.</para> +</warning> + +</answer> +</qandaentry> + +<!-- Not sure this is still applicable +<qandaentry> +<question> +<para>Is it possible to have FVWM2-like shadow frameworks for the +placement of windows?</para> +</question> +<answer> +<para>Yes. Run <application>&tde; Control Center</application> and select <guimenu>Look and Feel</guimenu> +followed by <guisubmenu>Window Behavior</guisubmenu> and finally +<guimenuitem>Advanced</guimenuitem>. There is a dialog option that +allows you to set the placement policy you want.</para> +</answer> +</qandaentry> +--> +</qandaset> +</chapter> + diff --git a/doc/khelpcenter/glossary/CMakeLists.txt b/doc/khelpcenter/glossary/CMakeLists.txt new file mode 100644 index 000000000..73a84f204 --- /dev/null +++ b/doc/khelpcenter/glossary/CMakeLists.txt @@ -0,0 +1,14 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( + FILES checkxrefs index.docbook tdeprintingglossary.docbook + DESTINATION khelpcenter/glossary ) diff --git a/doc/khelpcenter/glossary/Makefile.am b/doc/khelpcenter/glossary/Makefile.am new file mode 100644 index 000000000..e79a46842 --- /dev/null +++ b/doc/khelpcenter/glossary/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = khelpcenter/glossary diff --git a/doc/khelpcenter/glossary/checkxrefs b/doc/khelpcenter/glossary/checkxrefs new file mode 100755 index 000000000..6da64c184 --- /dev/null +++ b/doc/khelpcenter/glossary/checkxrefs @@ -0,0 +1,10 @@ +#!/bin/sh +DEFINED_ENTRIES=`sed -ne "s^.*<glossentry id=\"\(.*\)\">.*^\1^p" *.docbook` +REFERENCED_ENTRIES=`sed -ne "s^.*<glossseealso otherterm=\"\(.*\)\">.*^\1^p" *.docbook | unique` + +# Check for entries which are referenced but not defined. +for ENTRY in $REFERENCED_ENTRIES; do + if ! echo $DEFINED_ENTRIES | grep $ENTRY - > /dev/null 2>&1; then + echo "'$ENTRY' referenced but not defined!" + fi +done diff --git a/doc/khelpcenter/glossary/index.docbook b/doc/khelpcenter/glossary/index.docbook new file mode 100644 index 000000000..a812b50f4 --- /dev/null +++ b/doc/khelpcenter/glossary/index.docbook @@ -0,0 +1,295 @@ +<?xml version="1.0" ?> +<!DOCTYPE glossary PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE"> +<!ENTITY glossary-tdeprinting SYSTEM "tdeprintingglossary.docbook"> + +]> + + +<glossary id="glossary"> + +&glossary-tdeprinting; + + <glossdiv id="glossdiv-technologies"> + <title>Technologies</title> + <glossentry id="gloss-ioslave"> + <glossterm><acronym>IO</acronym> Slave</glossterm> + <glossdef><para><acronym>IO</acronym> Slaves enable &tde; applications to + access remote resources as easily as local resources (making them + <quote>network transparent</quote>). Remote resources (⪚ files) might + be stored on <acronym>SMB</acronym> shares or similar.</para> + <glossseealso otherterm="gloss-smb"><acronym>SMB</acronym></glossseealso> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-tdeio"> + <glossterm><acronym>TDEIO</acronym></glossterm> + <glossdef><para>The &tde; Input/Output system which makes use of so-called + <quote><acronym>IO</acronym> Slaves</quote>.</para> + <glossseealso otherterm="gloss-ioslave"><acronym>IO</acronym> +Slave</glossseealso> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-tdeparts"> + <glossterm>KParts</glossterm> + <glossdef><para>KParts is an embedding technology which allows &tde; + applications to embed other &tde; applications. For example, the text + view used by &konqueror; is a KPart.</para> + <glossseealso otherterm="gloss-konqueror">&konqueror;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-tdesycoca"> + <glossterm><acronym>KSycoca</acronym></glossterm> + <glossdef><para><acronym>KSycoca</acronym> (&tde; <emphasis>Sy</emphasis>stem + <emphasis>Co</emphasis>nfiguration <emphasis>Ca</emphasis>che) is a + configuration cache which, for example, guarantees fast access to the menu + entries.</para> + <glossseealso +otherterm="gloss-tdebuildsycoca"><application>KBuildSycoca</application></glossseealso> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="glossdiv-xfree86"> + <title>XFree86</title> + <glossentry id="gloss-antialiasing"> + <glossterm>Antialiasing</glossterm> + <glossdef><para>If mentioned in context with &tde;, antialiasing often means + the smoothing of the fonts visible on the screen. &Qt; version 2.3.0 + or higher used together with XFree86 4.x makes this possible under &tde; + as well.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-qt">&Qt;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-xserver"> + <glossterm>&X-Server;</glossterm> + <glossdef><para>The &X-Server; represents a basic layer upon which the + various &GUI;s like &tde; are built. It manages the + basic mouse and keyboard input (from the local host as well as from + remote hosts) and provides elementary graphic routines to draw + rectangles and other primitives.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="glossdiv-applications"> + <title>Applications</title> + <glossentry id="gloss-tdebuildsycoca"> + <glossterm><application>KBuildSycoca</application></glossterm> + <glossdef><para><application>KBuildSycoca</application> is a command line +program and regenerates the + so-called <acronym>KSycoca</acronym>. This is useful, for example, if some +or all modules in + &kcontrol; are missing.</para> + <glossseealso +otherterm="gloss-tdesycoca"><acronym>KSycoca</acronym></glossseealso> + <glossseealso otherterm="gloss-kcontrol">&kcontrol;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-kcontrol"> + <glossterm>&kcontrol;</glossterm> + <glossdef><para>This is the project and filename of the &tde; control + center. &kcontrol; allows you to customize virtually + every configuration option of &tde;.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-kicker"> + <glossterm>&kicker;</glossterm> + <glossdef><para>&kicker; is the nickname as well as project name of the + &tde; panel.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-panel">Panel</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-konqueror"> + <glossterm>&konqueror;</glossterm> + <glossdef><para>&konqueror; is a filemanager, web browser, picture viewer + and more, and a core part of the &tde; project. You can + find more information about &konqueror; at <ulink + url="http://www.konqueror.org">www.konqueror.org</ulink>.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-ksirc"> + <glossterm>&ksirc;</glossterm> + <glossdef><para>&ksirc; is the default <acronym>IRC</acronym> client, + which is shipped with &tde;. You can use &ksirc; to chat with anyone on + an <acronym>IRC</acronym> network.</para> + <glossseealso otherterm="gloss-irc"><acronym>IRC</acronym></glossseealso> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="glossdiv-desktop-terminology"> + <title>Desktop Terminology</title> + <glossentry id="gloss-draganddrop"> + <glossterm>Drag and Drop</glossterm> + <glossdef><para>This concept tries to replace many actions like copying + files from one place to another by a certain mouse movement, ⪚ + clicking on an icon in a &konqueror; window, moving the mouse to another + window while keeping the mouse button pressed, and releasing the mouse + button (<quote>dropping</quote> the object) copies files.</para> + <glossseealso otherterm="gloss-konqueror">&konqueror;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-gui"> + <glossterm>&GUI;</glossterm> + <glossdef><para>Abbreviation for <emphasis>G</emphasis>raphical + <emphasis>U</emphasis>ser <emphasis>I</emphasis>nterface. Every desktop + environment (like &tde;) is a &GUI;. Most + &GUI;s feature mouse support and/or windows to manage + the programs.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-kde"> + <glossterm>&tde;</glossterm> + <glossdef><para>Abbreviation for <quote>Trinity Desktop Environment</quote>, a + leading &GUI; for &UNIX;-based systems. You can find more + detailled information at <ulink + url="http://www.kde.org">www.kde.org</ulink>.</para> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-gnome"> + <glossterm><acronym>GNOME</acronym></glossterm> + <glossdef> + <para><emphasis>G</emphasis>NU <emphasis>N</emphasis>etwork <emphasis>O</emphasis>bject + <emphasis>M</emphasis>odel <emphasis>E</emphasis>nvironment, one of the + leading &UNIX; &GUI;s.</para> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-panel"> + <glossterm>Panel</glossterm> + <glossdef><para>Refers to the panel (also known as + <quote>&kicker;</quote>) which often resides at the bottom of the + screen.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-kicker">&kicker;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-ripping"> + <glossterm>ripping</glossterm> + <glossdef><para>The process of reading audio data from a &cdrom; and + storing it on the hard disk.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="kde-development"> + <title>&tde; Development</title> + <glossentry id="gloss-qt"> + <glossterm>&Qt;</glossterm> + <glossdef><para>The &GUI; of &tde; is built on top of + the &Qt; toolkit, which provides many graphical elements (so-called + <quote>Widgets</quote>) which are used to construct the desktop. You + can find more information about &Qt; at <ulink + url="http://www.trolltech.com">www.trolltech.com</ulink>.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + <glossseealso otherterm="gloss-widget">Widget</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-i18n"> + <glossterm>i18n</glossterm> + <glossdef><para>Abbreviation for <quote>internationalization</quote>. &tde; + supports many different languages, and several i18n techniques make it + easy to translate the &GUI; as well as the accompanying + documents of &tde; into all these languages. More information about the + i18n process is available at <ulink + url="http://i18n.kde.org">i18n.kde.org</ulink>.</para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-l10n"> + <glossterm>l10n</glossterm> + <glossdef><para>Abbreviation for <quote>localization</quote>, the process + of adapting a program to the local environment. This includes ⪚ the + currency used for monetary values or the time format.</para> + <glossseealso otherterm="gloss-i18n">i18n</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-widget"> + <glossterm>Widget</glossterm> + <glossdef><para>Graphical elements like scrollbars, buttons or input + fields which are used by &tde; to construct the &GUI;. + </para> + <glossseealso otherterm="gloss-kde">&tde;</glossseealso> + <glossseealso otherterm="gloss-gui">&GUI;</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-cvs"> + <glossterm><acronym>CVS</acronym></glossterm> + <glossdef> + <para><emphasis>C</emphasis>oncurrent <emphasis>V</emphasis>ersion +<emphasis>S</emphasis>ystem. + The <acronym>CVS</acronym> is a very elegant way of managing file +versions that allow more than one developer + to easily work on the same project. You can find a description of how to +get the latest (developer) version of the + &tde; sources via anonymous <acronym>CVS</acronym> on + <ulink +url="http://www.kde.org/anoncvs.html">http://www.kde.org/anoncvs.html</ulink>. + More about <acronym>CVS</acronym> is available at <ulink +url="http://www.cvshome.org">www.cvshome.org</ulink>. + + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="glossdiv-misc"> + <title>Miscellaneous</title> + <glossentry id="gloss-rfc"> + <glossterm><acronym>RFC</acronym></glossterm> + <glossdef><para><emphasis>R</emphasis>equest <emphasis>F</emphasis>or + <emphasis>C</emphasis>omment. A common way to publish new protocol + ideas or procedures for evaluation of the Internet community. Though + <acronym>RFC</acronym>s are not mandatory, many applications try to + adhere to them, once they have been approved by the community. More + information about <acronym>RFC</acronym>s can be found at the + <ulink url="http://www.rfc-editor.org">RFC Homepage</ulink>.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="glossdiv-protocols"> + <title>Various protocols</title> + <glossentry id="gloss-smb"> + <glossterm><acronym>SMB</acronym></glossterm> + <glossdef><para><emphasis>S</emphasis>erver <emphasis>M</emphasis>essage + <emphasis>B</emphasis>lock. A network protocol used in &Microsoft; &Windows; + networks to access the filesystems of other computers.</para> + <glossseealso otherterm="gloss-ioslave"><acronym>IO</acronym> +Slave</glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-irc"> + <glossterm><acronym>IRC</acronym></glossterm> + <glossdef><para><emphasis>I</emphasis>nternet <emphasis>R</emphasis>elay + <emphasis>C</emphasis>hat. A protocol defined in <acronym>RFC</acronym> + 1459, which handles the specification to enable real time text chat.</para> + <glossseealso otherterm="gloss-rfc"><acronym>RFC</acronym></glossseealso> + </glossdef> + </glossentry> + <glossentry id="gloss-host"> + <glossterm>host</glossterm> + <glossdef><para>This can either be a name from your + <filename>/etc/hosts</filename> file + (<systemitem class="systemname">mycomputer</systemitem>), + an Internet name (<systemitem +class="systemname">www.kde.org</systemitem>) or an IP-Address + (<systemitem>192.168.0.10</systemitem>). + </para> + </glossdef> + </glossentry> + </glossdiv> +</glossary> diff --git a/doc/khelpcenter/glossary/tdeprintingglossary.docbook b/doc/khelpcenter/glossary/tdeprintingglossary.docbook new file mode 100644 index 000000000..cec585741 --- /dev/null +++ b/doc/khelpcenter/glossary/tdeprintingglossary.docbook @@ -0,0 +1,1384 @@ + +<!-- +<?xml version="1.0" ?> +<!DOCTYPE glossary PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"customization/dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE"> +<!ENTITY glossary-tdeprinting SYSTEM "tdeprintingglossary.docbook"> + +]> +<glossary id="glossary"> +--> + <glossdiv id="glossdiv-printing"> + <title>Printing</title> + + + <glossentry id="gloss-acl"> + <glossterm><acronym>ACLs</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>A</emphasis>ccess + <emphasis>C</emphasis>ontrol <emphasis>L</emphasis>ists; + ACLs are used to check for the access by a given + (authenticated) user. A first rough support for ACLs + for printing is available from &CUPS;; this will be refined + in future versions.</para> + <glossseealso otherterm="gloss-authentication">Authentication</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-appsocketprotocol"> + <glossterm>AppSocket Protocol</glossterm> + <glossdef><para>AppSocket is a protocol for the transfer of + print data, also frequently called "Direct TCP/IP Printing". + &Hewlett-Packard; have taken AppSocket, added a few minor + extensions around it and been very successful in renaming + and marketing it under the brand "&HP; JetDirect"...</para> + <glossseealso otherterm="gloss-hpjetdirectprotocol">&HP; JetDirect Protocol</glossseealso> + <glossseealso otherterm="gloss-directtcpipprinting">Direct TCP/IP Printing</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-apsfilter"> + <glossterm>APSfilter</glossterm> + <glossdef><para>APSfilter is used mainly in the context of "classical" + &UNIX; printing (BSD-style LPD). It is a sophisticated shell script, + disguised as an "all-in-one" filtering program. In reality, + APSfilter calls "real filters" to do the jobs needed. It sends + printjobs automatically through these other filters, based on an + initial file-type analysis of the printfile. + It is written and maintained by Andreas Klemm. +<!-- + </para> + <para> +--> + It is + similar to Magicfilter and mostly uses Ghostscript for file conversions. + Some Linux Distributions (like &SuSE;) use APSfilter, others + Magicfilter (like &RedHat;), some have both for preference selection + (like *BSD). +<!-- + </para> + <para> +--> + &CUPS; has <emphasis>no</emphasis> need for APSfilter, + as it runs its own file type recognition (based on &MIME; types) + and applies its own filtering logic.</para> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + <glossseealso otherterm="gloss-magicfilter">Magicfilter</glossseealso> + <glossseealso otherterm="gloss-mimetypes">&MIME;-Types</glossseealso> + <glossseealso otherterm="gloss-printcap">printcap</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-authentication"> + <glossterm>Authentication</glossterm> + <glossdef><para>Proving the identity of a certain person (maybe via username/password + or by means of a certificate) is often called authentication. Once you are + authenticated, you may or may not get access to a requested ressource, + possibly based on ACLs.</para> + <glossseealso otherterm="gloss-acl">ACLs</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-bidirectionalcommunication"> + <glossterm>Bi-directional communication</glossterm> + <glossdef><para>In the context of printing, a server or a host may receive additional + information sent back from the printer (status messages &etc;), either + upon a query or unrequested. AppSocket ( = &HP; JetDirect), &CUPS; and IPP + support bi-directional communication, LPR/LPD and BSD-style printing + do not...</para> + <glossseealso otherterm="gloss-appsocketprotocol">AppSocket Protocol</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-directtcpipprinting">Direct TCP/IP Printing</glossseealso> + <glossseealso otherterm="gloss-hpjetdirectprotocol">&HP; JetDirect</glossseealso> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-lprlpd">LPR/LPD</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-bsdstyleprinting"> + <glossterm>BSD-style Printing</glossterm> + <glossdef><para>Generic term for different variants of the traditional &UNIX; + printing method. Its first version appeared in the early 70s on + BSD &UNIX; and was formally described in <ulink url="http://www.rfc.net/rfc1179.html">RFC 1179</ulink> only as late + as 1990. +<!-- + </para> + <para> +--> + At the time when BSD "remote" printing was first designed, printers + were serially or otherwise directly connected devices to a host + (with the Internet hardly consisting of more than 100 nodes!); printers + used hole-punched, continuous paper, fed through by a tractor + mechanism, with simple rows of ASCII text mechanically hammered on to + the medium, drawn from a cardboard box beneath the table. It came out + like a zig-zag folded paper "snake". Remote printing consisted of a + neighboring host in the next room sending a file + asking for printout. +<!-- + </para> + <para> +--> + How technology has changed! Printers generally use cut-sheet media, they have + built-in intelligence to compute the raster images of pages after pages + that are sent to them using one of the powerful page description + languages (PDL). Many are network nodes in their own right, + with CPU, RAM, a hard disk and their own Operation System, and + are hooked to a net with potentially millions of users... +<!-- + </para> + <para> +--> + It is a vast proof of the flexible &UNIX; concept for doing things, + that it made "Line Printing" reliably work even under these modern + conditions. But time has finally come now to go for something new + -- the IPP. + + It is strong proof of the flexibility of &UNIX;; that "Line Printing" works + reliably, even under these modern conditions. But time has finally come now + to go for something new -- mdash; the IPP. + + </para> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-lprlpd">LPR/LPD printing</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-cups"> + <glossterm>&CUPS;</glossterm> + <glossdef><para>Abbreviation for <emphasis>C</emphasis>ommon + <emphasis>U</emphasis>NIX <emphasis>P</emphasis>rinting + <emphasis>S</emphasis>ystem; &CUPS; is the most modern &UNIX; and Linux + printing system, also providing cross-platform print services + to &Microsoft; &Windows; and Apple &MacOS; clients. Based on IPP, it does + away with all the pitfalls of old-style BSD printing, + providing authentication, encryption and ACLs, plus many more + features. At the same time it is backward-compatible enough + to serve all legacy clients that are not yet up to IPP, via + LPR/LPD (BSD-style). +<!-- + </para> + <para> +--> + &CUPS; is able to control any &PostScript; printer by + utilizing the vendor-supplied PPD (PostScript Printer + Description file), targeted originally for &Microsoft; Windows NT + printing only. &tde; Printing is most powerful if based on + &CUPS;.</para> + <glossseealso otherterm="gloss-acl">ACLs</glossseealso> + <glossseealso otherterm="gloss-authentication">Authentication</glossseealso> + <glossseealso otherterm="gloss-bsdstyleprinting">BSD-style printing</glossseealso> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-tdeprint">TDEPrint</glossseealso> + <glossseealso otherterm="gloss-lprlpd">LPR/LPD</glossseealso> + <glossseealso otherterm="gloss-ppd">PPD</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-cupsfaq"> + <glossterm><acronym>&CUPS;-FAQ</acronym></glossterm> + <glossdef><para>Currently only available in German (translation is on the way), + the <ulink url="http://www.danka.de/printpro/faq.html">&CUPS;-FAQ</ulink> + is a valuable resource to answer many questions that anyone new to + &CUPS; printing might have at first. + </para> + <glossseealso otherterm="gloss-tdeprinthandbook">TDEPrint Handbook</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-cups-o-matic"> + <glossterm>&CUPS;-O-Matic</glossterm> + <glossdef><para>&CUPS;-O-Matic was the first "Third Party" plugin for + the &CUPS; printing software. It is available on the <ulink + url="http://www.linuxprinting.org/cups-doc.html">Linuxprinting.org + website</ulink> to provide an online PPD-generating service. +<!-- + </para> + <para> +--> + + Together with the companion <application>cupsomatic</application> Perl-Script, + that needs to be installed as an additional &CUPS; backend, + it redirects output from the native <application>pstops</application> filter into + a chain of suitable Ghostscript filters. Upon completion, it + passes the resulting data back to a &CUPS; "backend" for sending + to the printer. +<!-- + </para> + <para> +--> + In this way, &CUPS;-O-Matic enables support for any printer known to + have worked previously in a "classical" Ghostscript environment. + If no native &CUPS; support for that printer is in sight... &CUPS;-O-Matic + is now replaced by the more capable PPD-O-Matic.</para> + <glossseealso otherterm="gloss-cupsomatic">cupsomatic</glossseealso> + <glossseealso otherterm="gloss-PPD-O-Matic">PPD-O-Matic</glossseealso> + <glossseealso otherterm="gloss-foomatic">Foomatic</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-cupsomatic"> + <glossterm>cupsomatic</glossterm> + <glossdef><para>The Perl script <application>cupsomatic</application> (plus a working Perl installation + on your system) is needed to make any &CUPS;-O-Matic (or PPD-O-Matic) + generated PPD work with &CUPS;. It was written by Grant Taylor, author of + the Linux Printing HOWTO and Maintainer of the <ulink + url="http://www.linuxprinting.org/printer_list.cgi">printer + database</ulink> at the Linuxprinting.org website.</para> + <glossseealso otherterm="gloss-cups-o-matic">&CUPS;-O-Matic</glossseealso> + <glossseealso otherterm="gloss-foomatic">Foomatic</glossseealso> + <glossseealso otherterm="gloss-cupsomatic">cupsomatic</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-daemon"> + <glossterm><acronym>Daemon</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>D</emphasis>isk + <emphasis>a</emphasis>nd <emphasis>e</emphasis>xecution + <emphasis>mon</emphasis>itor; <acronym>Daemons</acronym> are present + on all &UNIX; systems to perform tasks independent of user + intervention. Readers more familiar with &Microsoft; &Windows; might + want to compare daemons and the tasks they are responsible + with "services". +<!-- + </para> + <para> +--> + One example of a daemon present on most + legacy &UNIX; systems is the LPD (Line Printer Daemon); &CUPS; is + widely seen as the successor to LPD in the &UNIX; world and + it also operates through a daemon.</para> + <glossseealso otherterm="gloss-spooling">SPOOLing</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-databaselinuxprinting"> + <glossterm>Database, Linuxprinting.org</glossterm> + <glossdef><para>Already years ago, when Linux printing was still really difficult + (only command line printing was known to most Linux users, no device + specific print options were available for doing the jobs), Grant Taylor, + author of the "Linux Printing HOWTO", collected most of the available + information about printers, drivers and filters in his database. +<!-- + </para> + <para> +--> + With the emerging + &CUPS; concept, extending the use of PPDs even to non-PostScript printers, + he realized the potential of this database: if one puts the different + datablobs (with content that could be described along the lines + "Which device prints with which Ghostscript or other + filter?", "How well?", and "What command line switches are available?") into + PPD-compatible files, he could have all the power of &CUPS; on top of + the traditional printer "drivers". +<!-- + </para> + <para> +--> + This has now developed into a broader + concept, known as "Foomatic". Foomatic extends the capabilities + of spoolers other than &CUPS; (LPR/LPD, LPRng, PDQ, PPR) to a certain + degree ("stealing" some concepts from &CUPS;). The Linuxprinting + Database is not a Linux-only stop -- mdash; people running other &UNIX; + based OSes (like *BSD or &MacOS; X) will also find valuable information + and software there. + </para> + <glossseealso otherterm="gloss-foomatic">Foomatic</glossseealso> + <glossseealso otherterm="gloss-linuxprintingdatabase">Linuxprinting database</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-directtcpipprinting"> + <glossterm>Direct TCP/IP Printing</glossterm> + <glossdef><para>This is a method that often uses TCP/IP port 9100 to connect + to the printer. It works with many modern network printers and has + a few advantages over LPR/LPD, as it is faster and provides some + "backchannel feedback data" from the printer to the host sending + the job.</para> + <glossseealso otherterm="gloss-appsocketprotocol">AppSocket Protocol</glossseealso> + <glossseealso otherterm="gloss-hpjetdirectprotocol">&HP; JetDirect Protocol</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-drivers"> + <glossterm>Drivers, Printer Drivers</glossterm> + <glossdef><para>The term "printer drivers", used in the same sense + as on the &Microsoft; &Windows; platform, is not entirely applicable + to a Linux or &UNIX; platform. A "driver" functionality + is supplied on &UNIX; by different modular components working + together. At the core of the printer drivers are "filters". Filters convert + print files from a given input format to another format that is acceptable + to the target printer. In many cases filters may be connected to a whole + filter "chain", where only the result of the last conversion is sent to the + printer. The actual transfer of the print data to the device is performed by + a "backend". + </para> + <glossseealso otherterm="gloss-filter">Filter</glossseealso> + <glossseealso otherterm="gloss-ppd">PPDs</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-easysoftwareproducts"> + <glossterm>Easy Software Products</glossterm> + <glossdef><para>Mike Sweet's company, which has contributed a few substantial + software products towards the Free Software community; amongst + them the initial version of <ulink + url="http://gimp-print.sf.net/">Gimp-Print,</ulink> the <ulink + url="http://www.easysw.com/epm/">EPM software packaging</ulink> tool + and <ulink url="http://www.easysw.com/htmldoc/">HTMLDOC</ulink> + (used by the "Linux Documentation Project" to build the PDF versions + of the HOWTOs) -- mdash; but most importantly: <ulink + url="http://www.cups.org/">&CUPS;</ulink> (the 'Common &UNIX; Printing + System'). +<!-- + </para> + <para> +--> + ESP finance themselves by selling a commercial version + of &CUPS;, called <ulink url="http://www.easysw.com/">ESP PrintPro,</ulink> + that includes some professional enhancements. + </para> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-espprintpro">ESP PrintPro</glossseealso> + <glossseealso otherterm="gloss-esp">ESP</glossseealso> + <glossseealso otherterm="gloss-gimpprint">Gimp-Print</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-encryption"> + <glossterm>Encryption</glossterm> + <glossdef><para>Encryption of confidential data is an all-important issue if + you transfer it over the Internet or even within intranets. +<!-- + </para> + <para> +--> + Printing + via traditional protocols is not encrypted at all -- mdash; it is very easy + to tap and eavesdrop ⪚ into &PostScript; or PCL data transfered + over the wire. +<!-- + </para> + <para> +--> + Therefore, in the design of IPP, provision was made for the easy + plugin of encryption mechanisms (which can be provided by the same + means as the encryption standards for HTTP traffic: SSL and TLS).</para> + <glossseealso otherterm="gloss-authentication">Authentication</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-ssl">SSL</glossseealso> + <glossseealso otherterm="gloss-tls">TLS</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-epson"> + <glossterm><acronym>Epson</acronym></glossterm> + <glossdef><para>Epson inkjets are among the best supported models by Free software + drivers, as the company was not necessarily as secretive about their + devices and handed technical specification documents to developers. + The excellent print quality achieved by Gimp-Print on the Stylus + series of printers can be attributed to this openness. +<!-- + </para> + <para> +--> + They have also + contracted Easy Software Products to maintain an enhanced version + of Ghostscript ("ESP GhostScript") for improved support of their + printer portfolio. + </para> + <glossseealso otherterm="gloss-ghostscript">ESP Ghostscript</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-escapesequence"> + <glossterm>Escape Sequences</glossterm> + <glossdef><para>The first ever printers printed ASCII data only. To + initiate a new line, or eject a page, they included special + command sequences, often carrying a leading [ESC]-character. + &HP; evolved this concept through its series of PCL language + editions until today, having now developed a full-blown + Page Description Language (PDL) from these humble beginnings. + </para> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + <glossseealso otherterm="gloss-pdl">PDL</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-escp"> + <glossterm><acronym>ESC/P</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>E</emphasis>pson + <emphasis>S</emphasis>tandard <emphasis>C</emphasis>odes for + <emphasis>P</emphasis>rinters. Besides &PostScript; and PCL, Epson's ESC/P + printer language is one of the best known.</para> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-hpgl">hpgl</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-esp"> + <glossterm><acronym>ESP</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>E</emphasis>asy + <emphasis>S</emphasis>oftware <emphasis>P</emphasis>roducts; + the company that developed &CUPS; (the "Common &UNIX; Printing System"). + </para> + <glossseealso otherterm="gloss-easysoftwareproducts">Easy Software Products</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-espprintpro">ESP PrintPro</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-espghostscript"> + <glossterm><acronym>ESP</acronym> Ghostscript</glossterm> + <glossdef><para>A Ghostscript version that is maintained by Easy Software + Products. It includes pre-compiled Gimp-Print drivers for + many inkjets (plus some other goodies). ESP Ghostscript + will produce photographic quality prints in many cases, especially + with the Epson Stylus model series. ESP Ghostscript is GPL-software. + </para> + <glossseealso otherterm="gloss-easysoftwareproducts">Easy Software Products</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-espprintpro">ESP PrintPro</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-espprintpro"> + <glossterm><acronym>ESP</acronym> PrintPro</glossterm> + <glossdef><para> This professional enhancement to &CUPS; (the "Common &UNIX; + Printing System") is sold by the developers + of &CUPS; complete with more than 2,300 printer drivers for several commercial + &UNIX; platforms. <ulink url="http://www.easysw.com/printpro/">ESP PrintPro</ulink> + is supposed to work "out of the box" with little or no configuration + for users or admins. ESP also sell support contracts for + &CUPS; and PrintPro. These sales help to feed the programmers who + develop the Free version of &CUPS;. + </para> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-filter"> + <glossterm>Filter</glossterm> + <glossdef><para>Filters, in general, are programs that take some input + data, work on it and pass it on as their output data. Filters + may or may not change the data. +<!-- + </para> + <para> +--> + Filters in the context of printing, are programs that convert + a given file (destined for printing, but not suitable in the + format it is presently) into a printable format. Sometimes + whole "filter chains" have to be constructed to achieve the + goal, piping the output of one filter as the input to the next. + </para> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + <glossseealso otherterm="gloss-rip">RIP</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-foomatic"> + <glossterm>Foomatic</glossterm> + <glossdef><para>Foomatic started out as the wrapper name for a set of + different tools available from <ulink + url="http://www.linuxprinting.org/">Linuxprinting.org</ulink> + These tools aimed to make the usage of traditional + Ghostscript and other print filters easier for users and + extend the filters' capabilities by adding more command line + switches or explain the driver's execution data. +<!-- + </para> + <para> +--> + Foomatic's different incarnations are &CUPS;-O-Matic, PPD-O-Matic, + PDQ-O-Matic, LPD-O-Matic, PPR-O-Matic, MF-O-Matic and + Direct-O-Matic. All of these allow the generation + of appropriate printer configuration files online, by simply + selection the suitable model and suggested (or alternate) driver + for that machine. +<!-- + </para> + <para> +--> + More recently, Foomatic gravitated towards becoming a "meta-spooling" + system, that allows configuration of the underlying print subsystem + through a unified set of commands (however, this is much more + complicated than TDEPrint's &GUI; interface, which performs a similar + task with regards to different print subsystems).</para> + <glossseealso otherterm="gloss-cups-o-matic">&CUPS;-O-Matic</glossseealso> + <glossseealso otherterm="gloss-PPD-O-Matic">PPD-O-Matic</glossseealso> + <glossseealso otherterm="gloss-cupsomatic">cupsomatic</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-ghostscript"> + <glossterm>Ghostscript</glossterm> + <glossdef><para>Ghostscript is a &PostScript; Raster Image Processor (RIP) in software, originally + developed by L. Peter Deutsch. There is always a <acronym>GPL</acronym> version + of Ghostscript available for free usage and distribution + (mostly 1 year old) while + the current version is commercially sold under another license. +<!-- + </para> + <para> +--> + Ghostscript is widely used inside the Linux and &UNIX; world + for transforming &PostScript; into raster data suitable + for sending to non-&PostScript; devices.</para> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-rip">RIP</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-gimpprint"> + <glossterm>Gimp-Print</glossterm> + <glossdef><para>Contrary to its name, Gimp-Print is no longer + just the plugin to be used for printing from the popular + Gimp program -- mdash; its codebase can also serve to be compiled + into... + <!-- + </para> + <para> +--> + *...a set of PPDs and associated filters that integrate seamlessly + into &CUPS;, supporting around 130 different printer models, providing + photographic output quality in many cases; +<!-- + </para> + <para> +--> + + *...a Ghostscript filter that can be used with any other + program that needs a software-RIP; +<!-- + </para> + <para> +--> + + *...a library that can be used by other software applications + in need of rasterization functions. + + +<!-- +after 4 hours fiddling, I +could not get those s!@*#? +<itemizedlist> to pass +through the meinproc checks. +For the time being I gave up +on it and handle it differently +now. + <itemizedlist> + <listitem>...a set of PPDs and associated filters that integrate seamlessly + into &CUPS;, supporting around 130 different printer models, providing + photografic output quality in many cases;</listitem> + <listitem>...a Ghostscript filter that can be used with any other + program that needs a software-RIP;</listitem> + <listitem>...a library that can be used by other software applications + in need of rasterization functions.</listitem> + </itemizedlist> +--> + </para> + <glossseealso otherterm="gloss-lexmark">Lexmark Drivers</glossseealso> + <glossseealso otherterm="gloss-rip">RIP</glossseealso> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-hp"> + <glossterm><acronym>&HP;</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>H</emphasis>ewlett-<emphasis>Packard</emphasis>; + one of the first companies to distribute their own Linux printer + drivers. -- mdash; More recently, the Company has released their + "HPIJS" package of drivers, including source code and a Free license. + This is the first printer manufacturer to do so. HPIJS supports most + current models of HP Ink- and DeskJets. + </para> + </glossdef> + </glossentry> + + + <glossentry id="gloss-hpgl"> + <glossterm><acronym>&HP;/GL</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>&HP;</emphasis> + <emphasis>G</emphasis>raphical <emphasis>L</emphasis>anguage; + a &HP; printer language mainly used for plotters; many CAD + (Computer Aided Design) software programs output &HP;/GL files for + printing.</para> + <glossseealso otherterm="gloss-escp">ESC/P</glossseealso> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-hpjetdirectprotocol"> + <glossterm>&HP; JetDirect Protocol</glossterm> + <glossdef><para>A term branded by &HP; to describe their implementation + of print data transfer to the printer via an otherwise "AppSocket" or + "Direct TCP/IP Printing" named protocol.</para> + <glossseealso otherterm="gloss-appsocketprotocol">AppSocket Protocol</glossseealso> + <glossseealso otherterm="gloss-directtcpipprinting">Direct TCP/IP Printing</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-ietf"> + <glossterm><acronym>IETF</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>I</emphasis>nternet + <emphasis>E</emphasis>ngineering <emphasis>T</emphasis>ask + <emphasis>F</emphasis>orce; an assembly of Internet, software + and hardware experts that discuss + new networking technologies and very often arrive at + conclusions that are regarded by many as standards. "TCP/IP" + is the most famous example. +<!-- + </para> + <para> +--> + + IETF standards, as well as + drafts, discussions, ideas and useful tutorials, are + put in writing in the famous series of "RFCs", which + are available to the public and included in most Linux and + BSD distributions.</para> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-pwg">PWG</glossseealso> + <glossseealso otherterm="gloss-rfc">RFC</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-ipp"> + <glossterm><acronym>IPP</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>I</emphasis>nternet + <emphasis>P</emphasis>rinting <emphasis>P</emphasis>rotocol; + defined in a series of RFCs accepted by the IETF with + status "proposed standard"; was designed + by the PWG. -- mdash; IPP is a completely new design for network printing, + but it utilizes a very well-known and proven method for the + actual data transfer: HTTP 1.1! By not "re-inventing the wheel", + and basing itself on an existing and robust Internet standard, + IPP is able to relatively easily bolt other HTTP-compatible standard + mechanisms into its framework: +<!-- + </para> + <para> +--> + * Basic, Digest or Certificate authentication + mechanisms; +<!-- + </para> + <para> +--> + * SSL or TLS for encryption of transferred + data; +<!-- + </para> + <para> +--> + * LDAP for directory services (to publish + data on printers, device-options, drivers, costs or + also to the network; or to check for passwords while + performing authentication). +<!-- + </para> + <para> +--> + +<!-- + </para> + <itemizedlist> + <listitem>Basic, Digest or Certificate authentication + mechanisms</listitem> + <listitem>SSL or TLS for encryption of transferred + data</listitem> + <listitem>LDAP for directory services (to publish + data on printers, device-options, drivers, costs or + elso to the network; or to check for passwords while + conducting authentication)</listitem> + </itemizedlist> +--> + </para> + + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-pwg">PWG</glossseealso> + <glossseealso otherterm="gloss-ietf">IETF</glossseealso> + <glossseealso otherterm="gloss-rfc">RFC</glossseealso> + <glossseealso otherterm="gloss-tls">TLS</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-tdeprint"> + <glossterm><acronym>TDEPrint</acronym></glossterm> + <glossdef><para>The new printing functionality of &tde; since version 2.2 + consists of several modules that translate the features and settings + of different available print subsystems (&CUPS;, BSD-style LPR/LPD, RLPR...) + into nice &tde; desktop &GUI; windows and dialogs to ease their + usage. +<!-- + </para> + <para> +--> + Most important for day-to-day usage is "kprinter", the new + &GUI; print command. -- mdash; Note: TDEPrint does <emphasis>not</emphasis> implement its own + spooling mechanism or its own &PostScript; processing; for this it + relies on the selected <emphasis>print subsystem</emphasis> + -- however it does add some functionality of its own on top of this + foundation... + </para> + <glossseealso otherterm="gloss-bsdstyleprinting">BSD-style printing</glossseealso> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-kprinter">kprinter</glossseealso> + <glossseealso otherterm="gloss-tdeprinthandbook">TDEPrint Handbook</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-tdeprinthandbook"> + <glossterm><acronym>TDEPrint Handbook...</acronym></glossterm> + <glossdef><para>...is the name of the reference document that describes TDEPrint + functions to users and administrators. You can load it into Konqueror by + typing "help:/tdeprint" into the address field. It is authored and maintained by Kurt + Pfeifle. + </para> + <glossseealso otherterm="gloss-cupsfaq">&CUPS;-FAQ</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-kprinter"> + <glossterm>kprinter</glossterm> + <glossdef><para><emphasis>kprinter</emphasis> is the new powerful + print utility that is natively used by all &tde; applications. +<!-- + </para> + <para> +--> + Contrary to some common misconceptions, + <emphasis>kprinter</emphasis> is <emphasis>not</emphasis> a &CUPS;-only tool, + but supports different print subsystems. You can even switch + to a different print subsystem "on the fly", in between two jobs, + without re-configuration. Of course, due to the powerful + features of &CUPS;, <emphasis>kprinter</emphasis> is + best suited for use with a &CUPS; frontend. +<!-- + </para> + <para> +--> + <emphasis>kprinter</emphasis> is the successor + to "qtcups", which is no longer being actively maintained. It has + inherited all the best features of qtcups and added several new ones. +<!-- + </para> + <para> +--> + + MOST IMPORTANT: you can use <emphasis>kprinter</emphasis> + with all its features in all non-&tde; applications that allow + a customized print command, like gv, Acrobat Reader, Netscape, + Mozilla, Galeon, StarOffice, OpenOffice and all GNOME programs. +<!-- + </para> + <para> +--> + <emphasis>kprinter</emphasis> can act as a "standalone" + utility, started from an X-Terminal or a "Mini-CLI" to + print many different files, from different folders, with different + formats, in one job and simultaneously, without the need to first open the + files in the applications! (File formats supported this way are &PostScript;, + PDF, International and ASCII Text, as well as many different popular graphic + formats, such as PNG, TIFF, JPEG, PNM, Sun RASTER, &etc;) + </para> + <glossseealso otherterm="gloss-qtcups">QtCUPS</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-lexmark"> + <glossterm><acronym>Lexmark</acronym></glossterm> + <glossdef><para>was one of the first companies to distribute their own Linux printer + drivers for some of their models. However, those drivers are binary only + (no source code available), and therefore cannot be used to integrate into + other Free printing software projects. + </para> + </glossdef> + </glossentry> + + <glossentry id="gloss-linuxprintingorg"> + <glossterm>Linuxprinting.org</glossterm> + <glossdef><para>Linuxprinting.org = not just for Linux; all &UNIX;-like OS-es, + like *BSD and commercial Unices may find useful printing + information on this site. This web site is the home for the interesting + Foomatic project, that strives to develop the "Meta Print Spool and Driver + Configuration Toolset" (being able to configure, through one common + interface, different print subsystems and their required drivers) with the + ability to transfer all queues, printers and configuration files seamlessly + to another spooler without new configuration effort. -- mdash; Also, they maintain + the Printing Database; a collection of driver and device information that + enables everybody to find the most current information about printer models, + and also generate online the configuration files for any + spooler/driver/device combo known to work with one of the common Linux or + &UNIX; print subsystems. + </para> + <glossseealso otherterm="gloss-linuxprintingdatabase">Linuxprinting database</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-linuxprintingdatabase"> + <glossterm><acronym>Linuxprinting.org Database</acronym></glossterm> + <glossdef><para>....Database containing printers and drivers that are suitable + for them... ...a lot of information and documentation to be found... ...it + is now also providing some tools and utilities for easing the integration + of those drivers into a given system... ...the "Foomatic" family + of utilities; being the toolset to make use of the database + for most of the commonly used print subsystems, for generating "on the fly" + working configurations for your printer model. + </para> + <glossseealso otherterm="gloss-foomatic">Foomatic</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-lprlpd"> + <glossterm><acronym>LPR/LPD</acronym> printing</glossterm> + <glossdef><para>LPR == some people translate <emphasis>L</emphasis>ine + <emphasis>P</emphasis>rinting <emphasis>R</emphasis>equest, others: + <emphasis>L</emphasis>ine <emphasis>P</emphasis>rinter + <emphasis>R</emphasis>emote.</para> + <glossseealso otherterm="gloss-bsdstyleprinting">BSD-style printing</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-magicfilter"> + <glossterm>Magicfilter</glossterm> + <glossdef><para>Similarly to the APSfilter program, Magicfilter + provides automatic file type recognition functions and, base + on that, automatic file conversion to a printable format, + depending on the target printer.</para> + <glossseealso otherterm="gloss-apsfilter">APSfilter</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-mimetypes"> + <glossterm>&MIME;-Types</glossterm> + <glossdef><para>Abbreviation for <emphasis>M</emphasis>ultipurpose (or + Multimedia) <emphasis>I</emphasis>nternet <emphasis>M</emphasis>ail + <emphasis>E</emphasis>xtensions; &MIME;-Types were first used to allow + the transport of binary data (like mail attachments containing + graphics) over mail connections that were normally only transmitting + ASCII characters: the data had to be encoded into an ASCII representation. +<!-- + </para> + <para> +--> + Later this concept was extended to describe a data format in + a platform independent, but at the same time non-ambiguous, way. + From &Windows; everybody knows the .doc extensions for &Microsoft; Word files. + This is handled ambiguously on the &Windows; platform: .doc extensions are also + used for simple text files or for Adobe Framemaker files. And if a real + Word file is renamed with a different extension, it can no longer be + opened by the program. +<!-- + </para> + <para> +--> + &MIME; typed files carry a recognition string with them, describing + their file format based on <emphasis>main_category/sub_category</emphasis>. + Inside IPP, print files are also described using the &MIME; type scheme. + &MIME; types are registered with the IANA (Internet Assigning Numbers + <emphasis>Association</emphasis>) to keep them unambiguous. +<!-- + </para> + <para> +--> + &CUPS; has some &MIME; types of its own registered, like + <emphasis>application/vnd.cups-raster</emphasis> (for the &CUPS;-internal + raster image format). + + </para> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-easysoftwareproducts">Easy Software Products</glossseealso> + <glossseealso otherterm="gloss-espprintpro">ESP PrintPro</glossseealso> + <glossseealso otherterm="gloss-gimpprint">Gimp-Print</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-pcl"> + <glossterm><acronym>PCL</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>P</emphasis>rinter + <emphasis>C</emphasis>ontrol <emphasis>L</emphasis>anguage; + developed by &HP;. PCL started off in version 1 as a simple + command set for ASCII printing; now, + in its versions PCL6 and PCL-X, it is capable of printing graphics + and color -- mdash; but outside the &Microsoft; &Windows; realm and &HP-UX; + (&HP;'s own brand of &UNIX;), it is not commonly used...</para> + <glossseealso otherterm="gloss-escp">ESC/P</glossseealso> + <glossseealso otherterm="gloss-hpgl">&HP;/GL</glossseealso> + <glossseealso otherterm="gloss-pdl">PDL</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-pdl"> + <glossterm><acronym>PDL</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>P</emphasis>age + <emphasis>D</emphasis>escription <emphasis>L</emphasis>anguage; + PDLs describe, in an abstract way, the graphical representation + of a page. - Before it is actually transferred into + toner or ink laid down on to paper, a PDL needs to be + "interpreted" first. In &UNIX;, the most important PDL + is &PostScript;. + </para> + <glossseealso otherterm="gloss-escp">ESC/P</glossseealso> + <glossseealso otherterm="gloss-hpgl">&HP;/GL</glossseealso> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-pixel"> + <glossterm>Pixel</glossterm> + <glossdef><para>Abbreviation for <emphasis>Pic</emphasis>ture + <emphasis>El</emphasis>ement; this term describes the smallest + part of a raster picture (either as printed on paper + or as displayed on a monitor by cathode rays or LCD elements). As + any graphical or image representation on those types of output + devices is composed of pixels, the values of "ppi" (pixel per inch) + and &dpi; (dots per inch) are one important parameter for the + overall quality and resolution of an image.</para> + <glossseealso otherterm="gloss-filter">Filter</glossseealso> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-raster">Raster</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-pjl"> + <glossterm><acronym>PJL</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>P</emphasis>rint + <emphasis>J</emphasis>ob <emphasis>L</emphasis>anguage; + developed by &HP; to control and influence default and per-job + settings of a printer. It may not only be used + for &HP;'s own (PCL-)printers; also many &PostScript; + and other printers understand PJL commands sent to them + inside a print job, or in a separate signal.</para> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-postscript"> + <glossterm>&PostScript;</glossterm> + <glossdef><para>&PostScript; (often shortened to "PS") is the de-facto + standard in the &UNIX; world for printing files. It was + developed by Adobe and licensed to printer manufacturers + and software companies. +<!-- + </para> + <para> +--> + As the &PostScript; specifications were + published by Adobe, there are also "Third Party" implementations + of &PostScript; generating and &PostScript; interpreting software + available (one of the best-known in the Free software world + being Ghostscript, a powerful PS-interpreter). + </para> + <glossseealso otherterm="gloss-escp">ESC/P</glossseealso> + <glossseealso otherterm="gloss-hpgl">&HP;/GL</glossseealso> + <glossseealso otherterm="gloss-pcl">PCL</glossseealso> + <glossseealso otherterm="gloss-ppd">PPD</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-ppd"> + <glossterm><acronym>PPD</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>P</emphasis>ostScript + <emphasis>P</emphasis>rinter <emphasis>D</emphasis>escription; + PPDs are ASCII files storing all information about the special + capabilities of a printer, plus definitions of the (PostScript- + or PJL-) commands to call on a certain capability (like print + duplexing). +<!-- + </para> + <para> +--> + + As the explanation of the acronym reveals, PPDs were originally + only used for &PostScript; printers. &CUPS; has extended the + PPD concept to all types of printers. +<!-- + </para> + <para> +--> + + PPDs for &PostScript; printers are provided by the printer + vendors. They can be used with &CUPS; and TDEPrint to have access + to the full features of any &PostScript; printer. The TDEPrint Team + recommends using a PPD originally intended for use with + &Microsoft; Windows NT. +<!-- + </para> + <para> +--> + + PPDs for non-PostScript printers <emphasis>need</emphasis> a + companion "filter" to process the &PostScript; print files into + a format digestible for the non-PostScript target device. Those + PPD/filter combos are not (yet) available from the vendors. After + the initiative by the &CUPS; developers to utilize PPDs, the Free + Software community was creative enough to quickly come up with + support for most of the currently used printer models, through + PPDs and classical Ghostscript filters. But note: the printout + quality varies from "hi-quality photographic output" (using + Gimp-Print with most Epson inkjets) to "hardly readable" (using + Foomatic-enabled Ghostscript filters for models rated as + "paperweight" in the Linuxprinting.org database). + </para> + <glossseealso otherterm="gloss-cups">&CUPS;</glossseealso> + <glossseealso otherterm="gloss-linuxprintingorg">Linuxprinting.org</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-PPD-O-Matic"> + <glossterm>PPD-O-Matic</glossterm> + <glossdef><para>PPD-O-Matic is a set of Perl scripts that run on the Linuxprinting.org + web server and can be used online to generate PPDs for any printer that is known + to print with Ghostscript. +<!-- + </para> + <para> +--> + + These PPDs can be hooked up to &CUPS;/TDEPrint, as well as + used inside PPD-aware applications like StarOffice to determine all different + parameters of your printjobs. It is now recommended, in most cases, to + use "PPD-O-Matic" instead of the older &CUPS;-O-Matic. +<!-- + </para> + <para> +--> + + To generate a PPD, go to the <ulink + url="http://www.linuxprinting.org/printer_list.cgi">printer + database</ulink>, select your printer model, follow + the link to show the available Ghostscript filters for that printer, select + one, click "generate" and finally save the file to your local system. + Be sure to read the instructions. Make sure that your local system + does indeed have Ghostscript and the filter, which you chose + before generating the PPD, installed. + </para> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-cups-o-matic">&CUPS;-O-Matic</glossseealso> + <glossseealso otherterm="gloss-linuxprintingorg">Linuxprinting.org</glossseealso> + <glossseealso otherterm="gloss-foomatic">Foomatic</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-printcap"> + <glossterm>printcap</glossterm> + <glossdef><para>In BSD-style print systems, the "printcap" file holds + the configuration information; the printing daemon reads this file + to determine which printers are available, what filters are to be + user for each, where the spooling folder is located, + if there are banner pages to be used, and so on... + Some applications also depend on read access to the printcap + file, to obtain the names of available printers.</para> + <glossseealso otherterm="gloss-bsdstyleprinting">BSD-style printing</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-printermib"> + <glossterm>Printer-<acronym>MIB</acronym></glossterm> + <glossdef><para>Abbreviation for + <emphasis>Printer</emphasis>-<emphasis>M</emphasis>anagement + <emphasis>I</emphasis>nformation <emphasis>B</emphasis>ase; the + Printer-MIB defines a set of parameters that are to be + stored inside the printer for access + through the network. This is useful if many (in some cases, literally + thousands) network printers are managed centrally + with the help of SNMP (Simple Network Management Protocol).</para> + <glossseealso otherterm="gloss-pwg">PWG</glossseealso> + <glossseealso otherterm="gloss-snmp">SNMP</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-pwg"> + <glossterm><acronym>PWG</acronym></glossterm> + <glossdef><para>Abbreviation for + <emphasis>P</emphasis>rinter <emphasis>W</emphasis>orking + <emphasis>G</emphasis>roup; the PWG is a loose grouping of + representatives of the printer industry that has, in the past + years, developed different standards + in relation to network printing. These were later accepted by the + IETF as RFC standards, like the "Printer-MIB" and the IPP.</para> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-ipp">IPP</glossseealso> + <glossseealso otherterm="gloss-printermib">Printer-MIB</glossseealso> + <glossseealso otherterm="gloss-snmp">SNMP</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-printtdeioslave"> + <glossterm>print:/ TDEIO Slave</glossterm> + <glossdef><para>You can use a syntax of "print:/..." to get quick access + to TDEPrint resources. Typing "print:/manager" as a Konqueror URL + address gives administrative access to TDEPrint. Konqueror uses &tde;'s + famous "KParts" technology to achieve that.</para> + <glossseealso otherterm="gloss-ioslave">IO Slave</glossseealso> + <glossseealso otherterm="gloss-tdeparts">KParts</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-printerdatabase"> + <glossterm>Printer Database</glossterm> + <glossdef><para>.</para> + <glossseealso otherterm="gloss-linuxprintingdatabase">Linuxprinting Database</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-qtcups"> + <glossterm><acronym>Qt&CUPS;</acronym></glossterm> + <glossdef><para>Qt&CUPS; and KUPS were the predecessors of TDEPrint; they are now + deprecated and no longer maintained. What was good in qtcups is all inherited + by "kprinter", the new TDE print dialog (which is much improved over qtcups); + what you liked about kups is now all in the TDEPrint Manager (accessible + via the Trinity Control Center or via the URL "print:/manager" from Konqueror) -- + with more functionality and less bugs... Its former developer, Michael Goffioul, is now + the developer of TDEPrint -- mdash; a very nice and productive guy and quick bug fixer... + </para> + <glossseealso otherterm="gloss-kprinter">kprinter</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-raster"> + <glossterm>Raster Image</glossterm> + <glossdef><para>Every picture on a physical medium + is composed of a pattern of discrete dots in different colors and (maybe) + sizes. This is called a "raster image". +<!-- + </para> + <para> +--> + + This is as opposed to a "vector image" + where the graphic is described in terms of continuous curves, shades, + forms and filled areas, represented by mathematical formula. Vector images + normally have a smaller file size and may be scaled in size + without any loss of information and quality --- but they cannot be + output directly, but always have to be "rendered" or "rasterized" + first to the given resolution that the output device is capable of... +<!-- + </para> + <para> +--> + + + The rasterization is done by a Raster Image Processor (RIP, + often the Ghostscript software) or some other filtering + instance.</para> + <glossseealso otherterm="gloss-pixel">Pixel</glossseealso> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-filter">Filter</glossseealso> + <glossseealso otherterm="gloss-rip">RIP</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-rip"> + <glossterm><acronym>RIP</acronym></glossterm> + <glossdef><para>Abbreviation for + <emphasis>R</emphasis>aster <emphasis>I</emphasis>mage + <emphasis>P</emphasis>rocess(or); if used in the context of + printing, "RIP" means a hardware or software + instance that converts &PostScript; (or other print formats + that are represented in one of the non-Raster PDLs) into a + raster image format in such a way that it is acceptable + for the "marking engine" of the printer. +<!-- + </para> + <para> +--> + + &PostScript; printers + contain their own PostScript-RIPs. A RIP may or may not be located + inside a printer. +<!-- + </para> + <para> +--> + + For many &UNIX; systems, Ghostscript is the package that provides + a "RIP in software", running on the host computer, and pre-digesting + the &PostScript; or other data to become ready to be sent to the + printing device (hence you may perceive a "grain of truth" in the + slogan "Ghostscript turns your printer into a &PostScript; + machine", which of course is not correct in the true sense of the + meaning).</para> + <glossseealso otherterm="gloss-filter">Filter</glossseealso> + <glossseealso otherterm="gloss-ghostscript">Ghostscript</glossseealso> + <glossseealso otherterm="gloss-postscript">&PostScript;</glossseealso> + <glossseealso otherterm="gloss-pdl">PDL</glossseealso> + <glossseealso otherterm="gloss-raster">Raster</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-rlpr"> + <glossterm><acronym>RLPR</acronym> (Remote LPR)</glossterm> + <glossdef><para>Abbreviation for <emphasis>R</emphasis>emote + <emphasis>L</emphasis>ine <emphasis>P</emphasis>rinting + <emphasis>R</emphasis>equest; this is a BSD-style printing system, + that needs no root privileges to be installed, and no "printcap" to + work: all parameters may be specified on the command + line. +<!-- + </para> + <para> +--> + + RLPR comes in handy for many laptop users who are + working in frequently changing environments. This is because it + may be installed concurrently with every other printing + sub system, and allows a very flexible and quick + way to install a printer for direct access via LPR/LPD. +<!-- + </para> + <para> +--> + + TDEPrint + has an "Add Printer Wizard" to make RLPR usage even easier. + The kprinter command allows switching to RLPR "on + the fly" at any time.</para> + <glossseealso otherterm="gloss-tdeprint">TDEPrint</glossseealso> + <glossseealso otherterm="gloss-kprinter">kprinter</glossseealso> + <glossseealso otherterm="gloss-printcap">printcap</glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-snmp"> + <glossterm><acronym>SNMP</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>S</emphasis>imple + <emphasis>N</emphasis>etwork <emphasis>M</emphasis>anagement + <emphasis>P</emphasis>rotocol; SNMP is widely used to control + all types of network node (Hosts, Routers, Switches, Gateways, + Printers...) remotely.</para> + <glossseealso otherterm="gloss-pwg">PWG</glossseealso> + <glossseealso otherterm="gloss-printermib">Printer-MIB</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-ssl"> + <glossterm><acronym>SSL(3)</acronym> encryption</glossterm> + <glossdef><para>Abbreviation for <emphasis>S</emphasis>ecure + <emphasis>S</emphasis>ocket <emphasis>L</emphasis>ayer; + <acronym>SSL</acronym> is a proprietary encryption method for data + transfer over HTTP that was developed by Netscape. It is now being + replaced by an IETF standard named TLS. + </para> + <glossseealso otherterm="gloss-tls"><acronym>TLS</acronym></glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-spooling"> + <glossterm><acronym>SPOOL</acronym>ing</glossterm> + <glossdef><para>Abbreviation for <emphasis>S</emphasis>ynchronous + <emphasis>P</emphasis>eripheral <emphasis>O</emphasis>perations + <emphasis>O</emphasis>n<emphasis>L</emphasis>ine; + <acronym>SPOOL</acronym>ing enables printing applications + (and users) to continue their work + as the job is being taken care of by a system <acronym>daemon</acronym>, + which stores the file at a temporary location until the printer is ready + to print.</para> + <glossseealso otherterm="gloss-daemon"><acronym>Daemon</acronym></glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-tls"> + <glossterm><acronym>TLS</acronym> encryption</glossterm> + <glossdef><para>Abbreviation for <emphasis>T</emphasis>ransport + <emphasis>L</emphasis>ayer <emphasis>S</emphasis>ecurity; + <acronym>TLS</acronym> is an encryption standard for + data transfered over HTTP 1.1; it is defined in RFC 2246; + although based on the former SSL development + (from Netscape) it is not fully compatible with it. + </para> + <glossseealso otherterm="gloss-ssl"><acronym>SSL(3)</acronym></glossseealso> + </glossdef> + </glossentry> + + + <glossentry id="gloss-systemVstyleprinting"> + <glossterm>System V-style printing</glossterm> + <glossdef><para>This is the second flavor of traditional &UNIX; + printing (as opposed to BSD-style printing). It uses + a different command set (lp, lpadmin,...) to BSD, + but is not fundamentally different from it. However, the + gap between the two is big enough to make the two + incompatible, so that a BSD-client cannot simply print + to a System V style print server without additional + tweaking... IPP is supposed to resolve this weakness + and more. + </para> + <glossseealso otherterm="gloss-bsdstyleprinting"><acronym>BSD-style printing</acronym></glossseealso> + <glossseealso otherterm="gloss-ipp"><acronym>IPP</acronym></glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-turboprint"> + <glossterm>TurboPrint</glossterm> + <glossdef><para>Shareware software providing photo quality printing for many + inkjet printers. It is useful if you are unable to find a driver for your + printer and may be hooked into either a traditional Ghostscript system + or a modern &CUPS; system.</para> + <glossseealso otherterm="gloss-gimpprint">Gimp-Print</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-xpp"> + <glossterm><acronym>XPP</acronym></glossterm> + <glossdef><para>Abbreviation for <emphasis>X</emphasis> + <emphasis>P</emphasis>rinting <emphasis>P</emphasis>anel; + <acronym>XPP</acronym> was the first Free + graphical print command for &CUPS;, written by Till Kamppeter, + and in some ways a model for the "kprinter" utility in &tde;.</para> + </glossdef> + </glossentry> +<!-- + <glossentry id="gloss-1"> + <glossterm>xxxx</glossterm> + <glossdef><para>.</para> + <glossseealso otherterm="gloss-1">xyz</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-3"> + <glossterm>xxxx</glossterm> + <glossdef><para>.</para> + <glossseealso otherterm="gloss-1">xyz</glossseealso> + </glossdef> + </glossentry> + + <glossentry id="gloss-4"> + <glossterm>xxxx</glossterm> + <glossdef><para>.</para> + <glossseealso otherterm="gloss-1">xyz</glossseealso> + </glossdef> + </glossentry> +--> + </glossdiv> + + +<!-- +</glossary> +--> diff --git a/doc/khelpcenter/helpnotfound/CMakeLists.txt b/doc/khelpcenter/helpnotfound/CMakeLists.txt new file mode 100644 index 000000000..856ae3155 --- /dev/null +++ b/doc/khelpcenter/helpnotfound/CMakeLists.txt @@ -0,0 +1,9 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/helpnotfound ) diff --git a/doc/khelpcenter/helpnotfound/index.docbook b/doc/khelpcenter/helpnotfound/index.docbook new file mode 100644 index 000000000..bcc0ca9ad --- /dev/null +++ b/doc/khelpcenter/helpnotfound/index.docbook @@ -0,0 +1,45 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article id="helpnotfound" lang="&language;"> +<title>Help Documentation Not Found</title> + +<articleinfo> +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +</articleinfo> + +<para>The requested help file was not found. &tde; looks for files +in a location that depends upon how &tde; was installed on your +computer. There are several possible reasons why no help file +was found. The document might not exist or might not have +been installed.</para> + +<para>To resolve the problem, first contact the upstream packager.</para> + +<para>If no help file exists, then please report this bug using the +<ulink url="http://bugs.trinitydesktop.org/">TDE Bug Tracker</ulink>. +</para> + +<para>If no help file exists and you are interested in helping further, +please consider writing the help file. Submitting a basic text file is acceptable.</para> + +<para>If no help file exists for your native language, please consider helping with a translation.</para> + +<para>Thank you for helping and thank you for your patience.</para> + +</article>
\ No newline at end of file diff --git a/doc/khelpcenter/quickstart/CMakeLists.txt b/doc/khelpcenter/quickstart/CMakeLists.txt new file mode 100644 index 000000000..ba7a81cfd --- /dev/null +++ b/doc/khelpcenter/quickstart/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/quickstart ) diff --git a/doc/khelpcenter/quickstart/Makefile.am b/doc/khelpcenter/quickstart/Makefile.am new file mode 100644 index 000000000..7e42282c4 --- /dev/null +++ b/doc/khelpcenter/quickstart/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/quickstart diff --git a/doc/khelpcenter/quickstart/index.docbook b/doc/khelpcenter/quickstart/index.docbook new file mode 100644 index 000000000..a70ab467c --- /dev/null +++ b/doc/khelpcenter/quickstart/index.docbook @@ -0,0 +1,1335 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "Quickstart Guide to &tde;"> + <!ENTITY package "tdebase"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>Quickstart Guide to &tde;</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<copyright> +<year>1999-2002</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para>Quickstart Guide to &tde;</para> +<para>An introduction to the Trinity Desktop Environment</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>quick start</keyword> +<keyword>introduction</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +This guide provides a brief introduction to the Trinity Desktop Environment. It +will familiarize you with some of the basic features of &tde;. +</para> + +<para> +This guide does not cover all aspects of the Trinity Desktop or even most +of them. This guide only describes some of the most basic ways to accomplish a few +of the most common tasks. The <ulink url="help:/khelpcenter/userguide">&tde; User's Guide</ulink> +provides detailed coverage of using Trinity. +</para> + +<para> +Use this guide with the presumption of being familiar with at least one graphical +user interface, such as <trademark>CDE</trademark>, +<trademark>Geos</trademark>, <trademark>GEM</trademark>, &NeXTSTEP;, +&Mac;, <trademark>OS/2</trademark> or &Microsoft; &Windows;. Basic concepts, such as +using the mouse or keyboard are not explained in this guide. +</para> + +</chapter> + +<chapter id="an-overview-of-kde"> +<title>An Overview of &tde;</title> + +<para> +This section is for users who prefer to learn by exploring and want +only a brief orientation to get started. Later sections provide a more +thorough introduction to the environment, with helpful hints and +shortcuts. If you are impatient to get started, skim this section, go +play for a bit, then come back and peruse the other sections of this +guide as needed. +</para> + +<note> +<para> +&tde; provides a highly configurable desktop environment. This +overview presumes that you are using the default environment. +</para> +</note> + +<sect1 id="the-kde-desktop"> +<title>The &tde; Desktop</title> + +<para>A typical Trinity desktop consists of several parts:</para> + +<itemizedlist> +<listitem> +<para>A <interface>panel</interface> at the bottom of the screen, used +to start applications and switch between desktops. Among other things, it +contains the &kmenu;, with an &ticon; +that displays a menu of applications to start. +</para> +</listitem> + +<listitem> +<para> +A <interface>taskbar</interface>, by default embedded in the panel, used +to switch between and manage currently running applications. Click on an +application on the taskbar to switch to the application. +</para> +</listitem> + +<listitem> +<para> +The <interface>desktop</interface> itself, on which frequently used +files and folders might be placed. &tde; provides multiple desktops, +each of which has its own windows. Click on the numbered buttons on +the panel to switch between desktops. +</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="ready-set-go"> +<title>Ready, Set, Go!</title> + +<para>Here are a few quick tips to get you up and running.</para> + +<itemizedlist> +<listitem> +<para> +To start an application, click on the &ticon; button on +the panel (called the <link linkend="starter">&kmenu;</link>) +and choose an item from the menu. +</para> +</listitem> +<listitem> +<para> +Click the icon that looks like a picture of a house on +the panel to access the files in your home folder using +&konqueror;, &tde;'s File Manager utility. +</para> +</listitem> +<listitem> +<para>Choose <menuchoice><guimenu>TDE menu</guimenu> +<guisubmenu>System</guisubmenu> +<guimenuitem>Konsole</guimenuitem></menuchoice> to get a &UNIX; +command prompt, or press <keycombo action="simul">&Alt; +<keycap>F2</keycap></keycombo> to get a mini command prompt window to +execute a single command. +</para> +</listitem> + +<listitem> +<para> +Choose the <menuchoice><guimenuitem>Control Center</guimenuitem> +</menuchoice> item on the &kmenu; to configure &tde;. +</para> +</listitem> + +<listitem> +<para> +Press <keycombo action="simul">&Alt;<keycap>Tab</keycap></keycombo> to +switch between applications and <keycombo +action="simul">&Ctrl;<keycap>Tab</keycap></keycombo> to switch between +desktops using the keyboard. +</para> +</listitem> + +<listitem> +<para> +Use the &RMB; mouse button to access context menus for the panel, +desktop, and most &tde; applications. +</para> +</listitem> +</itemizedlist> + +</sect1> +</chapter> + +<chapter id="launching-applications"> +<title>Launching Applications</title> + +<sect1 id="starter"> +<title>Using the &kmenu; and the Panel</title> + +<para> +At the bottom of the screen you will find the desktop panel, which is called +&kicker;. Use the panel to launch applications. Have a look at the +button on the left with a large &ticon;. +</para> + +<para> +This button is called the &kmenu;. When the mouse pointer hovers over the icon, +a small arrow on the top indicates that it will pop up a menu if you +click on it. The popup offers you easy access to all &tde; +applications installed on your computer system. +</para> + +<sect2> +<title>Customizing &kicker;</title> + +<!-- FIXME: To add a button, use the little arrows on kicker, not the TDE menu +I am not sure I agree - some distributions fade or hide the applet handles by default, but +I haven't found one yet that hides the kmenu. (JLH) --> + +<para>If you use one application or tool very often, then you might want to have fast +access to it. In this case you can add a single application or an entire sub-menu of the +&kmenu; as a special quick-launch button on the panel. If you want to reach an application +directly via a launch button, click with the &RMB; either on a clear space on the panel or on the +&kmenu; icon. Select <menuchoice><guimenu>Panel Menu</guimenu> <guisubmenu>Add Application to Panel... +</guisubmenu></menuchoice> and then navigate to the application or menu you would like to add to +the panel.</para> + + +<para> +You can add an entire menu this way, or one of the &ticon; +button sub-menus. For example, if you have &koffice; installed and +want quick access to all the &koffice; applications, without having to +navigate through the &kmenu;, then instead of choosing an +application, click on the <guimenuitem>Add Menu to Main Panel</guimenuitem> menu +entry. Thereafter you will have instant access to all the &koffice; +applications, without having to put an icon for each on the panel. +</para> + +<note> +<para> +You can move all items of the panel around with the +<guimenuitem>Move</guimenuitem> command of the context menu. Just click +with the <mousebutton>third</mousebutton> mouse button (the +<mousebutton>third</mousebutton> mouse button is normally the +<mousebutton>right</mousebutton> button, but if you have configured your +mouse differently, for example for left-handers, it might also be the +<mousebutton>left</mousebutton> one). A menu will pop up where you can +choose <guimenuitem>Move</guimenuitem>. Now move the mouse and see how +the icon follows while still staying on the panel. When you are done, +simply press the <mousebutton>first</mousebutton> mouse button (by default +the <mousebutton>left</mousebutton> one). As you might have noticed, +there is also a menu entry <guimenuitem>Remove</guimenuitem> in case you +are tired of a certain launch button on your desktop. +</para> +</note> + +</sect2> + +<sect2> +<title>Using Context menus</title> + +<para> +This leads us to another interesting topic: in many places, you can +click the <mousebutton>right</mousebutton> mouse button to display a +<interface>context menu</interface> with choices that are applicable to +the item you clicked. It is therefore always a good idea to try out the +<mousebutton>third</mousebutton> mouse button on something, if you do +not know what to do with it. Even the background of the desktops has +such a menu! +</para> + +</sect2> + +<sect2> +<title>Other Panel features</title> + +<para> +There are other interesting things possible with the panel. One +might be important if you have a low resolution on your monitor: it is +the <quote>hide-and-show</quote> function, activated by clicking on the +small arrowed button, which is at one or both ends of the panel. +</para> + +<para> +Perhaps you just do not like the panel extending the full width of the +screen. That's easily changed! &RMB; on an empty space in the panel, +and choose <menuchoice><guimenuitem>Configure Panel...</guimenuitem></menuchoice>. In the &kcontrolcenter; +dialog that pops up, you can choose <guilabel>Length</guilabel> on +the <guilabel>Appearance</guilabel> tab, and use the slider there to set +the panel to less than 100% width. +</para> + +<para> +If you're following along, and have that dialog open anyway, then feel +free to play with all the options, and use the +<guibutton>Apply</guibutton> to see the effect they have. You can +easily reset everything to the default configuration, by simply pressing +the <guibutton>Use Defaults</guibutton> button. +</para> + +<para> +By the way, if you are not sure what a certain button does in &tde;, +just move the mouse pointer over it and wait for a short while: &tde; +has a built-in mini context help, called <quote>tool tips</quote>, which +explains the functionality of such controls in a few words. +</para> + + +</sect2> +</sect1> + +<sect1 id="want-command-line-back"> +<title>I want access to the command line!</title> + +<para> +There is nothing to fear. &tde; does not remove the +effective command line. You can move +your files with the desktop, but you can also use the &UNIX; commands you are +accustomed to. In fact,&tde; puts command line power at your fingertips, +in perhaps some surprising places. +</para> + +<para> +&tde; provides a very sophisticated command line window called +&konsole;. Choose <menuchoice><guimenu>TDE menu</guimenu> +<guisubmenu>System</guisubmenu> +<guimenuitem>Konsole</guimenuitem></menuchoice> to start it. This might +be something you want on your panel. +</para> + +<para> +Sometimes, you only want to enter one command on the command line. In +these cases, you do not need a full-blown terminal. Just press +<keycombo>&Alt;<keycap>F2</keycap></keycombo> and you get a +small command line where you can enter one command. The command line +window will disappear afterwards, but it remembers your command. +</para> + +<para> +When you pop up this window (that is called +<application>minicli</application>) and press the <keycap>Up +arrow</keycap>, you can browse through all the commands you have +previously entered. Also, you can enter &URL;s in +<application>minicli</application> to open a &konqueror; window with +the specified &URL;. +</para> + +<para> +&konqueror; and the text editor &kate; can both display terminal windows, +which behave just like &konsole;. In &konqueror;, you can turn this +on with the menu choice +<menuchoice><guimenu>Window</guimenu><guimenuitem>Show Terminal +Emulator</guimenuitem></menuchoice>. The embedded terminal will display +at the bottom of your &konqueror; window, and the really clever part +is that it will follow your clicks in the file manager view, changing +folder as you do. In &kate; you can display a terminal with the +menu choice <menuchoice><guimenu>Settings</guimenu><guimenuitem>Show +Console</guimenuitem></menuchoice>. +</para> + +<tip> +<para> +To display a &UNIX; man page, enter +<userinput><command>man:</command><replaceable>command</replaceable></userinput> +in <application>minicli</application>, where <replaceable>command</replaceable> +is the name of a &UNIX; command. +</para> +</tip> + +<tip> +<para> +To search for a word or words on the Google search engine, you can try entering +<userinput><command>gg:</command><replaceable>word or +words</replaceable></userinput>. There are a whole lot more of these +shortcut commands, and you can even add your own! Take a look in +&kcontrolcenter;, in the tab <menuchoice><guilabel>Web Browsing</guilabel> + <guilabel>Enhanced Browsing</guilabel></menuchoice>. +</para> +</tip> + +<para> +Finally, there's a way to have your command line always available, no +matter what you're doing - add one to your &kicker; panel! +</para> + +<para>Simply &RMB; click on an empty space in the panel and choose +<menuchoice><guilabel>Add Applet to Panel...</guilabel></menuchoice>. In the dialog that appears, +scroll down until you see the <guilabel>Run Command</guilabel> list item. Select +it with the &LMB; and click <guilabel>Add to Panel</guilabel>. This will embed a mini-cli +directly into your panel, complete with command history.</para> + +<para> +In conclusion, the command line is never far from view when using &tde;. +</para> + +</sect1> +</chapter> + +<chapter id="working-with-windows"> +<title>Working with Windows</title> + +<para> +If you have not already done so, start an application using the <link +linkend="starter">&kmenu;</link>; for example, <guimenuitem>Find Files</guimenuitem>. +</para> + +<sect1 id="window-what-now"> +<title>A window! What now?</title> + +<para> +Usually people work <emphasis>inside</emphasis> windows, but +sometimes you might want to manipulate windows. Here's a quick overview +of some of the most common window related functions: +</para> + +<variablelist> +<varlistentry> +<term>Move a window</term> +<listitem> +<para> +Drag the window's title bar, or hold the &Alt; key down +and drag anywhere in the window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Resize a window:</term> +<listitem> +<para> +Drag the window's border, or hold the &Alt; key down and drag with the +&RMB; anywhere in the window. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Maximize a window</term> +<listitem> +<para> +Click the maximize button in the titlebar (in the default decoration it +is the button with a square, next to the X, located on the far right side +of the titlebar) to make the window fill the screen. If the window is +already maximized, shrink the window using the same button, although the +image will be a double square. +Clicking with the &MMB; maximizes the window vertically, and with +the &RMB;, horizontally. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Iconify a window</term> +<listitem> +<para> +Click the <guilabel>Minimize</guilabel> button in the titlebar (next to <guilabel>Maximize</guilabel>) +to hide the window. Restore it by clicking on the window's icon in the +taskbar. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Switch between windows</term> +<listitem> +<para> +Aside from the usual mouse click to switch to another window, +you can use <keycombo action="simul">&Alt; +<keycap>Tab</keycap></keycombo> to switch windows. See below for more +techniques. +</para> +</listitem> +</varlistentry> +</variablelist> + +<sect2> +<title>Titlebar buttons</title> + +<para> +&tde; windows have some standard buttons on their titlebars that +provide fast access to some common operations. The default button +layout looks like this: +</para> + +<itemizedlist> +<title>On the left side:</title> +<listitem> +<para> +A <guilabel>Menu</guilabel> button. This usually shows a mini icon for the application. Click +on it to get a window operations menu. Shortcut: <keycombo +action="simul">&Alt;<keycap>F3</keycap></keycombo> opens the window +menu. +</para> +</listitem> +<listitem> +<para>A <guilabel>sticky</guilabel> button. This button will look like a tumb tack or pin. +</para> +</listitem> + +</itemizedlist> + +<itemizedlist> +<title>On the right side:</title> +<listitem> +<para> +A <guilabel>Minimize</guilabel> button. +</para> +</listitem> + +<listitem> +<para> +A <guilabel>Maximize</guilabel> button. +</para> +</listitem> + +<listitem> +<para> +A <guilabel>Close</guilabel> button. This closes the window. Shortcut: <keycombo +action="simul">&Alt;<keycap>F4</keycap></keycombo>. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2> +<title>Switching between windows</title> + +<para> +Now that we know how to deal with windows, we encourage you to open +some other windows using the panel, since we will now discuss how to +switch between different windows. Since this is such a common +activity, &tde; offers several ways to do it; pick your favorite! +</para> + +<para> +Many graphical user interface systems require users to click the mouse in a window +to begin using it. This is &tde;'s default behavior, termed +<quote>Click To Focus</quote> focus policy. You can configure +your desktop in a way that moving the mouse pointer on to a window will +activate it. This is called <quote>Focus Follows Mouse</quote>. If you +select this policy using the <link linkend="configure">&tde; Control +Center</link>, the window under the mouse pointer is always the active +one. It does not necessarily come to the front automatically, but you +can still click on to the titlebar or the border of a window or, a +&tde; special, you can use the &Alt; key and click the &MMB; +anywhere on the window to raise it. +</para> + +<para> +Here are some other methods to switch windows: +</para> + +<itemizedlist> +<listitem> +<para> +Pick a window from the <emphasis>window list</emphasis> menu. To open +the menu, click the &MMB; on +an empty area of the desktop, or click the icon with several windows +on the panel, or finally click the up arrow at the left hand end of +the taskbar in the panel. +</para> +</listitem> + +<listitem> +<para> +Hold down the &Alt; key and press <keycap>Tab</keycap> to cycle through +the windows. +</para> +</listitem> + +<listitem> +<para> +Use the taskbar (next section). +</para> +</listitem> +</itemizedlist> + +</sect2> +</sect1> + +<sect1 id="using-taskbar"> +<title>Using the Taskbar</title> + +<para> +The <interface>taskbar</interface> displays a list of small icons, one +for each window on the desktop. In the default &tde; setup the taskbar +is located inside the panel, but can also be located at the top or +the bottom of the screen.</para> + +<para> +The taskbar is powerful. In the default configuration, if you +have more than one window from the same application open, they will be +<quote>grouped</quote>, so that you see one icon per application in +the taskbar.</para> + +<para>A simple &LMB; +click on the taskbar button will pop up a list of the open windows for +that application and you can choose the window you want to +use. Choosing one of these entries with the +<mousebutton>left</mousebutton> will bring you to the selected +window immediately. Click on a taskbar entry with the +<mousebutton>right</mousebutton> and you will see a menu allowing you +to operate on all the windows grouped under that icon, or each window +individually.</para> + +<para> +You can choose to see all the windows on all the desktops in your +taskbar, regardless of which desktop you are currently viewing, or to only +see the icons for the desktop you are viewing. You can choose +to ungroup the icons, so each open window will have its own icon +in the taskbar. There are many more options available simply by +right clicking on the taskbar handle (the small textured bar at the +left hand side) and choosing <guimenuitem>Configure Taskbar...</guimenuitem>. +</para> + +<para> +The icons on the taskbar resize themselves to make room for +applications, so you can fit many more applications than you might +think. Making the panel wider will let the taskbar icons take on a row +and column layout, but they will still resize to fit more icons. +</para> + +</sect1> + +<sect1 id="using-v-desktops"> +<title>Using Virtual Desktops</title> + +<para> +Now, what was that <guilabel>Sticky</guilabel> button? +</para> + +<para> +Perhaps you have more windows open than space on your +desktop. In this case you have three possibilities: +</para> + +<orderedlist> +<listitem> +<para> +Leave all windows open (cluttered desktop) +</para> +</listitem> + +<listitem> +<para> +Iconify those windows that you do not need at present and use +the taskbar or <keycombo action="simul">&Alt; +<keycap>Tab</keycap></keycombo> to switch between them +(still a bit confusing and much work!) +</para> +</listitem> + +<listitem> +<para> +Recommended: Use virtual desktops. +</para> +</listitem> +</orderedlist> + +<para> +The third option is the way to go! &tde; can handle several different desktops, +each with its own set of application windows. The default configuration provides four +desktops. You can switch between the virtual desktops easily with a +click on one of the desktop buttons on the panel. Also <keycombo +action="simul">&Ctrl;<keycap>F1...F4</keycap></keycombo> will send you +to the corresponding desktop immediately, or <keycombo +action="simul">&Ctrl; <keycap>Tab</keycap></keycombo> will cycle through +the desktops. +</para> + +<para> +Virtual desktops are nice. Yet sometimes you want a window to be +present on <emphasis>every</emphasis> desktop. This could be, for example, +a small chat window, an alarm clock or whatever. In this case you can +use the above mentioned <quote>sticky</quote> button that will pin the +window on the background so that it will appear on every virtual +desktop. +</para> + +<para> +The sticky button can also be used to move a window from one virtual +desktop to another one: push the sticky pin on the window, switch to a +different desktop, and release the pin by pushing it again. You can +achieve the same result by using the context popup menu of the +window's entry in the taskbar (menu item <guimenuitem>To Current +Desktop</guimenuitem>) or the <guimenuitem>To Desktop</guimenuitem> +option on the window operations menu. +</para> + +</sect1> +</chapter> + +<chapter id="managing-your-files"> +<title>Managing your files</title> + +<!-- NB Deliberate use of 'directory' rather than 'folder', since we're talking --> +<!-- about folders on disk --> +<para> +A common metaphor of graphical desktops is the use of folders to +represent folders on your hard disk. Folders contain files and +other folders. A &tde; application called &konqueror;, the Trinity File +Manager, uses this metaphor to help you manage your files. +</para> + +<sect1 id="using-konqueror"> +<title>Using &konqueror;</title> + +<para> +The first time you start &konqueror;, a window with lots of icons in it +appears. This is a &konqueror; window displaying the files in your +home folder (the area where your personal files are stored). The +pathname of the folder is displayed under the window's tool bar. If +you do not see such a window now, click the icon on the panel that +looks like a folder with a picture of a house. +</para> + +<para> +To open a file or folder, <quote>double-click</quote> it with the &LMB;. +You can also choose +<menuchoice><guimenu>Window</guimenu><guimenuitem>Show +Navigation Panel</guimenuitem></menuchoice> from the menu to display the folder +hierarchy for more direct navigation. Or you can edit the path +displayed under the toolbar to get to a specific folder quickly. +</para> + +<sect2> +<title>Opening Files</title> + +<para> +&tde; comes with a set of applications to view and edit files of many +common types, and when you select a file containing, say, a document +or image, &konqueror; will start an appropriate application to +display the file. If it does not know what application to start to open +a file you selected, &konqueror; will prompt you for the name of the +application to run, and when you have chosen, &konqueror; will offer +to remember your choice for the next time you open a file of that type. +</para> + +<note> +<para> +&konqueror; uses MIME types to associate +files with applications. +</para> +</note> + +</sect2> + +<sect2> +<title>Dragging and Dropping Icons</title> + +<para> +To copy or move a file, simply drag its icon to the desktop, to +another &konqueror; window, or to a folder icon. When you release the +button, &konqueror; displays a menu to allow you to choose to copy, +move, or create a link to the file. +</para> + +<note> +<para> +Note that if you choose to create a link, &tde; creates a &UNIX; +symbolic link (not a hard link), so if you move or delete the original +file, the link will be broken. +</para> +</note> + +<para> +Most &tde; applications also support drag and drop operations: you can +drag an icon on to a window of a running application, or on to an icon of +an application that is not started, to have the application open the +file. Try it! +</para> + +</sect2> + +<sect2> +<title>Setting File Properties</title> + +<para> +To change file properties, such as its name and permissions, &RMB; +click the icon and choose <guimenuitem>Properties</guimenuitem> from +the menu. +</para> + +</sect2> +</sect1> + +<sect1 id="archives-and-networks"> +<title>Working with Archives and Networks</title> + +<para> +Once upon a time users needed special software to access files on the +Internet. Not any more! +</para> + +<para> +&tde; supports a technology called <quote>Network Transparent +Access</quote> (<acronym>NTA</acronym>), which allows you to work with +files on the other side of the world as easily as those on your local +hard disk.</para> + +<para> +For example, to access files on an &FTP; server, just choose +<menuchoice><guimenu>Location</guimenu><guimenuitem>Open +Location</guimenuitem></menuchoice> from a &konqueror; menu, and enter +the <acronym>URL</acronym> of an &FTP; server. You can drag and drop +files to and from the folders on the server just as if they were on +your local disk. You'll even be able to open files on the &FTP; server +without having to manually copy them to your local disk (&tde; does it for you +when necessary). +</para> + +<note> +<para> +Note that &konqueror; uses anonymous &FTP; access, which might restrict +your access to files on the &FTP; server. If you have an account on +the server, you can supply your user <abbrev>ID</abbrev> as part of +the <acronym>URL</acronym>, like this: +<userinput><command>ftp://</command><parameter>userid</parameter>@<parameter>server</parameter>/<parameter>folder</parameter></userinput> +</para> + +<para> +&konqueror; will prompt you for your password, and if the login +succeeds, you will have full access to your files on the server. +</para> +</note> + +<para> +If you are used to the +<trademark><application>WinZip</application></trademark> utility on +&Microsoft; &Windows;, then you will be happy to know that &tde; can +look into archive files too. It treats such archives just like a +normal folder, and you can browse into the archive, open files, &etc; In +general, accessing files on the Internet and in archives should look +and feel just like accessing files on your local disk, except for +delays imposed by the network and extracting the archive. +</para> +</sect1> + +<sect1 id="using-templates"> +<title>Using Templates to Access Applications and Devices</title> + +<para> +In &tde; it's easy to put icons on the panel or the desktop to access +your applications. It's just as easy to add icons to access other +items of interest. &tde; has templates for shortcuts to: +</para> + +<itemizedlist> +<listitem> +<para> +Applications +</para> +</listitem> +<listitem> +<para> +Printers +</para> +</listitem> +<listitem> +<para> +Mountable Devices (⪚ floppy drives) +</para> +</listitem> +<listitem> +<para> +Internet resources (⪚ <acronym>WWW</acronym> documents, &FTP; +folders) +</para> +</listitem> +<listitem> +<para> +Documents for some of &tde;'s &koffice; applications. +</para> +</listitem> +</itemizedlist> + +<para> +You can add any of these items to the desktop by &RMB; clicking where +you want the icon, and choosing <guisubmenu>Create New</guisubmenu> +and selecting the item you want to link to. +</para> + +<para> +Nearly every item in the &kmenu;, on the desktop, and on +the panel refers to a <literal role="extension">.desktop</literal> +file on disk. The <literal role="extension">.desktop</literal> file +specifies what icon to display, as well as specific information about +what the icon represents (an application, device, or +<acronym>URL</acronym>). You can drag any <literal +role="extension">.desktop</literal> file to the panel to create a +quick-launch button. +</para> + +<!-- +<sect2> +<title>Setting up printers</title> + +<para> +You can create icons for your printers so you can print a file by +dragging it to a printer icon. Here's how: +</para> + +<procedure> +<step><para>Open the Templates folder located on the desktop.</para></step> +<step><para>Drag the Program icon in the folder to the desktop. Choose +<guimenuitem>Copy</guimenuitem> from the menu that appears when you drop the +icon.</para></step> +<step><para><mousebutton>Right</mousebutton> click the new icon, and choose +<guimenuitem>Properties</guimenuitem> from the context menu.</para></step> +<step><para>On the <guilabel>General</guilabel> tab, change the name to +<filename>Printer.kdelnk</filename>.</para></step> +<step><para>On the <guilabel>Execute</guilabel> tab, enter the following in the +first <guilabel>Execute</guilabel> field:</para> +<screen><command>lpr <option>%f</option></command></screen> +<note><para>This example presumes that you print using the <command>lpr</command> +command. If you use a different command, enter the one you +use.</para></note></step> +<step><para>Still in the <guilabel>Execute</guilabel> tab, click the icon that +looks like a <guiicon>cog</guiicon>, and select the <guiicon>Printer</guiicon> icon from the list that appears.</para></step> +</procedure> + +<para>Now you should be able to drag a file to the Printer icon and have it +printed on your default printer.</para> +</sect2> + +--> + +<sect2> +<title>Mounting devices</title> + +<para> +&UNIX; systems provide access to storage devices other than the primary +<hardware>hard disk</hardware> through a process called +<emphasis>mounting</emphasis>. &tde; uses <literal +role="extension">.desktop</literal> files to allow you to easily +mount, unmount, and access files on secondary storage devices such as +<hardware>floppy</hardware> drives and &cdrom; drives. +</para> + +<para> +As an example, here are the steps needed to create an icon to access +files on a floppy disk: +</para> + +<note> +<para> +Many &UNIX; systems require you to be logged in as <systemitem +class="username">root</systemitem> to mount and unmount devices. +</para> +</note> + +<procedure> +<step> +<para><mousebutton>Right</mousebutton> click on the desktop and choose +<menuchoice><guisubmenu>Create +New</guisubmenu><guisubmenu>Device</guisubmenu> +<guimenuitem>Floppy Device...</guimenuitem></menuchoice>. +</para> +</step> +<step> +<para> +On the <guilabel>General</guilabel> tab of the resulting dialog, change +the name to whatever you like, in the text box at the top. +</para> +</step> + +<step> +<para> +On the <guilabel>Device</guilabel> tab, enter <filename +class="devicefile">/dev/fd0</filename> (or the path to the floppy device +as it is named on your system) as the <guilabel>Device</guilabel>. +</para> +</step> +<step> +<para> +You can add a <guilabel>Mount Point</guilabel> here too. This should be +an existing folder, but empty. Common mount points are <filename +class="directory">/mnt/floppy</filename> or <filename +class="directory">/floppy</filename>, but you can just as easily have floppy +disks mounted on <filename class="directory">~/mydisk</filename> if you +want. +</para> +</step> +<step> +<para> +Click the <guilabel>Unmounted Icon</guilabel> and select the picture +of a floppy disk without the green light. +</para> +</step> +<step> +<para> +Once you're happy with your choices, choose <guibutton>OK</guibutton> +and you are finished! +</para> +</step> +</procedure> + +<para> +Now, place a properly formatted floppy in the drive and click the +<guiicon>Floppy</guiicon> icon to have &tde; mount the floppy drive and display +the files on the disk. Before removing the disk from the drive, &RMB; +click the <guiicon>Floppy</guiicon> icon and choose +<guimenuitem>Unmount</guimenuitem> from the menu. +</para> + +</sect2> +</sect1> +</chapter> + +<chapter id="configure"> +<title>Configuring your desktop</title> + +<para> +If you do not like something about the way the desktop looks or +operates, you can probably change it. &tde; is very configurable and you +can change almost every aspect of the appearance and the behavior of +your desktop. Unlike many other &UNIX; desktop environments, you do not +have to edit cryptic configuration files either (but you can if you +really want to!) You use the &kcontrolcenter;, a special program for +configuring your desktop. +</para> + +<sect1 id="using-kde-control"> +<title>Using the <application>&tde; Control Center</application></title> + +<para> +Launch the &kcontrolcenter; from the <link linkend="starter">&kmenu;</link>. +A window with two panes appears, displaying a list of +modules in the left pane. +</para> + +<para> +Open a module by clicking its name; a list of submodules will +appear. Then, click one of the submodule category names to edit its +configuration in the right pane. +</para> + +<para> +Changing the configuration is fairly straightforward. A help button is +available on each configuration panel to explain settings that are not +obvious. Each panel has buttons labeled <guibutton>Help</guibutton>, +<guibutton>Use Defaults</guibutton>, <guibutton>Apply</guibutton>, and +<guibutton>Reset</guibutton>, which work as follows: +</para> + +<variablelist> +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem> +<para> +Displays a short help text in the left hand pane, including a link to a +longer manual for the module in question. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Use Defaults</guibutton></term> +<listitem> +<para> +Sets all the options in the current module back to the default at the +time &tde; was installed. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Apply</guibutton></term> +<listitem> +<para> +Applies the current settings in the currently open module. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Reset</guibutton></term> +<listitem> +<para> +Resets the options to the state they were in when you opened the module. +If you have already used the <guibutton>Apply</guibutton> button, then +this button will reset the options to the state they were in when you +pressed <guibutton>Apply</guibutton>. +</para> +</listitem> +</varlistentry> +</variablelist> + +<note> +<para> +If you make changes on one configuration panel and move to a different module +without clicking <guibutton>OK</guibutton> or <guibutton>Apply</guibutton> +first, &kcontrolcenter; will prompt you to ask whether your changes should be applied +first. +</para> +</note> + +</sect1> + +</chapter> + +<chapter id="logging-out"> +<title>Logging out</title> + +<para> +We sincerely hope that using &tde; gives you so much fun and +pleasure that you never want to log out. But if you do, simply choose +<menuchoice><guimenu>TDE menu</guimenu> +<guimenuitem>Logout</guimenuitem></menuchoice>. +</para> + +<para> +There also is an applet logout button that can be added directly to the panel, which looks like a +small power button. Or you can press <keycombo action="simul">&Ctrl; +&Alt; <keycap>Delete</keycap></keycombo> to log out. +</para> + +<sect1 id="session-management"> +<title>Session Management</title> + +<para> +When you log out, &tde; can remember which applications you had open, as +well as where all the windows were located, so that it can open them +for you the next time you log in. This feature is termed +<emphasis>Session Management</emphasis>. &tde;-aware applications will +restore themselves to the state they were in when you logged out. For +example, &kate; remembers which files you were editing.</para> + +<para> +Non-&tde; applications might not memorize their state on logout, and +&tde; will warn you to make sure that you have saved any important +data in them when you start to log out. +</para> + +<para> +To illustrate session management, choose <menuchoice> +<guimenu>TDE menu</guimenu><guisubmenu>Editors</guisubmenu> +<guimenuitem>Kate</guimenuitem> </menuchoice> to start &kate;. Open +a text document to edit. Now log out and back in. You will observe +that &kate; will be restored to the exact same position on the screen, +including the correct virtual desktop, and the document we left open in +&kate; before we logged out is opened again automatically. &kate; +will even remember whether you had unsaved changes to your document +before you logged out and will save them to the file you were working +on if you choose <guimenuitem>Save</guimenuitem> from the +<guimenu>File</guimenu> menu. +</para> + +</sect1> +</chapter> + +<chapter id="kde-an-exciting-journey"> +<title>&tde;, an exciting Journey</title> + +<para> +We hope you enjoyed this brief tour of the Trinity Desktop Environment and +that this unique desktop environment will help you get your work done +faster and more comfortably than ever. +</para> + +<para> +Please remember that the &tde; project is not a commercial venture, +but rather a project run by volunteers from around the world. We +would like to invite you to join the &tde; project and become part of +this unique network of people. If you are a programmer you might +consider helping us write or improve &tde; applications. If you are an artist or +have experience with graphic design, consider creating icons sets, +color schemes, sound schemes and logos for &tde;. If you enjoy +writing we would love for you to join our documentation team. +</para> + +<para> +As you can see there are many ways that you can help. You are +invited to join this world-wide network of people dedicated +to making &tde; the best desktop environment for any computer. Please +visit <ulink url="http://www.trinitydesktop.org">www.trinitydesktop.org</ulink> for more +information. +</para> + +<para> +<emphasis>Welcome aboard on this exciting journey, </emphasis> +</para> +<para> +<literal>Your &tde; Team</literal> +</para> +</chapter> + +<!-- +2004-08-27 +Removed because it probably should not be here, and it will only end up +getting out-of-date if it is (Phil) +<chapter id="advanced-topics"> +<title>Advanced Topics</title> + +<sect1 id="mime"> +<title>&MIME; Types</title> + +<para> +&tde; comes with a number of &MIME; types predefined, but you can add +your own &MIME; types by choosing +<menuchoice><guimenu>Settings</guimenu> +<guisubmenu>Configure Konqueror...</guisubmenu> +</menuchoice> and then <guilabel>File +Associations</guilabel> in a &konqueror; window. +</para> + +<para> +&tde;'s handling of &MIME; types is very powerful, and very +configurable. On the one hand, you can set a default action to be +performed when you click on a file in &konqueror;. Just as usefully, +you can add many more actions, which are then available with a &RMB; +click menu on the file in question. +</para> + + +<procedure> +<title>To link a certain file type with a particular application:</title> +<step> +<para> +Make sure the application you want to start this file type has an +entry in the &kmenu;. +</para> +</step> + +<step> +<para>In &konqueror; find or make a file with the extension you wish to +link. +</para> +</step> + +<step> +<para> +<mousebutton>Right</mousebutton> click on the file, and choose +<guimenuitem>Edit File Type</guimenuitem> from the context menu, or +choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Edit File +Type</guimenuitem></menuchoice> in &konqueror;'s menu bar. +</para> +</step> + +<step> <para> Add file masks for the application by clicking the +<guibutton>Add</guibutton> button, and entering the file pattern you +want. Remember that &UNIX; is case sensitive, so you might need to add +variations - <userinput>*.mp3</userinput> might need +<userinput>*.MP3</userinput> added as well, for example. Add as many +extensions as you like in this way.</para> </step> + +<step> +<para> +Add a description if you like. This is optional. +</para> +</step> + +<step> +<para>In the section labeled <guilabel>Application Preference +Order</guilabel>, press the <guibutton>Add</guibutton> button. A +miniature copy of the &kmenu; will +open, where you can choose the application you want files of this type +to be opened with. +</para> +</step> + +<step> +<para> +Sometimes, you might want to use a different application to open this +file type. For example, you might like to use &kate; to open text +files you wish to edit, and &kedit; for text files that you just want +to take a quick peek into. You can add more applications in the same +way as you did in the last step, and you can change the preferred +order using the <guibutton>Move Up</guibutton> and <guibutton>Move +Down</guibutton> buttons. +</para> +</step> + +<step> +<para> +If you're satisfied with your choices, you can click the +<guibutton>Apply</guibutton> button to save your changes without +closing the dialog box. This gives you the opportunity to test in the +<application>Konqueror</application> window that your file association +is correct. You can choose <guibutton>OK</guibutton> to save your +changes and close the dialog box, or <guibutton>Cancel</guibutton> if +you have changed your mind and just want to close the dialog box. +</para> +</step> +</procedure> + +<para> +Be sure to try your new association by opening a folder containing +a file of the type you just selected. Click on the file, and the +program needed to edit it should start. +</para> + +<note> +<para> +&MIME; types are a way of describing the contents of files. You might +be used to using file extensions for that purpose, and you might know +that on &UNIX; systems the file extension often bears little or no +relation to the contents of the file. On the other hand, it might be +vital - for example, some implementations of <command>gunzip</command> +will not operate on files that are not named <literal +role="extension">.gz</literal>. +</para> + +<para> +&MIME; types naturally make use of filename patterns, but not +necessarily the extensions - you can set up any filename pattern you +like. For example, if you always want to open any files relating to a +particular client with &kate;, and you make a habit of naming the files +with the client's name at the beginning so that they naturally group in +the &konqueror; window, then you can set up a filename pattern that +matches <literal>^<replaceable>clientname</replaceable>*</literal>. +Then any files that have <replaceable>clientname</replaceable> at the +beginning (the <token>^</token> character means <quote>starts with...</quote>) and +without any regard to the rest of the filename. +</para> +</note> + +</sect1> + +</chapter> +--> +<chapter id="credits"> +<title>Credits</title> +<sect1 id="authors"> +<title>Authors</title> + +<itemizedlist> +<listitem><para>Matthias Ettrich +<email>[email protected]</email></para></listitem> +<listitem><para>Kalle Dahlheimer <email>[email protected]</email></para></listitem> +<listitem><para>Torben Weiss <email>[email protected]</email></para></listitem> +<listitem><para>Bernd Wuebben <email>[email protected]</email></para></listitem> +<listitem><para>Stephen Schaub <email>[email protected]</email> - +Editor</para></listitem> +<listitem><para>Robert Williams <email>[email protected]</email> - +Editor</para></listitem> +<listitem><para>Lauri Watts <email>[email protected]</email></para></listitem> +</itemizedlist> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; + +</sect1> +</chapter> +</book> diff --git a/doc/khelpcenter/releasenotes/CMakeL10n.txt b/doc/khelpcenter/releasenotes/CMakeL10n.txt new file mode 100644 index 000000000..7d0692737 --- /dev/null +++ b/doc/khelpcenter/releasenotes/CMakeL10n.txt @@ -0,0 +1,7 @@ +##### create translation templates ############## + +tde_l10n_create_template( + CATALOG "desktop_files/tde_release_notes.desktop/" + SOURCES tde_release_notes.desktop + DESTINATION "${CMAKE_SOURCE_DIR}/translations" +) diff --git a/doc/khelpcenter/releasenotes/CMakeLists.txt b/doc/khelpcenter/releasenotes/CMakeLists.txt new file mode 100644 index 000000000..4392e53e4 --- /dev/null +++ b/doc/khelpcenter/releasenotes/CMakeLists.txt @@ -0,0 +1,11 @@ +################################################# +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/releasenotes ) + +install( FILES tde_release_notes.desktop DESTINATION ${AUTOSTART_INSTALL_DIR} ) diff --git a/doc/khelpcenter/releasenotes/Makefile.am b/doc/khelpcenter/releasenotes/Makefile.am new file mode 100644 index 000000000..b6849ee28 --- /dev/null +++ b/doc/khelpcenter/releasenotes/Makefile.am @@ -0,0 +1,6 @@ +KDE_LANG = en +KDE_DOCS = khelpcenter/releasenotes + +autostart_DATA = tde_release_notes.desktop +autostartdir = $(datadir)/autostart + diff --git a/doc/khelpcenter/releasenotes/README b/doc/khelpcenter/releasenotes/README new file mode 100644 index 000000000..8a9d1b1d8 --- /dev/null +++ b/doc/khelpcenter/releasenotes/README @@ -0,0 +1,9 @@ +To update the Release Notes in the help handbook: + +* For archival purposes, copy index.docbook to index-Rxx.yy.zz.docbook, + where Rxx.yy.zz is the previous release version. For example. + index-R14.0.0.docbook. + +* Edit index.docbook as necessary for the next release. For example, R14.0.1. + +No changes or updates are needed in ./release_notes.desktop or ../../tde_release_notes. diff --git a/doc/khelpcenter/releasenotes/index.docbook b/doc/khelpcenter/releasenotes/index.docbook new file mode 100644 index 000000000..c25611e4b --- /dev/null +++ b/doc/khelpcenter/releasenotes/index.docbook @@ -0,0 +1,78 @@ +<?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 --> + + <!ENTITY r14.0.00 SYSTEM "r14.0.00.docbook"> + <!ENTITY r14.0.01 SYSTEM "r14.0.01.docbook"> + <!ENTITY r14.0.02 SYSTEM "r14.0.02.docbook"> + <!ENTITY r14.0.03 SYSTEM "r14.0.03.docbook"> + <!ENTITY r14.0.04 SYSTEM "r14.0.04.docbook"> + <!ENTITY r14.0.05 SYSTEM "r14.0.05.docbook"> + <!ENTITY r14.0.06 SYSTEM "r14.0.06.docbook"> + <!ENTITY r14.0.07 SYSTEM "r14.0.07.docbook"> + <!ENTITY r14.0.08 SYSTEM "r14.0.08.docbook"> + <!ENTITY r14.0.09 SYSTEM "r14.0.09.docbook"> + <!ENTITY r14.0.10 SYSTEM "r14.0.10.docbook"> + +]> + +<article id="release-notes" lang="&language;"> +<title>&tde-release-version; Release Notes</title> + +<articleinfo> +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<!-- <legalnotice>&FDLNotice;</legalnotice> --> + +<abstract> +<para>&tde-release-version; Release Notes</para> +</abstract> + +<keywordset> +<keyword>TDE</keyword> +<keyword>release notes</keyword> +</keywordset> + +</articleinfo> + +<sect1 id="release-notes-introduction"> +<title>Introduction</title> + +<para>This document contains important information for users, developers, and packagers. This document is +intended for people who are migrating from previous versions of Trinity. If you are a using Trinity for the +first time, then you can ignore the contents of this document.</para> + +<para>The Trinity Desktop is a full software desktop environment designed for Unix-like operating systems, +intended for computer users preferring a traditional desktop model focusing primarily on retaining the overall +KDE 3.5 user experience and efficiency. Trinity is free/libre software.</para> + +<para>First, thank you to the many people who contributed to all of these improvements. Many people played a +role, including bug fixing, enhancements, testing, etc.</para> + +</sect1> + +&r14.0.10; +&r14.0.09; +&r14.0.08; +&r14.0.07; +&r14.0.06; +&r14.0.05; +&r14.0.04; +&r14.0.03; +&r14.0.02; +&r14.0.01; +&r14.0.00; + +</article> diff --git a/doc/khelpcenter/releasenotes/r14.0.00.docbook b/doc/khelpcenter/releasenotes/r14.0.00.docbook new file mode 100644 index 000000000..9cd295e1b --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.00.docbook @@ -0,0 +1,912 @@ +<sect1 id="release-notes-r14.0.0"> +<title>R14.0.0 Release Notes</title> + +<para>Many changes were made to Trinity after the release of 3.5.13.</para> + +<para>An obvious change is the version scheme. Trinity evolved from the last KDE 3.5 release, 3.5.10. Subsequent +Trinity releases followed that numbering scheme. Release R14.0.0 marks a turning point in Trinity history +because a great deal of the code infrastructure was changed. While those changes do not effect the usability or +look-and-feel of the desktop that users enjoy, Trinity developers believe a change in the version scheme +distinguishes when those changes occurred. An original project goal by users was to retain the flavor of the +original KDE 3.5 desktop. That goal remains intact. To reflect that original goal, the last number in the +original version scheme is retained in the new version scheme but is now the primary version number. While the +infrastructure has changed, the desktop itself remains the same as the original KDE 3.5. This new version scheme +indicates a modest divergence from the original KDE 3.5 series and that Trinity is now its own desktop +environment. The new version scheme reminds users that Trinity retains the original KDE 3.5 design, but is +moving forward as a separate desktop project.</para> + +<para>Notable changes include renaming and rebranding efforts to avoid conflicts with KDE4. Both Trinity and +KDE4 have roots in KDE3. These changes focus on promoting a peaceful coexistence between the two desktop +environments when both are installed concurrently on the same system as well as avoid possible trademark +issues.</para> + +<para>Renaming and rebranding efforts include:</para> + +<itemizedlist> + +<listitem><para> +Libraries +</para></listitem> + +<listitem><para> +Classes +</para></listitem> + +<listitem><para> +Environment variables and config file locations +</para></listitem> + +<listitem><para> +Package names +</para></listitem> + +<listitem><para> +Application names +</para></listitem> + +</itemizedlist> + +<para>An exhaustive list of renaming changes is available at the end of this document.</para> + +<sect2 id="release-notes-usability-changes"> +<title>Usability Changes</title> + +<para>Because of the wide-scale renaming efforts, existing KDE3 and 3.5.13.x user profile directories will not +function properly under R14.0.0. Don't worry.</para> + +<para>When logging into Trinity R14.0.0, the starttde script (nee startkde), performs profile checks to ensure +settings and configurations are migrated correctly. These checks include preserving the original KDE3/3.5.13.x +profile directory as-is while using those files as the basis to create the new R14.0.0 profile named +$HOME/.trinity.</para> + +<para>The underlying migration checking has been tested, but because of the renaming and rebranding efforts, +upstream packagers should test support scripts for problems and anomalies.</para> + +<para>There is another special script to help update profile directories. That script is +/opt/trinity/bin/migratekde3. This script is intended for people using versions of Trinity prior to 3.5.13. +Before starting R14.0.0 the first time, use this script to update any KDE3 profile directory. The definition of +a KDE3 profile directory includes Trinity 3.5.11 and 3.5.12. The script will look for profile directory names +of ~/.kde3, ~/.kdemod3, and ~/.kde. Because the latter directory name is also used in KDE4, several tests are +performed to ensure the directory is a KDE3 profile and not KDE4.</para> + +<para>The renaming might cause certain shortcuts and menu links to stop functioning. The underlying migration +checks performed when logging into R14.0.0 for the first time should find all of these differences, but fixing +those that are missed is straightforward. All that is needed is knowing the new name of the command or +application. For example, changing kdesu to tdesu, although that specific change is covered by the +scripts.</para> + +<para>The Trinity launcher menu, tdemenu (nee kmenu), has been reorganized to reduce clutter. In addition to +built-in XDG changes in *.desktop files, There are two methods available to manage KDE4 apps in the Trinity +menu. One method includes a build-time configuration option in tdelibs, WITH_KDE4_MENU_SUFFIX, that adds a +"[KDE4]" tag to KDE4 menu items. This tag helps identify apps of the same name. The default is OFF and requires +a package rebuild to change. A second method includes a global menu replacement, tde-applications.menu-no-kde +that explicitly excludes KDE4 apps from the menu. Using that special menu requires administrative privileges to +update.</para> + +<para>Because of a common heritage shared with KDE, Trinity still shares many app and library names with KDE. +Therefore to avoid conflicts, the normal practice is to install Trinity to /opt/trinity. Because of this +atypical installation location, on many systems non-Trinity desktops and window managers initially will not +find any Trinity apps. For systems using /etc/profile.d, ensure the packager includes appropriate scripts to +populate all necessary environment variables. For other systems, at least the XDG_CONFIG_DIRS and XDG_DATA_DIRS +environment variables must be modified to recognize the /opt/trinity directory. Typical modifications look like +this:</para> + +<itemizedlist> + +<listitem><para> +XDG_CONFIG_DIRS=/etc/trinity/xdg:/etc/xdg:/etc/kde/xdg +</para></listitem> +<listitem><para> +XDG_DATA_DIRS=/opt/trinity/share:/usr/share +</para></listitem> + +</itemizedlist> + +<para>Users who do not install any tde-i18n package will encounter broken symlinks if they browse the +non-English documention folders of some applications. Such symlinks are hooks to the correct location +of localized common resources and will work properly once the related tde-i18n package is installed. +Please refrain from filing bugs related to those broken symlinks.</para> + +<para>Some old wallpapers have been removed from the list displayed in Trinity Control Center --> +Appearance & Themes --> Background and a few new ones have been added. The removed wallpapers +are still available and if desired they can be manually selected. They are located in the +/opt/trinity/share/wallpapers/obsolete folder.</para> + +<para>As part of the rebranding effort, TDE now has its own theme style and system-wide changes have +been made to conform to such style as much as possible.</para> + +</sect2> + +<sect2 id="release-notes-major-improvements"> +<title>Major Improvements from 3.5.13</title> + +<itemizedlist> +<listitem><para> +New HAL-independent hardware support based on udev. HAL support is still available for those systems (such as *bsd) that require it. +</para></listitem> +<listitem><para> +Significant renaming of applications, libraries and packages to avoid conflicts with other desktop environments (most notably KDE) allowing TDE to be installed in parallel with other DE. +</para></listitem> +<listitem><para> +Switched from 'plain' Qt3 to the 'new' TQt3 interface, an enhanced version of Qt3 with a particular eye on improved stability and multi-threading support. +</para></listitem> +<listitem><para> +A new TQt interface layer between TDE libraries/applications and TQt3. This allows selective adaptation of some Qt4 programming widgets. +</para></listitem> +<listitem><para> +Support for network-manager 0.9 and newer. +</para></listitem> +<listitem><para> +Switched compositor from Kompmgr to Compton. +</para></listitem> +<listitem><para> +Added support for ARM architectures and RaspBian. +</para></listitem> +<listitem><para> +MIME detection system now based on libmagic. +</para></listitem> +<listitem><para> +New website design. +</para></listitem> +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-new-or-improved-features"> +<title>New or Improved Features</title> + +<itemizedlist> + +<listitem><para> +Migrated the TDE source repository to GIT. +</para></listitem> +<listitem><para> +Significant branding overhaul and restyling. +</para></listitem> +<listitem><para> +Further improved XDG compliance. +</para></listitem> +<listitem><para> +Additional theme engines available. +</para></listitem> +<listitem><para> +Continued migration from autotools to cmake. +</para></listitem> +<listitem><para> +TDE-style dialog box support for LibreOffice. +</para></listitem> +<listitem><para> +Improved Secure Attention Key. +</para></listitem> +<listitem><para> +Mac-like window switching. +</para></listitem> +<listitem><para> +Kate sort plugin now available. +</para></listitem> +<listitem><para> +Rearrangeable items in the taskbar. +</para></listitem> +<listitem><para> +Show Icons Only option for taskbar. +</para></listitem> +<listitem><para> +Improved application crash report framework, now also including source code commit references for better debugging. +</para></listitem> +<listitem><para> +A mouse double-click speed test option in the control panel. +</para></listitem> +<listitem><para> +A smooth crossfade effect is now available when changing the desktop wallpaper. +</para></listitem> +<listitem><para> +Improved project documentation and localization. +</para></listitem> +<listitem><para> +Faster startup and logout. +</para></listitem> +<listitem><para> +Improved Konqueror speed for listing files in folder. +</para></listitem> +<listitem><para> +Ability to force Kate into MDI mode all the time. +</para></listitem> +<listitem><para> +File copy window focus enhancement: focus is now on the file name edit line by default. +</para></listitem> +<listitem><para> +GUI support for controlling whether to display archives as folders. +</para></listitem> +<listitem><para> +Improved Logout Status Dialog. +</para></listitem> +<listitem><para> +Improved support for global and individual panels. +</para></listitem> +<listitem><para> +New Desktop Device Icons: My Computer, My Documents, My Network Places, Printers, Web Browser. +</para></listitem> +<listitem><para> +Rearrangeable (draggable) items in the taskbar. +</para></listitem> +<listitem><para> +Reduced TDE menu clutter and duplication. +</para></listitem> +<listitem><para> +Accelerator key for Konsole main menu can be enabled when desired. +</para></listitem> +<listitem><para> +Konqueror file rename improvement: in list view mode it is now possible to move directly to the next/previous file without leaving the rename mode. Default key shortcuts are Tab (next) and Shift+Tab (previous). +</para></listitem> +<listitem><para> +Kate taskbar: middle mouse click close selected document, if enabled. +</para></listitem> +<listitem><para> +The number of files in the Kate MRU (Most Recently Used) list is user-configurable. +</para></listitem> +<listitem><para> +Added a progress bar to the logout status dialog. +</para></listitem> +<listitem><para> +Kate syntax highlighting files have been updated and the lookup moved to the TDE repository +</para></listitem> +<listitem><para> +tdecmshell --list output is now sorted alphabetically. +</para></listitem> +<listitem><para> +Additional xdg folders support in Kickoff menu +</para></listitem> +<listitem><para> +Fixed Konqueror selection handling when using arrow keys. +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-new-packages"> +<title>New Packages</title> + +<itemizedlist> + +<listitem><para> +GTK3/TQt Theme Engine +</para></listitem> +<listitem><para> +Kate Sort plugin +</para></listitem> +<listitem><para> +Kasablanca +</para></listitem> +<listitem><para> +KBibTex +</para></listitem> +<listitem><para> +KBiff +</para></listitem> +<listitem><para> +KControl LDAP Manager +</para></listitem> +<listitem><para> +KControl Autostart +</para></listitem> +<listitem><para> +KDbg +</para></listitem> +<listitem><para> +KFTPGrabber +</para></listitem> +<listitem><para> +KLCDDimmer +</para></listitem> +<listitem><para> +KNmap +</para></listitem> +<listitem><para> +KRecipes +</para></listitem> +<listitem><para> +KScope +</para></listitem> +<listitem><para> +KSensors +</para></listitem> +<listitem><para> +KShowmail +</para></listitem> +<listitem><para> +KShutdown +</para></listitem> +<listitem><para> +LDAP/Kerberos Toolkit +</para></listitem> +<listitem><para> +MPlayerthumbs +</para></listitem> +<listitem><para> +Qt4/TQt Theme Engine +</para></listitem> +<listitem><para> +Tdeio-ftps +</para></listitem> +<listitem><para> +Tdeio-sword +</para></listitem> +<listitem><para> +TorK +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-package-renaming"> +<title>Package Renaming</title> + +<itemizedlist> + +<listitem><para> +kde-i18n -> tde-i18n +</para></listitem> +<listitem><para> +kde-guidance -> tde-guidance +</para></listitem> +<listitem><para> +kde-style-lipstik -> tde-style-lipstik +</para></listitem> +<listitem><para> +kde-style-qtcurve -> tde-style-qtcurve +</para></listitem> +<listitem><para> +kde-systemsettings -> tde-systemsettings +</para></listitem> +<listitem><para> +kdeaccessibility -> tdeaccessibility +</para></listitem> +<listitem><para> +kdeaddons -> tdeaddons +</para></listitem> +<listitem><para> +kdeadmin -> tdeadmin +</para></listitem> +<listitem><para> +kdeartwork -> tdeartwork +</para></listitem> +<listitem><para> +kdebase -> tdebase +</para></listitem> +<listitem><para> +kdebindings -> tdebindings +</para></listitem> +<listitem><para> +kdeedu -> tdeedu +</para></listitem> +<listitem><para> +kdegames -> tdegames +</para></listitem> +<listitem><para> +kdegraphics -> tdegraphics +</para></listitem> +<listitem><para> +kdelibs -> tdelibs +</para></listitem> +<listitem><para> +kdemultimedia -> tdemultimedia +</para></listitem> +<listitem><para> +kdenetwork -> tdenetwork +</para></listitem> +<listitem><para> +kdenetworkmanager -> tdenetworkmanager +</para></listitem> +<listitem><para> +kdepim -> tdepim +</para></listitem> +<listitem><para> +kdepowersave -> tdepowersave +</para></listitem> +<listitem><para> +kdesdk -> tdesdk +</para></listitem> +<listitem><para> +kdesudo -> tdesudo +</para></listitem> +<listitem><para> +kdesvn -> tdesvn +</para></listitem> +<listitem><para> +kdetoys -> tdetoys +</para></listitem> +<listitem><para> +kdeutils -> tdeutils +</para></listitem> +<listitem><para> +kdevelop -> tdevelop +</para></listitem> +<listitem><para> +kdewebdev -> tdewebdev +</para></listitem> +<listitem><para> +kdmtheme -> tdmtheme +</para></listitem> +<listitem><para> +kio-apt -> tdeio-apt +</para></listitem> +<listitem><para> +kio-locate -> tdeio-locate +</para></listitem> +<listitem><para> +kio-umountwrapper -> tdeio-umountwrapper +</para></listitem> +<listitem><para> +kradio -> tderadio +</para></listitem> +<listitem><para> +kwin-style-crystal -> twin-style-crystal +</para></listitem> +<listitem><para> +pykde -> pytde +</para></listitem> +<listitem><para> +qca -> tqca +</para></listitem> +<listitem><para> +qca-tls -> tqca-tls +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-application-and-file-renaming"> +<title>Application and File Renaming</title> + +<itemizedlist> + +<listitem><para> +applications-kmenuedit.menu -> applications-tdemenuedit.menu +</para></listitem> +<listitem><para> +.kderc -> .tderc +</para></listitem> +<listitem><para> +kab2kabc -> tdeab2tdeabc +</para></listitem> +<listitem><para> +kbuildsycoca -> tdebuildsycoca +</para></listitem> +<listitem><para> +kcache -> tdecache +</para></listitem> +<listitem><para> +kcmshell -> tdecmshell +</para></listitem> +<listitem><para> +kconf_update -> tdeconf_update +</para></listitem> +<listitem><para> +kde-$USER -> tde-$USER +</para></listitem> +<listitem><para> +kde-config -> tde-config +</para></listitem> +<listitem><para> +kdebugdialog -> tdedebugdialog +</para></listitem> +<listitem><para> +kdeeject -> tdeeject +</para></listitem> +<listitem><para> +kdekillall -> tdekillall +</para></listitem> +<listitem><para> +kdepasswd -> tdepasswd +</para></listitem> +<listitem><para> +kdessh -> tdessh +</para></listitem> +<listitem><para> +kdesu -> tdesu +</para></listitem> +<listitem><para> +kdesudo -> tdesudo +</para></listitem> +<listitem><para> +kdevelop -> tdevelop +</para></listitem> +<listitem><para> +kdm -> tdm +</para></listitem> +<listitem><para> +kdmtheme -> tdmtheme +</para></listitem> +<listitem><para> +kfile -> tdefile +</para></listitem> +<listitem><para> +kfilereplace -> tdefilereplace +</para></listitem> +<listitem><para> +kfontinst -> tdefontinst +</para></listitem> +<listitem><para> +kfontview -> tdefontview +</para></listitem> +<listitem><para> +khtml -> tdehtml +</para></listitem> +<listitem><para> +kiconedit -> tdeiconedit +</para></listitem> +<listitem><para> +kinit* -> tdeinit* +</para></listitem> +<listitem><para> +kio_apt -> tdeio_apt +</para></listitem> +<listitem><para> +kio_camera -> tdeio_camera +</para></listitem> +<listitem><para> +kio_ftp -> tdeio_ftp +</para></listitem> +<listitem><para> +kio_http -> tdeio_http +</para></listitem> +<listitem><para> +kio_locate -> tdeio_locate +</para></listitem> +<listitem><para> +kio_thumbnail -> tdeio_thumbnail +</para></listitem> +<listitem><para> +kioslave -> tdeioslave +</para></listitem> +<listitem><para> +klaunch -> tdelaunch +</para></listitem> +<listitem><para> +kmenu -> tdemenu +</para></listitem> +<listitem><para> +kmid -> tdemid +</para></listitem> +<listitem><para> +knetworkmanager -> tdenetworkmanager +</para></listitem> +<listitem><para> +knewstuff -> tdenewstuff +</para></listitem> +<listitem><para> +kpowersave -> tdepowersave +</para></listitem> +<listitem><para> +kprint -> tdeprint +</para></listitem> +<listitem><para> +kprintfax -> tdeprintfax +</para></listitem> +<listitem><para> +kradio -> tderadio +</para></listitem> +<listitem><para> +krandrtray -> tderandrtray +</para></listitem> +<listitem><para> +kresources -> tderesources +</para></listitem> +<listitem><para> +krita -> chalk +</para></listitem> +<listitem><para> +ksocket -> tdesocket +</para></listitem> +<listitem><para> +kstyle -> tdestyle +</para></listitem> +<listitem><para> +kwallet -> tdewallet +</para></listitem> +<listitem><para> +kwin -> twin +</para></listitem> +<listitem><para> +kwin4 -> twin4 +</para></listitem> +<listitem><para> +qmake -> tqmake +</para></listitem> +<listitem><para> +qmoc -> tqmoc +</para></listitem> +<listitem><para> +qtconfig -> tqconfig +</para></listitem> +<listitem><para> +quic -> tquic +</para></listitem> +<listitem><para> +startkde -> starttde +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-environment-variable-renaming"> +<title>Environment Variable Renaming</title> + +<itemizedlist> + +<listitem><para> +KDEBINDIR -> TDEBINDIR +</para></listitem> +<listitem><para> +KDEDIR -> TDEDIR +</para></listitem> +<listitem><para> +KDEDIRS -> TDEDIRS +</para></listitem> +<listitem><para> +KDEHOME -> TDEDEHOME +</para></listitem> +<listitem><para> +KDEROOTHOME -> TDEROOTHOME +</para></listitem> +<listitem><para> +KDESRCDIR -> TDESRCDIR +</para></listitem> +<listitem><para> +KDESU_USER -> TDESU_USER +</para></listitem> +<listitem><para> +KDESYCOCA -> TDESYCOCA +</para></listitem> +<listitem><para> +KDETMP -> TDETMP +</para></listitem> +<listitem><para> +KDEVARTMP -> TDEVARTMP +</para></listitem> +<listitem><para> +KDEWM -> TDEWM +</para></listitem> +<listitem><para> +KDE_FORK_SLAVES -> TDE_FORK_SLAVES +</para></listitem> +<listitem><para> +KDE_FULL_SESSION -> TDE_FULL_SESSION +</para></listitem> +<listitem><para> +KDE_KIOSK_NO_PROFILES -> TDE_KIOSK_NO_PROFILES +</para></listitem> +<listitem><para> +KDE_KIOSK_NO_RESTRICTIONS -> TDE_KIOSK_NO_RESTRICTIONS +</para></listitem> +<listitem><para> +KDE_LANG -> TDE_LANG +</para></listitem> +<listitem><para> +KDE_MAKE_VERSION -> TDE_MAKE_VERSION +</para></listitem> +<listitem><para> +KDE_MALLOC -> TDE_MALLOC +</para></listitem> +<listitem><para> +KDE_MULTIHEAD -> TDE_MULTIHEAD +</para></listitem> +<listitem><para> +KDE_NO_IPV6 -> TDE_NO_IPV6 +</para></listitem> +<listitem><para> +KDE_SESSION_UID -> TDE_SESSION_UID +</para></listitem> +<listitem><para> +KDE_UTF8_FILENAMES -> TDE_UTF8_FILENAMES +</para></listitem> +<listitem><para> +KDE_VERSION -> TDE_VERSION +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-class-and-library-renaming"> +<title>Class and Library Renaming</title> + +<itemizedlist> + +<listitem><para> +KABC -> TDEABC +</para></listitem> +<listitem><para> +KAbout -> TDEAbout +</para></listitem> +<listitem><para> +KAboutData -> TDEAboutData +</para></listitem> +<listitem><para> +KApplication -> TDEApplication +</para></listitem> +<listitem><para> +KBuffer -> TDEBuffer +</para></listitem> +<listitem><para> +KClipboard -> TDEClipboard +</para></listitem> +<listitem><para> +KCModule -> TDECModule +</para></listitem> +<listitem><para> +KComp -> TDEComp +</para></listitem> +<listitem><para> +KConfig -> TDEConfig +</para></listitem> +<listitem><para> +KCmd -> TDECmd +</para></listitem> +<listitem><para> +KCmdLineArgs -> TDECmdLineArgs +</para></listitem> +<listitem><para> +KGlobal -> TDEGlobal +</para></listitem> +<listitem><para> +KIcon -> TDEIcon +</para></listitem> +<listitem><para> +KInstance -> TDEInstance +</para></listitem> +<listitem><para> +KIO -> TDEIO +</para></listitem> +<listitem><para> +KIO_EXPORT -> TDEIO_EXPORT +</para></listitem> +<listitem><para> +KIOBuffer -> TDEIOBuffer +</para></listitem> +<listitem><para> +KIOConfig -> TDEIOConfig +</para></listitem> +<listitem><para> +KIOInput -> TDEIOInput +</para></listitem> +<listitem><para> +KIOJob -> TDEIOJob +</para></listitem> +<listitem><para> +KListBox -> TDEListBox +</para></listitem> +<listitem><para> +KListView -> TDEListView +</para></listitem> +<listitem><para> +KListViewItem -> TDEListViewItem +</para></listitem> +<listitem><para> +KLocale -> TDELocale +</para></listitem> +<listitem><para> +KLock -> TDELock +</para></listitem> +<listitem><para> +KPopupMenu -> TDEPopupMenu +</para></listitem> +<listitem><para> +KProcess -> TDEProcess +</para></listitem> +<listitem><para> +KServer -> TDEServer +</para></listitem> +<listitem><para> +KShared -> TDEShared +</para></listitem> +<listitem><para> +KSocket -> TDESocket +</para></listitem> +<listitem><para> +KStandardDirs -> TDEStandardDirs +</para></listitem> +<listitem><para> +KStartupInfo -> TDEStartupInfo +</para></listitem> +<listitem><para> +KStyle -> TDEStyle +</para></listitem> +<listitem><para> +KTrader -> TDETrader +</para></listitem> +<listitem><para> +KZone -> TDEZone +</para></listitem> +<listitem><para> +kdefx -> tdefx +</para></listitem> +<listitem><para> +kdeinit -> tdeinit +</para></listitem> +<listitem><para> +kiobuffer -> tdeiobuffer +</para></listitem> +<listitem><para> +kioslave -> tdeioslave +</para></listitem> +<listitem><para> +kwin -> twin +</para></listitem> +<listitem><para> +libkdecorations -> libtdecorations +</para></listitem> +<listitem><para> +libkdecore -> libtdecore +</para></listitem> +<listitem><para> +libkdefakes -> libtdefakes +</para></listitem> +<listitem><para> +libkdepim -> libtdepim +</para></listitem> +<listitem><para> +libkdeprint -> libtdeprint +</para></listitem> +<listitem><para> +libkdesu -> libtdesu +</para></listitem> +<listitem><para> +libkdeui -> libtdeui +</para></listitem> +<listitem><para> +lkabc -> ltdeabc +</para></listitem> +<listitem><para> +lkdnssd -> ltdednssd +</para></listitem> +<listitem><para> +lkfile -> ltdefile +</para></listitem> +<listitem><para> +lkhtml -> ltdehtml +</para></listitem> +<listitem><para> +lkio -> ltdeio +</para></listitem> +<listitem><para> +lkimproxy -> ltdeimproxy +</para></listitem> +<listitem><para> +libkio -> libtdeio +</para></listitem> +<listitem><para> +lknewstuff -> ltdenewstuff +</para></listitem> +<listitem><para> +lkparts -> ltdeparts +</para></listitem> +<listitem><para> +lkspell -> ltdespell +</para></listitem> +<listitem><para> +lkunittest -> ltdeunittest +</para></listitem> +<listitem><para> +lkutils -> ltdeutils +</para></listitem> +<listitem><para> +makekdewidgets -> maketdewidgets +</para></listitem> + +</itemizedlist> + +</sect2> + +<sect2 id="release-notes-thank-you"> +<title>Thank You!</title> + +<para>Thank you for using and supporting &tde;.</para> + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.01.docbook b/doc/khelpcenter/releasenotes/r14.0.01.docbook new file mode 100644 index 000000000..022fe7fcf --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.01.docbook @@ -0,0 +1,60 @@ +<sect1 id="release-notes-r14.0.1"> +<title>R14.0.1 Release Notes</title> + +<para>R14.0.1 is the first maintenance release of the R14.0 series, +and is the result of several months of ongoing effort by the TDE +development team.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.1-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Konqueror file filtering now works correctly</para></listitem> + <listitem><para>TDE session manager crashes should no longer be experienced</para></listitem> + <listitem><para>KHelpcenter incorrectly displayed content is now visualized correctly</para></listitem> + <listitem><para>Incorrect window transparency with TDE Compton has been eliminated</para></listitem> + <listitem><para>Incorrect circular dependency in Debian/Ubuntu packages has been resolved</para></listitem> + <listitem><para>TDEFileReplace no longer hangs/crashes when circular links are encountered</para></listitem> + <listitem><para>TDENetworkManager no longer crashes if an interace is removed</para></listitem> + <listitem><para>TDENetworkManager no longer hangs on point-to-point connections</para></listitem> + <listitem><para>TDevelop cmake template projects now builds correctly</para></listitem> + <listitem><para>Digikam slideshow no longer hangs</para></listitem> + <listitem><para>Several FTBFS has been addressed</para></listitem> + <listitem><para>KDesktop no longer hangs on startup</para></listitem> + <listitem><para>KMail no longer crashes if closed in offline mode</para></listitem> + <listitem><para>KSquirrel can load codecs - works again</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Added support for Ubuntu Vivid 15.04</para></listitem> + <listitem><para>Added initial support for FreeBSD</para></listitem> + <listitem><para>Added support for ARM64 and PowerPC64le</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>Several qt3/tqt3 security alerts have been fixed</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + +<sect2 id="release-notes-r14.0.1-freebsd"> +<title>FreeBSD Support</title> +<para>TDE now has basic support for FreeBSD! Additional developers are always +welcome to help port over the remaining features and applications.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.02.docbook b/doc/khelpcenter/releasenotes/r14.0.02.docbook new file mode 100644 index 000000000..84281cf3b --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.02.docbook @@ -0,0 +1,45 @@ +<sect1 id="release-notes-r14.0.2"> +<title>R14.0.2 Release Notes</title> + +<para>R14.0.2 is the second maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.1 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.2-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed installation/logon problem when installed in systems with Unity and Gnome</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Added support for Ubuntu 15.10 - Wily</para></listitem> + <listitem><para>Added ports of some applications for FreeBSD</para></listitem> + <listitem><para>Added support for XDG_SESSION_DESKTOP and XDG_CURRENT_DESKTOP in TDM.</para> + <para>This improves coexistence with other desktop environments</para></listitem> + <listitem><para>Added subversion 1.9 support</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + +<sect2 id="release-notes-r14.0.2-freebsd"> +<title>FreeBSD Support</title> +<para>Support for FreeBSD is improving - the port of a first group of +applications is now completed! However, there are still some issues that +need to be addressed before full FreeBSD support can be achieved. Additional +developers or contributors willing to help porting the remaining features +and applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.03.docbook b/doc/khelpcenter/releasenotes/r14.0.03.docbook new file mode 100644 index 000000000..92f18b3e4 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.03.docbook @@ -0,0 +1,50 @@ +<sect1 id="release-notes-r14.0.3"> +<title>R14.0.3 Release Notes</title> + +<para>R14.0.3 is the third maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.2 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.3-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed floppy support in media manager</para></listitem> + <listitem><para>Fixed an annoying bug with zip file support that prevented some applications (such as KOffice and k3b) from opening their own saved files</para></listitem> + <listitem><para>Fixed detection of mime types not contained in TDE settings (using magic library) which prevented sound files from being played in some recent distros</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Improved handling of various types of discs in media manager</para></listitem> + <listitem><para>Added giflib 5.1 support</para></listitem> + <listitem><para>Added ruby 2.2 support</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>Fixed a bunch of security issues</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + +<sect2 id="release-notes-r14.0.3-freebsd"> +<title>FreeBSD Support</title> +<para>There are still some issues that need to be addressed before full +FreeBSD support can be achieved. Additional developers or contributors +willing to help porting the remaining features and applications are +always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.04.docbook b/doc/khelpcenter/releasenotes/r14.0.04.docbook new file mode 100644 index 000000000..971dbc3d1 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.04.docbook @@ -0,0 +1,65 @@ +<sect1 id="release-notes-r14.0.4"> +<title>R14.0.4 Release Notes</title> + +<para>R14.0.4 is the fourth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.3 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.4-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed handling of certificate “permanent” acceptance</para></listitem> + <listitem><para>Fixed screensaver activation and computer suspend code interaction</para></listitem> + <listitem><para>Fixed occasional Konqueror crashes on kjs/regexp</para></listitem> + <listitem><para>Fixed utf8 handling in tdeabc, libkcal, CardDAV</para></listitem> + <listitem><para>Fixed invisible (miniature) icons in the tray</para></listitem> + <listitem><para>Fixed positioning of main panel to the screen side when the clock is displayed in the system tray</para></listitem> + <listitem><para>Fixed crash of some non-TDE applications due to wrong X symbolic color database</para></listitem> + <listitem><para>Fixed “ESC” support in TDEPowersave countdown dialog</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Switch to new jabber protocol in Kopete</para></listitem> + <listitem><para>Improved startup of tdehw dbus daemon</para></listitem> + <listitem><para>Improved support for TQt python scripts</para></listitem> + <listitem><para>Improved handling of folder location in save dialog</para></listitem> + <listitem><para>Relaxed time limit for computer suspend settings in TDEPowersave</para></listitem> + <listitem><para>Updated METAR URL in KWeather</para></listitem> + <listitem><para>Added CUPS 2.2 support</para></listitem> + <listitem><para>Added FFMPEG3 support</para></listitem> + <listitem><para>Added GCC 6.x support</para></listitem> + <listitem><para>Added GStreamer 1.x support</para></listitem> + <listitem><para>Added rar 5.x support</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>Fixed security issues</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + + +<sect2 id="release-notes-r14.0.4-freebsd"> +<title>FreeBSD Support</title> +<para>Support for FreeBSD is still partial and some new issues have arisen +with the latest versions of FreeBSD. The TDE team will try their best to +improve support for FreeBSD but progress will probably be slow. Additional +developers or contributors willing to help porting the remaining features +and applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.05.docbook b/doc/khelpcenter/releasenotes/r14.0.05.docbook new file mode 100644 index 000000000..12353c5c2 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.05.docbook @@ -0,0 +1,78 @@ +<sect1 id="release-notes-r14.0.5"> +<title>R14.0.5 Release Notes</title> + +<para>R14.0.5 is the fifth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.4 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.5-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed OGG file playing (TDE login sounds now works again :-) )</para></listitem> + <listitem><para>Fixed sound server and arts crashes</para></listitem> + <listitem><para>Fixed device detection from Media Manager in kscd</para></listitem> + <listitem><para>Fixed several kdesktop_lock related bugs</para></listitem> + <listitem><para>Fixed status of Trash bin on desktop</para></listitem> + <listitem><para>Fixed notification of removable media</para></listitem> + <listitem><para>Fixed info page protocol support (regression in previous release)</para></listitem> + <listitem><para>Fixed regression with open/save dialogs on ftp or removable disks</para></listitem> + <listitem><para>Fixed javascript syntax highlighting in Kate</para></listitem> + <listitem><para>Fixed support for NetworkManager with randomized MAC addresses</para></listitem> + <listitem><para>Fixed detection whether the system is big endian</para></listitem> + <listitem><para>Fixed memory leaks</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Improved timer handling in TDEPowersaver</para></listitem> + <listitem><para>New sessions can now correctly be started as "pre-lock", useful where autologin is enabled</para></listitem> + <listitem><para>Added support for GnuPG 2.1</para></listitem> + <listitem><para>Improved KGPG server configuration</para></listitem> + <listitem><para>Enhanced Ark and Ark plugin interface and support for .rar files</para></listitem> + <listitem><para>Improved calculations in mini-cli</para></listitem> + <listitem><para>Improved icon display in system tray</para></listitem> + <listitem><para>Improved support for Jabber protocol in Kopete</para></listitem> + <listitem><para>Dropped support for discontinued AIM protocol in Kopete</para></listitem> + <listitem><para>Enhanced mime type code</para></listitem> + <listitem><para>Added support for G-code in Kate syntax highlighting</para></listitem> + <listitem><para>Added support for OpenSSL 1.1</para></listitem> + <listitem><para>Improved support for TLS v1.2</para></listitem> + <listitem><para>Improved support for Clang</para></listitem> + <listitem><para>Added support for GCC7 and GCC8</para></listitem> + <listitem><para>Added support for Java8 and newer</para></listitem> + <listitem><para>Added support for ICU 58 and newer</para></listitem> + <listitem><para>Added detection for ruby 2.3, 2.4 and 2.5</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>Fix security issue CVE-2016-10040</para></listitem> + <listitem><para>Fix security issue CVE-2017-6410</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + + +<sect2 id="release-notes-r14.0.5-freebsd"> +<title>FreeBSD Support</title> +<para>TDE continues to offer support for FreeBSD, although still partial +given some of the new issues that have arisen with the latest versions +of FreeBSD. The TDE team will try their best to improve support for +FreeBSD but progress will probably be slow. Additional developers or +contributors willing to help porting the remaining features and +applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.06.docbook b/doc/khelpcenter/releasenotes/r14.0.06.docbook new file mode 100644 index 000000000..2396174b3 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.06.docbook @@ -0,0 +1,70 @@ +<sect1 id="release-notes-r14.0.6"> +<title>R14.0.6 Release Notes</title> + +<para>R14.0.6 is the sixth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.5 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.6-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Reboot and shutdown now works with other DM (other than TDM) as long as logind is present</para></listitem> + <listitem><para>Passwords with special characters are now accepted</para></listitem> + <listitem><para>Fixed bugs with pdf handling and displaying</para></listitem> + <listitem><para>Improved TDM log file handling</para></listitem> + <listitem><para>Fixed GUI related glitches and missing icons in various places</para></listitem> + <listitem><para>Fixed annoying double notification when inserting some special removable media</para></listitem> + <listitem><para>Fixed few KOrganizer crashes</para></listitem> + <listitem><para>Fixed Kdesktop unresponsive behaviour when multiple users log into the same machine at the same time</para></listitem> + <listitem><para>Fixed support for array of object path key maps in dbus-1-tqt</para></listitem> + <listitem><para>Fixed SSL initialization for OpenSSL >= 1.1</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Added support for safe conversion from TQString to char*</para></listitem> + <listitem><para>Added support for global LDFLAGS set at the system level</para></listitem> + <listitem><para>Several packages have been migrated to CMake build system</para></listitem> + <listitem><para>Improved GCC visibility detection in CMake builds</para></listitem> + <listitem><para>Created a CMake framework for updating translation templates</para></listitem> + <listitem><para>Added support for Weblate web based translation (yet to be officially announced)</para></listitem> + <listitem><para>Improved TDE related CMake capabilities</para></listitem> + <listitem><para>Improved support for large files detection</para></listitem> + <listitem><para>Better detection of dynamic loaded libraries location</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>Fix security issue CVE-2018-19870</para></listitem> + <listitem><para>Fix security issue CVE-2018-19873</para></listitem> + <listitem><para>Fix security issue CVE-2018-7225</para></listitem> + <listitem><para>Fix security issue CVE-2018-20021</para></listitem> + <listitem><para>Fix security issue CVE-2018-20022</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + + +<sect2 id="release-notes-r14.0.6-freebsd"> +<title>FreeBSD Support</title> +<para>TDE continues to offer support for FreeBSD, although still partial +given some of the new issues that have arisen with the latest versions +of FreeBSD. The TDE team will try their best to improve support for +FreeBSD but progress will probably be slow. Additional developers or +contributors willing to help porting the remaining features and +applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.07.docbook b/doc/khelpcenter/releasenotes/r14.0.07.docbook new file mode 100644 index 000000000..d902655d0 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.07.docbook @@ -0,0 +1,104 @@ +<sect1 id="release-notes-r14.0.7"> +<title>R14.0.7 Release Notes</title> + +<para>R14.0.7 is the seventh maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.6 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.7-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed some SAK related bugs</para></listitem> + <listitem><para>Fixed TLS support in recent distros</para></listitem> + <listitem><para>Clean up links to non functional old websites</para></listitem> + <listitem><para>Fixed several FTBFS caused by newer library versions</para></listitem> + <listitem><para>Fixed annoying crashes in TDevelop</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Several packages have been migrated to CMake build system</para></listitem> + <listitem><para>General polishing of TDE look and brand</para></listitem> + <listitem><para>Several translation updates (thanks to all translators)</para></listitem> + <listitem><para>Better support for XDG standard</para></listitem> + <listitem><para>Improved detection of ruby version</para></listitem> + <listitem><para>Added support for a new location of the ICEauthority file</para></listitem> + <listitem><para>Added support for recent versions of libpqxx</para></listitem> + <listitem><para>Added support for MySQL 8.x</para></listitem> + <listitem><para>Added initial support for DilOS builds</para></listitem> + <listitem><para>Added initial support for build with musl libc</para></listitem> + <listitem><para>Added support for build with LibreSSL</para></listitem> + <listitem><para>Restored both AIM and MSN protocols in kopete</para></listitem> + <listitem><para>Revived NetBSD support for various packages</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>CVE-2019-14744: Prevent arbitrary code execution from .desktop files</para></listitem> + <listitem><para>CVE-2018-19872: Fix crash in tqimage for certain malformed ppm image files</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + +<sect2 id="release-notes-r14.0.7-hints"> +<title>Useful notes on upgrading</title> +<para>When upgrading from previous releases you may run into some of +the following use cases. Follow the recommended instructions to minimize +potential problems.</para> + +<sect3 id="release-notes-r14.0.7-hints-gpg"> +<title>New GPG signing key for deb repositories</title> +<para>A new GPG key is now used to sign Debian / Raspbian / Ubuntu repositories.</para> +<para>If you use any of such distros and already have the trinity-keyring +package installed, changing the GPG key for the repository will not affect +you. If you do not have the trinity-keyring package installed, you must +first obtain a new GPG key as described in Import GPG signing key otherwise +the repository will be reported as untrusted.</para> +</sect3> + +<sect3 id="release-notes-r14.0.7-hints-kpilot"> +<title>Conflict between KPilot and tde-i18n packages</title> +<para>For historical reasons KPilot translations were part of the tde-i18n +package. Now the translations have been carved out from tde-i18n and moved +to the kpilot package.</para> +<para>If you have kpilot installed, we recommend uninstalling the package +before upgrading to the new release to avoid conflicts of translation files. +You can reinstall KPilot after the upgrade process has completed.</para> +</sect3> + +<sect3 id="release-notes-r14.0.7-hints-dbus"> +<title>Removed dbus policy at_console</title> +<para>A newer version of SystemD has removed the dbus policy at_console. +As a result, communication with the TDE Hardware Control daemon may stop +working.</para> +<para>While this will be addressed in the R14.1.0 release, for the time +being if you encounter this problem we recommend to change the policy from +at_console="true" to some other acceptable options such as group="users" +in /etc/dbus-1/system.d/org.trinitydesktop.hardwarecontrol.conf.</para> +</sect3> +</sect2> + + +<sect2 id="release-notes-r14.0.7-freebsd"> +<title>FreeBSD Support</title> +<para>TDE continues to offer support for FreeBSD, although still partial +given some of the new issues that have arisen with the latest versions +of FreeBSD. The TDE team will try their best to improve support for +FreeBSD but progress will probably be slow. Additional developers or +contributors willing to help porting the remaining features and +applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.08.docbook b/doc/khelpcenter/releasenotes/r14.0.08.docbook new file mode 100644 index 000000000..3d1d7e28d --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.08.docbook @@ -0,0 +1,104 @@ +<sect1 id="release-notes-r14.0.8"> +<title>R14.0.8 Release Notes</title> + +<para>R14.0.8 is the eighth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.7 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.8-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important fixes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed avahi support</para></listitem> + <listitem><para>Fixed parsing of CPU cores frequency on some hardware</para></listitem> + <listitem><para>Fixed parsing of battery information on some hardware</para></listitem> + <listitem><para>Fixed detection of closing the lid on some hardware</para></listitem> + <listitem><para>Fixed incorrect update of KNote "last modified" field</para></listitem> + <listitem><para>Fixed several FTBFS caused by newer library versions</para></listitem> + <listitem><para>Fixed K3B crashes when trying to write an audio CD with cd text</para></listitem> + <listitem><para>Fixed tdenetworkmanager crashes</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Many translation updates (thanks to all translators)</para></listitem> + <listitem><para>Several packages have been migrated to CMake build system</para></listitem> + <listitem><para>For some packages have been dropped the automake build system</para></listitem> + <listitem><para>Added option to disable tdekbdledsync</para></listitem> + <listitem><para>Added option to select default file manager</para></listitem> + <listitem><para>The selected default terminal is also used for Open terminal here</para></listitem> + <listitem><para>Improved LibreSSL support</para></listitem> + <listitem><para>Improved musl libc support</para></listitem> + <listitem><para>Improved support for DilOS distribution</para></listitem> + <listitem><para>Improved support for XDG folders</para></listitem> + <listitem><para>Improved support for Pinebook Pro</para></listitem> + <listitem><para>Initial work to support reproducible builds</para></listitem> + <listitem><para>Initial support for translating desktop files using Weblate</para></listitem> + <listitem><para>Using Ninja build for Cmake building on FreeBSD</para></listitem> + <listitem><para>Dropped Kerry and code related to Beagle search</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>CVE-2019-14744: Solved similar cases of arbitrary code execution from .desktop files</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> +</sect2> + +<sect2 id="release-notes-r14.0.8-hints"> +<title>Useful notes on upgrading</title> +<para>When upgrading from previous releases you may run into some of +the following use cases. Follow the recommended instructions to minimize +potential problems.</para> + +<sect3 id="release-notes-r14.0.8-hints-dbus"> +<title>Removed dbus policy at_console</title> +<para>A newer version of SystemD has removed the dbus policy at_console. +Because the TDE does not yet contain a policykit agent (this will be addressed +in R14.1.0), a plugdev group policy has been added in the default TDE Hardware +Control daemon dbus configuration. This group should be available on most +systems. To enable communication with the TDE Hardware Control daemon, add +users to the plugdev group.</para> +<para>Note: If a policykit is installed but a policykit agent is not +available, it does not work well. In this case, it is advisable to +uninstall policykit to allow the use of dbus rules.</para> +</sect3> + +<sect3 id="release-notes-r14.0.8-hints-r14-xdg-tests"> +<title>Test failures in r14-xdg-update</title> +<para>If you experience test failures at login time during the execution of +the r14-xdg-update script, please try logging out and logging in again. Most +failures will be automatically fixed. In case of persistent failures that +don't get automatically recovered, please contact the TDE team on their +official channels (mailing lists or IRC).</para> +<para>For example you may experience TEST9 failures if you had previously +edited your TDE menu and there are references to both 'kde-*' and 'tde-*' +files for the same application. This will require manual editing to +determine what is the correct way to fix the problem.</para> +</sect3> + +</sect2> + + +<sect2 id="release-notes-r14.0.8-freebsd"> +<title>FreeBSD Support</title> +<para>TDE continues to offer support for FreeBSD, although still partial +given some of the new issues that have arisen with the latest versions +of FreeBSD. The TDE team will try their best to improve support for +FreeBSD but progress will probably be slow. Additional developers or +contributors willing to help porting the remaining features and +applications are always welcome.</para> +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.09.docbook b/doc/khelpcenter/releasenotes/r14.0.09.docbook new file mode 100644 index 000000000..91373133d --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.09.docbook @@ -0,0 +1,139 @@ +<sect1 id="release-notes-r14.0.9"> +<title>R14.0.9 Release Notes</title> + +<para>R14.0.9 is the ninth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.8 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<sect2 id="release-notes-r14.0.9-notes"> +<title>Important fixes</title> + +<para>This section highlights some of the most important changes introduced by this +release.</para> + +<itemizedlist> +<listitem> + <para>New applications</para> + <itemizedlist> + <listitem><para>Codeine - a video player with a simple, uncluttered interface.</para></listitem> + <listitem><para>KEximDB plugin for converting MS Access MDB databases.</para></listitem> + <listitem><para>KoolDock - a cool application launcher.</para></listitem> + <listitem><para>KXMLEditor - an editor for XML files.</para></listitem> + <listitem><para>Mathemagics - a RPN scientific calculator.</para></listitem> + <listitem><para>Qalculate - a small, simple to use, yet powerful calculator.</para></listitem> + <listitem><para>TastyMenu - an alternative TDE menu.</para></listitem> + <listitem><para>TDE style Baghira - Apple's MacOS X's style for TDE.</para></listitem> + <listitem><para>TDE style Domino - a smooth style with a soft look.</para></listitem> + <listitem><para>TDE style Ia Ora - Mandriva Ia Ora theme for TDE.</para></listitem> + <listitem><para>TDEDocker - dock any application to the system tray.</para></listitem> + <listitem><para>TDEpacman - a pacman game clone.</para></listitem> + <listitem><para>Transcode added to dependency repository for Debian-like distros.</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Bug fixes</para> + <itemizedlist> + <listitem><para>Fixed problem with assignment of keyboard shortcuts in recent distros.</para></listitem> + <listitem><para>Various fixes to KMix, this will partially help when PulseAudio is installed.</para></listitem> + <listitem><para>Autostart TCC module no longer crashes when non-service entries are used.</para></listitem> + <listitem><para>Fixed Konqueror's kdiff3 preview plugin functionality.</para></listitem> + <listitem><para>Various fixes related to compiling and linking.</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Enhancements</para> + <itemizedlist> + <listitem><para>Many translation updates (thanks to all translators).</para></listitem> + <listitem><para>Several packages have been migrated to CMake build system.</para></listitem> + <listitem><para>Dropped automake build system for various packages.</para></listitem> + <listitem><para>Continued overall look polishing.</para></listitem> + <listitem><para>TDE's QtCurve style updated to upstream version 1.8.5.</para></listitem> + <listitem><para>Added brightness control in kmilo generic monitor.</para></listitem> + <listitem><para>Improved support for bluray discs.</para></listitem> + <listitem><para>Added support for xine 1.2.10.</para></listitem> + <listitem><para>Changed CDDB database from freedb.org (no longer working) to gnudb.org.</para></listitem> + </itemizedlist> +</listitem> +<listitem> + <para>Security</para> + <itemizedlist> + <listitem><para>CVE-2020-17507: Fix buffer overflow in XBM parser.</para></listitem> + </itemizedlist> +</listitem> +</itemizedlist> + +<para>The full list of changes is available at these links:</para> +<itemizedlist> + <listitem><para><ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/tde/issues/29">TGW issue list.</ulink></para></listitem> + <listitem><para><ulink url="https://bugs.trinitydesktop.org/showdependencytree.cgi?id=3085&hide_resolved=0">Bugzilla bug list.</ulink></para></listitem> + <listitem><para><ulink url="https://wiki.trinitydesktop.org/Changelog_For_R14.0.9">Detailed commit change log.</ulink></para></listitem> + <listitem><para><ulink url="https://wiki.trinitydesktop.org/Release_Notes_For_R14.0.9">Full release notes on TDE wiki.</ulink></para></listitem> +</itemizedlist> +</sect2> + + +<sect2 id="release-notes-r14.0.9-hints"> +<title>Useful notes on upgrading</title> +<para>When upgrading from previous releases you may run into some of +the following use cases. Follow the recommended instructions to minimize +potential problems.</para> + +<sect3 id="release-notes-r14.0.9-hints-pulseaudio"> +<title>PulseAudio support workarounds</title> +<para>Initial support for PulseAudio is planned for the R14.1.0 release.</para> +<para>For the time being you can try one of the following workarounds in case you have troubles with PA +(especially muting/unmuting). +<itemizedlist> + <listitem> + <para>You can mute/unmute from the KMix slider LED, this should work fine with PA.</para> + </listitem> + <listitem> + <para>You can open KMix mixer window -> Settings -> Configure global shortcuts and remap the "toggle mute" + keyboard shortcut to some other key combination. Do not use "XF86AudioMute" key, since this is normally + used by KMilo and therefore may not work.</para> + </listitem> + <listitem> + <para>You can create a script that calls "dcop kmix Mixer-1 toggleMasterMute", this will mute/unmute the PA + master channel. You can add an input action tied to a keyboard shortcut to call this easy.</para> + </listitem> +</itemizedlist> +</para> +</sect3> + +<sect3 id="release-notes-r14.0.9-hints-knotes-global-shortcuts"> +<title>Change in KNotes global shortcuts</title> +<para>KNotes had four global keyboard shortcuts that were bounded to Alt + Shift + C/N/S/H. These shortcuts were +overlapping with other key combinations used in some common programs, for example Midnight Commander.</para> +<para>In R14.0.9 those KNotes global keyboard shortcuts have been left unassigned by default. If you wish to +keep using the previous setup, you need to right click on KNotes system tray icon, select "Configure shortcuts" +and then assign the following key combinations. +<itemizedlist> + <listitem> + <para>New Note --> Alt + Shift + N</para> + </listitem> + <listitem> + <para>New Note From Clipboard --> Alt + Shift + C</para> + </listitem> + <listitem> + <para>Hide All Notes --> Alt + Shift + H</para> + </listitem> + <listitem> + <para>Show All Notes --> Alt + Shift + S</para> + </listitem> +</itemizedlist> +</para> +</sect3> + +<sect3 id="release-notes-r14.0.9-hints-arch-support"> +<title>Restriction of supported distros/architectures</title> +<para>Starting from this TDE release, apt sources for i386 architecture are no longer provided for Ubuntu 20.04 onwards.</para> +<para>If you have a multi-arch system that includes i386 as well, you need to either remove i386 from the list of known architectures or +remove that architecture from your apt sources.</para> +<para>For example, if you have both i386 and amd64, you need to add [arch=amd64] in your apt sources.list file to make sure i386 is not used.</para> +</sect3> + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/r14.0.10.docbook b/doc/khelpcenter/releasenotes/r14.0.10.docbook new file mode 100644 index 000000000..13950a2d8 --- /dev/null +++ b/doc/khelpcenter/releasenotes/r14.0.10.docbook @@ -0,0 +1,12 @@ +<sect1 id="release-notes-r14.0.10"> +<title>R14.0.10 Release Notes (draft)</title> + +<para>R14.0.10 is the tenth maintenance release of the R14.0 series, +and is built on and improves the previous R14.0.9 version.</para> +<para>Maintenance releases are intended to promptly bring bug fixes +to users, while preserving overall stability through the avoidance +of both major new features and major codebase re-factoring.</para> + +<para>The ongoing temporary list of changes introduced by this release can be found <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/tde/issues/36">here</ulink>.</para> + +</sect1> diff --git a/doc/khelpcenter/releasenotes/tde_release_notes.desktop b/doc/khelpcenter/releasenotes/tde_release_notes.desktop new file mode 100644 index 000000000..eb82e1dea --- /dev/null +++ b/doc/khelpcenter/releasenotes/tde_release_notes.desktop @@ -0,0 +1,9 @@ +[Desktop Entry] +Encoding=UTF-8 +Name=tde_release_notes +Exec=tde_release_notes +Type=Application +X-TDE-autostart-phase=2 +X-TDE-StartupNotify=false +X-TDE-UniqueApplet=true +Categories=System; diff --git a/doc/khelpcenter/userguide/CMakeLists.txt b/doc/khelpcenter/userguide/CMakeLists.txt new file mode 100644 index 000000000..50fb573cd --- /dev/null +++ b/doc/khelpcenter/userguide/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/userguide ) diff --git a/doc/khelpcenter/userguide/Makefile.am b/doc/khelpcenter/userguide/Makefile.am new file mode 100644 index 000000000..488634323 --- /dev/null +++ b/doc/khelpcenter/userguide/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/userguide + diff --git a/doc/khelpcenter/userguide/a-window.png b/doc/khelpcenter/userguide/a-window.png Binary files differnew file mode 100644 index 000000000..cfd93ddb4 --- /dev/null +++ b/doc/khelpcenter/userguide/a-window.png diff --git a/doc/khelpcenter/userguide/accessibility.docbook b/doc/khelpcenter/userguide/accessibility.docbook new file mode 100644 index 000000000..d5ac064eb --- /dev/null +++ b/doc/khelpcenter/userguide/accessibility.docbook @@ -0,0 +1,150 @@ + +<chapter id="accessibility"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Gary</firstname> +<surname>Cramblitt </surname> +</author> +</authorgroup> +</chapterinfo> + +<title>Accessibility</title> + +<indexterm><primary>Accessibility</primary></indexterm> + +<para><acronym>KDEAP</acronym> (the &tde; Accessibility Project) aims to ensure that &tde;, as a desktop environment, is accessible to all users, including those of us with physical disabilities. In addition to the accessibility aids in the <link linkend="kcontrol-regional-and-accessibility">Control Center</link>, &tde; has several other accessibility tools, which are available in the &tde;-Accessibility package. This package may not be installed on your computer; if it is not, you can download it from here:</para> + +<para><itemizedlist> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.tar.gz">tdeaccessibility-1.0.0.tar.gz</ulink>, or +<ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.tar.bz2">tdeaccessibility-1.0.0.tar.bz2</ulink></para></listitem> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.md5">MD5</ulink></para></listitem> +<listitem><para><ulink url="ftp://ftp.kde.org/pub/kde/stable/apps/KDE3.x/accessibility/tdeaccessibility-1.0.0.lsm">lsm file</ulink></para></listitem> +</itemizedlist></para> + +<para>For more information on the project, visit the <ulink url="http://accessibility.kde.org/">&tde; Accessibility Home Page</ulink>.</para> + +<sect1 id="kmousetool"> +<title><application>KMouseTool</application></title> + +<indexterm><primary>Mouse</primary><secondary>clicking +automatically</secondary></indexterm> + +<para> + <application>KMouseTool</application> is a &tde; program, which clicks the mouse for you, so you + do not have to. <application>KMouseTool</application> works with any mouse or pointing device. +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmousetool.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>KMouseTool</phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para><application>MouseTool</application> Website: <ulink url="http://mousetool.com/">http://mousetool.com</ulink></para></listitem> + <listitem><para><ulink url="help:/kmousetool"><application>KMouseTool</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="kmagnifier"> +<title>KMagnifier</title> + +<indexterm><primary>Magnifier</primary></indexterm> + +<para>KMagnifier (or <command>kmag</command>, to use its &UNIX; name) is a small utility for Linux to magnify + a part of the screen. It magnifies the area of the screen around the + mouse pointer or, optionally, a user-defined area. Additionally, it can save + a magnified screenshot to disk. +</para> + +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmag.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>KMag</phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://kmag.sourceforge.net/">http://kmag.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kmag"><application>KMag</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="kmouth"> +<title><application>KMouth</application></title> + +<indexterm><primary>Speech</primary></indexterm> + +<para><application>KMouth</application> is a TDE program which enables people who cannot speak to let their + computer speak, ⪚ mutal people or people who have lost their voice. + It has a text-input field and speaks the sentences that you enter. It also has + support for user-defined phrasebooks. +</para> + +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>First screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth2.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Second screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> +<para> +<inlinemediaobject> + <imageobject> + <imagedata fileref="kmouth3.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Third screenshot of <application>KMouth</application></phrase> + </textobject> +</inlinemediaobject> +</para> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://www.schmi-dt.de/kmouth/index.en.html">http://www.schmi-dt.de/kmouth/index.en.html</ulink></para></listitem> + <listitem><para><ulink url="help:/kmouth"><application>KMouth</application> Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="ktts"> +<title><application>KTTS</application> - Text-to-Speech</title> + +<para><application>KTTS</application> is a &tde; application for the conversion of text into audible speech. Currently, since &kde; 3.4, you can use <application>KTTS</application> to speak any text from the &klipper;, the &tde; clipboard, any text from a plain text file (using &kate; or otherwise), speak any portion of text from a &HTML; page in &konqueror;, and much more.</para> + +<para>To get <application>KTTS</application> up-and-running you will need to start by running <command>kttsmgr</command>, the &tde; Text-to-Speech manager.</para> + +<!-- Insert Screeny here --> + +<itemizedlist><title>Related Information</title> + <listitem><para>Website: <ulink url="http://accessibility.kde.org/developer/kttsd/">http://accessibility.kde.org/developer/kttsd/</ulink></para></listitem> + <listitem><para><ulink url="help:/kttsd"><application>KTTSD</application> Handbook</ulink></para></listitem> + +</itemizedlist> + +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/amarok-icon.png b/doc/khelpcenter/userguide/amarok-icon.png Binary files differnew file mode 100644 index 000000000..3a4191fe3 --- /dev/null +++ b/doc/khelpcenter/userguide/amarok-icon.png diff --git a/doc/khelpcenter/userguide/amarok.png b/doc/khelpcenter/userguide/amarok.png Binary files differnew file mode 100644 index 000000000..1affe7f29 --- /dev/null +++ b/doc/khelpcenter/userguide/amarok.png diff --git a/doc/khelpcenter/userguide/base-tde-applications.docbook b/doc/khelpcenter/userguide/base-tde-applications.docbook new file mode 100644 index 000000000..dc3074b81 --- /dev/null +++ b/doc/khelpcenter/userguide/base-tde-applications.docbook @@ -0,0 +1,423 @@ +<chapter id="basic-applications"> + +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>The Base &tde; Applications</title> + +<para>What follows is a brief description of a few of the base &tde; applications. For more information on any of the applications you should check the links recommended with each respective entry.</para> + +<!-- What are they?? (Phil) --> +<!-- Included a few here; may be a good idea to add to this in future --> + +<sect1 id="base-applications-fundamental"> + +<title>Fundamentals</title> + +<variablelist> +<varlistentry> +<term>&konqueror;</term> + <listitem><para>&tde;'s file manager, web browser, <acronym>FTP</acronym> client and much more. &konqueror; is the canvas for all the latest &tde; technology, from TDEIO slaves (which provide mechanisms for file access) to component embedding, allowing it to be a universal viewing application, capable of displaying various image files as well as documents.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konqueror.org">http://konqueror.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/konqueror</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kate;</term> + <listitem><para>&tde;'s advanced multi-view text editor. &kate; is excellent for things such as viewing the &HTML; source of a webpage to handling advanced coding in <acronym>C++</acronym>, <acronym>PHP</acronym> and <acronym>XML</acronym> with its powerful syntax highlighting engine and code folding capabilities. &kate; is a very speedy application, being capable of opening huge text files in a matter of seconds, as well as allowing you to view a hefty amount of multiple views in order to see more instances of the same document and/or more documents at any particular time.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kate.kde.org">http://kate.kde.org</ulink></para></listitem> + <listitem><para><ulink + url="help:/kate">&kate; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Insert Screeny --> + +</varlistentry> + +<varlistentry> +<term>&konsole;</term> + <listitem><para>The X terminal emulator for &tde;. &konsole;, like many &tde; applications, is extremely customizable; while you can create your own user sessions, you can also of course open &Linux; console sessions, shell sessions, as well as standard <systemitem class="username">root</systemitem> and sudo sessions.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konsole.kde.org">http://konsole.kde.org</ulink></para></listitem> + <listitem><para><ulink + url="help:/konsole">&konsole; Handbook</ulink></para></listitem> + <listitem><para>User Guide <xref linkend="konsole-intro" /></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kicker;</term> + <listitem><para>The &tde; Panel, used for handling your currently running applications, a pager allowing you to switch between desktops, quick launch buttons to act as application launchers and much more.</para> + + <itemizedlist> + <listitem><para>See <xref linkend="panel-and-desktop"/> for altering some of its settings.</para></listitem> + <listitem><para><ulink + url="help:/kicker">&kicker; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>kdcop</application></term> +<!-- Mainly mentioned to raise awareness, for DCOP --> + <listitem><para>A <acronym>GUI</acronym> front-end to the powerful &DCOP; (Desktop COmmunications Protocol). &DCOP; provides a comprehensive protocol for interprocess communication between &tde; applications. While this is increasingly useful to &tde; programmers, it is also beneficial to the ordinary user who would want to create a script, or, say, a <application>SuperKaramba</application> theme.</para> + + <itemizedlist> + <listitem><para>In the User Guide <xref linkend="scripting-the-desktop"/> and <ulink url="help:/khelpcenter/adminguide#kdialog">The &tde; Administrator Guide</ulink></para></listitem> + <listitem><para>Other Documentation: <ulink + url="http://developer.kde.org/documentation/library/kdetqt/dcop.html">http://developer.kde.org/documentation/library/kdetqt/dcop.html</ulink></para></listitem> + + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kcontrol;</term> + <listitem><para>The control center for the Trinity Desktop Environment. You can alter a myriad of different things, ranging from themes, fonts and screensavers, to Internet, security and system administration.</para> + + <itemizedlist> + <listitem><para>See <xref linkend="control-center"/>.</para></listitem> + <listitem><para><ulink + url="help:/kcontrol">&kcontrol; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&khelpcenter;</term> + <listitem><para>The &tde; help system is used to provide access to the base &UNIX; help pages (man or info) as well as the native &tde; documentation provided by the &tde; documentation team or the application authors. You should be able to access all of the &tde; application handbooks from here.</para> + + <itemizedlist> + <listitem><para><ulink + url="help:/khelpcenter">&khelpcenter; Handbook</ulink></para></listitem> + <listitem><para>For information on the &tde; Documentation team, how to possibly join and help &tde;, see: <ulink url="http://kde.org/documentation">http://kde.org/documentation</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + </variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para><ulink url="http://kde-apps.org">http://kde-apps.org</ulink> -- mdash; The largest directory of third-party &tde; applications.</para></listitem> + <listitem><para>As you may have noticed, a wealth of information is accessible from the respective handbooks themselves, which can be accessed either by using the help TDEIO slave in &konqueror; (that is, type <userinput>help:/<replaceable>application</replaceable></userinput> in the Location toolbar), or by selecting it in the &khelpcenter;.</para></listitem> + <listitem><para>You can also likely find out quite a bit of information from the &tde; website, itself, at <ulink url="http://kde.org">http://kde.org</ulink>.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="base-applications-tdepim"> +<sect1info> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</sect1info> + +<title>Personal Information Management</title> + +<para>&tde; <acronym>PIM</acronym> (Personal Information Manager) is a sub-project of &tde;, and it aims to provide an application suite to manage personal information. It has several components, but these can all be brought under one application -- mdash; &kontact;, which is the personal information manager. Below is an overview of a few of its popular components; that is, a few of the applications that integrate into it.</para> + +<variablelist> +<varlistentry> +<term>&kontact;</term> + <listitem><para>This serves as the medium by which the rest of the applications in &tde; <acronym>PIM</acronym> can integrate with one another. All of the applications in &tde; <acronym>PIM</acronym> can be displayed inside here, and you can easily choose which ones to display. It also contains a Summary page by which you can get a brief overview of events and information in the other components.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kontact.kde.org">http://kontact.kde.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/kontact</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kmail;</term> + <listitem><para>The mail component. &kmail; comes with full <acronym>IMAP</acronym>, <acronym>POP3</acronym> and <acronym>SMTP</acronym> support. Signing and encrypting of emails is permitted, and there are many comprehensive anti-spam functions available. A spell check can easily be used, &HTML; emails can be viewed appropriately, and there is an advanced search feature.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kmail.kde.org">http://kmail.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kmail">&kmail; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&korganizer;</term> + <listitem><para>A fully customizable organizer which constitutes as the calender component. &korganizer; provides management of events and tasks, alarm notification, web export, network transparent handling of data, group scheduling, import and export of calendar files, and much more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://korganizer.kde.org">http://korganizer.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/korganizer">&korganizer; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kaddressbook;</term> + <listitem><para>The contacts component. &kaddressbook; enables you to manage your contacts efficiently and comfortably; contacts can be easily exported and imported from a plethora of different address book standards, and it can be efficiently integrated with &kopete;, &tde;'s multi-protocol instant messenger. Other features include support for all international character sets and advanced search functions.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://pim.kde.org/components/kaddressbook.php">http://pim.kde.org/components/kaddressbook.php</ulink></para></listitem> + <listitem><para><ulink url="help:/kaddressbook">&kaddressbook; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&knotes;</term> + <listitem><para>A handy component which can serve to handle all your digital sticky notes. You can have them displayed on your desktop, they can be <quote>dragged n' dropped</quote> into emails, printed, or even be displayed after &kontact; is closed down.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://pim.kde.org/components/knotes.php">http://pim.kde.org/components/knotes.php</ulink></para></listitem> + <listitem><para><ulink url="help:/knotes">&knotes; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&knode;</term> + <listitem><para>The newsreader component. It is <acronym>GNSKA</acronym> (The Good Net-Keeping Seal of Approval) compliant, has support for <acronym>MIME</acronym> and multiple servers.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://knode.sourceforge.net/">http://knode.sourceforge.net/</ulink></para></listitem> + <listitem><para><ulink url="help:/knode">&knode; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&akregator;</term> + <listitem><para>A lightweight and fast program to display news items provided by feeds, supporting all commonly used versions of <acronym>RSS</acronym> and <acronym>Atom</acronym> feeds. Useful features include searching in article titles, management of feeds in folders and setting archiving preferences.</para> + <itemizedlist> + <listitem><para>Website: <ulink url="http://akregator.sourceforge.net">http://akregator.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/akregator">&akregator; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>See <ulink url="http://kontact.kde.org">http://kontact.kde.org</ulink> and <ulink url="http://tdepim.kde.org">http://tdepim.kde.org</ulink> for more information.</para></listitem> + <listitem><para><ulink url="help:kontact">&kontact; Handbook</ulink></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="network-applications"> + +<title>Network</title> + +<para>There are several network-related applications in &tde;. Below is a description of a few of these.</para> + +<variablelist> +<varlistentry> +<term>&kopete;</term> + <listitem><para>A fully-featured and advanced <acronym>IM</acronym> (Instant Messaging) client, which has a number of protocols including <trademark class="registered">MSN</trademark>, <trademark class="registered">Yahoo</trademark>, and <trademark class="registered">AIM</trademark>. &kopete; can fetch display pictures, set aliases for particular persons, as well as run multiple <acronym>IM</acronym> sessions at any particular time. &kopete; is quite extensible, and has a comprehensive plugin system which comes with a searchable History of previous chats, statistics on a user's status, as well as a note system allowing you to create notes for each contact.</para> + <itemizedlist> + <listitem><para>Website: <ulink url="http://kopete.kde.org">http://kopete.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kopete">&kopete; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kdict;</term> + <listitem><para>A &GUI; front-end to the <acronym>DICT</acronym> protocol. It enables you to search through dictionary databases for a word or phrase, then displays suitable definitions.</para> + <itemizedlist> + <listitem><para><ulink url="help:/kdict">&kdict; Handbook</ulink></para></listitem> + <listitem><para>The <acronym>DICT</acronym> Development Group: <ulink url="http://www.dict.org/bin/Dict">http://www.dict.org/bin/Dict</ulink>.</para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kget;</term> + <listitem><para>A manager for your downloads which integrates with &konqueror;. &kget; allows you to group your downloads, pause and resume them, as well as several other things.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kget.sourceforge.net/">http://kget.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kget">&kget; Handbook</ulink></para></listitem> + + </itemizedlist> + </listitem> +</varlistentry> +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more &tde; network applications can be found in the &tde; Extragear; see <xref linkend="extragear-network"/>, under <xref linkend="extragear-components"/>.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="office-applications"> + +<title>Office</title> + +<para>This includes all applications in the &koffice; suite. See <xref linkend="tde-office-components" /> for a summary of the components.</para> + +</sect1> + +<sect1 id="graphics-applications"> + +<title>Graphics</title> + +<para>&tde; has several graphics-related applications, ranging from <acronym>PDF</acronym> viewers to applications enabling you to take screenshots. Below is a delineation, as well as some related links, for a few of them.</para> + +<variablelist> + +<varlistentry> +<term><application>KColorEdit</application></term> + <listitem><para>A small and handy application for editing color palettes, as well as color choosing and naming. Colors can be chosen by giving the <acronym>RGB</acronym> hex code, by choosing the color from a myriad of different colors in the program, or even by grabbing the precise color of any particular thing on your screen.</para> + + <itemizedlist> + <listitem><para><ulink url="help:/kcoloredit"><application>KColorEdit</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KPDF</application></term> + <listitem><para>An advanced <acronym>PDF</acronym> viewer, based on <application>xpdf</application>, for &tde;. <application>KPDF</application> contains a number of ways to search through the document (standard find dialog, thumbnail filter, etc.) and has other features such as hands-free reading.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kpdf.kde.org">http://kpdf.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kpdf"><application>KPDF</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KView</application></term> + <listitem><para>An image viewer program which supports a number of different image filetypes including <acronym>JPEG</acronym>, <acronym>GIF</acronym>, <acronym>PNG</acronym>, <acronym>TIFF</acronym> and many others. <application>Kview</application> has full integration with &tde; and it can be embedded into &konqueror; for viewing image files on your diskdrive as well as your <acronym>FTP</acronym> site or webserver, using its &URL; open support. Other features include a few image manipulations such as zoom, rotate, grayscale and flip.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.ph.unimelb.edu.au/~ssk/kde/kview/">http://www.ph.unimelb.edu.au/~ssk/kde/kview/</ulink></para></listitem> + <listitem><para><ulink url="help:/kview"><application>KView</application> Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&ksnapshot;</term> + <listitem><para>An application for taking screenshots. It is capable of capturing images of the whole desktop, a single window, or a selected region. The images can then be saved in a variety of formats, including <acronym>JPG</acronym> and <acronym>PNG</acronym>.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.ipso-facto.demon.co.uk/ksnapshot/">http://www.ipso-facto.demon.co.uk/ksnapshot/</ulink></para></listitem> + <listitem><para><ulink url="help:/ksnapshot">&ksnapshot; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kolourpaint;</term> + <listitem><para>A simple and easy-to-use paint program, with features such as basic painting (drawing diagrams and finger painting), image manipulation and icon editing.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kolourpaint.sourceforge.net">http://kolourpaint.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="help:/kolourpaint">&kolourpaint; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kooka;</term> + <listitem><para>An intuitive raster image scan program. &kooka; helps you to handle the most important scan parameters, find the correct image file format to save and manage your scanned images.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kooka.kde.org">http://kooka.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/kooka">&kooka; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more advanced &tde; graphics applications can be found in the &tde; Extragear; under the <xref linkend="extragear-components"/>, see <xref linkend="extragear-graphics"/> for a list of a few of them.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="multimedia-applications"> +<title>Multimedia</title> + +<para>A brief overview of a few of the multimedia-related applications below.</para> + +<variablelist> +<varlistentry> +<term>&juk;</term> + <listitem><para>An easy-to-use music player for &tde;. &juk; is playlist and meta-data focused, allowing you to quickly search through the dynamic playlist provided. Some of the features include &CD; cover-art fetching from <trademark class="registered">Google</trademark> images, <application>MusicBrainz</application> integration for file identification over the Internet, and multiple audio backends, including &arts;, <application>GStreamer</application> and <application>aKode</application>.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://developer.kde.org/~wheeler/juk.html">http://developer.kde.org/~wheeler/juk.html</ulink></para></listitem> + <listitem><para><ulink url="help:/juk">&juk; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&kmix;</term> + <listitem><para>An application that allows you to change the volume of your sound card, and it supports several sound drivers. Each mixer device is represented by a volume slider, and you have basic options such as to mute that particular mixer device.</para> + + <itemizedlist> + <listitem><para><ulink url="help:/kmix">&kmix; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +<varlistentry> +<term>&noatun;</term> + <listitem><para>A media player capable of playing <acronym>WAV</acronym>, <application>Ogg Vorbis</application>, as well as DivX encoded <acronym>AVI</acronym>s and other media formats. &noatun; features audio effects, a six-band graphic equalizer, a full plugin architecture, network transparency, and various look and feels.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://noatun.kde.org">http://noatun.kde.org</ulink></para></listitem> + <listitem><para><ulink url="help:/noatun">&noatun; Handbook</ulink></para></listitem> + </itemizedlist> + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Several more advanced &tde; multimedia applications can be found in the &tde; Extragear; under the <xref linkend="extragear-components"/>, see <xref linkend="extragear-multimedia"/> for a list of a few of them.</para></listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/browser-fine-tuning.docbook b/doc/khelpcenter/userguide/browser-fine-tuning.docbook new file mode 100644 index 000000000..34a45e606 --- /dev/null +++ b/doc/khelpcenter/userguide/browser-fine-tuning.docbook @@ -0,0 +1,53 @@ +<sect1 id="customizing-konqueror"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Fine Tuning your Browsing Experience</title> + +<example> +<title>Using your own style for webpages</title> + +<para>Webpages come in every possible set of colors and fonts, and +sometimes this doesn't give the best result. For example, if you have +visual difficulties, it may be impossible to read certain combinations +of background and text colors. &konqueror; provides a way to choose +your own colors and apply them to all webpages. Here's how:</para> + +<orderedlist> +<listitem><para>Open &konqueror; and go to +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Konqueror...</guimenuitem></menuchoice>.</para> +</listitem> +<listitem><para>In the configuration dialog that appears, select the +<guilabel>Stylesheets</guilabel> page on the left hand side.</para> +</listitem> +<listitem><para>On this page, choose <guilabel>Use accessibility +stylesheet defined in "Customize" tab</guilabel>, then go to the +<guilabel>Customize</guilabel> tab, and choose the settings you prefer.</para> +</listitem> +<listitem><para>Close all &konqueror; windows (you may need to restart +&tde; to be sure) and when you re-open them, your settings should be applied.</para> +</listitem> +</orderedlist> + +</example> + + +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> diff --git a/doc/khelpcenter/userguide/burning-cds.docbook b/doc/khelpcenter/userguide/burning-cds.docbook new file mode 100644 index 000000000..21f5214fd --- /dev/null +++ b/doc/khelpcenter/userguide/burning-cds.docbook @@ -0,0 +1,20 @@ +<sect1 id="burning"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Burning CDs and DVDs</title> + +<para>Brief overview of k3b</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/control-center.docbook b/doc/khelpcenter/userguide/control-center.docbook new file mode 100644 index 000000000..5446cd0b0 --- /dev/null +++ b/doc/khelpcenter/userguide/control-center.docbook @@ -0,0 +1,903 @@ +<chapter id="control-center"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup>Here you can set up different profiles for your Wireless card, +to be able to quickly switch settings if you connect to multiple +networks. You can select a profile to be loaded on TDE startup. +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>The &kcontrolcenter;</title> + +<indexterm><primary>&kcontrolcenter;</primary></indexterm> +<indexterm><primary>&kcontrol;</primary></indexterm> +<indexterm><primary>Configuration</primary></indexterm> +<indexterm><primary>Customization</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="kcontrol.png" format="PNG" /> +</imageobject> +<textobject><phrase>The &kcontrolcenter;</phrase></textobject> +<caption><para>The &kcontrolcenter;</para></caption> +</mediaobject> + +<para>The &kcontrolcenter; is the place to go to change any settings that +affect the whole of your &tde; environment. You can open it using the +<guimenuitem>Control Center</guimenuitem> item in the &kmenu;, or with its +command-line name, <filename>kcontrol</filename>.</para> + +<para>The settings are divided into several major categories, which each +contain several pages of settings. To display a settings page, expand the +major category by clicking on the <guilabel>+</guilabel> button next to it, +and then click on the name of the page you want. The settings page then +appears on the right, and you can change settings to your heart's +content. No changes take effect until you click on the +<guibutton>Apply</guibutton> button. If you decide, after making some +changes, that you want to leave the settings as they were, just click on +<guibutton>Reset</guibutton>.</para> + +<para>If you need more help with a page, visit that page, then click on the +<guilabel>Help</guilabel> tab. You might also want to look at the +&kcontrolcenter; Handbook, which you can open with the +<menuchoice><guimenu>Help</guimenu><guimenuitem>&kcontrolcenter; +Handbook</guimenuitem></menuchoice>.</para> + + +<sect1 id="kcontrol-appearance-and-themes"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Appearance & Themes</title> + +<para>Here you will find settings that change the way your &tde; desktop and +applications look.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Background</guilabel></term> +<listitem> +<para>This section controls the color or image that is set as your desktop +background. These settings can be applied to all virtual workspaces, or to +only a specific one. There are a range of background wallpapers that come +with &tde; or you can supply your own.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Colors</guilabel></term> +<listitem> +<para>This is where you can modify the colors for your kde applications. +There are a variety of color schemes installed with &tde; by default, and +you can find others at kde-look.org. You can also create your own. Here you +can also modify the contrast and choose whether you want your &tde; colors +to be applied to non-TDE applications, for a more consistant overall +appearance.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Fonts</guilabel></term> +<listitem> +<para>Here you can control the various font settings for &tde; applications. +You can also modify here anti-aliasing settings, including what range of +fonts to exclude from anti-aliasing settings.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Icons</guilabel></term> +<listitem> +<para>This section is where you can manage your icon themes and other +settings related to icons. New icon themes can be downloaded from +kde-look.org, and installed here. Conversely, you can remove icon themes by +highlighting them in the list and clicking remove. You can also set icon +sizes for various uses in &tde; and effects to apply to icons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Launch Feedback</guilabel></term> +<listitem> +<para>This is where you can modify what kind of cursor and/or taskbar +feedback you'd like for launching applications. You can also set the +duration of this feedback here. For example, the default setting is for a +bouncing cursor with a duration of 30 seconds, or when the application has +loaded.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Screen Saver</guilabel></term> +<listitem> +<para>Here you can configure options about your screensaver. You can +configure the timeout before it starts, and whether it requires a password +to unlock the screen.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Splash Screen</guilabel></term> +<listitem> +<para>This is where you can install, remove and test the splash screens that +display on &tde; startup. More splash screens can be downloaded from +<ulink +url="http://www.kde-look.org"> + +http://www.kde-look.org</ulink>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Style</guilabel></term> +<listitem> +<para>This section allows you to modify your widget style. A variety of +styles come with &tde;, and more can be downloaded from <ulink url="http://www.kde-look.org">http://www.kde-look.org</ulink>. This is also +where you would enable or disable interface options such as transparent +menus, showing icons on buttons and tooltips. Some styles have more +configuration options than others.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Theme Manager</guilabel></term> +<listitem> +<para>This is where you can create and manage themes that are made up of +personalized settings. They are a combination of desktop background, colors, &tde; widget styles, icons, fonts and what Screensaver you'd like to display . This allows you to save your favorite +<quote>looks</quote> and apply them with the click of a mouse button.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window Decorations</guilabel></term> +<listitem> +<para>Here you can configure your window decorations. You can modify the +style as well as place the buttons in custom positions. Some window +decorations will have more configuration options than others.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> <listitem><para>If &kcontrolcenter; +doesn't have the setting you want, you may need to edit a configuration file +manually. See <xref linkend="hand-editing-config-files" /> for more +information about how to do this.</para> +</listitem> + +<listitem><para>If you enjoy modifying the appearance of your &tde; desktop, +you can find plenty of themes and styles at <ulink url="http://kde-look.org">kde-look.org</ulink>.</para> +</listitem> + +</itemizedlist> + + +</sect1> + +<sect1 id="kcontrol-desktop"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Desktop</title> + +<para>This is where you will find settings to configure the appearance and +behavior of your &tde; desktop.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Behavior</guilabel></term> +<listitem> +<para>Here you can configure the behavior of your desktop. This is where +you would go to configure options such as showing or hiding desktop icons, +showing tooltips and icon layout. You can also specify if you would like to +see previews of particular filetypes on the desktop, and which devices you'd +like to see icons for.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Multiple Desktops</guilabel></term> +<listitem> +<para>This is where you would configure the number of virtual desktops or +workspaces you would like to have, and what you would like them to be +called. By default &tde; has 4 virtual desktops, and you can configure up to +20. You can also enable switching between virtual desktops using the scroll +button on your mouse.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Panels</guilabel></term> +<listitem> +<para>Here you can modify options to do with &kicker; and other &tde; +panels. Among the options are size, position, length and hiding. You can +also modify the appearance of the panel with transparency, background images +and icon zooming. This is also where you would configure various menu +options including what applications you'd like to show in your +&kmenu;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Taskbar</guilabel></term> +<listitem> +<para>The Taskbar module allows you to configure options related to your +taskbar. You can configure whether to show windows from all desktops, +grouping of similar tasks and what actions you would like to assign to your +mouse buttons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window Behavior</guilabel></term> +<listitem> +<para>This is where you would configure options related to the behavior of +&tde;'s window manager, &twin;. &twin; is extremely configurable and has +advanced features such as focus stealing prevention and different focus +policies such as focus follows mouse. You can also configure what actions +you would like to bind to certain keys and mouse events.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Window-Specific Settings</guilabel></term> +<listitem> +<para>This is an advanced configuration dialog where you can set options for +the behavior of specific windows. There are many options here for the fine +tuning of your window layout, including what position on the screen you +would like certain windows to open to, and whether they should be shown on +the taskbar or pager. You can select windows by application, or even by +their specific role within an application.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-internet-and-network"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Internet & Network</title> + +<para>This section is where you would configure settings to do with internet +and networking under &tde;.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Connection Preferences</guilabel></term> +<listitem> +<para>Here you can set advanced networking options such as timeout values +for server connects. Usually you would leave these options at the defaults +unless you really knew what you were doing.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Desktop Sharing</guilabel></term> +<listitem> +<para>Desktop Sharing allows you to invite someone to share your session +with you, or can enable you to log in remotely to your machine from another +location. You would then use a VNC client like &tde;'s Remote Desktop +Connection application to control your desktop over the network. This is +extremely useful if you want someone to help you perform a task.</para> + +<para>Here you can create and manage invitations as well as set your +security policy for uninvited connections. You can also configure whether to +show a background image and which port for the service to 'listen' +on.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>File Sharing</guilabel></term> +<listitem> +<para>File sharing allows you to configure Samba (&Microsoft; &Windows;) and +<acronym>NFS</acronym> (&UNIX;) file sharing. To make changes in this module +you need to have the root or administrator password. This is where you would +set up whether users are allowed to share files without knowing the root +password, and which users are allowed to do so. You can also configure which +folders you're like to be shared, using which type of sharing and who is +allowed to view these shares.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Local Network Browsing</guilabel></term> +<listitem> +<para>Here you can configure options related to browsing network shares in +&konqueror;. &konqueror; is able to browse a variety of network shares and +manipulate remote files as though they were on your local machine. You can +configure it to remember your preferred username and password for connecting +to &Windows; shares (Samba). You can also set what types of network shares +you would like to be able to browse, including &FTP;, <acronym>NFS</acronym> +and <acronym>SMB</acronym>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Local Network Chat</guilabel></term> +<listitem> +<para>This module allows you to configure options relating to the &UNIX; +<command>talk</command> daemon. It is a very simple network chat program +that runs in a terminal, designed for chatting over a local area +network. Some of it's features are being able to set up an 'answering +machine' that will email to you messages left for you, and being able to +forward messages to another location.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Proxy</guilabel></term> +<listitem> +<para>This is where you would configure &tde; to connect to a proxy server +rather than directly to the internet. Once again you would generally leave +these options at their defaults unless you really knew what you were +doing. If you do use a proxy server your network administrator will be able +to tell you what details to fill in here.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Samba</guilabel></term> +<listitem> +<para>The Samba Configuration module requires the +<systemitem class="username">root</systemitem> or administrator password. It is +an advanced configuration tool that allows you to control Samba's security, +shares, users and printers in an intuitive graphical interface. This is a +very powerful tool with support for configuring everything from simple file +and printer sharing, to using your Samba server as a &Windows; NT Domain +Controller.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Service Discovery</guilabel></term> +<listitem> +<para>You can set up services browsing with ZeroConf. You can for example browse +your local network using multicast DNS.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Web Browser</guilabel></term> +<listitem> +<para>This module is where you would configure options relating to +&konqueror; as a web browser. The usual options you would expect from a +web browser, such as cookie configuration, cache and history can be found +here as well as sections to modify keyboard shortcuts, plugins and +fonts.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Wireless Network</guilabel></term> +<listitem> +<para>Here you can set up different profiles for your Wireless card, to be +able to quickly switch settings if you connect to multiple networks. You can +select a profile to be loaded on &tde; startup.</para> +</listitem> +</varlistentry> +</variablelist> + + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> + +<sect1 id="kcontrol-kde-components"> + + +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>&tde; Components</title> + +<para>This section is where you can modify advanced &tde; options such as +file associations and default applications.</para> + +<variablelist> + +<varlistentry><term><guilabel>Default Applications</guilabel></term> + +<listitem><para>This module allows you to select the default +applications you would like to use for various services. Here you can define +what Email Client, Embedded Text Editor, Instant Messenger, Terminal +Emulator and Web Browser to use. If you prefer to use +<application>Xterm</application>, <application>Vim</application> or +<application>Mozilla</application>, this is the place to specify those +preferences.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>File Associations</guilabel></term> + +<listitem><para>This is where you configure everything to do with file +associations. Here you can select a filetype, and choose what applications +you would like to be able to open it with. You can also select which icon +you would like to represent each filetype, and whether to show it in an +embedded or a separate viewer.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>File Manager</guilabel></term> + +<listitem><para>Here you can configure the behavior of &konqueror; in file +manager mode. Among the options are fonts and font sizes, previews over +various network protocols and context menus. &konqueror; is an extremely +powerful and configurable file management tool with a plethora of +options. For more information, consult the &konqueror; handbook.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Performance</guilabel></term> + +<listitem><para>Here are settings related to the memory usage of +&konqueror;. <guilabel>Minimize Memory Usage</guilabel> allows you to +control whether separate instances of &konqueror; will open or whether all +new &konqueror; windows connect to the same instance. This has the effect of +reducing memory usage. You can also select whether to pre-load &konqueror; +after &tde; startup, to reduce start times.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Resources Configuration</guilabel></term> + +<listitem><para><remark>To be written</remark></para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Service Manager</guilabel></term> + +<listitem><para>The Service Manager module displays a static list of +services that are started on demand, and a second list of services that can +be manipulated by the user. The services in the first list cannot be +modified or changed. The services in the second list you can enable or +disable a service loading at start up, and manually start and stop +services.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Session Manager</guilabel></term> + +<listitem><para>Here you can configure how you would like &tde; to handle +sessions. You can configure &tde; to remember your previous session and +restore the applications you were using the next time you log in. You can +also specify individual applications to exclude from being restored, or +disable restoring sessions on login entirely.</para> +</listitem> +</varlistentry> + +<varlistentry><term><guilabel>Spell Checker</guilabel></term> + +<listitem><para>This module allows you to configure the &tde; Spell +checker. It allows you to modify what spell checker to use, what types of +error to check for and also what default dictionary to use. &tde; supports +the use of both <application>ASpell</application> and +<application>ISpell.</application></para> +</listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Vim Component Configuration</guilabel></term> + +<listitem><para>This module allows you to configure the use of +<application>Vim</application> as an embeddable component. You need to have +a recent version of <application>Gvim</application> or +<application>Kvim</application> installed for this. You can configure the +appearance of the editor as well as which <command>vim</command> binary to +use.</para> +</listitem> +</varlistentry> + +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-peripherals"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> +<title>Peripherals</title> + +<para>This section is where you would change settings related to peripheral +devices such as keyboards and joysticks.</para> + +<variablelist> +<varlistentry><term><guilabel>Display</guilabel></term> + +<listitem><para>Here you can modify settings to do with the size, +orientation and refresh rate of your display, and whether you would like +these settings to be applied on &tde; startup. On the <guilabel>Power +Control</guilabel> tab, you can configure your power management options for +this screen such as blanking.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Joystick</guilabel></term> + +<listitem><para>This section allows you to configure your joystick and test +that it is working properly. You can also calibrate your joystick here, and +manually specify the joystick device if it is not autodetected correctly. +</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard</guilabel></term> + +<listitem><para>This module allows you to configure basic keyboard settings. +These include keyboard repeat delay and rate, and what state you would +prefer numlock to be on TDE startup.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Mouse</guilabel></term> + +<listitem><para>Here is where you can configure settings to do with your +mouse device. You can switch the button order, reverse the scroll direction +or modify the behaviour of clickable icons. You may also preview, install +and select cursor themes. The <guilabel>Advanced</guilabel> tab allows you +to fine tune your mouse settings further.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Printers</guilabel></term> + +<listitem><para> This dialog allows you to configure printers using a +variety of print systems. You can add local and remote printers, check +current jobs and look at printer properties.</para> +</listitem> +</varlistentry> + +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-power-control"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Power Control</title> + +<para>This section has a single module, <guilabel>Laptop Battery</guilabel>. +Here you can configure the appearance and behaviour of the <application>Klaptopdaemon</application> +battery monitor. You can select battery icons to represent different power states, and set up +notification of certain events. In the case that your battery runs down to a critical level, you can +configure the daemon to suspend or shutdown your laptop, to save you from losing data. +</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + +</sect1> + +<sect1 id="kcontrol-regional-and-accessibility"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>Regional & Accessibility</title> +<para>This section is where you can configure options to do with region +and locale, and also acessibility related options for disabled +persons.</para> + +<variablelist> + +<varlistentry><term><guilabel>Accessibility</guilabel></term> + +<listitem><para>Here is where you can configure options for users who have +difficulty hearing system sounds or using a keyboard. You can configure the +system bell to use a visual signal, such as flashing the screen or inverting +screen colors. You can also configure keyboard accessibility options such +as sticky keys and slow keys.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Country/Region & Language</guilabel></term> + +<listitem><para>This module allows you to configure options that are +specific to your location such as language, currency and date format. To +make available more languages, install the tde-i18n packages for your +distribution.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Input Actions</guilabel></term> + +<listitem><para>Here is where you would configure input actions, such as +mouse gestures and keyboard shotcuts for launching applications and running +commands.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard Layout</guilabel></term> + +<listitem><para>This module is where you would configure +<application>Kxkb</application>, a keyboard layout switching utility that +uses the &X-Window; xkb extension. It allows you to switch between different +layouts using a tray indicator or a keyboard shortcut. You can +enable/disable keyboard layouts through this dialog, and add more. Some of +the more powerful features are the ability to configure switching of layouts +globally, per application or per window.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Keyboard Shortcuts</guilabel></term> + +<listitem><para>Here you can configure global &tde; keyboard +shortcuts. There are several predefined shortcut schemes you can use if you +are more used to another windowing environment, like &Windows; or +&MacOS;. If you prefer, you can customise your own scheme and modifier keys. +</para></listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + +<sect1 id="kcontrol-security-and-privacy"> +<sect1info> +<authorgroup> +<author> +&Anne-Marie.Mahfouf; +&Anne-Marie.Mahfouf.mail; +</author> +<author> +<firstname>Javier</firstname> +<surname>Martín Diez</surname> +</author> +<othercredit role="reviewer"> +<personname><firstname>Rocco</firstname> <surname>Stanzione</surname> +</personname> +</othercredit> +</authorgroup> +</sect1info> +<title>Security & Privacy</title> + +<para>This section is where you can configure options related to +security and privacy such as the use of cryptography, enabling the TDE +wallet, setting your identity and managing caches.</para> + +<variablelist> +<varlistentry><term><guilabel>Crypto</guilabel></term> +<listitem><para>This module allows you to configure SSl for use with most +TDE applications, as well as manage your personal certificates +and the known certificate authorities.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>TDE Wallet</guilabel></term> +<listitem><para> +Here you can change your TDE Wallet Manager settings.</para> + +<para>TDE Wallet aims to provide secure storage for passwords and web form data. +You can group different passwords in different wallets, and each one will only +be opened with a master password (which you should never forget!). The +default wallet is named "kdewallet", and you can either create a new wallet +for your local passwords or accept the default wallet for all data in +the "Automatic Wallet Selection" section.</para> + +<para>TDE programs like Konqueror, Kmail and Kopete are fully compatible with +the TDE Wallet Manager. All of them will ask at least once for permission to +access to actual wallet. You can give different access levels, such as "always +allow", "allow once", etc. If you want to change that access level, you can do +it from the "Access Control" tab by deleting the program entry and selecting a +new preference the next time that application requests access to the +wallet.</para> + + <variablelist> + + <varlistentry><term><guilabel>Wallet Preferences</guilabel></term> + + <listitem><para>To enable the TDE wallet subsystem, check the <guilabel> +Enable the TDE wallet subsystem</guilabel> box. +Unchecking this box will disable the TDE Wallet on your system.</para> + +<para>By default, TDE Wallet Manager is kept opened until the +user session is closed, but you can change that in the <guilabel>Close +Wallet</guilabel> section to close it when unused for a time, when a screen +saver starts or when the last application stops using it.</para> + +<para>As you can have several wallets, <guilabel>Automatic Wallet +Selection</guilabel> allows you start TDE with a given wallet.</para> + +<para>TDE Wallet will appear in your system tray by default, but you can hide +it. Uncheck <guilabel>Show manager in the system tray</guilabel> to keep it +always hidden, or check <guilabel>Hide system tray icon when last wallet +closes</guilabel> to hide it only when all wallets are closed. These items are +in the <guilabel>Wallet Manager</guilabel> section.</para></listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Access Control</guilabel></term> + +<listitem><para>You can set here what policy you want for your +TDE applications, regarding to the wallet use.</para></listitem> +</varlistentry> +</variablelist> + +</listitem> +</varlistentry> + + +<varlistentry><term><guilabel>Password & User Account</guilabel></term> +<listitem><para>You can change here your personal information +which will be used in mail programs and word processors. You +can change your login password by clicking the <guibutton>Change +Password...</guibutton> button.</para></listitem> +</varlistentry> + +<varlistentry><term><guilabel>Privacy</guilabel></term> +<listitem><para>This module allows you to erase traces which +TDE leaves on your system such as command histories or +browser caches.</para></listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<!-- <sect1 id="kcontrol-sound-and-multimedia"> +<title>Sound & Multimedia</title> +<para>to be written</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para></para> +</listitem> +</itemizedlist> + +</sect1> --> + +<sect1 id="kcontrol-system-administration"> +<sect1info> +<authorgroup> +<author> +&J.Hall; +&J.Hall.mail; +</author> +</authorgroup> +</sect1info> + +<title>System Administration</title> +<para>This module allows you to configure aspects of your system such as +the bootloader, the kernel and helps you perform essential system tasks. Most of these +sections will require the root or Administrator password to effect changes.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Boot Manager (LILO)</guilabel></term> +<listitem><para>If you use the popular bootloader +<acronym>LILO</acronym> this section will allow you to configure it. +You can configure the location to install the bootloader to, set the timeout +on the <acronym>LILO</acronym> boot screen as well as add or modify +kernel images for the boot list.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Date & Time</guilabel></term> +<listitem><para>This configuration module allows you to configure the system date and time +settings. You can set the date, time, and also the current time zone. These settings will be applied system-wide.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Font Installer</guilabel></term> +<listitem><para>Here is where you would configure both personal and system-wide fonts. +This dialog allows you to install new fonts, delete old ones and preview the fonts you +have installed. By default, it displays personal fonts. To modify system-wide fonts click the <guibutton>Administrator Mode</guibutton> button.</para> </listitem> +</varlistentry> +<varlistentry> +<term><guilabel>IBM Thinkpad Laptop</guilabel></term> +<listitem><para>This configuration module allows you to configure the special keys on an IBM thinkpad + laptop. You will need the <quote>nvram</quote> module to use these features.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Linux Kernel</guilabel></term> +<listitem><para>If you run &tde; on &Linux; there is a &kcontrol; module to create or modify +configuration files for a &Linux; kernel. This configurator is compatible with kernels previous to 2.5.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Login Manager</guilabel></term> +<listitem><para>This module allows you to configure the &tde; login manager, &tdm;. &tdm; is +a powerful login manager with a large range of options. It supports user switching, remote graphical logins and has a fully customizable appearance. For more information, see the &tdm; handbook.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Paths</guilabel></term> +<listitem><para>This dialog allows you to configure the default locations where certain +important files are kept. The <guilabel>Desktop</guilabel> directory contains all the files on your desktop. The <guilabel>Autostart</guilabel> directory contains files or links to files that you want run when &tde; starts, and the <guilabel>Documents</guilabel> directory is the default location &tde; applications will open or save documents to.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Sony Vaio Laptop</guilabel></term> +<listitem><para>This configuration module allows you to configure features specific to +Sony Vaio laptops. If you have a Sony Vaio, you will have to install the <quote>sonypi</quote> +driver to use this section.</para></listitem> +</varlistentry> +</variablelist> +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/creating-graphics.docbook b/doc/khelpcenter/userguide/creating-graphics.docbook new file mode 100644 index 000000000..61c9b545a --- /dev/null +++ b/doc/khelpcenter/userguide/creating-graphics.docbook @@ -0,0 +1,30 @@ +<sect1 id="graphics"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Creating Graphics</title> + +<para>How to create graphics with &tde; apps.. (ok, maybe not)</para> + +<!-- Add links to "further reading" here - in this case, for the whole --> +<!-- chapter. --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/credits-and-license.docbook b/doc/khelpcenter/userguide/credits-and-license.docbook new file mode 100644 index 000000000..9ca864aff --- /dev/null +++ b/doc/khelpcenter/userguide/credits-and-license.docbook @@ -0,0 +1,299 @@ +<sect1 id="credits"> +<title>Credits</title> +<para> +&tde-team; thanks and acknowledges the original &kde; contributors of this guide. +</para> + +<para>Individual credits: +<variablelist> + +<varlistentry> +<term>Tom Albers</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="integrated-messaging" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Waldo Bastian</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the notes which became <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Gardner Bell</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="networking-with-windows"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="konsole-intro" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Gary Cramblitt</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="accessibility" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>David Faure</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="adding-extra-keys" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Nicolas Goutte</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="hand-editing-config-files" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Francis.Giannaros;</term> +<listitem> + +<itemizedlist> + <listitem><para>Proofreading and update on various parts.</para></listitem> + <listitem><para>Wrote <xref linkend="root" />.</para></listitem> + <listitem><para>Wrote <xref linkend="ktts" />.</para></listitem> + <listitem><para>Wrote <xref linkend="basic-applications" />.</para></listitem> + <listitem><para>Wrote <xref linkend="extragear-applications" />.</para></listitem> + <listitem><para>Re-wrote <xref linkend="tde-edutainment" />.</para></listitem> + <listitem><para>Wrote <xref linkend="migrator-applications" />.</para></listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Adriaan de Groot</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="configuring-toolbars"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="tdedebugdialog" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>J Hall</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="kcontrol-appearance-and-themes" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-desktop" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-internet-and-network" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-kde-components" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-peripherals" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-power-control" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="kcontrol-regional-and-accessibility" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="troubleshooting-network-x" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Anne-Marie.Mahfouf;</term> +<listitem> + +<itemizedlist> + <listitem><para>Proofreading and update on various parts.</para></listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>&Richard.J.Moore;</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the <application>kstart</application> and +<application>ksystraycmd</application> sections.</para> + +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Peter Nuttall</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="messaging" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Steven Robson</term> +<listitem> + +<itemizedlist> +<listitem><para>Took the screenshots for <xref +linkend="playing-music"/>, <xref linkend="audio-cd"/>, <xref +linkend="file-manager"/> and <xref linkend="accessibility"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>&Philip.Rodrigues;</term> +<listitem> + +<itemizedlist> +<listitem><para>Reviewing and proofreading.</para> +</listitem> +<listitem><para>Wrote <xref linkend="windows-how-to-work"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="panel-and-desktop"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="logging-in"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="using-the-clipboard"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="configuring-programs"/>.</para> +</listitem> +<listitem><para>Wrote <xref linkend="menus"/>.</para> +</listitem> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Deepak Sarda</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="audio-cd"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Robert Stoffers</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="programs-launching" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Juan Carlos Torres</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="customizing-desktop" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry> +<term>Simon Vermeersch</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="fonts"/>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>&Lauri.Watts;</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote the outline.</para> +</listitem> +<listitem><para>Wrote <xref linkend="getting-help"/>.</para> +</listitem> +<listitem><para>Marked up parts of <ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink>.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +<varlistentry><term>Christian Weickhmann</term> +<listitem> + +<itemizedlist> +<listitem><para>Wrote <xref linkend="file-manager" />.</para> +</listitem> +<listitem><para>Wrote <xref linkend="switching-sessions" />.</para> +</listitem> +</itemizedlist> + +</listitem> +</varlistentry> + +</variablelist> +</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/customizing-desktop.docbook b/doc/khelpcenter/userguide/customizing-desktop.docbook new file mode 100644 index 000000000..a8ed7cb42 --- /dev/null +++ b/doc/khelpcenter/userguide/customizing-desktop.docbook @@ -0,0 +1,347 @@ +<chapter id="customizing-desktop"> +<chapterinfo> +<authorgroup> +<author> +<firstname>Juan Carlos</firstname> +<surname>Torres</surname> +</author> +</authorgroup> +</chapterinfo> + +<title>Customizing the Appearance of your &tde; Desktop</title> + +<para>Changing the appearance of your &tde; desktop can be done quite easily and +flexibly by either individually controlling different parts of the visual +appearance or by using a predefined theme. This guide explains the various +customizable parts of &tde; and how to control their appearance.</para> + +<sect1 id="background"> +<title>Background</title> +<para>The desktop background, more commonly known as the wallpaper, allows you +to display certain images on your desktop. The settings for the background are +found in the &kcontrolcenter;, or by <mousebutton>right</mousebutton>-clicking +on the desktop and selecting <guilabel>Configure Desktop...</guilabel>.</para> + +<para>In &tde;, you have the option to use no picture, a single picture, or a +slideshow of images. If <guilabel>No picture</guilabel> is chosen to be the +desktop background, the <guilabel>Colors</guilabel> options are used instead. +You can also choose whether to use a single +background on all virtual desktops or to apply a different background for each +desktop. This is done by selecting <guilabel>All desktops</guilabel> or the +specific desktop name from the drop-down menu.</para> + +<para>Other background images can be downloaded using the +<guibutton>Get New Wallpapers</guibutton> button on the right or you can visit +the <ulink url="http://www.kde-look.org/index.php?xcontentmode=1x2x3x4x5x6x7"> +Wallpapers section</ulink> of the kde-look.org website.</para> +</sect1> + +<sect1 id="colors"> +<title>Colors</title> +<para>The <guilabel>Colors</guilabel> settings of the &kcontrolcenter; allow you to control the +colors that are used for various window elements, such as window titlebars, +window backgrounds, text, and buttons. You can change the color of each window +element by selecting the element from the drop down list and choosing a color +for it. You can then save your changes by clicking on +<guibutton>Save Scheme...</guibutton>. This will save your settings in a Color +Scheme file. Color schemes are text files, with a <literal +role="extension">.kcsrc</literal> extension, that contain +entries for each window widget and its color, in RGB format. It is also very +easy to add color schemes that you have downloaded by clicking on +<guibutton>Import Scheme...</guibutton> and pointing to the <literal +role="extension">.kcsrc</literal> file. With color schemes, you can save the +changes you have done in one convenient file or easily change to a predefined +color setting, without having to change each window element separately.</para> + +<para>Additional color schemes can be downloaded from <ulink +url="http://www.kde-look.org/index.php?xcontentmode=28">the Color Schemes +section</ulink> of kde-look.org.</para> +</sect1> + +<sect1 id="icons"> +<title>Icons</title> +<para>An icon theme contains the images used to represent actions, files, +devices, and applications. Managing icon themes is easily done through the Icons +module in the &kcontrolcenter;. Simply select the icon theme you want to use and +click on <guibutton>Apply</guibutton> to switch to the new theme. To install new +icon themes, all you need to do is to click on <guibutton>Install New +Theme...</guibutton> and browse to the location of the icon theme archive. There +is no need to extract the contents of the archive into a directory. In fact, the +Icons module only accepts archived icon themes. To remove an icon theme, simply +select the theme from the list and click on <guibutton>Remove Theme</guibutton>. +Note that you cannot remove the icon theme that you are currently using. You +need to switch to some other theme before the current one will become removable. +You also cannot remove icon themes that were installed by the administrator +(<systemitem class="username">root</systemitem>) or by your distribution's +package manager.</para> +<para>Other icon themes can be found in <ulink +url="http://www.kde-look.org/index.php?xcontentmode=27">the Icon Themes +subsection</ulink> of kde-look.org.</para> +</sect1> + +<sect1 id="splash-screen"> +<title>Splash Screen</title> + +<mediaobject> +<imageobject> +<imagedata fileref="splash-screen.png" format="PNG" /> +</imageobject> +<textobject><phrase>The default &tde; splash screen</phrase></textobject> +<caption><para>The default &tde; splash screen</para></caption> +</mediaobject> + +<para>The splash screen is the animated image or screen that is displayed while +&tde; loads after you log in. Each user can have a different splash screen. +Changing the splash screen for the current user can be done in the Splash +Screen module of the &kcontrolcenter;. Select the splash screen you want to +use and click on <guibutton>Apply</guibutton>. You can also test what a splash +screen will look like by selecting the splash screen and clicking on +<guibutton>Test</guibutton>. Installing a new splash theme is very easy. Just +click on <guibutton>Add...</guibutton> and browse to the splash screen archive you +want to add. There is no need to extract the contents of the archive. Removing +splash screens is also easily done by selecting the splash screen and clicking +on <guibutton>Remove</guibutton>. Note that you cannot remove splash screens +installed by the administrator (<systemitem class="username">root</systemitem>) +or by your distribution's package manager.</para> + +<para>Splash screen themes can be found on kde-look.org, in <ulink +url="http://www.kde-look.org/index.php?xcontentmode=35">the Splash Screens +section</ulink>. Take note that some splash screens require a specific &ksplash; +engine to be installed.</para> +</sect1> + +<sect1 id="win-deco"> +<title>Window Decorations</title> +<para>You can change the appearance of window borders, titlebars and buttons in +&tde; using window decorations. Some window decorations even have the capability +to apply effects such as translucency. Window decorations must be able to do all +these without sacrificing speed and performance. This is the reason why window +decorations come in source code that must be compiled, or as binary packages +that must be installed. Basically, Window decorations are plugins or small +programs that instruct &twin;, &tde;'s Window Manager, +how to display window frames.</para> + +<para>In order to add a new window decoration, you need to compile it from +source code. If a binary package for your distribution or system is provided, +you simply need to install it using your distribution's package manager. Please +refer to your distribution's manual for instructions on how to do this. Once the +window decoration has been installed, it can be accessed in the Window +Decorations settings in the &kcontrolcenter;. In the +<guilabel>Window Decoration</guilabel> tab, +a list of installed window decorations can be seen in the drop down box. Simply +select the decoration you want to use and click on <guibutton>Apply</guibutton>. +Different window decorations have different capabilities and settings. Play +around with the different options available. The <guilabel>Buttons</guilabel> tab allows you to +control the buttons on the window titlebar. Enable the <guilabel>Use custom +titlebar button positions</guilabel> check box in order to rearrange, remove, or +add buttons. To add buttons to the titlebar, drag an item from the list to the +titlebar preview above it. To remove a button, drag the button from the titlebar +preview to the item list. Simply drag buttons in the titlebar preview to +rearrange them.</para> + +<para>While all window decorations need to be compiled from source code, some +window decorations can load pixmap-based theme files that do not need to be +compiled. &tde; ships with a pixmap-based window decoration called the IceWM +window decoration. Another pixmap-based window decoration is <ulink +url="http://www.kde-look.org/content/show.php?content=31447">deKorator</ulink>, +which can be found on kde-look.org. Please refer to your distribution's +documentation on how to install these. The advantage of using pixmap-based +window decorations is it is relatively easy to make themes for them, by using +images and editing a configuration file. The tradeoff is a slight loss of performance, +while this may be unnoticeable on very fast systems.</para> + +<para>To add an IceWM theme, select IceWM as the window decoration and click on +the <guilabel>Open &tde;'s IceWM theme folder</guilabel> link in the window +decoration description area. This will open a &konqueror; window +to <filename>$<envar>TDEHOME</envar>/share/apps/twin/icewm-themes</filename>. +Extract your IceWM theme to this folder. The theme will then be added to +the list of IceWM themes. Select the theme you want to use and click on +<guibutton>Apply</guibutton>.</para> + +<para>To add a deKorator theme after you've installed deKorator, select +deKorator from the window decorations list and go to the <guilabel>Themes</guilabel> +tab. Click on <guibutton>Install New Theme</guibutton> and locate +your deKorator theme archive. Make sure that the version of the deKorator theme +matches the deKorator version installed on your system. Once the theme has been +added, select the theme you want to use and click on <guibutton>Set Theme +Paths</guibutton>. Click on <guibutton>Apply</guibutton> for the changes to +take effect.</para> + +<para>Some more window decorations are available at kde-look.org under <ulink +url="http://www.kde-look.org/index.php?xcontentmode=17">the +Native &tde; 3.x</ulink> and <ulink +url="http://www.kde-look.org/index.php?xcontentmode=20">the +Native &tde; 3.2+</ulink> subsections. Themes for the <ulink +url="http://www.kde-look.org/index.php?xcontentmode=18">IceWM</ulink> and +<ulink +url="http://www.kde-look.org/index.php?xcontentmode=21">deKorator</ulink> window +decorations have their own subsections under the Window Decorations +category.</para> +</sect1> + +<sect1 id="style"> +<title>Style</title> +<para>Widgets are the basic elements of a graphical user interface, such as +buttons, scrollbars, tabs, and menus. A widget style is a plugin or a small +program that instructs &tde; how widgets are displayed. Since widgets are the +very basic parts of an interface, they are frequently accessed and must be able +to respond very quickly. This is why widget styles must come as source code to +be compiled or as binary packages to be installed, just like window decorations. +Please refer to your distribution's documentation on how to compile from source +or install binary packages.</para> + +<para>Once a widget style has been installed, it will be added to the list of +available styles in the <guilabel>Style</guilabel> module in the &kcontrolcenter;. +The <guilabel>Style</guilabel> tab allows +you to select a widget style from the list and to configure it if the style has +a <guibutton>Configure...</guibutton> feature. Different styles have different options. A preview of the +selected style is available at the lower portion of the tab. The +<guilabel>Effects</guilabel> tab +controls different visual effects for some widgets like comboboxes and tooltips. +The <guilabel>Toolbar</guilabel> tab gives some options on the general appearance of toolbars.</para> + +<para>Additional widget styles can be found in <ulink +url="http://www.kde-look.org/index.php?xcontentmode= +8x9x10x11x12x13x14x15x16">the different &tde; subsections of the +Themes/Styles</ulink> of kde-look.org. Take note that styles come in source +code or binary package forms. They are not &tde; theme files.</para> +</sect1> + +<sect1 id="kde-theme"> +<title>&tde; Theme</title> +<para>&tde; allows you to save the different changes you made to your desktop's +appearance in one file, using the Theme Manager in &kcontrolcenter;. Once you +have set up your desktop the way you want, click on <guibutton>Create New +Theme...</guibutton>. Enter the details you want to give your theme, such as theme +name, author, version, &etc;, then click <guibutton>OK</guibutton> when done. +This will add your theme to the list of available themes and save your settings +in a &tde; theme. A &tde; theme (<literal role="extension">.kth</literal> file) +instructs &tde; on what window decoration, style, or color scheme to use for +that particular theme. To add a &tde; theme from an outside source, click on +<guibutton>Install New Theme...</guibutton> and locate the &tde; theme file. +Removing a theme is easily done by clicking on <guibutton>Remove +Theme</guibutton>. If you made changes to your theme, you have to either create +a new theme name for it, or remove the previous version first to be able to use +the same theme name.</para> + +<para>The following are the settings that are saved and indicated in a &tde; +Theme:</para> + +<itemizedlist> +<listitem><para> +Background</para> +</listitem> +<listitem> +<para> +Screen Saver</para> +</listitem> +<listitem> +<para> +Icon Theme</para> +</listitem> +<listitem> +<para> +System Notifications</para> +</listitem> +<listitem> +<para> +Color Scheme</para> +</listitem> +<listitem> +<para> +Cursor Theme</para> +</listitem> +<listitem> +<para> +Window Decoration</para> +</listitem> +<listitem> +<para> +&konqueror; background (File Management)</para> +</listitem> +<listitem> +<para> +Panel background</para> +</listitem> +<listitem> +<para> +Style</para> +</listitem> +<listitem> +<para> +Fonts</para> +</listitem> +</itemizedlist> + +<para>One very important thing to consider when using or installing a &tde; +Theme is that it only indicates what settings to use for the above. A &tde; +Theme includes only system notifications, desktop background, panel background, +&konqueror; background, and the color scheme in its package. The other +components must be installed separately if they do not already come with +&tde;.</para> + +<para>&tde; Themes can be downloaded from the <ulink +url="http://www.kde-look.org/index.php?xcontentmode=8">Theme-Manager +subsection</ulink> of +kde-look.org, under the Themes/Styles section.</para> +</sect1> + +<sect1 id="desktop-glossary"> +<title>Glossary</title> + +<glosslist> +<glossentry id="gloss-background"> +<glossterm>Background</glossterm> +<glossdef><para>Background/wallpaper image or color for the +desktop</para></glossdef> +</glossentry> + +<glossentry id="gloss-color-scheme"> +<glossterm>Color Scheme</glossterm> +<glossdef><para>(<literal role="extension">.kcsrc</literal>) +Configuration file that indicates what colors to use +for certain widgets</para></glossdef> +</glossentry> + +<glossentry id="gloss-icons"> +<glossterm>Icons</glossterm> +<glossdef><para>Images representing applications, files, +devices, &etc;</para></glossdef> +</glossentry> + +<glossentry id="gloss-splash-screen"> +<glossterm>Splash Screen</glossterm> +<glossdef><para>Animated image or screen that displays while &tde; +loads after logging in</para></glossdef> +</glossentry> + +<glossentry id="gloss-win-deco"> +<glossterm>Window Decoration</glossterm> +<glossdef><para>Plugins or small programs that instruct the window +manager how to display window frames</para></glossdef> +</glossentry> + +<glossentry id="gloss-style"> +<glossterm>Style</glossterm> +<glossdef><para>Plugin or a small program that instructs &tde; +how widgets are displayed</para></glossdef> +</glossentry> + +<glossentry id="gloss-kde-theme"> +<glossterm>&tde; Theme</glossterm> +<glossdef><para>(<literal role="extension">.kth</literal>) +A file that contains instructions on what settings to use for +different GUI components</para></glossdef> +</glossentry> + +<glossentry id="gloss-widgets"> +<glossterm>Widgets</glossterm> +<glossdef><para>Basic elements that build up a graphical user +interface: buttons, scrollbars, menus, tabs, &etc;</para></glossdef> +</glossentry> + +</glosslist> +</sect1> + + +</chapter> diff --git a/doc/khelpcenter/userguide/desktop.png b/doc/khelpcenter/userguide/desktop.png Binary files differnew file mode 100644 index 000000000..c9e03af97 --- /dev/null +++ b/doc/khelpcenter/userguide/desktop.png diff --git a/doc/khelpcenter/userguide/email.docbook b/doc/khelpcenter/userguide/email.docbook new file mode 100644 index 000000000..8f69e5e6e --- /dev/null +++ b/doc/khelpcenter/userguide/email.docbook @@ -0,0 +1,236 @@ +<chapter id="email"> + +<chapterinfo> +<authorgroup> +<author> +&Daniel.Naber; +</author> +<author> +&David.Rugge; +</author> +</authorgroup> +</chapterinfo> + +<!-- Stolen and modified by Phil from the KMail manual --> +<!-- TODO: Screenies! --> +<title>Getting Started with Email</title> + +<indexterm><primary>Email</primary><secondary>getting +started</secondary></indexterm> + +<indexterm><primary>&kmail;</primary></indexterm> + +<para>&tde; features a powerful and easy-to-use email client called +&kmail;, which allows you to send, receive, and organize your email +quickly and efficiently. Let us look at how to set it up. If you have +any problems with this procedure, refer to the full &kmail; manual.</para> + +<sect1 id="email-information-needed"> +<title>Information you will need before you start</title> + +<para>Many email settings can vary greatly depending on the setup of +your system, your ISP's configuration, or your local network +setup. You will need to find out some information before you can start +setting up your email: +<variablelist> + +<varlistentry> +<term>Your email address</term> +<listitem><para>This should be provided by your ISP or system administrator.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Your username and password for your email account</term> +<listitem><para>The username is often the same as the part before the +<quote>@</quote> symbol in your email address, but not always: check +with your <acronym>ISP</acronym>.</para></listitem> +</varlistentry> + +<varlistentry> + + +<term> +<indexterm><primary>Email</primary><secondary>SMTP +server</secondary></indexterm> +Your outgoing email (<acronym>SMTP</acronym>) server name and +details</term> +<listitem><para>Again, your ISP should have provided +you with this information. If not, you can try the form <systemitem +class="systemname">smtp.<replaceable>your-isp-name</replaceable>.com</systemitem>.</para></listitem> +</varlistentry> + +<varlistentry> + +<term> +<indexterm><primary>Email</primary><secondary>IMAP +server</secondary></indexterm> + +<indexterm><primary>Email</primary><secondary>POP3 +server</secondary></indexterm> + +Your incoming email (<acronym>IMAP</acronym> or +<acronym>POP</acronym>) server name and details</term> +<listitem><para>If you do not have this information to hand, you can +try <systemitem +class="systemname">imap.<replaceable>your-isp-name</replaceable>.com</systemitem> +for <acronym>IMAP</acronym> or <systemitem +class="systemname">pop.<replaceable>your-isp-name</replaceable>.com</systemitem> +if you use <acronym>POP3</acronym>.</para></listitem> +</varlistentry> +</variablelist> +</para> + +<para>Once you have that information, you are ready to start setting +up &kmail;. Open &kmail; from the <guimenu>TDE</guimenu> menu (you can +find it in the <guisubmenu>Internet</guisubmenu> submenu, or use one +of the methods described in <xref linkend="programs-launching"/>.) Once +&kmail; has opened, select the menu entry +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KMail...</guimenuitem> +</menuchoice>. The next sections describe how to use the dialog that +appears to set up &kmail;.</para> +</sect1> + + +<sect1 id="email-setting-your-identity"> +<title>Setting your Identity</title> + +<para> +The settings in the <guilabel>Identities</guilabel> page are fairly +straightforward. Select the <guilabel>default</guilabel> identity and +click <guibutton>Modify...</guibutton>. Fill in the <guilabel>Your +name</guilabel> field with your full name (⪚ <userinput>John +Doe</userinput>) and, optionally, the +<guilabel>Organization</guilabel> field with the appropriate +information. +</para> +<para> +Next, fill in the <guilabel>Email address</guilabel> field with +your email address (⪚ <userinput>[email protected]</userinput>). +</para> + +<para>That is all for this dialog unless you want to use the more +advanced features (cryptography, a signature, &etc;). You can find +more information about these features in the full &kmail; +manual. Click on the <guibutton>OK</guibutton> button to close this +dialog, and move on to the next configuration page...</para> + +</sect1> + +<sect1 id="email-setting-up-your-account"> +<title>Setting up your Account</title> + +<para>Click on the <guilabel>Network</guilabel> icon to move to the +network configuration page. It contains the settings that +tell &kmail; how to send and receive your email messages. You will see +two tabs on the right-hand side: <guilabel>Sending</guilabel> and +<guilabel>Receiving</guilabel>. You need to set up both, so let us look +at them each in turn:</para> + +<sect2 id="sending-mail"> +<title>Sending Messages</title> + +<indexterm><primary>Email</primary><secondary>sending</secondary></indexterm> + +<para>The <guilabel>Sending</guilabel> tab provides a list of +ways to send messages. The first item in the list is the default +way to send messages. Using the <guibutton>Add...</guibutton> +button you can choose between two different ways of sending messages: +<guilabel>SMTP</guilabel> and +<guilabel>Sendmail</guilabel>. &Sendmail; here +means a local software installation — this has a +reputation of being difficult to set up, so if you do not already have a +working &Sendmail; configuration, choose +<guilabel>SMTP</guilabel> and fill in the <guilabel>Name</guilabel> +field with a descriptive name +(⪚ <userinput>My Mail Account</userinput>) +and the <guilabel>Host</guilabel> +field with the name and domain of your mail server +(⪚ <userinput>smtp.provider.com</userinput>). You will probably +not need to change the <guilabel>Port</guilabel> setting (the default is +<userinput>25</userinput>).</para> + +<para>A description of the other options can be found +in the full &kmail; manual. Click on <guibutton>OK</guibutton> to +close this dialog, and then click on the +<guilabel>Receiving</guilabel> tab.</para> + +</sect2> + +<sect2 id="receiving-mail"> +<title>Receiving Messages</title> + +<para>To set up an account so you can receive mail, press the +<guibutton>Add...</guibutton> button in the +<guilabel>Receiving</guilabel> tab. You will then be prompted for the +type of your email account; most users should select +<guilabel>POP3</guilabel> or <guilabel>IMAP</guilabel>. If you wish to +use a different system, consult the &kmail; manual.</para> + +<para>You will then be presented with +the <guilabel>Add account</guilabel> window. First, fill in the +<guilabel>Name</guilabel> field to name your account. You can choose any name +you like. <guilabel>Login</guilabel>, <guilabel>Password</guilabel>, and +<guilabel>Host</guilabel> should be filled in with the information you +gathered earlier. You should not usually need to change the <guilabel>Port</guilabel> setting.</para> + +<para>You are now ready to send and receive mail. For +<acronym>IMAP</acronym>, just open your folders in the +folder tree in &kmail;'s main window. &kmail; then connects to your +server and displays the messages it finds. For POP3 use +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>.</para> + +</sect2> + +</sect1> + +<sect1 id="email-testing-your-setup"> +<title>Testing your Setup</title> + +<indexterm><primary>Email</primary><secondary>testing</secondary></indexterm> + +<para>First, you should send yourself a message to test your +configuration. To send a message, either hit <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo>, select the +<guiicon>New Message</guiicon> icon or select +the <menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message...</guimenuitem></menuchoice> menu item. The +composer window will appear. Fill in the +<guilabel>To:</guilabel> field with your email address and type +something in the <guilabel>Subject</guilabel> field. Send the message by +selecting <menuchoice><guimenu>Message</guimenu> <guimenuitem>Send</guimenuitem> +</menuchoice>.</para> + +<para>To check your email, select +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>. In the lower-right corner of the main +window, a progress bar will indicate how many messages are being +downloaded. If you receive the message you just sent, then +congratulations! If, however, you receive any error messages while +testing your setup, make sure that your network connection is working +and recheck your settings at +<menuchoice><guimenu>Settings</guimenu> <guimenuitem>Configure +&kmail;...</guimenuitem></menuchoice>.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>The &kmail; Handbook has full descriptions of advanced +email settings and so on. You can read it in the &khelpcenter; or by +entering <userinput>help:/kmail</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +<listitem><para>The &kmail; website at <ulink +url="http://kmail.kde.org">http://kmail.kde.org</ulink> contains +latest news, tips and tricks, and plenty more.</para> +</listitem> + +</itemizedlist> + + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/extragear-applications.docbook b/doc/khelpcenter/userguide/extragear-applications.docbook new file mode 100644 index 000000000..5d0d2671b --- /dev/null +++ b/doc/khelpcenter/userguide/extragear-applications.docbook @@ -0,0 +1,199 @@ +<chapter id="extragear-applications"> + +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; +&Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>&tde; Extragear Applications</title> + +<para>These are applications that are directly associated with &tde;, the project, but do not appear and are not shipped with the main &tde; distribution. This can be down to a number of reasons, but a common case is either down to a duplication of functionality, or because they're simply too specialised. Perhaps the most popular occurence however is that the developers themselves may not want it to appear in the main &tde; distribution; choosing, rather, to handle their own release schedules. Nevertheless, the applications in Extragear are distinguished by &tde;, and many are increasingly popular.</para> + +<sect1 id="extragear-components"> +<title>Available in the &tde; Extragear</title> + +<!-- Begin Multimedia --> +<sect2 id="extragear-multimedia"> +<title>Multimedia</title> + +<variablelist> +<varlistentry> +<term>&amarok;</term> + <listitem><para>An advanced and comprehensive music player with the capability to play <acronym>MP3</acronym>, <acronym>WAV</acronym>, and <acronym>OGG</acronym> audio filetypes and others. There is not room here to mention all of &amarok;'s features, but by default, &amarok; can automatically fetch cover art, embed song lyrics, and display aesthetically pleasing visualizations. &amarok; remains, as much of &tde; does, highly customizable; it contains a powerful scripting interface, and the context browser can be stylised easily using &CSS;. &amarok; also supports several backends, including <application>GStreamer</application>, <application>xine</application>, <acronym>NMM</acronym>, <acronym>MAS</acronym>, <application>aKode</application> and &arts;.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://amarok.kde.org">http://amarok.kde.org</ulink></para></listitem> + <listitem><para>View the handbook by typing <userinput>help:/amarok</userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;; if you do not already have &amarok; installed (and hence do not have the handbook), then you can view it online <ulink url="http://amarok.kde.org/component/option,com_staticxt/staticfile,index.html/Itemid,49/">here</ulink>.</para></listitem> + </itemizedlist> + + </listitem> + +<!-- Insert Screeny --> + +</varlistentry> + +<varlistentry> +<term><application>K3b</application></term> + <listitem><para>The definitive &CD;/<acronym>DVD</acronym> burning application for &tde;. With <application>K3b</application> you can create data, video, and audio (it comes with plugins for <acronym>WAV</acronym>, <acronym>MP3</acronym>, <acronym>FLAC</acronym>, and <application>Ogg Vorbis</application>) &CD;s. Projects can be saved and loaded, &CD;-ripping is supported, and you can appropriately make &CD;/<acronym>DVD</acronym> copies.</para> + + <itemizedlist> + <listitem><para>Extragear Summary: <ulink url="http://extragear.kde.org/apps/k3b/">http://extragear.kde.org/apps/k3b/</ulink></para></listitem> + <listitem><para>Website: <ulink url="http://k3b.org">http://k3b.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-multimedia/k3b/index.html"><application>K3b</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +<!-- End Multimedia --> +</sect2> + +<!-- Begin Graphics --> +<sect2 id="extragear-graphics"> +<title>Graphics</title> +<variablelist> +<varlistentry> +<term>&digikam;</term> + <listitem><para>A photo management application which can conveniently organize and import digital photos. Features include complete tagging functionality, a plugin system, and a fully-featured comment system. &digikam; also makes use of <acronym>KIPI</acronym> (&tde; Image Plugin Interface), therefore contributing to the initiative to create a common plugin infrastructure, which allows development of image plugins that can be shared among graphical applications in &tde; (others include <application>Gwenview</application>, <application>ShowImg</application> and <application>KimDaBa</application>).</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://digikam.org">http://digikam.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/digikam/index.html">&digikam; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>Gwenview</application></term> + <listitem><para>Another advanced image viewer which can load and save all image formats supported by &tde;, as well as being able to display the <application>GIMP</application> (*.<acronym>xcf</acronym>) image filetype. <application>Gwenview</application> can perform a few graphical manipulations (rotate, mirroring) and has full support for TDEIO slaves (allowing you to use it via &FTP;). Other features also include file management operations, such as copy, paste, move and delete.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://gwenview.sourceforge.net/">http://gwenview.sourceforge.net/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/gwenview/index.html"><application>Gwenview</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term><application>ShowImg</application></term> + <listitem><para>A feature-rich image viewer, written for &tde;, which can display numerous formats, including <acronym>JPEG</acronym>, <acronym>PNG</acronym>, [animated] <acronym>GIF</acronym> and <acronym>MNG</acronym>. It consists of a tree-view frame, a directory/preview frame, and a view frame. The (larger) view frame can be exchanged with the (smaller) directory/preview frame. It can preview and display images from multiple directories and search for identical images. <application>ShowImg</application> also features a full-screen mode, zooming, sorting, drag and drop with &konqueror;, and support for images in compressed archives.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.jalix.org/projects/showimg/">http://www.jalix.org/projects/showimg/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/showimg/index.html"><application>ShowImg</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KimDaBa</application></term> + <listitem><para><application>KimDaBa</application> (&tde; Image Database) attempts to provide an efficient solution for the organization of hundreds (or even thousands) of images. Having been highly optimized for annotating images, <application>KimDaBa</application> can help you locate an image in a matter of seconds.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://ktown.kde.org/kimdaba/">http://ktown.kde.org/kimdaba/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-graphics/kimdaba/index.html"><application>KimDaBa</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Graphics --> + +<!-- Begin Network --> + +<sect2 id="extragear-network"> +<title>Network</title> +<variablelist> +<varlistentry> +<term>&konversation;</term> + <listitem><para>A fully-featured <acronym>IRC</acronym> client which supports per channel encoding, downloading and resuming file transfers, nick completion and highlighting, as well as tight integration with &kontact; and the rest of &tde;.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://konversation.kde.org">http://konversation.kde.org</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-network/konversation/index.html">&konversation; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KMldonkey</application></term> + <listitem><para>A &tde; frontend for <application>MLDonkey</application>, a powerful <acronym>P2P</acronym> file-sharing tool. Highly configurable, real-time graphical bandwidth and network statistics, and much more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kmldonkey.org/">http://kmldonkey.org/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-network/kmldonkey/index.html"><application>KMldonkey</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KNemo</application></term> + <listitem><para>Displays for every network interface an icon in the systray. Tooltips and an info dialog provide further information about the interface. Passive popups inform about interface changes and a traffic plotter is also integrated.</para> + + <itemizedlist> + <listitem><para><ulink url="http://kde-apps.org">&tde;-apps</ulink> entry: <ulink url="http://kmldonkey.org/">http://www.kde-apps.org/content/show.php?content=12956</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Network --> + +<!-- Beging Utilities --> + +<sect2 id="extragear-utilities"> +<title>Utilities</title> +<variablelist> +<varlistentry> +<term><application>Filelight</application></term> + <listitem><para>A simple, yet ideal, application for graphically displaying where your diskpace is being used. <application>Filelight</application> displays this information by representing your filesystem as a set of concentric segmented-rings.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.methylblue.com/filelight/">http://www.methylblue.com/filelight/</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-utils/filelight/index.html"><application>Filelight</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +<!-- Insert Screeny here --> +</varlistentry> + +<varlistentry> +<term><application>Krecipes</application></term> + <listitem><para>A &tde; recipe tool that can manage a recipe database with an easy-to-use interface. Full support for creating and removing ingredients as well as units; helps with diets, can calculate the amount of calories, vitamins, carbohydrates etc. Other advantages are its flexilibity and potential to extend further.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://krecipes.sourceforge.net">http://http://krecipes.sourceforge.net</ulink></para></listitem> + <listitem><para><ulink url="http://docs.kde.org/development/en/extragear-utils/krecipes/index.html"><application>Krecipes</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> +</variablelist> +</sect2> +<!-- End Utilities --> + +</sect1> + +<sect1 id="extragear-related-information"> +<title>Related Information</title> +<itemizedlist> +<title>Related Information and Links</title> + <listitem><para>It should be stressed that the above is but a preview of what is available in the &tde; extragear. To view all of the applications and utilities available there visit <ulink url="http://extragear.kde.org">http://extragear.kde.org</ulink>, where a briefer summary of each application is provided.</para></listitem> + <listitem><para>The handbooks for the majority of applications in extragear can be viewed from <ulink url="http://docs.kde.org">http://docs.kde.org</ulink>.</para></listitem> + <listitem><para>Once again, you can find a plethora of other [third-party] &tde; applications at the popular <ulink url="http://kde-apps.org">http://kde-apps.org</ulink>.</para></listitem> +</itemizedlist> +</sect1> + +</chapter>
\ No newline at end of file diff --git a/doc/khelpcenter/userguide/file-sharing.docbook b/doc/khelpcenter/userguide/file-sharing.docbook new file mode 100644 index 000000000..1ab5c4f61 --- /dev/null +++ b/doc/khelpcenter/userguide/file-sharing.docbook @@ -0,0 +1,91 @@ +<sect1 id="file-sharing"> + +<sect1info> +<authorgroup> +<author> +&Lauri.Watts; +</author> +</authorgroup> +</sect1info> + + +<title>File Sharing</title> +<sect2 id="file-sharing-kpf"> +<title>How to share files with &kpf;</title> + +<indexterm><primary>File sharing</primary></indexterm> +<indexterm><primary>Shared Folders</primary></indexterm> + +<para>&kpf; provides simple file sharing using &HTTP; (the Hyper Text +Transfer Protocol,) which is the same protocol used by web sites to provide +data to your web browser. &kpf; is strictly a public fileserver, which means +that there are no access restrictions to shared files: whatever you select +for sharing is available to anyone.</para> + +<para>&kpf; is designed to be used for sharing files with friends, not to +act like a fully-fledged web server such as +<application>Apache</application>. &kpf; was primarily conceived as an easy +way to share files with others while chatting on <acronym>IRC</acronym> +(Internet Relay Chat, or <quote>chat rooms</quote>.)</para> + +<para>&kpf; runs as an applet inside &kicker;. This means that it takes up +little space on your screen and its status is always visible. To start the +&kpf; applet, <mousebutton>right</mousebutton> click on &kicker; and choose +<guimenu>Add Applet to Panel...</guimenu> to open the <guilabel>Add +Applet</guilabel> dialog. Select <guilabel>Public File Server</guilabel> and +click the <guibutton>Add to Panel</guibutton> button.</para> + +<para>&kpf; employs the concept of shared folders. You may choose one or +more folders to make public, and all files in that folder (and any +subfolders) will be shared.</para> + +<note><para>Please be extremely careful about which folders you share. Remember +that all files in the folder and its subfolders, including +<quote>hidden</quote> files (<quote>dotfiles</quote> to the techies) will be +made available to the world, so be careful not to share sensitive +information, such as passwords, cryptographic keys, your addressbook, +documents private to your organization, &etc;.</para></note> + +<para>Once &kpf; is running, you will see a square applet with a thin sunken +bevel and an icon depicting an <guiicon>hot air balloon</guiicon>. The +balloon is visible when no folders are being shared.</para> + +<para>To share a folder, <mousebutton>right</mousebutton> click on the +balloon icon and a pop-up menu will appear, containing only one item, +<guimenuitem>New Server...</guimenuitem>. Selecting this entry will cause a +<quote>wizard</quote> to appear, which will ask you a few simple +questions. Completing the questions will set up a folder for sharing.</para> + +<para>There is an alternative to using the applet directly when you want to +share a folder. &kpf; is integrated with &konqueror;.</para> + +<para>With &konqueror; open and displaying a folder, +<mousebutton>right</mousebutton> click on the background and bring up the +<quote>Properties</quote> dialog. On install, &kpf; added a +<guilabel>Sharing</guilabel> tab to this dialog. You will be offered the +option of starting &kpf; if it is not running. Choosing +<guibutton>Ok</guibutton> will send a signal to the &kpf; applet, asking it +to add a new share.</para> + +<para>For more detailed information, such as how to share different +directories to different people, see the <ulink +url="help:/kpf">&kpf;</ulink> handbook.</para> + +</sect2> + +<!-- <sect2 id="file-sharing-other-strategies"> +<title>Other strategies</title> + +Samba, local cgi? nfs devices +--> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> + + +</sect2>--> +</sect1> diff --git a/doc/khelpcenter/userguide/font-installation.docbook b/doc/khelpcenter/userguide/font-installation.docbook new file mode 100644 index 000000000..1248f660c --- /dev/null +++ b/doc/khelpcenter/userguide/font-installation.docbook @@ -0,0 +1,61 @@ +<sect1 id="fonts"> + +<sect1info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>[email protected]</email> +</author> +</authorgroup> +</sect1info> + +<title>Fonts - Installing and Configuring</title> + +<indexterm><primary>Fonts</primary></indexterm> + +<para>Fonts are really easy to configure in &tde;. Open up the Control +Center (with <menuchoice><guimenu>TDE Menu</guimenu><guimenuitem>Control +Center</guimenuitem></menuchoice>) and choose +<guilabel>Font Installer</guilabel> in <guilabel>System +Administration</guilabel>in the tree view.</para> + +<para>There are two kinds of fonts: Personal and Global fonts. +Personal fonts are only accessible to your user, whereas global fonts are +accessible to everyone. When you open the <application>Font +Installer</application>, you're in Personal mode (you can see this in +the <guilabel>Location</guilabel> bar). When you click on the <guibutton>Administrator Mode</guibutton> +button, and put the <systemitem class="username">root</systemitem> password, +you can access global mode, where you can change the fonts for every user on +this computer.</para> + +<para>For the rest, there is no difference between those two kind of fonts.</para> + +<indexterm><primary>Fonts</primary><secondary>previewing</secondary></indexterm> + +<para>There is a list of fonts in the center. Click on a font to see a preview. +In the toolbar on the top you have buttons to access the top directory, +refresh and change the view.</para> + +<para>If you want to, you can organise your fonts in multiple directories, so that +you can easily find them later.</para> + +<indexterm><primary>Fonts</primary><secondary>installing</secondary></indexterm> + +<para>To install a font, click on the <guibutton>Add +Fonts...</guibutton> button. A file open dialog will appear where you can +choose your font.</para> + +<para>Alternatively, you can drag fonts from &konqueror; to the +list. To remove a font, <mousebutton>right</mousebutton> click on it and +choose <guibutton>Delete</guibutton>.</para> + + + +<para>Configuration (anti-aliasing)</para> + +<para>tdefontinst and tdefontview should probably get a mention too, since +they don't seem to have any existing docs.</para> +</sect1> diff --git a/doc/khelpcenter/userguide/getting-help.docbook b/doc/khelpcenter/userguide/getting-help.docbook new file mode 100644 index 000000000..facea078d --- /dev/null +++ b/doc/khelpcenter/userguide/getting-help.docbook @@ -0,0 +1,155 @@ +<sect1 id="getting-help"> + +<title>Getting Help</title> + +<sect2 id="user-manuals"> +<title>User Manuals</title> + +<indexterm><primary>User Manual</primary></indexterm> +<para>Most applications come with a user manual<indexterm><primary>User Manual</primary><secondary>Handbook +</secondary></indexterm>, which can be reached in various ways:</para> + +<itemizedlist> +<listitem> +<para>By pressing <keycap>F1</keycap> while inside the application.</para> +</listitem> +<listitem> +<para>From the menu bar: +<menuchoice><guimenu>Help</guimenu><guimenuitem><replaceable>Application name +</replaceable></guimenuitem></menuchoice>.</para> +</listitem> +<listitem> +<para>By browsing in &khelpcenter;<indexterm><primary>&khelpcenter;</primary></indexterm>.</para> +</listitem> +<listitem> +<para>By using the help KIOslave in &konqueror;. For example, in the Location bar, type <userinput>help:/<replaceable>Application name</replaceable></userinput>, where <replaceable>Application name</replaceable> is the name of the application. +</para> +</listitem> +</itemizedlist> + +</sect2> + +<sect2 id="context-help"> +<title>Context and <quote>What's This</quote> Help</title> + +<para>Many applications also provide context help in two forms: +Tooltips and <quote>What's This</quote> help.</para> + +<sect3 id="tooltips"> +<title>Tooltips</title> + +<indexterm><primary>Tooltips</primary></indexterm> +<para>Tooltips are small informational windows or balloons that appear when +hovering the mouse pointer over an item.</para> + +<para>&tde; uses tooltips in many places to provide brief help or +information on the screen about an item. For instance, most toolbar buttons +inside applications will display their name in a tooltip when resting or hovering +the mouse pointer over them.</para> + +<para>Tooltips have another function, which is not specifically tied to +help. In the &konqueror; file manager and on the Desktop, tooltips can +provide information about files. This information is commonly referred to as +<quote>meta information.</quote></para> + +<para>Learn more about meta-information tooltips in the section +about <link linkend="file-manager">the &konqueror; file manager</link>.</para> + +</sect3> + +<sect3 id="whats-this-help"> +<title><quote>What's This?</quote></title> + +<indexterm><primary>What's This?</primary></indexterm> + +<para><quote>What's This?</quote> help usually is more detailed than tooltips. +Access <quote>What's This?</quote> help in two ways:</para> + +<itemizedlist> +<listitem> +<para>By selecting the <guibutton>?</guibutton> button in the titlebar of the +window.</para> +</listitem> +<listitem> +<para>By pressing the key combination +<keycombo>&Shift;<keycap>F1</keycap></keycombo>.</para> +</listitem> +</itemizedlist> + +<para>The mouse pointer will change to a pointer with a question mark. +Select an item to learn more, and a small window will +pop up displaying information.</para> + +</sect3> +</sect2> + +<sect2 id="mailing-lists-newsgroups-and-irc"> +<title>Mailing Lists, Newsgroups, and <acronym>IRC</acronym></title> + +<sect3 id="mailing-lists"> +<title>Mailing Lists</title> + +<indexterm><primary>Mailing Lists</primary></indexterm> +<para>&tde-team; provides some mailing lists to provide help +and guidance with using and configuring &tde;:</para> + +<variablelist> +<varlistentry> +<term>The &tde; User List +<indexterm><primary>&tde; User Mailing List</primary></indexterm></term> +<listitem> +<para>This mailing list focuses specifically on questions +and discussions about using &tde;. For example, +the question <quote>How do I change the margin size for KWord +documents</quote> is appropriate for this list.</para> +<para>Subscribe to this list at <ulink +url="http://www.trinitydesktop.org/mailinglist.php">http://www.trinitydesktop.org/mailinglist.php</ulink>.</para> +<para>Find list archives at <ulink +url="http://trinity-users.pearsoncomputing.net/">http://trinity-users.pearsoncomputing.net/</ulink>.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect3> + +<sect3> +<title>IRC</title> + +<para>There is a #trinity channel on Freenode (irc.freenode.net) for support and other general talk about &tde;. +Access this channel by using any of &tde;'s popular IRC clients, which include <application>Konversation</application>, +&ksirc; and &kopete;. For more information, check the <xref linkend="irc"/> section.</para> + +</sect3> +</sect2> + + +<sect2 id="more-resources"> +<title>More Resources</title> + +<para>Other resources that might prove useful:</para> + +<variablelist> +<varlistentry> +<term>trinitydesktop.org/rss.php (RSS Feed) +<indexterm><primary>&tde; News Resource</primary></indexterm></term> +<listitem> +<para>The RSS feed news resource to stay informed about &tde;.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<varlistentry> +<term><ulink +url="http://www.trinitydesktop.org/wiki">http://www.trinitydesktop.org/wiki</ulink> +<indexterm><primary>The &tde; Wiki</primary></indexterm></term> +<listitem> +<para>The &tde; Wiki. The wiki should not be used as a substitute for the +respective application's handbook or official &tde; documentation.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/userguide/glossary.docbook b/doc/khelpcenter/userguide/glossary.docbook new file mode 100644 index 000000000..dda9f666f --- /dev/null +++ b/doc/khelpcenter/userguide/glossary.docbook @@ -0,0 +1,20 @@ +<chapter id="glossary"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Glossary of Terms</title> + +<para>TDE/GUI/UNIX terms that are worth explaining.</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/index.docbook b/doc/khelpcenter/userguide/index.docbook new file mode 100644 index 000000000..2ffdc84f5 --- /dev/null +++ b/doc/khelpcenter/userguide/index.docbook @@ -0,0 +1,582 @@ +<?xml version="1.0" ?> + <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "<replaceable>KApp</replaceable>"> + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % imageobjectco.module "INCLUDE"> + <!ENTITY getting-help SYSTEM "getting-help.docbook"> + <!ENTITY programs-controlling SYSTEM "programs-controlling.docbook"> + <!ENTITY troubleshooting-no-open SYSTEM "troubleshooting-no-open.docbook"> + <!ENTITY troubleshooting-network-x SYSTEM "troubleshooting-network-x.docbook"> + <!ENTITY windows-how-to SYSTEM "windows-how-to.docbook"> + <!ENTITY the-filemanager SYSTEM "the-filemanager.docbook"> + <!ENTITY panel-and-desktop SYSTEM "panel-and-desktop.docbook"> + <!ENTITY programs-and-documents SYSTEM "programs-and-documents.docbook"> + <!ENTITY control-center SYSTEM "control-center.docbook"> + <!ENTITY customizing-desktop SYSTEM "customizing-desktop.docbook"> + <!ENTITY base-tde-applications SYSTEM "base-tde-applications.docbook"> + <!ENTITY removable-disks SYSTEM "removable-disks.docbook"> + <!ENTITY burning-cds SYSTEM "burning-cds.docbook"> + <!ENTITY playing-music SYSTEM "playing-music.docbook"> + <!ENTITY playing-audiocds SYSTEM "playing-audiocds.docbook"> + <!ENTITY playing-movies SYSTEM "playing-movies.docbook"> + <!ENTITY your-tde-account SYSTEM "your-tde-account.docbook"> + <!ENTITY tde-as-root SYSTEM "tde-as-root.docbook"> + <!ENTITY switching-sessions SYSTEM "switching-sessions.docbook"> + <!ENTITY file-sharing SYSTEM "file-sharing.docbook"> + <!ENTITY networking-with-windows SYSTEM "networking-with-windows.docbook"> + <!ENTITY shared-sessions SYSTEM "shared-sessions.docbook"> + <!ENTITY printer-setup SYSTEM "printer-setup.docbook"> + <!ENTITY printing-from-apps SYSTEM "printing-from-apps.docbook"> + <!ENTITY pdf-files SYSTEM "pdf-files.docbook"> + <!ENTITY font-installation SYSTEM "font-installation.docbook"> + <!ENTITY creating-graphics SYSTEM "creating-graphics.docbook"> + <!ENTITY screen-captures SYSTEM "screen-captures.docbook"> + <!ENTITY konsole-intro SYSTEM "konsole-intro.docbook"> + <!ENTITY tde-edutainment SYSTEM "tde-edutainment.docbook"> + <!ENTITY accessibility SYSTEM "accessibility.docbook"> + <!ENTITY under-the-hood SYSTEM "under-the-hood.docbook"> + <!ENTITY net-connection-setup SYSTEM "net-connection-setup.docbook"> + <!ENTITY email SYSTEM "email.docbook"> + <!ENTITY internet-shortcuts SYSTEM "internet-shortcuts.docbook"> + <!ENTITY browser-fine-tuning SYSTEM "browser-fine-tuning.docbook"> + <!ENTITY usenet SYSTEM "usenet.docbook"> + <!ENTITY messaging-intro SYSTEM "messaging-intro.docbook"> + <!ENTITY tde-office SYSTEM "tde-office.docbook"> + <!ENTITY migrator-dictionary SYSTEM "migrator-dictionary.docbook"> + <!ENTITY glossary SYSTEM "glossary.docbook"> + <!ENTITY standard-menu-entries SYSTEM "standard-menu-entries.docbook"> + <!ENTITY where-next SYSTEM "where-next.docbook"> + <!ENTITY credits-and-license SYSTEM "credits-and-license.docbook"> + <!ENTITY extragear-applications SYSTEM "extragear-applications.docbook"> + <!ENTITY migrator-applications SYSTEM "migrator-applications.docbook"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>The &tde; (Trinity Desktop Environment) User Guide</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2004-2005</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<abstract> +<para>A general user guide to the Trinity Desktop Environment. +</para> + +<para>Please report problems with this document to +<email>[email protected]</email>. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>desktop</keyword> +<keyword>handbook</keyword> +<keyword>tutorial</keyword> +</keywordset> + +</bookinfo> + +<part id="introduction"> +<title>Introduction</title> + +<chapter id="welcome"> +<title>Welcome to the &tde; User Guide</title> + +<para>This User Guide provides an overview of &tde;. Use this +guide after installing &tde; and accompanying packages. This guide should be +a first point of reference for basic &tde; configuration questions, or +to learn to perform common tasks.</para> + +<sect1 id="what-the-ug-is"> +<title>What this guide aims to be</title> + +<para>The first place to look and a one-stop location for questions +regarding &tde;.</para> + +<para>A quick guide to commonly performed tasks. In most cases, learning +basic functions does not require configuring every option in an application. +Provided in this guide is information that works +for most common situations, along with links to sources of +further information.</para> + +<para>There are also some tips and tricks showing useful features +of &tde; and ways to save time and effort.</para> + +</sect1> + +<sect1 id="what-the-ug-is-not"> +<title>What this book is not</title> + +<para>This guide is not intended to replace the individual application +handbook help manuals. Use the appropriate handbook to help with specific program +configuration and troubleshooting issues not covered in this guide. Where to find +additional information is provided when answers are outside the scope of this guide.</para> + +<para>Several applications provided outside the main &tde; suite +are mentioned in this guide, but mostly this guide covers only the +applications provided as part of the main suite.</para> + +<para>The user guide is not specific to a distribution and covers a default &tde; +installation. Local installations might be customized by +distribution providers, or end-users. Therefore advice provided in this guide is +generic. For example, file paths used to run files might be different than +described in this guide.</para> +</sect1> + +<sect1 id="typographic-conventions"> +<title>Conventions used in this book</title> + +<para>The following formatting conventions are used: +<informaltable> +<tgroup cols="3"> + +<thead> +<row> +<entry>Type of Text</entry> +<entry>Style</entry> +<entry>Example</entry> +</row> +</thead> +<tbody> + +<row> +<entry>Text appearing in the &GUI; (on buttons, &etc;)</entry> +<entry>Light gray background</entry> +<entry><guilabel>Settings</guilabel></entry> +</row> + +<row> +<entry>Names of keys</entry> +<entry>Bold font</entry> +<entry>&Ctrl;</entry> +</row> + +<row> +<entry>Menu entries</entry> +<entry><quote>Menu Name</quote>-><quote>Menu Item</quote></entry> +<entry><menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem> +</menuchoice></entry> +</row> + +<row> +<entry>Key combinations (pressed simultaneously)</entry> +<entry><quote>Modifier Key</quote>+<quote>Action Key</quote></entry> +<entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap> +</keycombo></entry> +</row> + +<row> +<entry>Text you should enter</entry> +<entry>Bold, fixed width font</entry> +<entry><userinput>ls -al tde/</userinput></entry> +</row> + +<row> +<entry>Text you should replace as appropriate</entry> +<entry>Italic green font</entry> +<entry><replaceable>user</replaceable></entry> +</row> + +</tbody> +</tgroup> +</informaltable> +</para> + +<para>Mouse buttons often are referred to as the left mouse button and right mouse button. +Traditionally, the left mouse button is used the primary button to select items and the right +mouse button is used as the secondary button to open popup context menus. Within that context, +terms such as "left-click" and "right-click" have become common. Unfortunately, that terminology +describes the buttons from a right-handed perspective. For people using a mouse configured +for left-handed use, the roles of the buttons are reversed. That is, the right mouse button +becomes the primary button and the left mouse button becomes the secondary button. To avoid +confusion in this guide, that traditional terminology will be used as little as possible. +Although this guide is revised periodically, those traditional terms might still be used.</para> + +</sect1> + +<sect1 id="system-locations"> +<title>System Locations</title> + +<para>The following system location information might be useful: + +<variablelist> + +<varlistentry> +<term>&tde; prefix</term> +<listitem><para>&tde; installs into its own folder tree, which is found by +running the command <userinput><command>tde-config</command> <option>--prefix</option></userinput>. This folder is referred to +by the environment variable $<envar>TDEDIR</envar> and possibly +$<envar>TDEDIRS</envar>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>&tde; user-specific settings</term> +<listitem><para>The environment variable $<envar>TDEHOME</envar> +points to the folder where &tde; should find user-specific settings. +The default location is <filename class="directory">$HOME/.trinity</filename>.</para> +</listitem> +</varlistentry> + +</variablelist> + +</para> +</sect1> + +<sect1 id="overview"> +<title>Overview, or <quote>Where to look in the User Guide</quote></title> + +<para>Here's an overview of what's in the User Guide:</para> + +<para><xref linkend="desktop"/> contains an introduction to the basic +use of &tde;, such as <xref linkend="windows-how-to-work"/>, and the tools +used in all &tde; applications, like <xref +linkend="programs-save-open" />. Those users new to &tde; or +computers in general, will find this section helpful.</para> + +<para><xref linkend="components"/> explains some important components +of a &tde; installation and how they fit together. &tde;'s multimedia +and networking capabilities are extensive and not covered thoroughly +here, but there's a taster of both of them in this part of the User +Guide. At the end of this part are suggestions for tweaking &tde; +in <xref linkend="tinkering-under-the-hood"/>.</para> + +<para><xref linkend="tde-online"/> highlights &tde;'s suite of +Internet applications. &tde; includes a powerful web browser, +&konqueror;, a full-featured email client, &kmail;, a news reader, +&knode;, and many more applications to use the Internet. +This part of the User Guide contains +information about configuring these applications.</para> + +</sect1> +</chapter> +</part> + +<part id="desktop"> +<title>The Desktop</title> + +<chapter id="basics"> +<title>The Basics</title> +<para>The <quote>desktop</quote><indexterm><primary>Desktop</primary> +</indexterm> is the name for the layout of +the screen when starting &tde;. The desktop might look slightly different, +but the main features should be the same as the following image.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="desktop.png" format="PNG"/> +</imageobject> +<textobject><phrase>A default desktop layout</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>Let us look at the most important parts: +<itemizedlist> +<listitem><para>Most of the screen is +occupied by the background<indexterm><primary>Background</primary></indexterm>. With some distributions, +there might be a picture for the background. This picture is referred to as the +<quote>wallpaper,</quote><indexterm><primary>Wallpaper</primary></indexterm> and can be changed by every user.</para> +</listitem> + +<listitem><para>In the left-hand side are two icons: +<guiicon>Trash</guiicon> and <guiicon>Home</guiicon>. Selecting +these will open the <filename>Trash</filename> folder and Home +folder, respectively. Add more icons to the desktop as desired +to open favorite programs, or access removable media.</para> +</listitem> + +<listitem><para>At the bottom is the &tde; Panel<indexterm><primary>Panel</primary></indexterm>, also known as +<quote>&kicker;</quote>. The Panel contains several useful ways of +interacting with &tde;. The Panel houses the &kmenu; button, from where +any &tde; application can be started. The Panel can be configured to show all the +programs that are running, as well as the date and time, and more. +Read <xref linkend="panel-and-desktop"/> for more +information about the &tde; Panel.</para> +</listitem> +</itemizedlist></para> + +<!-- Put this somewhere else +At the far left is the &kmenu; +button. Selecting this button will open the main &tde; menu, which +has links to all the installed &tde; applications, and some useful +commands, like <guilabel>Find Files</guilabel> and <guilabel>Log +Out</guilabel>. Start an application from the +&kmenu;. Like the other things on the desktop, +the &kmenu; can be changed.</para> +</listitem> +--> + +<!-- Put this in the Panel section +<listitem><para>Next to the &kmenu; button are icons which will +start some commonly-used &tde; applications. These icons are similar +to the ones on the desktop, but only links to programs +(and not links to removable media, like CDs).</para> +</listitem> + +--> + +<sect1 id="logging-in"> + +<title>Logging In and Logging Out</title> +<para>There are two ways to log into &tde;: graphically and via the +command line.</para> + +<sect2 id="logging-in-graphically"> +<title>Logging in Graphically</title> +<indexterm><primary>login</primary></indexterm> +<indexterm><primary>&tdm;</primary></indexterm> + +<para>A screen similar to the one shown below means +the computer is ready for logging in graphically.</para> + +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="tdm.png" format="PNG"/> +</imageobject> +<textobject><phrase>A typical TDM display</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> Enter a username in the +<guilabel>Username</guilabel> text box and password in the +<guilabel>Password</guilabel> text box. The password will not be shown +while typing, instead displaying as asterisks or dots. When finished, +select the <guibutton>Login</guibutton> button, or press the Enter key, +and &tde; will start. A &tde; splash image will appear, +and provide &tde; startup information. When done +&tde; will be ready to use.</para> +</sect2> + +<sect2 id="logging-in-via-cmdline"> +<title>Logging in at the Command Line</title> +<indexterm><primary><command>starttde</command></primary></indexterm> +<indexterm><primary><command>startx</command></primary></indexterm> + +<para>For those preferring the command line, log in to &tde; +with the <command>startx</command> command. If necessary then in the +system or user <filename>.xinitrc</filename> file, add the line +<userinput>exec starttde</userinput>. &tde; should start the same way as +when logging in graphically.</para> +</sect2> + +<sect2 id="logging-out"> +<title>Logging Out</title> +<indexterm><primary>logout</primary></indexterm> + +<para>When finished using &tde; for the moment, then +log out until next time. The easiest way to do this is to +select the &kmenu; button +<guiicon> +<inlinemediaobject> +<imageobject> +<imagedata fileref="../common/kmenu.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</guiicon> +at the bottom left of the screen, and then +select the <guimenuitem>Log Out...</guimenuitem> item.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <ulink url="help:/tdm">&tdm; Handbook</ulink> has information about using and configuring +the &tde; graphical login manager. Read more in &khelpcenter; or +by entering <userinput>help:/tdm</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> +</itemizedlist> + +</sect2> +</sect1> + +&getting-help; +&windows-how-to; + +&the-filemanager; + + +</chapter> + +&panel-and-desktop; + +&programs-and-documents; + +</part> + +<part id="components"> +<title>&tde; Components</title> + +&control-center; + +&base-tde-applications; + +&extragear-applications; + +<chapter id="multimedia"> +<title>Multimedia With &tde;</title> + +&removable-disks; + +&playing-music; + +&playing-audiocds; + +&playing-movies; + +</chapter> + +<chapter id="multiuser-kde"> +<title>&tde; the Multiuser Desktop</title> + +&your-tde-account; + +&tde-as-root; + +&switching-sessions; +</chapter> + +<chapter id="networking"> +<title>Networking with &tde;</title> + +&file-sharing; + +&networking-with-windows; + +&shared-sessions; +</chapter> + +<chapter id="graphics-printing-and-fonts"> +<title>Graphics, Printing, and Fonts</title> + +&printer-setup; + +&printing-from-apps; + +&pdf-files; + +&font-installation; + +&creating-graphics; + +</chapter> +&customizing-desktop; + +&konsole-intro; + +&tde-edutainment; + +&accessibility; + +&under-the-hood; +</part> + +<part id="tde-online"> +<title>&tde; and the Internet</title> + +&net-connection-setup; + +&email; + +<chapter id="browser"> +<title>&konqueror;</title> + +<para>Intro to the browser</para> + +&internet-shortcuts; + +&browser-fine-tuning; +</chapter> + +&usenet; + +&messaging-intro; + +</part> + +&tde-office; + +<part id="more"> +<title>More Tools</title> + +&migrator-applications; + +&migrator-dictionary; + +&standard-menu-entries; + +&glossary; + +<chapter id="troubleshooting"> +<title>Troubleshooting Problems</title> + +<para>Problems that aren't</para> + +<para>Frozen apps (how to kill them)</para> + +<para>Things won't open</para> + +<para>That scary crash dialog</para> + +<para>Reporting Bugs</para> + +<para>More Resources</para> + +&troubleshooting-network-x; + +&troubleshooting-no-open; + +</chapter> + +<chapter id="contributing"> +<title>Contributing to &tde;</title> + +<para>Some basic information to get encourage people to contribute to +&tde;, information about what's available, and how to get +started.</para> + +</chapter> + +</part> + + +<appendix id="appendix-credits"> +<title>Credits and Licenses</title> + +&credits-and-license; + +<sect1 id="license"> +<title>License</title> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +</sect1> + +</appendix> + +&documentation.index; + +</book> diff --git a/doc/khelpcenter/userguide/internet-shortcuts.docbook b/doc/khelpcenter/userguide/internet-shortcuts.docbook new file mode 100644 index 000000000..a4cfa1e68 --- /dev/null +++ b/doc/khelpcenter/userguide/internet-shortcuts.docbook @@ -0,0 +1,62 @@ +<sect1 id="internet-keywords"> +<sect1info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>[email protected]</email> +</author> +</authorgroup> +</sect1info> + +<title>Internet Shortcuts</title> + +<indexterm><primary>Web shortcuts</primary></indexterm> +<indexterm><primary>Internet Shortcuts</primary></indexterm> +<indexterm><primary>gg:</primary></indexterm> + +<para>Internet shortcuts are a really useful feature of &konqueror;: +once you get used to them, you'll wonder how you ever lived without them.</para> + +<para>To see what internet shortcuts are, open up &konqueror; and type +<userinput>gg:kde</userinput> in the <guilabel>Location</guilabel> +bar.</para> + +<para>You will go to Google, searching for &tde;.</para> + +<para>They are many such shortcuts like <userinput>ggl:</userinput> (Google +I'm feeling lucky), <userinput>bug:</userinput> (bugs.trinitydesktop.org) and so +on.</para> + +<para>To get a full list, click on <guimenu>Settings</guimenu> in the +&konqueror; menu, and select <guilabel>Web Shortcuts</guilabel>. Here you will find a full list of all the shortcuts. You can create +new ones, change existing ones, or delete unused shortcuts. You can also +disable web shortcuts if you don't like them. If you set the <guilabel>Default +search engine</guilabel>, you don't have to type the shortcut anymore. For +instance if you set it to Google, you can just type +<userinput>kde</userinput> in the <guilabel>Location</guilabel> bar, +and it will search Google for <quote>&tde;</quote>.</para> + +<para>In <guilabel>Keyword delimiter</guilabel> you can choose if you want +to separate a shortcut with a colon (<userinput>gg: kde</userinput>) or a +space (<userinput>gg kde</userinput>).</para> + +<para>A nice tip with Internet shortcuts is that you can use them from the +<guilabel>Run Command</guilabel> dialog. Just open it (through the &kmenu; +or with <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>) and +type your shortcut, ⪚ <userinput>gg: kde</userinput>, and press +&Enter;. It will automatically open &konqueror; with a Google +search for &tde;.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/juk-icon.png b/doc/khelpcenter/userguide/juk-icon.png Binary files differnew file mode 100644 index 000000000..a9b9150aa --- /dev/null +++ b/doc/khelpcenter/userguide/juk-icon.png diff --git a/doc/khelpcenter/userguide/juk.png b/doc/khelpcenter/userguide/juk.png Binary files differnew file mode 100644 index 000000000..3c5517cb8 --- /dev/null +++ b/doc/khelpcenter/userguide/juk.png diff --git a/doc/khelpcenter/userguide/kaboodle-icon.png b/doc/khelpcenter/userguide/kaboodle-icon.png Binary files differnew file mode 100644 index 000000000..7737031df --- /dev/null +++ b/doc/khelpcenter/userguide/kaboodle-icon.png diff --git a/doc/khelpcenter/userguide/kaboodle.png b/doc/khelpcenter/userguide/kaboodle.png Binary files differnew file mode 100644 index 000000000..ca64fee01 --- /dev/null +++ b/doc/khelpcenter/userguide/kaboodle.png diff --git a/doc/khelpcenter/userguide/kcalc-systray.png b/doc/khelpcenter/userguide/kcalc-systray.png Binary files differnew file mode 100644 index 000000000..c36073d3c --- /dev/null +++ b/doc/khelpcenter/userguide/kcalc-systray.png diff --git a/doc/khelpcenter/userguide/kcontrol.png b/doc/khelpcenter/userguide/kcontrol.png Binary files differnew file mode 100644 index 000000000..d09af9aef --- /dev/null +++ b/doc/khelpcenter/userguide/kcontrol.png diff --git a/doc/khelpcenter/userguide/kmag.png b/doc/khelpcenter/userguide/kmag.png Binary files differnew file mode 100644 index 000000000..0b9de2399 --- /dev/null +++ b/doc/khelpcenter/userguide/kmag.png diff --git a/doc/khelpcenter/userguide/kmousetool.png b/doc/khelpcenter/userguide/kmousetool.png Binary files differnew file mode 100644 index 000000000..fe5dfb6a2 --- /dev/null +++ b/doc/khelpcenter/userguide/kmousetool.png diff --git a/doc/khelpcenter/userguide/kmouth.png b/doc/khelpcenter/userguide/kmouth.png Binary files differnew file mode 100644 index 000000000..ebc59d291 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth.png diff --git a/doc/khelpcenter/userguide/kmouth2.png b/doc/khelpcenter/userguide/kmouth2.png Binary files differnew file mode 100644 index 000000000..3e435b772 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth2.png diff --git a/doc/khelpcenter/userguide/kmouth3.png b/doc/khelpcenter/userguide/kmouth3.png Binary files differnew file mode 100644 index 000000000..63a52ef65 --- /dev/null +++ b/doc/khelpcenter/userguide/kmouth3.png diff --git a/doc/khelpcenter/userguide/knode-identity.png b/doc/khelpcenter/userguide/knode-identity.png Binary files differnew file mode 100644 index 000000000..7039f440a --- /dev/null +++ b/doc/khelpcenter/userguide/knode-identity.png diff --git a/doc/khelpcenter/userguide/knode-mail-account.png b/doc/khelpcenter/userguide/knode-mail-account.png Binary files differnew file mode 100644 index 000000000..d8dc560a2 --- /dev/null +++ b/doc/khelpcenter/userguide/knode-mail-account.png diff --git a/doc/khelpcenter/userguide/knode-news-account.png b/doc/khelpcenter/userguide/knode-news-account.png Binary files differnew file mode 100644 index 000000000..66eb4adec --- /dev/null +++ b/doc/khelpcenter/userguide/knode-news-account.png diff --git a/doc/khelpcenter/userguide/knode-start.png b/doc/khelpcenter/userguide/knode-start.png Binary files differnew file mode 100644 index 000000000..709978a9c --- /dev/null +++ b/doc/khelpcenter/userguide/knode-start.png diff --git a/doc/khelpcenter/userguide/konq-sidebar.png b/doc/khelpcenter/userguide/konq-sidebar.png Binary files differnew file mode 100644 index 000000000..d58cdda3b --- /dev/null +++ b/doc/khelpcenter/userguide/konq-sidebar.png diff --git a/doc/khelpcenter/userguide/konq-simple.png b/doc/khelpcenter/userguide/konq-simple.png Binary files differnew file mode 100644 index 000000000..b2f40fda8 --- /dev/null +++ b/doc/khelpcenter/userguide/konq-simple.png diff --git a/doc/khelpcenter/userguide/konsole-intro.docbook b/doc/khelpcenter/userguide/konsole-intro.docbook new file mode 100644 index 000000000..35c49519b --- /dev/null +++ b/doc/khelpcenter/userguide/konsole-intro.docbook @@ -0,0 +1,108 @@ +<chapter id="konsole-intro"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +</author> +</authorgroup> +</chapterinfo> + + +<title>&konsole; Introduction</title> + +<para>Extremely brief intro to managing in a shell</para> + +<para>Emergency procedures: killing wild apps, etc</para> + +<para>SSH, sessions, envars, other fun things</para> + +<para>Some tips and tricks</para> + + +<!-- Some Content borrowed from the konsole handbook --> + +<para>&konsole; is a terminal emulator for the X Window System. It is +essentially based on the <ulink url="http://vt100.net">DEC's VT100</ulink> +and many of its succesors. &konsole; – also referred to as a +shell – is an +essential tool on &Linux; and &UNIX; based machines for fast and productive +work.</para> + +<para>Emergency Procedures:</para> + +<para>On &Linux; and &UNIX;-based systems every process runs independently in its own memory +space so it can't accidentally overwrite any other processes memory, unless +of course it has <systemitem class="username">root</systemitem> privileges. +If a process in &tde; crashes due to a bug one should not need to worry +about it accessing any other active process.</para> + +<para>To keep track of all system processes use the <command>top</command> +command or <command>ps</command> in &konsole;. Using these utilities will +make it much easier to find and kill off rogue programs.</para> + +<para>An example of using signals in &konsole;, &konqueror; has crashed +leaving behind a running process of +<application>nspluginviewer</application> which is taking up 12% of your +memory and 10% of your cpu cycles. In <command>top</command> use the <keycap>k</keycap> +command switch to kill the task. You will be prompted for the PID and then +the signal to send to kill it. For more on info on what signals you can +send to a running process see the full manual on signals (type +<command>man signal</command> in a &konsole; or go to +<userinput>#signal</userinput> in &konqueror;).</para> + +<para>SSH, sessions, envars, other fun things.</para> + +<para>If you are using &konsole; for remote administration consider using +&konsole;'s <quote>Session</quote> feature. To use this click on the menu +entry +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &konsole;</guimenuitem></menuchoice>. +From here choose the <guimenuitem>Sessions</guimenuitem> tab and fill in the +name for your new session. This will now become your default session when +you start &konsole;.</para> + +<para>When &konsole; is invoked <application>bash</application> specific +commands and &tde; specific variables are read and executed from +<filename>~/.bashrc</filename> or <filename>~/.bash_profile</filename>. +The preferred configuration file for user environments is +<filename>~/.bash_profile</filename>, the commands +<command>printenv</command> or <command>env</command> can be used to +display all currently set variables. To set a variable in the shell use +<command>VARNAME=<replaceable>value</replaceable></command>. For a full +list of variables that can be set in &tde; see the <ulink +url="http://wiki.kde.org/tiki-index.php?page=Environment+Variables">wiki +</ulink>.</para> + +<para>Some tips and tricks</para> + +<para>To rename &konsole;'s session use <keycombo +action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> and enter the new +name.</para> + +<para>If you find the need to run any &tde; program with <systemitem +class="username">root</systemitem> privileges, you can use the &tdesu; command with the <option>-c</option> switch +from the command line like this: <userinput><command>tdesu</command> +<option>-c -n <replaceable>PROGRAM</replaceable></option></userinput>, using +the <option>-n</option> switch will prevent &tde; from remembering your +passwords.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + + +<listitem><para>The &konsole; +Handbook has much more information about the features available in +&konsole;. You can read it in &khelpcenter; or by entering +<userinput>help:/konsole</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +</itemizedlist> + + + + + +</chapter> diff --git a/doc/khelpcenter/userguide/kopete.png b/doc/khelpcenter/userguide/kopete.png Binary files differnew file mode 100644 index 000000000..6d1fb850b --- /dev/null +++ b/doc/khelpcenter/userguide/kopete.png diff --git a/doc/khelpcenter/userguide/kppp-dialer-tab.png b/doc/khelpcenter/userguide/kppp-dialer-tab.png Binary files differnew file mode 100644 index 000000000..174248710 --- /dev/null +++ b/doc/khelpcenter/userguide/kppp-dialer-tab.png diff --git a/doc/khelpcenter/userguide/kppp-wizard.png b/doc/khelpcenter/userguide/kppp-wizard.png Binary files differnew file mode 100644 index 000000000..5e720df9a --- /dev/null +++ b/doc/khelpcenter/userguide/kppp-wizard.png diff --git a/doc/khelpcenter/userguide/messaging-intro.docbook b/doc/khelpcenter/userguide/messaging-intro.docbook new file mode 100644 index 000000000..f5e26e222 --- /dev/null +++ b/doc/khelpcenter/userguide/messaging-intro.docbook @@ -0,0 +1,170 @@ +<chapter id="messaging"> + +<chapterinfo> +<authorgroup> +<author> +<firstname>Peter</firstname> +<surname>Nuttall</surname> +</author> + +<author> +<firstname>Tom</firstname> +<surname>Albers</surname> +</author> + +</authorgroup> + +</chapterinfo> + + +<title>Introduction to messaging</title> + + +<para>The default way to send instant messages in &tde; is to use the <acronym>IM</acronym> +client, &kopete;. This is a multi-protocol <acronym>IM</acronym> client, meaning that it +handles several different protocols including <acronym>MSN</acronym>, +Jabber, <acronym>AOL</acronym> and <acronym>IRC</acronym>. It also has +useful features including support for &kaddressbook;, meta-contacts, +encryption support and lots more.</para> + +<screenshot> +<screeninfo>&kopete;, the &tde; IM client.</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kopete.png" format="PNG"/> </imageobject> +<textobject> +<phrase>&kopete;, the &tde; IM client.</phrase> +</textobject> +<caption> +<para>&kopete;, the &tde; IM client.</para> +</caption> +</mediaobject> +</screenshot> + +<sect1 id="messaging-getting-started"> +<title>How to get started</title> + +<para>Start up &kopete; from the menu (it can normally be found in the +Internet folder) When it starts up you should see a window with &kopete; +at the top, menus and a tool bar below, and then your contacts below. +You should add some accounts by clicking on the +<guimenu>Settings</guimenu> menu and selecting the <guimenuitem>Configure +Kopete</guimenuitem> option. By selecting the <guilabel>Accounts</guilabel> +option you should see a list of your accounts (initially empty) and +options to add new accounts and to edit or remove existing accounts. +By clicking on the <guibutton>add new account</guibutton> button, you can +add a new account using the wizard. When you have added an account, you can +connect to this account by clicking on the relevant icon at the bottom of +your main &kopete; window. This should make your contacts appear in the +contacts window.</para> + +</sect1> + +<sect1 id="meta-contacts"> +<title>Meta-contacts</title> + +<para>Meta contacts are one of the features of &kopete; that make sense +once you figure out what they are. Until you do, they annoy you. They are +basically a way of taking a contact on one network (such as +<acronym>MSN</acronym>) and linking it to another contact on a different +network. This is useful for when people have accounts on different networks +as you can chat to them without needing to know which account they are +signed on to. This also lets you assign names to your meta-contacts that +don't change when people change their names on their account, this is useful +if you have contacts who insist upon setting their +<acronym>MSN</acronym> nick to something like +<quote>=EF=81=8A</quote>.</para> + +<para>You can do other useful things with meta-contacts like link them to +entries in your address book. See <xref +linkend="integrated-messaging"/></para> + +</sect1> + +<sect1 id="irc"> +<title><acronym>IRC</acronym></title> + +<para>Internet Relay Chat (<acronym>IRC</acronym>) has been around far longer than most <acronym>IM</acronym> +systems, and is still widely used. It is mainly designed for group (many-to-many) communication in discussion forums called channels, but also allows one-to-one communication.</para> + +<para>The #kde channel is under Freenode, the <acronym>IRC</acronym> server, which provides an interactive environment for coordination and support of peer-directed projects, including -- mdash; and placing particular stress upon -- mdash; those relating to free software and open source projects, such as &tde;.</para> + + +<para>While &kopete; has a <acronym>IRC</acronym> plugin, and handles both channels and nicks well, +long time <acronym>IRC</acronym> users might prefer a client designed just +for that role, which is what <application>Konversation</application> is. It supports features such +as granting and taking op status, banning, easy nick changing, special +channel support for passwords and invites, and other things that the power +<acronym>IRC</acronym> users expect. It also is far better at handling +large channels such as #debian. If you have used another +power-<acronym>IRC</acronym> client before, you should have no trouble using +<application>Konversation</application>.</para> + + +</sect1> + +<sect1 id="integrated-messaging"> +<title>Linking email and messaging</title> + +<para>Did it happen to you? You received an email and the first thing +you would like to do is to give a reaction on it, but not by +email. So you switch to your instant messaging client and/or IRC +client and look if that person is online via MSN, Jabber or IRC. Well +&tde; 3.3 has made that a lot easier. A step-by-step manual:</para> + +<para>The requirements are &kmail;, &kaddressbook; and &kopete; +(<application>Konversation</application> should do as well). Make sure &kmail; is configured and +fully functional for email, and Kopete is well configured for IRC, +Jabber and/or MSN and/or any other protocol.</para> + +<para>If an email comes in from a contact you know, the first thing +you have to do is to add it to your address book. This can be achieved +by right clicking the address and choosing the entry <guibutton>Add to Address +Book</guibutton>.</para> + +<para>If you know the nickname which the user uses on, for example, IRC, +go to &kopete;. Go to +<menuchoice><guimenu>File</guimenu><guimenuitem>Add +contact</guimenuitem> </menuchoice>. In the wizard, select the +checkbox at the bottom called <guilabel>Use the TDE address book for +this contact</guilabel> and choose <guibutton>Next</guibutton>. Select +the right Address Book entry for that contact and press +<guibutton>Next</guibutton>. Now you can set the display name and the +group it belongs to for &kopete;. In the next screen select which +protocol should be used if you have set up more then one protocol. You +can select more than one protocol. After that, depending on the +protocol, there will be some other questions, which you can answer as +you like.</para> + +<para>Although we did specify to choose from the address book, +&kopete; has not automatically linked your contact to the address +book. So select the contact and choose +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Properties</guimenuitem> +</menuchoice>. On the <guilabel>General</guilabel> tab check the box +labeled <guilabel>Has address book entry</guilabel>. Press +<guilabel>...</guilabel> and select the contact. Close these two +windows.</para> + +<para>Now go to your addressbook, if you select the contact you will +see that it shows an extra field <guilabel>Presence</guilabel>, followed by the current +status. This status will automatically update as soon as the contact +goes away, offline, online, and so on. Now go to &kmail;, select another email and return to the original email (in other words: reload +the current email). You can now see behind the email address the +current state of your contact.</para> + +<para>If you want to chat with this person, just right click the +address in &kmail; and choose <guilabel>Chat With...</guilabel>. Your +Instant Messenger will start a conversation with the contact.</para> + +<!-- Add links to "further reading" here --> +<!--<itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/migrator-applications.docbook b/doc/khelpcenter/userguide/migrator-applications.docbook new file mode 100644 index 000000000..8e511861e --- /dev/null +++ b/doc/khelpcenter/userguide/migrator-applications.docbook @@ -0,0 +1,266 @@ +<chapter id="migrator-applications"> +<chapterinfo> +<authorgroup> +<author> +&Francis.Giannaros; &Francis.Giannaros.mail; +</author> +</authorgroup> +</chapterinfo> + +<title>Application Guide for Migrates</title> + +<!-- Section needs a +lot+ of work. I couldn't do any of the Mac equivalents, as I haven't used it before. More entries could be put in, too. --> + +<para>&tde; has many applications, often prefixed with (or containing) the letter k. The names are generally self-explanatory, but it can still be difficult sometimes to find the appropriate packages. Migrates from operating systems such as <trademark class="registered">Microsoft Windows</trademark> or <trademark class="registered">Apple Macintosh</trademark> might have some difficulty in locating an application for a particular job. Below is a table with an expansion on the &kmenu; and the respective Win/Mac equivalent.</para> + +<table><title>Sample Table</title> +<tgroup cols='6' align='left' colsep='1' rowsep='1'> +<colspec colname='c1'/> +<colspec colname='c2'/> +<colspec colname='c3'/> +<colspec colname='c5'/> +<colspec colnum='6' colname='c6' /> +<thead> +<row> + <entry namest="c1" nameend="c2" align="center"><para>&kmenu; Location</para></entry> + <entry><para>&tde; Application</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Equivalent</para></entry> + <entry><para><trademark class="registered">Macintosh</trademark> Equivalent</para></entry> + <entry><para>Notes</para></entry> +</row> +</thead> +<!--<tfoot> +<row> + <entry><para>f1</para></entry> + <entry><para>f2</para></entry> + <entry><para>f3</para></entry> + <entry><para>f4</para></entry> + <entry><para>f5</para></entry> +</row> +</tfoot>--> +<tbody> +<row> + <entry align="center" namest="c1" nameend="c2"><para>File Manager</para></entry> + <entry align="center"><para>&konqueror; (Home Folder)</para></entry> + <entry align="center"><para>Windows Explorer</para></entry> + <entry align="center"><para>Integrated file manager, content +viewer/player and web browser</para></entry> +</row> +<row> + <entry namest="c1" nameend="c2"><para>System and User Settings</para></entry> + <entry><para>&kcontrol;</para></entry> + <entry><para>Control Center</para></entry> +</row> +<row> + <entry morerows='1' valign='middle'><para>Office</para></entry> + <entry><para>Office Suite: + <orderedlist> + <listitem><para>Word Processing</para></listitem> + <listitem><para>Spreadsheets</para></listitem> + <listitem><para>Slide Presentations</para></listitem> + <listitem><para>Flowchart & Diagram Editing</para></listitem> + <listitem><para>Scalable Graphics</para></listitem> + <listitem><para>Image Manipulation</para></listitem> + <listitem><para>Report Generator</para></listitem> + <listitem><para>Chart</para></listitem> + <listitem><para>Database Creation</para></listitem> + <listitem><para>Formula Editor</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para> + <orderedlist> + <listitem><para>&kword;</para></listitem> + <listitem><para>&kspread;</para></listitem> + <listitem><para>&kpresenter;</para></listitem> + <listitem><para>&kivio;</para></listitem> + <listitem><para>&karbon14;</para></listitem> + <listitem><para>&chalk;</para></listitem> + <listitem><para>&kugar;</para></listitem> + <listitem><para>&kchart;</para></listitem> + <listitem><para>&kexi;</para></listitem> + <listitem><para>&kformula;</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para> + <orderedlist> + <listitem><para><application><acronym>MS</acronym> Word</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Excel</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Powerpoint</application></para></listitem> + <listitem><para><application>Adobe Illustrator</application></para></listitem> + <listitem><para><application>Adobe Photoshop</application></para></listitem> + <listitem><para><application>Report Generator</application></para></listitem> + <listitem><para><application>Chart</application></para></listitem> + <listitem><para><application><acronym>MS</acronym> Access</application></para></listitem> + </orderedlist> + + + +</para></entry> + +<!--Fill in Mac equivalents + <entry><para>Office Suite: +<orderedlist> + <listitem><para>Word Processing</para></listitem> + <listitem><para>Spreadsheets</para></listitem> + <listitem><para>Slide Presentations</para></listitem> + <listitem><para>Flowchart & Diagram Editing</para></listitem> + <listitem><para>Scalable Graphics</para></listitem> + <listitem><para>Image Manipulation</para></listitem> + <listitem><para>Report Generator</para></listitem> + <listitem><para>Chart</para></listitem> + <listitem><para>Database Creation</para></listitem> + <listitem><para>Formula Editor</para></listitem> +</orderedlist> + +</para></entry>--> + +</row> + +<row> + <entry><para>Personal Information Management: + <orderedlist> + <listitem><para>Mail</para></listitem> + <listitem><para>Address Book</para></listitem> + <listitem><para>Personal Organizer</para></listitem> + <listitem><para>News Reader</para></listitem> + <listitem><para>Pop-up Notes</para></listitem> + <listitem><para><acronym>RSS</acronym> Reader</para></listitem> + </orderedlist> + + </para></entry> + <entry><para> + <orderedlist> + <listitem><para>&kmail;</para></listitem> + <listitem><para>&kaddressbook;</para></listitem> + <listitem><para>&korganizer;</para></listitem> + <listitem><para>&knode;</para></listitem> + <listitem><para>&knotes;</para></listitem> + <listitem><para>&akregator;</para></listitem> + </orderedlist> + + </para></entry> + + <entry><para><application><acronym>MS</acronym> Outlook</application></para></entry> + + <entry><para>The Personal Information Manager is &kontact;; all other &tde; <acronym>PIM</acronym> applications integrate into it.</para></entry> + +</row> + +<row> + <entry morerows='2' valign='middle'><para>Internet</para></entry> + <entry><para>Web Browser</para></entry> + <entry><para>&konqueror;</para></entry> + <entry><para><acronym>MS</acronym> Internet Explorer</para></entry> + <entry><para><application>Safari</application></para></entry> + <entry><para>Integrated file manager, web browser, <acronym>FTP</acronym> manager, and univerval viewing application.</para></entry> + + +</row> + +<row> + <entry><para>Instant Messaging</para></entry> + <entry><para>&kopete; + <itemizedlist> + <listitem><para><acronym>AIM</acronym></para></listitem> + <listitem><para><acronym>MSN</acronym></para></listitem> + <listitem><para><acronym>ICQ</acronym></para></listitem> + <listitem><para>Jabber</para></listitem> + <listitem><para>Novell GroupWise</para></listitem> + <listitem><para>Yahoo</para></listitem> + <listitem><para><acronym>IRC</acronym></para></listitem> + <listitem><para><acronym>SMS</acronym></para></listitem> + </itemizedlist> + +</para></entry> + <entry><para><acronym>MSN</acronym> Messenger</para></entry> + <entry><para>Comprehensive multi-network compatible instant messaging software</para></entry> +</row> + +<row> + <entry><para>Chat (<acronym>IRC</acronym>)</para></entry> + <entry><para>&ksirc;</para></entry> + <entry><para><application>mIRC</application></para></entry> +</row> + +<row> + <entry morerows='4' align="center"><para>Multimedia</para></entry> + <entry><para>Music/Audio</para></entry> + <entry><para>&juk;</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Media Player</para></entry> +</row> + +<row> + <entry><para>&CD;/<acronym>DVD</acronym> Burner</para></entry> + <entry><para><application>K3b</application></para></entry> + <entry><para>Nero</para></entry> +</row> + +<row> + <entry><para>Video Player</para></entry> + <entry><para>&noatun;</para></entry> + <entry><para><trademark class="registered">Windows</trademark> Media Player</para></entry> +</row> + +<row> + <entry><para>Audio &CD; Ripper</para></entry> + <entry><para><application>KAudioCreator</application></para></entry> +</row> + +<row> + <entry><para>Sound Controls</para></entry> + <entry><para>&kmix;</para></entry> +</row> + +<row> + <entry><para>Terminal</para></entry> + <entry><para>&konsole;</para></entry> + <entry><para><application>CMD</application></para></entry> +</row> + +<row> + <entry><para>User Manager</para></entry> + <entry><para>&kuser;</para></entry> + <entry><para>User Manager</para></entry> +</row> + +<row> + <entry><para>Package Manager</para></entry> + <entry><para>&kpackage;</para></entry> + <entry><para><application>Add/Remove Programs</application></para></entry> +</row> + +<row> + <entry morerows='2' align="center"><para>Utilities</para></entry> + <entry><para>Archiver</para></entry> + <entry><para>&ark;</para></entry> + <entry><para><application>WinZip</application></para></entry> +</row> + +<row> + <entry><para>Password Manager</para></entry> + <entry><para><application>TDEWallet</application></para></entry> +</row> + +<row> + <entry><para>Text Editor</para></entry> + <entry><para>&kate;</para></entry> + <entry><para>Notepad</para></entry> +</row> + + +</tbody> +</tgroup> + +</table> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>Many more &tde; applications are available from the &tde; extragear (see <xref linkend="extragear-applications" /> for more information) or from <ulink url="http://kde-apps.org">http://kde-apps.org</ulink>.</para></listitem> +<listitem><para>Reference: <ulink url="http://kudos.berlios.de/kf/kf1.html#pkgtablestock">http://kudos.berlios.de/kf/kf1.html#pkgtablestock</ulink></para></listitem> +</itemizedlist> + +</chapter>
\ No newline at end of file diff --git a/doc/khelpcenter/userguide/migrator-dictionary.docbook b/doc/khelpcenter/userguide/migrator-dictionary.docbook new file mode 100644 index 000000000..d92c328c9 --- /dev/null +++ b/doc/khelpcenter/userguide/migrator-dictionary.docbook @@ -0,0 +1,20 @@ +<chapter id="migration-dictionary"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Dictionary for Migrators</title> + +<para>Tables of terminology differences</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/net-connection-setup.docbook b/doc/khelpcenter/userguide/net-connection-setup.docbook new file mode 100644 index 000000000..4e59dab48 --- /dev/null +++ b/doc/khelpcenter/userguide/net-connection-setup.docbook @@ -0,0 +1,218 @@ +<chapter id="setup"> + +<chapterinfo> +<authorgroup> +<author> +&Lauri.Watts; +</author> +</authorgroup> +</chapterinfo> + + +<title>Setting up an Internet Connection</title> +<!-- Contents shamelessly stolen from the KPPP manual, written by --> +<!-- Lauri --> + +<para>&tde; offers a complete Internet experience, with all the +programs you'll need to make the most of the Web, email, Usenet and +many other Internet technologies. But before you can enjoy &tde;'s +advanced features, you'll need to get online. Here's how:</para> + +<para>If you're using <quote>dialup</quote> (that is, connecting to +the Internet with a modem connected to a telephone line), you'll want +to set up the &tde; dialing program, &kppp;. If that sounds +complicated, don't worry: &kppp; has an advanced configuration wizard, +which will usually take the pain out of setting up your dialup +connection. Take a look at the next two sections for more +details.</para> + +<para>If you're using a broadband connection, or connecting via a +local network, things are easier (from the point of view of +&tde;). Once you've set up the connection with the tools provided by +your &Linux; or &UNIX; distribution, &tde; will use the connection +automatically.</para> + +<sect1 id="getting-online"> +<title>Getting online the easy way</title> + +<sect2 id="things-to-prepare"> +<title>A few things you should have ready before you start</title> + +<para>If you have a fairly modern &Linux; distribution, you might find the rest +of this document superfluous. &kppp; comes with a clever little wizard that in +many cases can have you up and running with an internet connection in just a few +minutes.</para> + +<para>Whether using the wizard or not, you should know the following information +before you begin:</para> + +<itemizedlist> +<listitem><para>Your <acronym>ISP</acronym> modem pool phone +number.</para></listitem> +<listitem><para>Your username and password for your +<acronym>ISP</acronym>.</para></listitem> +<listitem><para>Your <acronym>ISP</acronym>'s <acronym>DNS</acronym> servers +(one is sufficient, but two is better).</para></listitem> +</itemizedlist> + +<para>Other optional information you should find out to fully access your +<acronym>ISP</acronym>'s services are:</para> + +<itemizedlist> +<listitem><para>The incoming mail server address (often <systemitem +class="systemname">pop.yourisp.com</systemitem> or <systemitem +class="systemname">mail.yourisp.com</systemitem>).</para><para>Also find out if +your <acronym>ISP</acronym> uses the POP3 protocol or IMAP.</para></listitem> +<listitem><para>The outgoing (<acronym>SMTP</acronym>) mail server address (it +could be the same as the incoming mail server, or it is often called something +like <systemitem +class="systemname">smtp.yourisp.com</systemitem>).</para></listitem> +<listitem><para>The Usenet News (<acronym>NNTP</acronym>) server address (possibly +<systemitem class="systemname">news.yourisp.com</systemitem> or <systemitem +class="systemname">nntp.yourisp.com</systemitem>).</para></listitem> +<listitem><para>Any proxy servers your <acronym>ISP</acronym> has set +up.</para></listitem> +</itemizedlist> + +<para>All this information is probably available on any paperwork you received +from your <acronym>ISP</acronym> when you signed up with them, or you can find +it out from your <acronym>ISP</acronym>'s support telephone line.</para> + +<para>Armed with the above, and a fairly recent default installation +of &Linux;, you may well find that setting up an internet connection +is as simple as running the &kppp; wizard.</para> + + +</sect2> + +</sect1> + +<sect1 id="wizard"> +<title>The &kppp; wizard</title> + +<sect2 id="starting-the-wizard"> +<title>Starting the Wizard.</title> + +<para>You can start the wizard from &kppp;'s initial screen. Start &kppp; from +your <guimenu>TDE</guimenu> menu, where you will find its entry in the +<guisubmenu>Internet</guisubmenu> as <guimenuitem>&kppp; (Internet Dial-Up +Tool</guimenuitem>.</para> + +<para>The following dialog will appear:</para> + +<screenshot> +<screeninfo>The &kppp; dialer startup dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kppp-dialer-tab.png" format="PNG"/> +</imageobject> +<textobject><phrase>The &kppp; dialer startup dialog</phrase> +</textobject> +<caption><para>The &kppp; dialer startup dialog</para></caption> +</mediaobject> +</screenshot> + +<para>It will probably not have any entries to begin with, and that's +what we're about to do now.</para> + +<para>Click the <guibutton>Configure...</guibutton> button to begin setting up a new +Internet connection.</para> +<!-- the following is outdated and has to be rewritten 27.06.2006 lueck--> +<para>The wizard will offer you three choices, <guibutton>Wizard</guibutton>, +<guibutton>Dialog Setup</guibutton> and <guibutton>Cancel</guibutton></para> + +<screenshot> +<screeninfo>The wizard asks you what you want to do...</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="kppp-wizard.png" format="PNG"/> +</imageobject> +<textobject><phrase>The wizard asks you what you want to +do...</phrase></textobject> +<caption><para>The wizard asks you what you want to do</para></caption> +</mediaobject> +</screenshot> + +<variablelist> +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem><para>Choose this if you really don't want to be setting up a new +account right now. The message box will go away, and you will be left with the +dialer window as before.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Wizard</guibutton></term> +<listitem><para>If you have a fairly standard modem, and use one of the larger +ISP's for your country, the wizard will probably be able to set you up +immediately with a working Internet Connection. Try this first, before you try +to set up the connection manually.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Dialog Setup</guibutton></term> +<listitem><para>If you don't succeed with the Wizard, or you just want to do +things yourself, choose this. The wizard currently is only useful for a small +subset of countries and Internet Providers.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>For the purposes of this chapter, we'll assume you are choosing +<guibutton>Wizard</guibutton>, and the dialog based setup will be +described in a later chapter.</para> + +</sect2> + +<sect2 id="finishing-the-wizard"> +<title>The Rest of the Wizard</title> + +<para>The first window you see contains just introductory text, explaining the +things you read about in the first section of this chapter. Click +<guibutton>Next</guibutton> to move on.</para> + +<para>The second window asks you to choose the country you live in. Not all +countries are represented here, and if the country you live in is not listed, +you will have to click <guibutton>Cancel</guibutton>, in which case the Dialog-based setup will start for you to continue +with.</para> + +<para>On the next window, you will be given a choice of Internet +Providers that &kppp; knows about, based on your choice of location in +the previous window. Again, if your <acronym>ISP</acronym> is not +listed here, you will have to click <guibutton>Cancel</guibutton> and +do your setup in the Dialog-based setup</para> + +<para>You will now be asked to enter your username and password for your +internet connection. Please note, that for some <acronym>ISP</acronym>s this +differs from your mail account user name and password, so make sure you use the +right one. Choose <guibutton>Next</guibutton> to continue.</para> + +<para>On the next window, you have a chance to enter any special dial prefixes +you might have - for example, if you must dial <quote>0</quote> for an outside +line, or if you have a prefix you can dial to turn off call waiting. Choose +<guibutton>Next</guibutton> to continue.</para> + +<para>And that's all! If you want to revisit any of your choices, you can use +the <guibutton>Back</guibutton> and <guibutton>Next</guibutton> buttons to move +back and forth through the dialogs. When you're done with your settings, click the +<guibutton>Finish</guibutton> button, and you're all done.</para> + +<para>If you need more details, you can read the full &kppp; +manual in the &tde; Help Center, or by typing +<userinput>help:/kppp</userinput> in the <guilabel>Location</guilabel> +bar in &konqueror;.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect2> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/networking-with-windows.docbook b/doc/khelpcenter/userguide/networking-with-windows.docbook new file mode 100644 index 000000000..08d57e81e --- /dev/null +++ b/doc/khelpcenter/userguide/networking-with-windows.docbook @@ -0,0 +1,110 @@ +<sect1 id="networking-with-windows"> +<sect1info> +<authorgroup> +<author> +<firstname>Gardner</firstname> +<surname>Bell</surname> +</author> +</authorgroup> +</sect1info> + + +<title>Networking With Windows</title> + +<para> This section is borrowed and modified from Alexander Neundorf's +README file on LISa.</para> + +<para>&tde; features two powerful servers called the Lan Information +Server (<application>LISa</application>) and Restricted Lan +Information Server (<application>resLISa</application>) which are used +to identify CIFS and other servers on your local network providing a +function similar to <quote>Network Neighbourhood</quote> in +&Microsoft; &Windows;.</para> + +<sect2 id="How-It-Works"> +<title>How It Works</title> + +<para>&lisa; only depends on the TCP/IP stack so samba configuration is not +required to make it work but the <ulink +url="http://www.samba.org">samba</ulink> package is a dependency. To find +hosts on your local network you set a range of IP-Addresses in your +configuration file that &lisa; will check. When you start the &lisa; daemon +it will send a <ulink url="http://www.ietf.org/rfc/rfc792.txt">ICMP</ulink>, +echo request message to all the IP addresses given in the configuration file +and await a response.</para> + +<note><para>The &lisa; daemon requires root privileges to open the socket, +but once the socket has been established root privileges are immediately +dropped.</para></note> + +<para>You can also execute &lisa; using <command>nmblookup +<option>"*"</option></command>.<note><para>If you do not have the +<command>nmblookup</command> program it can be found at <ulink +url="http://www.samba.org">http://www.samba.org</ulink> or through packages +provided by your distribution</para></note>. The samba command +<command>nmblookup <option>"*"</option></command> will send a broadcast +message to the attached network and any host that is running the +smb-services will send a reply stating that it is accepting +connections.</para> +</sect2> + +<sect2 id="resLISa"> +<title><application>resLISa</application></title> + +<para>If your company network has very strict guidelines governing what +ports can and cannot be opened you will have to use &reslisa; to communicate +with other hosts on your network. Because &reslisa; cannot ping entire +networks or address ranges you will have to add each host by name to your +confiuration file. Currently you are able to add up to 64 hosts, and these +addresses are pingable.</para> + +<note><para>&reslisa; will only provide the information over a &UNIX; domain +socket, &ie; not over the network. The name of the socket is +<filename>/tmp/resLISa-<replaceable>YourLoginName</replaceable></filename>, +so &reslisa; can be safely run on the same machine by more than one +user.</para></note> +</sect2> + +<sect2 id="configuration"> +<title>Configuration</title> + +<para>At startup &lisa; first parses the configuration file in the users +home directory under <filename>$<envar>HOME</envar>/.lisarc</filename>. If +this file does not exist &lisa; will then look for a system wide +confiuration located at <filename>/etc/lisarc</filename>. Now for a sample +example configuration file:</para> + +<programlisting> +PingAddresses = 192.168.100.0/255.255.255.0;192.168.100.10-192.168.199.19;192.168.200.1; +PingNames = my_host1;my_host2 #Hosts by name (required for <application>resLISa</application>) +AllowedAddresses = 192.168.0.0/255.255.0.0 +BroadcastNetwork = 192.168.100.0/255.255.255.0 +SearchUsingNmblookup = 1 #also try nmblookup +FirstWait = 30 #30 one-hundredth's of a second +SecondWait = -1 #Only try once +#SecondWait = 60 #Try twice and wait 0.6 seconds +UpdatePeriod = 300 #Update every 300 sec's +DeliverUnnamedHosts = 0 #Don't publish unnamed hosts +MaxPingsAtOnce = 256 #Send up to 256 ICMP echo requests at once +</programlisting> + +<para>&lisa; can also be configured graphically in the +<menuchoice><guimenuitem>&kcontrolcenter;</guimenuitem><guisubmenu>Internet +& Network</guisubmenu><guimenuitem>Local Network Browsing</guimenuitem> +</menuchoice> item in the &kmenu;. However, to use this option &lisa; must +be started with the <option>-K</option> command line switch.</para> + +<!--TODO add a section explaining graphical configuration? --> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>For a full list of command line switches and further +examples see the entire &lisa; manual by entering +<userinput>help:/lisa</userinput> in &konqueror;.</para> +</listitem> +</itemizedlist> + + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/noatun-icon.png b/doc/khelpcenter/userguide/noatun-icon.png Binary files differnew file mode 100644 index 000000000..15131ce39 --- /dev/null +++ b/doc/khelpcenter/userguide/noatun-icon.png diff --git a/doc/khelpcenter/userguide/noatun.png b/doc/khelpcenter/userguide/noatun.png Binary files differnew file mode 100644 index 000000000..9d0d2d764 --- /dev/null +++ b/doc/khelpcenter/userguide/noatun.png diff --git a/doc/khelpcenter/userguide/oggfolder.png b/doc/khelpcenter/userguide/oggfolder.png Binary files differnew file mode 100644 index 000000000..130fc63b7 --- /dev/null +++ b/doc/khelpcenter/userguide/oggfolder.png diff --git a/doc/khelpcenter/userguide/open-file-dialog.png b/doc/khelpcenter/userguide/open-file-dialog.png Binary files differnew file mode 100644 index 000000000..2ebd2b254 --- /dev/null +++ b/doc/khelpcenter/userguide/open-file-dialog.png diff --git a/doc/khelpcenter/userguide/panel-and-desktop.docbook b/doc/khelpcenter/userguide/panel-and-desktop.docbook new file mode 100644 index 000000000..c89a2539b --- /dev/null +++ b/doc/khelpcenter/userguide/panel-and-desktop.docbook @@ -0,0 +1,298 @@ +<chapter id="panel-and-desktop"> + +<title>The Panel and the Desktop</title> + +<sect1 id="kicker-panel"> +<title>&kicker;, the &tde; Panel</title> + +<indexterm +significance="preferred"><primary>Panel</primary></indexterm> +<indexterm +significance="preferred"><primary>&kicker;</primary></indexterm> + +<para>&kicker; is the application launcher panel of the Trinity Desktop +Environment. By default, it appears along the bottom of the screen, +and takes up the whole of the width of the screen, but this is +configurable. &kicker; is something of a one-stop shop for (almost!) +everything that you might want quick access to. Besides the &ticon; +Menu, where you can start applications, &kicker; is also capable of +running docked applets like the pager, the taskbar or the clock, and +extensions, such as child panels. With all these options, you will +probably want to configure &kicker; so that it works best for you. The +next section describes some common ways to customize the panel.</para> +<!-- TODO: steal screenies from kicker manual --> +</sect1> + +<!-- FIXME: Titles and id's in this section should be more consistent --> +<sect1 id="kicker-configuring"> +<title>Configuring &kicker;</title> + + +<sect2 id="customize-panel-icons"> +<title>Customizing the icons on the panel</title> + +<para>When you first start &tde;, kicker displays some icons next to +the <guimenu>TDE</guimenu> menu. These can be used to start the +applications that they represent. To see which application is launched + by each icon, hold the mouse cursor over the icon until a tooltip (a +small popup label) appears telling you the name of the application.</para> + +<para>These default icons might not represent the applications you use +most often, so you can remove the ones you do not want and add icons +for other applications that you use. To remove an icon, &RMB;-click on +the icon, and select <guilabel>Remove <replaceable>application +name</replaceable> Button</guilabel> in the popup menu that +appears. To add a new icon, &RMB;-click on an empty space on the +panel, and follow the menu entry <guisubmenu>Add Application to Panel +</guisubmenu>. This leads you to a copy of the +<guimenu>TDE</guimenu> menu, where you can find all of the &tde; +applications. For example, to add an icon for the &juk; music player, +follow through the menus to <menuchoice><guisubmenu>Add Application +to Panel</guisubmenu><guisubmenu>Multimedia</guisubmenu><guimenuitem>&juk; (Music +Player)</guimenuitem></menuchoice>. The icon will appear on the +panel in the space that you <mousebutton>right</mousebutton>-clicked on.</para> + +</sect2> + + +<sect2 id="adding-extras-and-applets"> +<title>Adding extras and applets</title> + +<indexterm><primary>Applets</primary></indexterm> + +<para>&kicker; can add many types of items as well as application +launch icons. You can find these items using the same menu as before, +but this time selecting +<guisubmenu>Add Applet to Panel...</guisubmenu> +or +<guisubmenu>Add New Panel</guisubmenu>. +The items in the <guilabel>Add Applet</guilabel> window are small +programs that can reside on the panel. An example of an applet is the +<guilabel>Desktop Preview & Pager</guilabel><indexterm><primary>Pager</primary></indexterm>, which shows a small image of each of your virtual +desktops. (For more information about virtual desktops, see <xref +linkend="using-multiple-desktops" />). You can switch to a different +virtual desktop by clicking on its image in the desktop pager. +<!-- TODO: screenie --></para> +<para>You can find information about the other applets available for +&kicker; in the &kicker; manual. Just enter +<userinput>help:/kicker</userinput> in the +<guilabel>Location</guilabel> bar in &konqueror;.</para> +</sect2> + +<sect2 id="the-system-tray"> +<sect2info> +<authorgroup> +<author> +<personname> +<firstname>Simon</firstname> +<surname>Vermeersch</surname> +</personname> +<email>[email protected]</email> +</author> +</authorgroup> +</sect2info> + +<title>The System Tray</title> + +<!-- Simon Vermeersch --> +<para>The system tray is where programs that are run, but not directly needed are +kept. Some programs (like music players) are shown there, because you +probably want to keep them open, but so that it does not take too much space on +your screen, it will put an icon in the system tray.</para> + +<para>When you <mousebutton>right</mousebutton> click on such an icon, a +popup menu will appear where you can see some options of the program (like +play, pause, stop, ... in a music player).</para> +<para>When you <mousebutton>left</mousebutton> click on it, the main window +of the program will appear. If you hover your mouse above the icon, a tool +tip will appear with some information (in the music player case information +like the current song). Programs that normally support system tray icons are +music players, IRC clients, organizers, ...</para> + +<para>In most of these programs you can configure if you want an icon to be +shown or not. For other tricks and tips with the system tray see the section on <xref linkend="system-tray" />.</para> + +</sect2> + +<sect2 id="removing-panel-items"> +<title>Removing Panel Items</title> + +<!-- TODO: Need a screenie to show the handles, since they're not very --> +<!-- easy to describe (and also very small - possible --> +<!-- accessibility/usability issue? --> +<para>You can remove applets and other special items from the panel +using the arrow on its handle on the applet's left. Right click on the +arrow, and choose <guimenuitem>Remove <replaceable>applet +name</replaceable></guimenuitem>.</para> +</sect2> + +</sect1> + +<sect1 id="kicker-taskbar"> +<title>The Taskbar</title> +<!-- TODO: Screenie (again), write more about why taskbar is useful --> +<para>The taskbar is an item on the panel which displays an entry for +each window that you have opened. You can use the taskbar to switch +between windows by clicking on the entry of the window you want to +activate. The taskbar has entries for windows on each virtual desktop, +including windows which have been minimized.</para> + +</sect1> + +<sect1 id="using-the-clipboard"> +<sect1info> +<authorgroup> +<author>&Philip.Rodrigues; +</author> +</authorgroup> +</sect1info> + +<title>Using the Clipboard</title> + +<indexterm><primary>Clipboard</primary></indexterm> + +<para>Very often, it's useful to move some text, or an object in a +program, from one place to another. It's also very common to need to +duplicate some text, for example, if you're typing the same thing +several times. The system used for doing this is known as the +<firstterm>clipboard</firstterm>. There are two slightly different ways to use this system, +known technically as the <quote>selection</quote> and the +<quote><glossterm>clipboard</glossterm></quote>. We'll look at them separately: +</para> + +<!-- TODO: Describe how to select text --> + +<sect2 id="the-selection"> +<title>The Selection</title> +<indexterm><primary>Selection</primary></indexterm> + +<para>This method uses the mouse to copy text from one place to +another. The method is: +<orderedlist> + +<listitem><para>Select the text you want to copy.</para> +</listitem> + +<listitem><para>Click the &MMB; at the place you want the text to be +copied to. This can be in the same program as you copied the text +from, or in another program entirely.</para> +</listitem> +</orderedlist> +If you have three buttons on your mouse, this is easy, but if not, all +is not lost! If you have only two buttons, try clicking them both at +the same time instead of the &MMB;. +<!-- Should we mention Emulate3Buttons in XF86Config here? --> +</para> +</sect2> + +<sect2 id="the-clipboard-proper"> +<title>The Clipboard</title> +<indexterm><primary>Cut</primary></indexterm> +<indexterm><primary>Paste</primary></indexterm> +<para>With this method, you can copy text, or <quote>cut</quote> it +(that is, remove it from one place and move it to another). You can +use either the mouse and the menu entries, or the keyboard with this +method. I'll list both ways, with the menu entry to use, followed by +the keyboard shortcut which will do the same thing, like this:</para> +<para> +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem> +</menuchoice> </para> +<para> +<orderedlist> +<title>Moving (<quote>Cutting</quote>) Text</title> +<listitem><para>Select the text you want to cut.</para> +</listitem> +<listitem><para>From the menu, select +<menuchoice><shortcut><keycombo + action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem> +</menuchoice>, and the text will be removed from its current location.</para> +</listitem> +<listitem><para>Position the text cursor at the point you want to +insert the text. This can be in the same application you got the text +from, or another application entirely. Select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem> +</menuchoice>, and the text will appear at the point where you placed +the cursor.</para> +</listitem> +</orderedlist> +</para> + +<para> +Copying text from one place to another is very similar: +<orderedlist> +<title>Copying Text</title> +<listitem><para>Select the text you want to copy.</para> +</listitem> +<listitem><para>From the menu, select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem> +</menuchoice>, and the text will be copied in the clipboard.</para> +</listitem> +<listitem><para>Position the text cursor at the point you want to +insert the text. This can be in the same application you got the text +from, or another application entirely. Select +<menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem> +</menuchoice></para> +</listitem> +</orderedlist> +</para> + + +</sect2> +<sect2 id="klipper"> +<title>More Advanced Clipboard Use</title> +<indexterm><primary>&klipper;</primary></indexterm> +<indexterm><primary>Clipboard</primary><secondary>History</secondary></indexterm> +<!-- Should we describe this advanced use, or just point to it? --> +<para>The instructions above describe the default <glossterm>clipboard</glossterm> +behavior. The &klipper; application, which you can add as an applet in +the panel (see <xref linkend="kicker-configuring"/> for instructions +on how to do this), provides some useful clipboard-related features, +like a clipboard history, and the ability to change the behavior of +the clipboard and selection. Take a look at the &klipper; Handbook for +more information.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>You can find more information about &kicker;, the +&tde; Panel, in &khelpcenter; or by entering +<userinput>help:/kicker</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +<listitem><para>The &klipper; +Handbook has information about the advanced clipboard management +features in &tde;. You can read it in &khelpcenter; or by entering +<userinput>help:/klipper</userinput> in &konqueror;'s +<guilabel>Location</guilabel> bar.</para> +</listitem> + +</itemizedlist> + + +</sect2> + +</sect1> + +<sect1 id="kicker-related-information"> +<title>Related Information</title> +<itemizedlist> +<title>Related Information</title> +<listitem><para>Though some information has been presented here, there is a lot more information on &kicker; tips, options, tricks and hacks, in the &kicker; handbook. You can access it via the &khelpcenter; or by simply entering <userinput>help:/kicker</userinput> in the &konqueror; Location toolbar.</para> +</listitem> +</itemizedlist> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/pdf-files.docbook b/doc/khelpcenter/userguide/pdf-files.docbook new file mode 100644 index 000000000..73d951e18 --- /dev/null +++ b/doc/khelpcenter/userguide/pdf-files.docbook @@ -0,0 +1,22 @@ +<sect1 id="pdfs"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>PDF Files</title> + +<para>How to print to a pdf file</para> + +<para>Viewing pdf files</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/playing-audiocds.docbook b/doc/khelpcenter/userguide/playing-audiocds.docbook new file mode 100644 index 000000000..26e7e494c --- /dev/null +++ b/doc/khelpcenter/userguide/playing-audiocds.docbook @@ -0,0 +1,124 @@ +<sect1 id="audio-cd"> +<sect1info> +<author> +<personname> +<firstname>Deepak</firstname> +<surname>Sarda</surname> +</personname> +<email>[email protected]</email> +</author> +</sect1info> + +<title>Audio CD Ripping in &tde;</title> + +<para>The conventional way of ripping Audio CDs to MP3 or Ogg files is to +use a standalone program such as <trademark class="registered"><application>iTunes</application></trademark>, Winamp or &tde;'s own +<application>KAudioCreator</application>. But if we stick to conventions, +where's the fun?! So in this article, I am going to show you how to feel +elite by ripping your CDs in the, umm.. elite way. ;-) </para> + +<sect2 id="audio-cd-ingredients"> +<title>Ingredients</title> + +<para>What do we need to be cool? Vanilla &tde;, without any extra +ingredients, will be able to rip your CDs. But to encode them, you'll need +to install the relevant codecs. At the moment, Ogg Vorbis, MP3 and FLAC formats +are supported. To enable encoding to these formats, you'll have to install +libogg, lame and flac respectively. How exactly you install these depends on +your distribution: take a look at their documentation to find out how.</para> + +<para>Once you have your favourite codec(s) installed, open &kcontrolcenter; and navigate your way to <menuchoice><guimenu>Sound & +Multimedia</guimenu><guimenuitem>Audio CDs</guimenuitem></menuchoice> +and configure the settings on the various tabs to your liking. You can leave +everything in the default state if you so wish, but it's helpful to take a +look so you at least know what's on offer. Again, take a look at +<menuchoice><guimenu>Sound & Multimedia</guimenu><guimenuitem>CDDB +Retrieval</guimenuitem></menuchoice> and change anything that's not to your +liking. <acronym>CDDB</acronym>, in case you didn't know, stands for CD DataBase (or Compact +Disc DataBase in it's more free flowing form). This functionality enables +&tde; to retrieve the Artist/Album/Track information about your CDs from the +Internet. This metadata is also used to write tags to the MP3 or Ogg files +that you'll be encoding your CDs to anytime now.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="ripsettings.png"/> +</imageobject> +</mediaobject> + +</sect2> + +<sect2 id="audio-cd-recipe"> +<title>Recipe</title> + +<para>Without further delay, let's get down to the business of being cool. +First, pop in the CD you want to rip (obviously!). Next, fire up a +&konqueror; window and open the <guilabel>Services</guilabel> tab on the Navigation panel. The +Navigation panel sits on the left side of the window, as shown in the +screenshot below. If it's not visible, you can produce it out of thin air by +pressing the magic <keycap>F9</keycap> key.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="services.png"/> +</imageobject> +</mediaobject> + + +<para>Now click on Audio CD Browser and in a few seconds, you'll see a lot +of folders which you can start browsing. If it's taking some time to show +anything, it's because it's trying to fetch information about the CD from +the CDDB database you configured earlier.</para> + +<para>In the screenshot below, you can see the contents of the Ogg Vorbis +folder. It shows all the songs in the Ogg format; it even shows their file +size! But, you and I both know that audio CDs don't contain Ogg tracks. So +what exactly is happening here?</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="oggfolder.png"/> +</imageobject> +</mediaobject> + + +<para>All the folders you see under Audio CD Browser are virtual folders. +They show contents of the CD through different filters, so to speak. When +you open the Ogg Vorbis folder, you are actually seeing the contents of the +CD <emphasis>as if</emphasis> it were stored in the Ogg format. You can go through the other +folders and you'll find MP3, flac and wav representations of the CD's +contents. You can even see the approximate file sizes when encoded in the +various formats.</para> + + +<para>So how do we rip and encode the CD? I think you can guess the answer +by now. Just decide which format you wish to rip to, open that folder, and +copy and paste those files in your target folder. That's it! &tde; will start +ripping and encoding the files on the fly! If you copy any of the files in +the <guilabel>Full CD</guilabel> folder, you'll be ripping the entire CD as +one continuous stream.</para> + + +<mediaobject> +<imageobject> +<imagedata format="PNG" fileref="rip.png"/> +</imageobject> +</mediaobject> + + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <application>amaroK</application> website at +<ulink url="http://amarok.sf.net">http://amarok.sf.net</ulink> has the +latest news and information about <application>amaroK</application>.</para> +</listitem> +</itemizedlist> + +<!-- TODO: Add a link to the full audiocd documentation as soon as --> +<!-- it's fixed :-) --> +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/playing-movies.docbook b/doc/khelpcenter/userguide/playing-movies.docbook new file mode 100644 index 000000000..135289a02 --- /dev/null +++ b/doc/khelpcenter/userguide/playing-movies.docbook @@ -0,0 +1,30 @@ +<sect1 id="playing-movies"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Playing Movies</title> + +<para>Intro to xine plugin to aRts</para> + +<para>Alternatives (kaffeine, kmplayer)</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> diff --git a/doc/khelpcenter/userguide/playing-music.docbook b/doc/khelpcenter/userguide/playing-music.docbook new file mode 100644 index 000000000..2b8c529eb --- /dev/null +++ b/doc/khelpcenter/userguide/playing-music.docbook @@ -0,0 +1,132 @@ +<sect1 id="playing-music"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<sect1info> +<authorgroup> +<author>&Lauri.Watts;</author> +</authorgroup> +</sect1info> + +<title>Playing Music</title> +<indexterm><primary>Music</primary></indexterm> +<indexterm><primary>Sound</primary></indexterm> +<indexterm><primary>Audio</primary></indexterm> +<indexterm><primary>&arts;</primary></indexterm> + +<para>Intro to &arts;</para> + +<para>Performance tuning, sharing devices</para> + +<sect2 id="music-media-players"> +<title>Music Players</title> + +<para>There are several &tde; music players with somewhat overlapping +feature sets, however, each is quite different in style.</para> + +<variablelist> +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="noatun-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&noatun; +<indexterm><primary>&noatun;</primary></indexterm> +</term> +<listitem> +<para>Noatun is the default &tde; music player. It features a highly +configurable interface, including several styles of playlist manager, and +many plugins to provide different &GUI;s, visualizations, and other +features.</para> +<para>&noatun; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="noatun.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="juk-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&juk; +<indexterm><primary>&juk;</primary></indexterm></term> +<listitem> +<para>&juk; is a media manager, playlist manager, and metadata tagger. It is a +highly efficient way to manage all your music files, make and maintain +playlists, and maintain the metadata tags in your music.</para> +<para>It is equally useful as your primary music player, or managing +playlists and files for use in another application.</para> +<para>&juk; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="juk.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="kaboodle-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +&kaboodle; +<indexterm><primary>&kaboodle;</primary></indexterm></term> +<listitem> +<para>&kaboodle; is a one shot player. That means, it will run, play a file, +and stop. &kaboodle; is useful for instance if you want to quickly listen +to a single file without interupting your current playlist from another +media player.</para> +<para>&kaboodle; is part of the tdemultimedia package.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="kaboodle.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term> +<inlinemediaobject> +<imageobject><imagedata fileref="amarok-icon.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +<application>amaroK</application></term> +<listitem> +<para><application>amaroK</application> is a popular third party application. You should be able to +find packages from your normal distribution source.</para> + +<para><mediaobject> +<imageobject><imagedata fileref="amarok.png" format="PNG"/> +</imageobject> +</mediaobject></para> + +</listitem> +</varlistentry> +</variablelist> + +<para>Most of the &tde; based movie players such as +<application>Kaffeine</application> and <application>kmplayer</application> +also make useful music players.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/printer-setup.docbook b/doc/khelpcenter/userguide/printer-setup.docbook new file mode 100644 index 000000000..216c9e819 --- /dev/null +++ b/doc/khelpcenter/userguide/printer-setup.docbook @@ -0,0 +1,29 @@ +<sect1 id="printing"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Setting Up a Printer</title> + +<para>Assume everything is pre-configured, how to set up a printer, refer to +big manual if there is trouble</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect1> diff --git a/doc/khelpcenter/userguide/printing-from-apps.docbook b/doc/khelpcenter/userguide/printing-from-apps.docbook new file mode 100644 index 000000000..964431189 --- /dev/null +++ b/doc/khelpcenter/userguide/printing-from-apps.docbook @@ -0,0 +1,22 @@ +<sect1 id="printing-from-apps"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Printing From Applications</title> + +<para>Printing from &tde; apps</para> + +<para>Printing from non-TDE apps</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/programs-and-documents.docbook b/doc/khelpcenter/userguide/programs-and-documents.docbook new file mode 100644 index 000000000..b56f486b4 --- /dev/null +++ b/doc/khelpcenter/userguide/programs-and-documents.docbook @@ -0,0 +1,522 @@ +<chapter id="programs-and-documents"> + +<title>Programs and Documents</title> + +<sect1 id="programs-launching"> + +<title>Launching Programs</title> + +<para>&tde; offers a varying number of ways to launch programs. You may:</para> + <itemizedlist> + <listitem> + <para>Simply select the relevant item in the &kmenu;.</para> + </listitem> + <listitem> + <para>Run the program from &konsole;, or by clicking the &kmenu; and choosing <guimenuitem>Run Command...</guimenuitem> (while you still might prefer the quick keyboard shortcut, which is simply <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>).</para> + </listitem> + <listitem> + <para>Create a shortcut on the desktop or use &kicker;'s quick launcher.</para> + </listitem> +</itemizedlist> + +<para>The &kmenu; functions much like the Start menu of &Windows;, however +it breaks programs up by what they do. Programs on the &kmenu; are broken +into category menus, such as <guisubmenu>Multimedia</guisubmenu> and +<guisubmenu>Office</guisubmenu>. Under these category menus there are +subcategory menus, such as <guisubmenu>Sound</guisubmenu>, +<guisubmenu>Video</guisubmenu> and <guisubmenu>Graphics</guisubmenu>. Under +the subcategory menus lie program launchers, which, when clicked on, launch +the associated application.</para> + +<para>Depending on the program, there may not be a launcher in the &kmenu;. +To search your hard drive for more applications, click the &kmenu;, choose +<guimenuitem>Run Command</guimenuitem> and type +<userinput><command>kappfinder</command></userinput>. In +&kappfinder;, click <guibutton>Scan</guibutton>, and the hard drive will be +searched for programs. Click the checkbox next to each program to be added +to the &kmenu;, and click <guibutton>Apply</guibutton> and +<guibutton>Close</guibutton>. The &kmenu; now will have new program +launchers under the relevant category menus.</para> + +<para>Launchers to programs may also be placed on the desktop. To create a +new launcher, <mousebutton>right</mousebutton> click on the desktop, and +choose <menuchoice><guimenu>Create +New</guimenu><guimenuitem>Link to +Application</guimenuitem></menuchoice>. On the &kdesktop; properties dialog +box, type in the name of the program on the <guilabel>General</guilabel> +tab. You may also wish to choose a custom icon by clicking on the gear icon. +Click the <guilabel>Application</guilabel> tab and type a short sentence +about the program in the <guilabel>Description</guilabel> textbox. In the +<guilabel>Command</guilabel> textbox, type the name of the program (case +sensitive), and any command line options you wish to use. Choose +<guibutton>OK</guibutton>, and your new program launcher will be created on +your desktop. Simply click on the new launcher on the desktop and the + associated program will run.</para> + +<para>To launch a program using &konsole;, click the &kmenu; and choose +<menuchoice><guisubmenu>System</guisubmenu><guisubmenu>Terminals +</guisubmenu><guimenuitem>Konsole</guimenuitem></menuchoice>. Once &konsole; +appears on the screen, simply type the name of the program you wish to +launch (remembering that <application>bash</application>, the command language interpreter that &konsole; uses by default, is case-sensitive) and press +<keycap>Enter</keycap>. If you are unsure about the name of a program, type +the first few letters then press the 	 key on your keyboard. By pressing +	, <application>bash</application> (through &konsole;) will try to guess the name of the program you wish to +launch. If it finds more then one matching program, a list of + matching programs will be printed on the screen. Type the name of the + program from the list and press <keycap>Enter</keycap> to launch.</para> + +<para>Whichever way you choose, launching a program is a simple affair with +&tde;. From the &kmenu;, to &konsole;, all your programs are just a few +clicks or key-presses away.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>Check the &kicker; handbook for more information on enabling or disabling the &kmenu;, adding applications to the quick launch, or on organizing the categorization of the applications in the &kmenu;. You can view the &kicker; handbook either via the &khelpcenter; or by using &konqueror;'s KIOslave by typing <userinput>help:/kicker</userinput> in the Location toolbar.</para> +</listitem> +</itemizedlist> + + + +</sect1> + +&programs-controlling; + +<sect1 id="programs-save-open"> + +<title>Opening and Saving Files</title> +<!-- TODO: Convert this whole thing to an image with callouts. It --> +<!-- should be much nicer that way. --> + + +<para>&tde; provides a unified way to open or save files via the file +dialog. In almost every &tde; program you will find a +<menuchoice><guimenu>File</guimenu><guimenuitem>Open</guimenuitem> +</menuchoice> and <menuchoice><guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem></menuchoice> (and/or <guimenuitem>Save +As...</guimenuitem>) entry.</para> + +<sect2 id="file-dialog"> +<title>The File Dialog</title> + +<!-- +<screenshot> +<screeninfo>The &tde; <quote>Open File</quote> dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="open-file-dialog.png" format="PNG"/> </imageobject> +<textobject> +<phrase>The &tde; <quote>Open File</quote> dialog</phrase> +</textobject> +<caption> +<para>The &tde; <quote>Open File</quote> dialog</para> +</caption> +</mediaobject> +</screenshot> +--> +<screenshot> +<mediaobjectco> +<imageobjectco> +<areaspec units="calspair"> +<area id="navigation-area-co" coords="1 1"/> +<area id="icon-view-co" coords="1 1"/> +<area id="bottom-area-co" coords="1 1"/> +<area id="quick-access-co" coords="1 1"/> +<area id="preview-area-co" coords="1 1"/> +</areaspec> +<imageobject> +<imagedata fileref="open-file-dialog.png" format="PNG"/> +</imageobject> +</imageobjectco> +</mediaobjectco> +</screenshot> + +<!-- ====================================================================== + +<calloutlist> + +<callout arearefs="pt-first-channel-1"><para>This is called the <interface>Input Line</interface>. To send a message to everyone in the channel, type the message here and press &Enter;. + Your message, as well as everyone else's messages appear in the channel scroll above. + Each message is preceded by the time and user's &nickname;.</para></callout> + + +</calloutlist> + + + ====================================================================== --> +<para>This dialog consists of between three and five areas. The +top area is where you find the navigation and configuration functions. The +main area (in the middle) is where all your files are being displayed as +icons. This is called an icon view. The bottom area is where you can edit +filename or filter expressions and say <guibutton>Save</guibutton> or +<guibutton>Open</guibutton>.</para> + +<para>In addition to that you can add two even more sophisticated areas: +the <link linkend="quick-access">Quick Access Navigation Panel</link> and +the <link linkend="preview-area">Preview Panel</link>.</para> + +<calloutlist> + +<callout arearefs="navigation-area-co"> + +<para>Next to the three navigation buttons (one directory +<guiicon>up</guiicon>, <guiicon>back</guiicon> and +<guiicon>forward</guiicon>) and the <guiicon>new folder</guiicon> button +there is the <guiicon>bookmarks</guiicon> menu. Here you can mark any folder +you visit often to find it quickly. The <guiicon>wrench</guiicon> icon holds +the different functions to sort your files by name, date or size and to +enable the two extra panels mentioned above. Next to it you can type the +directory and choose (on the very right side) the encoding.</para> +</callout> + + +<callout arearefs="icon-view-co"> + +<para>You'll find the icon view in the middle of the dialog. You will find +most of the navigation functions in the context menu by clicking on the +items or the background with the <mousebutton>right</mousebutton> mouse +button.</para> + +</callout> + +<callout arearefs="bottom-area-co"> + + +<para>The bottom of the dialog consists of the address field holding the +file name you chose or typed in and the maybe most powerful tool: The +filter. Here you can make the icon view display only items that match the +criteria you define. Try filtering files whose names contain +<quote>air</quote> by typing <userinput>*air*</userinput> into the filter +field.</para> + +</callout> + +<callout arearefs="quick-access-co"> + +<anchor id="quick-access"/> + +<para>The Quick Access Panel (activate it by typing the +<keycap>F9</keycap> key on your keyboard or through the wrench icon on top +of the dialog) provides configurable shortcuts to frequently used +locations on your hard drive or even on the Internet. There are several +preconfigured locations such as your home directory. Try right clicking on +any item to configure it or to empty space to add a new entry. You will be +shown a context menu. Here you can choose the icon size and to add, modify +or rename any entry. Choose <guimenuitem>Add Entry</guimenuitem> and you +will see a window containing anything you need: Type your description, enter +the location (or choose it via the dialog opening by clicking on the +folder symbol), choose a symbol from a vast variety in the symbol dialog +opening when you click on the predefined icon (usually a simple folder +symbol).</para> + +</callout> + +<callout arearefs="preview-area-co"> + +<anchor id="preview-area"/> +<para>The Preview area (activate it by typing the <keycap>F11</keycap> +key on your keyboard or via the wrench icon on top of the dialog) +makes it easy to preview almost any file on your filesystem. Images +will be displayed as thumbnails. Usually also sound files (such as +MP3, Ogg or Wave-Files), text files (among them raw text, PDF and +&HTML;) and even video files (MPG, AVI and so on) will be +previewed.</para> + +<note><para>Note that large files might take a long time to be previewed +(⪚ scaled down if they are large images). You can disable automatic +previews by unselecting <guilabel>Automatic Preview</guilabel> below the +preview. You can still preview individual files: just click <guibutton>Preview</guibutton>. You can also disable previews for files above a certain +size. Go to &kcontrolcenter;, choose <menuchoice><guilabel>TDE +components</guilabel><guilabel>File manager</guilabel></menuchoice>, go to +the <guilabel>Preview and Metafiles</guilabel> tab and change the +<guilabel>Maximum Filesize</guilabel> value.</para></note> + +</callout> +</calloutlist> + +<!-- Add links to "further reading" here --> +<!--<itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + </sect2> + + +</sect1> + +<sect1 id="configuring-programs"> + +<title>Configuring Programs</title> + +<sect2 id="configure-kapp"> +<title>Application Configuration</title> +<!-- FIXME: Make a more friendly title --> +<indexterm><primary>Configuration</primary></indexterm> +<indexterm><primary>Customization</primary></indexterm> + +<para>&tde; applications are intended to be as useful and usable as +possible <quote>out of the box</quote>, but they also offer a wide +range of options which you can change to make &tde; work for you. As +well as the settings which affect the whole of &tde; (see <xref +linkend="control-center"/>), each application has a set of +configuration options, which you can access using the menu option +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +<replaceable>Application</replaceable></guimenuitem> +</menuchoice>. This is the same for all &tde; applications, which +makes it easy to find the configuration dialog for an +application.</para> + +<!-- TODO: Screenie of a typical config dialog --> + +<para>On the left of the configuration dialog is a list of +sections. Clicking on one of these sections displays the configuration +page for that section on the right-hand side of the dialog. You can +change these options to fit your preferences.</para> + +<para>When you have made the changes you want, you can click on +<guibutton>OK</guibutton> to save your changes and close the +configuration dialog. If you want to see the effect of your changes, +but not close the configuration dialog, click on the +<guibutton>Apply</guibutton> button. This is useful if you aren't sure +about the change you've made, and might want to change back, because +the dialog is still open, ready for you to do so.</para> + +<para>If you decide that you don't want to keep the changes you've +made, just click <guibutton>Cancel</guibutton> to close the dialog +without saving your changes.</para> + +</sect2> + +<sect2 id="configure-shortcuts"> +<title>Configuring Keyboard Shortcuts</title> + +<indexterm><primary>Shortcuts</primary></indexterm> +<indexterm><primary>Keybindings</primary></indexterm> + +<para>Most &tde; applications offer keyboard shortcuts for the main +actions in the application. If you find that you don't like the +default keyboard shortcuts, or that they conflict with the shortcuts +of another application (maybe one that's not part of &tde;), you can +change them with the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem> +</menuchoice> menu entry. This brings up the +<guilabel>Configure Shortcuts</guilabel> dialog for the +application. As an example of how to use this dialog, let's add a +shortcut for the <guimenuitem>Send Link Address...</guimenuitem> action to +&konqueror;, so that we can email the locations of interesting pages +to friends just by hitting a key (or two): </para> +<procedure> +<step><para>Open the <guilabel>Configure Shortcuts</guilabel> +dialog in &konqueror;, as described above.</para> +</step> +<step><para>Click on the <guilabel>Send Link Address...</guilabel> item +in the main listbox (it's near the bottom, in the +<guilabel>Konqueror</guilabel> section).</para> +</step> +<step><para>In the <guilabel>Shortcut for Selected +Action</guilabel> panel, select <guilabel>Custom</guilabel>, since we +are going to give this action a keyboard shortcut that we have chosen.</para> +</step> +<step><para>A small shortcut entry dialog pops up. Just hit +<keycombo action="simul">&Ctrl;<keycap>E</keycap> +</keycombo> (or whatever you want to change the shortcut to), and the +dialog disappears. The <quote>key</quote> icon in the +<guilabel>Configure Shortcuts</guilabel> dialog now shows the new +shortcut.</para> +</step> +<step><para>If you made a mistake, or change your mind about what +to use as the shortcut, just click on the key icon showing the current +shortcut. The shortcut entry dialog reappears, and you can press the +key combination for the shortcut you want.</para> +</step> +</procedure> + +<!-- TODO: Screenie --> + +</sect2> + +<sect2 id="configure-notifications"> +<title>Configuring Notifications</title> + +<indexterm><primary>Notifications</primary></indexterm> +<indexterm><primary>Sounds</primary></indexterm> + +<para>Something about +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications...</guimenuitem> +</menuchoice>.</para> +</sect2> + + +<sect2 id="configuring-toolbars"> +<sect2info> +<author> +<firstname>Adriaan</firstname> +<surname>de Groot</surname> +</author> +</sect2info> +<title>Configuring Toolbars</title> + +<para>Nearly every &tde; application has one or more toolbars at the top of +the application window, underneath the menu. The toolbar contains icons +(toolbar buttons) that represent commonly used actions and configuration +settings. The &kmail; window, for instance, has a toolbar that contains +buttons for <guiicon>New Message</guiicon>, <guiicon>Check Mail</guiicon> +and several others. Each of these actions is something you do often, so +that's why they have toolbar buttons as well as menu entries (<guiicon>New +Message</guiicon> is under +<menuchoice><guimenu>Message</guimenu><guimenuitem>New +Message</guimenuitem></menuchoice>, <guiicon>Check Mail</guiicon> is +<menuchoice><guimenu>File</guimenu><guimenuitem>Check +Mail</guimenuitem></menuchoice>).</para> + +<para>Not everybody agrees on what actions are commonly used, though, (I +never use the <guiicon>New Message</guiicon> toolbar button or the menu +item, I use the keyboard shortcut <keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo>). To ensure that your +screen isn't cluttered with things you don't need, each toolbar can be +customized. Additionally, you can usually customize which toolbars are +displayed and how, as well.</para> + +<sect3 id="customizing-toolbar-displays"> +<title>Customizing Toolbar Displays</title> + +<para>The easiest thing to customize with the toolbars of any given +application is whether they are displayed at all. Most applications have a +<menuchoice><guimenu>Settings</guimenu><guisubmenu>Toolbars</guisubmenu> +</menuchoice> menu where you can select which toolbars are displayed and +which are not. &konqueror; has four toolbars, <interface>Main</interface>, +<interface>Extra</interface>, <interface>Location</interface> and +<interface>Bookmark</interface>. It can be convenient to turn off the +<interface>Bookmark</interface> toolbar to save +screen space. To do so, click on the <guimenu>Settings</guimenu> menu, +choose <guisubmenu>Toolbars</guisubmenu>, and then uncheck the +<guimenuitem>Bookmark Toolbar</guimenuitem> entry (do this just by clicking +on the menu item).</para> + +<para>If there is no <guimenu>Settings</guimenu> menu, you can also +<mousebutton>right</mousebutton> click on the toolbar itself, and choose the +<guisubmenu>Toolbars</guisubmenu> sub-menu from the resulting context +menu.</para> + +<para>The same <guimenu>Toolbar</guimenu> context menu, accessed by +<mousebutton>right</mousebutton> clicking on the toolbar, allows you to +customize other properties of the toolbar:</para> + +<itemizedlist> +<listitem> +<para>Its orientation, so that instead of appearing at the top of the +window under the menu bar you can place it on the left, right or bottom of +the window.</para> +</listitem> +<listitem> +<para>Its orientation, so that the toolbar <quote>floats</quote> as a +separate window which you can move independently.</para> +</listitem> +<listitem> +<para>Its orientation, so that the toolbar is squashed into a little flat +grip that you can re-open by double-clicking on it (this is subtly +different from making the toolbar vanish completely, since it it easier to +cause it to re-appear).</para> +</listitem> +<listitem> +<para>The appearance of text alongside, underneath, or instead of the icons +on the toolbar.</para> +</listitem> +<listitem> +<para>The size of the icons (if they are not supplanted by +text).</para> +</listitem> +</itemizedlist> +</sect3> + +<sect3 id="customizing-icons-on-toolbar"> +<title>Customizing the Icons on the Toolbar</title> + +<para>The toolbar is intended for actions that you perform often, so what do +you do if there is some useless icon there, like <guiicon>Cut</guiicon>? Or +what if you really want a <guiicon>cut</guiicon> button on the toolbar, but +the application doesn't give you one? This is where the customize toolbars +dialog comes in — it give you complete control over the actions that +are available on each toolbar.</para> + +<para>Choose <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Toolbars</guimenuitem></menuchoice> from the application's menu, or +<guimenuitem>Configure Toolbars</guimenuitem> from the context menu of the +toolbar itself. This displays the configure toolbars dialog, which consists +of a combobox <!-- drop-down box? --> with which you can select +<emphasis>which</emphasis> toolbar to customize, and two lists of items +— one of the available actions, and one of the actions that are +already in use on the toolbar.</para> + +<para>Often there are many many more actions available ( <guiicon>activate +tab #12</guiicon>, for instance) than you would ever want on the toolbar, or +even that you know exist in the application. The customize toolbar dialog +can be a learning experience. You can drag actions from one list box to the +other, rearrange the items on the toolbar <!-- in the list box on the right +..... not sure if I should be LTR-centric -->, or change the icon for a +selected action. This allows you to drag the actions you don't want off of +the toolbar and into the list of available actions; similarly, the actions +you do want can be dragged into the toolbar. Clicking +<guibutton>OK</guibutton> in the dialog immediately updates the toolbar with +your new preferred actions.</para> + +<para>There are a few special items that can end up in the listbox for the +current toolbar:</para> + +<itemizedlist> +<listitem> +<para>separators, which exist in two flavors: +<itemizedlist> +<listitem><para><guilabel>line separator</guilabel> appears as a line +between two action icons</para> +</listitem> +<listitem><para><guilabel>separator</guilabel> appears as a larger +space between two action icons</para> +</listitem> +</itemizedlist> +</para> +</listitem> +<listitem> +<para><guilabel><Merge></guilabel>, which is a special item that +allows plugins and other loadable components of the application to insert +their actions into the toolbar as well. It is generally not a good idea to +remove this, since you cannot get it back.</para> +</listitem> +<listitem> +<para><guilabel>ActionList:</guilabel>, these appear in various flavors +(there is a viewmode_toolbar one in &konqueror;) and again these +represent lists of actions that might be inserted by +plugins.</para> +</listitem> +</itemizedlist> + +<para>Whenever you click on an action in the list of current actions, a +description of it is shown in the dialog. This description will warn you if +it is a bad idea to remove the action.</para> + +<para>If you do not like to drag things around, there are four buttons in +the middle of the dialog which allow you to move the selected action from +one list to the other, and to move a selected current action up or down in +the list. There must be a way to restore the default toolbars in an +application, in order to recover from accidentally deleting an important +action like <guilabel><Merge></guilabel>, but I don't know what it +is.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + +</sect3> +</sect2> + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/programs-controlling.docbook b/doc/khelpcenter/userguide/programs-controlling.docbook new file mode 100644 index 000000000..5d170f3a0 --- /dev/null +++ b/doc/khelpcenter/userguide/programs-controlling.docbook @@ -0,0 +1,22 @@ +<sect1 id="programs-controlling"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Controlling Programs</title> + +<para>Standard Toolbar layout</para> + +<para>Keybindings</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/removable-disks.docbook b/doc/khelpcenter/userguide/removable-disks.docbook new file mode 100644 index 000000000..92929dcbe --- /dev/null +++ b/doc/khelpcenter/userguide/removable-disks.docbook @@ -0,0 +1,122 @@ +<sect1 id="removable-disks"> + +<sect1info> +<authorgroup> +<author> +<firstname>Edward</firstname> +<surname>Haven</surname> +<email>[email protected]</email> +</author> +</authorgroup> +</sect1info> + +<title>Removable Disks</title> + +<para>For &tde; to use any device, removable or not, the device must +first be mounted. When a device is mounted, &tde; gets all the needed +information about the device: how to read it, how to write information to +it, and much more.</para> + +<para>The use of a device is controlled by the operating +system and it is important your operating system has tools for managing +these devices. &tde; can also auto mount devices, working with +<acronym>HAL</acronym> (Hardware Abstraction Layer). Your distribution +should have set up <acronym>HAL</acronym> automatically; if not, +consult the documentation provided by your distribution.</para> +<para>There are several ways to find the list of media devices: use +whichever one suits you best:</para> + +<itemizedlist> +<listitem> +<para>Enter <userinput>media:/</userinput> or +<userinput>system:/media</userinput> into the &konqueror; location bar.</para> +</listitem> + +<listitem> +<para>Navigate to it by clicking on the <guilabel>Services</guilabel> +tab in &konqueror;'s Navigation Panel, then selecting <guilabel>Storage +Media</guilabel>.</para> +</listitem> + +<listitem> +<para>Select <menuchoice><guimenu>Go</guimenu><guimenuitem>Storage Media</guimenuitem> +</menuchoice> from the &konqueror; menus.</para> +</listitem> + +<listitem> +<para>Click the <guilabel>System</guilabel> desktop icon, then from +the window that appears, click on <guilabel>Storage +Media</guilabel>.</para> +</listitem> + +</itemizedlist> + + +<para>The <guilabel>Storage Media</guilabel> location (also known as +the media:/ protocol) will show all devices which are recognized by +&tde;, including the hard drive and &CD; and <acronym>DVD</acronym> +drives, as well as <acronym>USB</acronym> and Firewire devices, +provided that your distribution is set up correctly to tell &tde; +about them.</para> + + + <para>You can also setup &tde; to display a device icon +on the desktop. To start or configure this feature in the &kcontrolcenter; go +to +<menuchoice><guilabel>Desktop</guilabel><guilabel>Behavior</guilabel></menuchoice> +and select the <guilabel>Device Icons</guilabel> Tab. The device icon action +can be used to show both mounted and unmounted devices, or to only create an +icon when media is detected and automounted (only if automount is properly +configured), by not checking the unmounted boxes.</para> + +<sect2 id="automounting"> +<title>Automount</title> + +<para>With &tde; 3.5 and newer, devices can be automounted, meaning one only +has to insert the removable disk. &tde; will then open an automount prompt +asking the user <quote>What do you want to do?</quote> with the media. To +configure the list of options prompted for devices open the &kcontrolcenter; and +navigate to <menuchoice><guilabel>Peripherals</guilabel><guilabel>Storage +Media</guilabel></menuchoice>. Here you can add and remove programs from the +list of devices.</para> + +<para>The automount feature will only work if +<application>dbus</application>, <application>hal</application> and +<application>udev</application> are installed and the kernel is properly +configured. To find out if they are running on your system check the +<guilabel>Process Table</guilabel> in &ksysguard; for: +<command>hald</command>, <command>dbus-deamon</command>, and +<command>udevd</command>. &tde; does not provide any of these +components. You must check with you distribution.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="http://wiki.kde.org/tiki-index.php?page=DBUS">HOWTO: setting up D-BUS and HAL with TDE's media ioslave +edit</ulink> (A community maintained HOWTO on the &tde; wiki)</para></listitem> +<listitem><para><ulink url="http://www.freedesktop.org/wiki/Software/dbus">The DBus page</ulink></para></listitem> +<listitem><para><ulink url="http://www.freedesktop.org/wiki/Software/hal"></ulink>HAL - Hardware Abstraction Layer</para></listitem> +</itemizedlist> + +</sect2> + +<sect2 id="mounting-removable-disks"> +<title>Mounting</title> + +<para>If your system does not automount, &tde; is configured to mount and +unmount devices which the current user has permission to mount. If a device +is mounted as the root partition (&ie; <literal>/</literal>), and you log in +to &tde; as a user, &tde; can not mount or unmount it without being given a +higher permission. To check a devices mount permission see the +<filename>/etc/fstab</filename> file.</para> + +<para>To mount and unmount devices manually in &tde; one only has to &RMB; +click the device icon in media:/ or on the desktop and select +<guimenuitem>Mount</guimenuitem> or <guimenuitem>Unmount</guimenuitem>, for +removable devices one can also unmount with <guimenuitem>Safely Remove</guimenuitem>. &tde; still requires the device to be setup in +/etc/fstab.</para> +</sect2> + + + + +</sect1> diff --git a/doc/khelpcenter/userguide/rip.png b/doc/khelpcenter/userguide/rip.png Binary files differnew file mode 100644 index 000000000..b1461a979 --- /dev/null +++ b/doc/khelpcenter/userguide/rip.png diff --git a/doc/khelpcenter/userguide/ripsettings.png b/doc/khelpcenter/userguide/ripsettings.png Binary files differnew file mode 100644 index 000000000..e4e50addb --- /dev/null +++ b/doc/khelpcenter/userguide/ripsettings.png diff --git a/doc/khelpcenter/userguide/screen-captures.docbook b/doc/khelpcenter/userguide/screen-captures.docbook new file mode 100644 index 000000000..b6ea1da1f --- /dev/null +++ b/doc/khelpcenter/userguide/screen-captures.docbook @@ -0,0 +1,20 @@ +<sect1 id="screen-captures"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Screen Captures</title> + +<para>Grabbing screen caps</para> + +</sect1> diff --git a/doc/khelpcenter/userguide/services.png b/doc/khelpcenter/userguide/services.png Binary files differnew file mode 100644 index 000000000..7ccd315d4 --- /dev/null +++ b/doc/khelpcenter/userguide/services.png diff --git a/doc/khelpcenter/userguide/shared-sessions.docbook b/doc/khelpcenter/userguide/shared-sessions.docbook new file mode 100644 index 000000000..5712bf817 --- /dev/null +++ b/doc/khelpcenter/userguide/shared-sessions.docbook @@ -0,0 +1,28 @@ +<sect1 id="shared-sessions"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>Shared Sessions</title> + +<para>Sharing your desktop with krfb and pals</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> diff --git a/doc/khelpcenter/userguide/splash-screen.png b/doc/khelpcenter/userguide/splash-screen.png Binary files differnew file mode 100644 index 000000000..cd11c5d35 --- /dev/null +++ b/doc/khelpcenter/userguide/splash-screen.png diff --git a/doc/khelpcenter/userguide/standard-menu-entries.docbook b/doc/khelpcenter/userguide/standard-menu-entries.docbook new file mode 100644 index 000000000..379b0fa0a --- /dev/null +++ b/doc/khelpcenter/userguide/standard-menu-entries.docbook @@ -0,0 +1,301 @@ +<chapter id="menus"> +<chapterinfo> +<authorgroup> +<author> +&Philip.Rodrigues; +</author> +</authorgroup> +</chapterinfo> + + +<title>The Standard Menu Entries</title> + +<!-- FIXME: The text is immensely repetitive. Fix that. --> + +<para>One of the main ways that you'll control programs in &tde; is +via the program's menus. They provide access to nearly everything +you'll need to do with that program. So that you can more easily +remember where things are in the menus, and to help you learn new +programs more easily, the menus have a standard layout. This means +that once you know how to open a file in one program, you know how to +open a file in any &tde; program. Let's take a look at the standard +menus:</para> <!-- TODO: Note that programs have other menu entries as well--> + +<!-- Probably a good place for a screenie, but we'd need one showing +*only* the standard entries --> + +<variablelist> +<title>The <guimenu>File</guimenu> Menu</title> +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap> +</keycombo> +</shortcut><guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para>This entry will start a new, blank document that's +appropriate to the program you're using. For example, in &kate; (the +&tde; Advanced Text Editor) this entry creates a new text file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap> +</keycombo> +</shortcut><guimenuitem>Open...</guimenuitem> +</menuchoice></term> +<listitem><para>The <guimenuitem>Open...</guimenuitem> menu entry +displays the &tde; <quote>Open File</quote> dialog box, where you can +choose a file to open in the program you're using. The <quote>Open +File</quote> dialog is also standardized, so it's the same for all +&tde; programs. You can find out more about using this dialog +somewhere else in this guide <!-- FIXME: real link -->.</para> +<para>You probably noticed that this menu entry had an ellipsis (...) +after the name of the entry. This means that clicking on the entry +will open a dialog box of some kind. If you make any changes in the +dialog box that appears, they won't take effect until you click on the +<guibutton>OK</guibutton> button in the dialog. You can always ignore +any changes you made, and close the dialog, by clicking on the +<guibutton>Cancel</guibutton> button.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap> +</keycombo> +</shortcut><guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry will save any changes you've made to +the file that you are currently working on. If this is the first time +that you've saved the file, the &tde; <quote>Save File</quote> dialog +will appear, and ask you for a name and location for the file. <!-- TODO: Point to another section for more info --></para> +</listitem> +</varlistentry> + + + +<varlistentry> +<term><menuchoice><guimenuitem>Save As...</guimenuitem> +</menuchoice></term> +<listitem><para>The <guimenuitem>Save As...</guimenuitem> menu entry +will save the file you're working on with a different name. The +<quote>Save File</quote> dialog appears, and you can choose a name and +location as usual. Note that after you save the file with +<guimenuitem>Save As..</guimenuitem>, you will be working on the +<emphasis>new</emphasis> file. If you save changes, they will be saved +under the new filename. To make this a bit clearer, let's take an +example: + +<orderedlist> +<listitem><para>You are working on a file called +<filename>hello.txt</filename> that contains the text <quote>Hello +World!</quote> </para> +</listitem> + +<listitem><para>You use the <guimenuitem>Save As...</guimenuitem> menu +entry to save the file with the new name +<filename>newhello.txt</filename>.</para> +</listitem> + +<listitem><para>You add the text <quote>Nice to see you!</quote> to +the file, and use the <guimenuitem>Save</guimenuitem> menu entry to +save these changes.</para> +</listitem> +</orderedlist> + + + +Now, the file <filename>newhello.txt</filename> contains the text +<quote>Hello World! Nice to see you!</quote>, while the file +<filename>hello.txt</filename> contains only the text <quote>Hello +World!</quote>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap> +</keycombo> +</shortcut><guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry displays the &tde; +<quote>Print</quote> dialog, read to print the current +document. Youcan find more information about the options available in +this dialog in <xref linkend="printing-from-apps"/>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>W</keycap> +</keycombo> +</shortcut><guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry closes the current document. If you +have made any changes since you last saved the document, you will be +asked whether you want to save those changes. You can choose to +<guibutton>Save</guibutton> or <guibutton>Discard</guibutton> those +changes. If you didn't really want to close the file, just click +<guibutton>Cancel</guibutton>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap> +</keycombo> +</shortcut><guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para>Use this entry to close the program you're using. If +you have unsaved changes in any files, you will be asked whether you +want to +save them.</para> +</listitem> +</varlistentry> + + + +</variablelist> + +<variablelist> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap> +</keycombo> +</shortcut><guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para>Use this entry to remove the effect of the last +action you performed in the application. For example, if you deleted a +line of text, the <guimenuitem>Undo</guimenuitem> menu entry will +replace that line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap> +</keycombo> +</shortcut><guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para>Use this menu entry to perform the last action that +you removed with the <guimenuitem>Undo</guimenuitem> menu entry. For +example, if, as in the example above, you had replaced a deleted line +of text with <guimenuitem>Undo</guimenuitem>, the +<guimenuitem>Redo</guimenuitem> entry would redo the action of +deleting the line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>X</keycap> +</keycombo> +</shortcut><guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry cuts the contents of the current +selection to the clipboard. See <xref linkend="using-the-clipboard"/> +for more information. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap> +</keycombo> +</shortcut><guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry copies the contents of the current +selection to the clipboard. See <xref linkend="using-the-clipboard"/> +for more information. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>V</keycap> +</keycombo> +</shortcut><guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry inserts the contents of the clipboard +in the current document. The clipboard contents are inserted where the +cursor is currently positioned.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap> +</keycombo> +</shortcut><guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem><para>Use this item to select the whole of the current +document.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap> +</keycombo> +</shortcut><guimenuitem>Find...</guimenuitem> +</menuchoice></term> +<listitem><para>This menu entry displays the <guilabel>Find +Text</guilabel> dialog, which you can use to search for a particular +word or phrase in the current document. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut><keycombo action="simul"><keycap>F3</keycap> +</keycombo> +</shortcut><guimenuitem>Find Next</guimenuitem> +</menuchoice></term> +<listitem><para>Use this item to find the next occurrence of the most +recent text you searched for using <guimenuitem>Find...</guimenuitem>. +</para> +</listitem> +</varlistentry> + +</variablelist> + +<variablelist> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change the keyboard shortcuts used by the application. See <xref +linkend="configure-shortcuts"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure +Toolbars...</guimenuitem></menuchoice></term> + +<listitem><para>In the dialog displayed by this menu entry, you can +change which buttons appear on the application's toolbars. See <xref +linkend="configuring-toolbars"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure Notifications...</guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change the notifications (sounds, error messages, &etc;) used by the +application. See <xref +linkend="configure-notifications"/>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Configure <replaceable>Application</replaceable></guimenuitem></menuchoice></term> +<listitem><para>In the dialog displayed by this menu entry, you can +change settings relating to how the application works in general. +</para> +</listitem> +</varlistentry> + +</variablelist> + + +&help.menu.documentation; + +</chapter> diff --git a/doc/khelpcenter/userguide/switching-sessions.docbook b/doc/khelpcenter/userguide/switching-sessions.docbook new file mode 100644 index 000000000..0c15df8e1 --- /dev/null +++ b/doc/khelpcenter/userguide/switching-sessions.docbook @@ -0,0 +1,63 @@ +<sect1 id="switching-sessions"> + +<title>Switching Sessions</title> + +<para>From version 3.3 onwards, &tde; provides a session management +system which allows you to switch between different user account on +one computer. You can stay logged in and ⪚ let your sister, +brother, wife, neigbour or whoever read her or his emails just for a +moment. Before you had to log off (therefore ⪚ close programs or +save documents) and let her or him log in.</para> + +<para>Now it's almost as easy as switching to another virtual desktop.</para> + +<variablelist> +<title>Switching Sessions: How it works</title> + +<varlistentry> +<term>The <guimenuitem>Switch User</guimenuitem> Menu</term> +<listitem> +<para>The &kmenu; now bears a new entry. Rather at the bottom of the menu +you will find a <guisubmenu>Switch User</guisubmenu> submenu. It contains +the command to lock the current and start a new session which means that +your desktop will start the screensaver and after a few seconds can log in +with TDM as always. The <guimenuitem>Start New Session</guimenuitem> entry +skips the activation of your screensaver.</para> + +<para>Once you have running more than one session you can either choose to +press <keycombo action="simul">&Ctrl;&Alt;<keycap>F7</keycap></keycombo> + or <keycap>F8</keycap> and so on (what is usually configured by default) or +— even more comfortable — choose from the list of active +sessions at the bottom of the <guisubmenu>Switch User</guisubmenu> +submenu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Switch User with the screensaver</term> +<listitem><para>If you have activated your screensaver and another user +wants to log in she or he can simply press the <guibutton>Switch +User...</guibutton> button and log into another session.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Switch Session in &tdm;</term> +<listitem><para>If you are in &tdm; and want to switch to another active +session you can press the <guibutton>Menu</guibutton> button and choose +<guisubmenu>Switch User</guisubmenu> which is mainly the same as described +above.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + + +</sect1> diff --git a/doc/khelpcenter/userguide/tde-as-root.docbook b/doc/khelpcenter/userguide/tde-as-root.docbook new file mode 100644 index 000000000..c7e9b966e --- /dev/null +++ b/doc/khelpcenter/userguide/tde-as-root.docbook @@ -0,0 +1,34 @@ +<sect1 id="root"> + +<sect1info> +<authorgroup> +<author> +&Francis.Giannaros; &Francis.Giannaros.mail; +</author> +</authorgroup> +</sect1info> + + +<title>Using &tde; as Root</title> + +<para>For &UNIX; operating systems there are often different users, which in turn might have different privileges. The conventional method is to have an ordinary user account, whose files are generally stored in <filename>/home/username</filename>, and then to also have a <systemitem class="username">root</systemitem> account. The <systemitem class="username">root</systemitem>, or Super User, account has system-wide privileges, being able to modify any file on the system.</para> + +<para>Although this means that it is easy to perform administrative tasks without hassle, it also means that there are no security restrictions imposed upon it. Thus, a small typographical error or other mistake can result in irrevocable damage.</para> + +<para>Some of the operating systems that run &tde; come with a graphical <systemitem class="username">root</systemitem> login enabled. Despite this, you should never log in to &tde; as <systemitem class="username">root</systemitem>, and you should never need to. Your system is far more open to attack, particularly if you are browsing the Internet as <systemitem class="username">root</systemitem>, and you dramatically increase your chances of damaging your system.</para> + +<para>Some &Linux; distributions have tried to stress this point so much that they have disabled the <systemitem class="username">root</systemitem> account altogether, and instead use the <command>sudo</command> model. Nevertheless, the basic security model in <command>sudo</command> is the same as <command>su</command>, and thus they share the same security strengths and weaknesses, essentially.</para> + +<para>If you should ever need to run a program with Super User privileges, then it is always recommend that you use &tdesu;. From &konsole; or from hitting <keycombo action="simul">&Alt;<keycap>F2</keycap></keycombo>, enter <userinput>tdesu <replaceable>application</replaceable></userinput>, and the application will be run with the appropriate Super User privileges.</para> + +<para>Even if you have set up your system to use <command>sudo</command>, or you are on a distribution that uses <command>sudo</command>, such as &kubuntu;, you should still use &tdesu;. The program will be appropriately modified by the developers to use the correct settings. You should not, however, ever use <command>sudo <replaceable>application</replaceable></command> to run an application with <systemitem class="username">root</systemitem> permissions; it can derange permissions of certain configuration files for a program. Running a graphical applications as <systemitem class="username">root</systemitem> in general is not a good idea, but using &tdesu; will always be your safest bet with it.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="help:tdesu">&tdesu; Handbook</ulink></para> +</listitem> +</itemizedlist> + + +</sect1> diff --git a/doc/khelpcenter/userguide/tde-edutainment.docbook b/doc/khelpcenter/userguide/tde-edutainment.docbook new file mode 100644 index 000000000..0cafe8f04 --- /dev/null +++ b/doc/khelpcenter/userguide/tde-edutainment.docbook @@ -0,0 +1,324 @@ +<chapter id="tde-edutainment"> +<!-- Uncomment this and add your name in order to be credited for +writing this section +<chapterinfo> +<authorgroup> +<author> +Your name here +</author> +</authorgroup> +</chapterinfo> +--> + +<title>&tde; Edutainment</title> + +<para>The &tde; Edutainment Project offers children, families, and teachers some +educational programs. You can find applications to help you improve +your language skills and train your vocabulary, like &kvoctrain; and +&kwordquiz;; or Scientific programs, like the +very advanced &kstars; (a planetarium) and &kig; (interactive +geometry), which will bring you to the edge of knowledge. Have fun learning +touch-typing with &ktouch;. Teachers will find an easy way to make +their lessons with &keduca;. You can find a complete list of &tde; +educational software on <ulink url="http://edu.kde.org">the TDE-Edu +website</ulink>. What follows is an overview of a few of them. +</para> +<para>View the handbook of each application by typing <userinput>help:/<appname></userinput> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;.</para> + +<sect1 id="languages"> +<title>Improve your language skills</title> + +<variablelist> +<varlistentry> +<term>&khangman;</term> + <listitem><para>An easy-to-use application which implements the classical hangman game. You can choose for the words to be from a particular topic and even choose from a selection of difficulty levels. The program comes in twenty-four languages, and is therefore quite ideal for learning the spelling of basic nouns in other languages.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/khangman">http://edu.kde.org/khangman</ulink></para></listitem> + <listitem><para><ulink + url="help:/khangman">&khangman; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&klettres;</term> + <listitem><para>An application specially designed to help the user learn the alphabet of a new language and then to learn to read simple syllables. Ideal for children, or any person attempting to learn and familiarize themselves with a foreign language's alphabet. A number of alphabets are currently supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/klettres">http://edu.kde.org/klettres</ulink></para></listitem> + <listitem><para><ulink + url="help:/klettres">&klettres; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kanagram;</term> + <listitem><para>A simple mind-training game, in which you have to figure out the word that has been given in the program. The letters from the word are disordered, and from the given words you have to solve which word the letters might make, if rearranged. Similar to the popular Countdown game as seen on Television.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kanagram">http://edu.kde.org/kanagram</ulink></para></listitem> + <listitem><para><ulink + url="help:/kanagram">&kanagram; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kverbos;</term> + <listitem><para>A simple way to learn and study Spanish verb forms. The program suggests a verb and a tense and the user enters the different forms. The program corrects the user input and gives feedback. The user can edit the list of the verbs that can be studied and the program can build regular verb forms, and the forms of the most important verb groups, by itself. Irregular verb forms can be entered by the user.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kverbos">http://edu.kde.org/kverbos</ulink></para></listitem> + <listitem><para><ulink + url="help:/kverbos">&kverbos; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kvoctrain;</term> + <listitem><para>Another advanced vocabulary training application, using the flash card approach. <ulink url="http://edu.kde.org/contrib/kvtml.php">Vocabulary files</ulink> and be downloaded and loaded into the application.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kvoctrain">http://edu.kde.org/kvoctrain</ulink></para></listitem> + <listitem><para><ulink + url="help:/kvoctrain">&kvoctrain; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + + +<varlistentry> +<term>&kiten;</term> + <listitem><para>A Japanese reference and learning tool. Words from both English and Japanese can be looked up, and filtered, using the <application>Edict</application> and <application>Kanjidic</application> dictionary protocols. Other features in &kiten; include a few comprehensive search functions, a history of searches, and a learning section which contains various different learning modes.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kiten">http://edu.kde.org/kiten</ulink></para></listitem> + <listitem><para><ulink + url="help:/kiten">&kiten; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&klatin;</term> + <listitem><para>A program to help revise Latin. There are vocabulary, grammar, and verb testing sections. In addition there is a set of revision notes that can be used for self-guided revision.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/klatin">http://edu.kde.org/klatin</ulink></para></listitem> + <listitem><para><ulink + url="help:/klatin">&klatin; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="mathematics"> +<title>Mathematics</title> + +<para>Several applications to help you with Mathematics and Geometry.</para> + +<variablelist> +<varlistentry> +<term>&kbruch;</term> + <listitem><para>An application with several exercise types in order to enhance your calculating with fractions. Different tasks include exercises to find the sum of two fractions, the conversion of fractions into the respective decimal, the comparison (with less than, more than) of fractions, and more.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kbruch">http://edu.kde.org/kbruch</ulink></para></listitem> + <listitem><para><ulink + url="help:/kbruch">&kbruch; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kig;</term> + <listitem><para>A great application with interactive geometry. Ideal for teachers attempting to draw a graph on the computer, or students who wish to find out more and investigate with graphs and curves. Currently many things are supported, and you can very easily construct several things from parabolas and hyperbolas, to ellipses.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kig">http://edu.kde.org/kig</ulink></para></listitem> + <listitem><para><ulink + url="help:/kig">&kig; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kpercentage;</term> + <listitem><para>Essentially an application to help you improve your skills in calculating percentages. Different exercises are included, and there are varying difficulty levels to target persons with varying abilities.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kpercentage">http://edu.kde.org/kpercentage</ulink></para></listitem> + <listitem><para><ulink + url="help:/kpercentage">&kpercentage; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> +<term>&kmplot;</term> + <listitem><para>A mathematical function plotter. It has built in a powerful parser. You can plot different functions simultaneously and combine their function terms to build new functions. &kmplot; supports functions with parameters and functions in polar coordinates. Several grid modes are possible and plots may be printed with high precision in correct scale.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kmplot">http://edu.kde.org/kmplot</ulink></para></listitem> + <listitem><para><ulink + url="help:/kmplot">&kmplot; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + + +</sect1> +<sect1 id="science"> +<title>Science</title> + +<variablelist> +<varlistentry> +<term>&kstars;</term> + <listitem><para>A desktop Planetarium for &tde;. It provides an accurate graphical simulation of the night sky, from any location on Earth, at any date and time. The display includes 130,000 stars, 13,000 deep-sky objects,all 8 planets, the Sun and Moon, and thousands of comets and asteroids.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kstars">http://edu.kde.org/kstars</ulink></para></listitem> + <listitem><para><ulink + url="help:/kstars">&kstars; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> + <term>&kalzium;</term> + <listitem><para>A fully-featured periodic table, with the full list of all elements, and extended information about each individual element is accessible. As well as being able to view a basic overview, other features include being able to view its chemical data, atomic model, energies, as well as a picture of the element.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kalzium">http://edu.kde.org/kalzium</ulink></para></listitem> + <listitem><para><ulink url="help:/kalzium">&kalzium; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="teaching_tools"> +<title>Teaching Tools</title> +<variablelist> +<varlistentry> + <term>&keduca;</term> + <listitem><para>A flash card application, which allows you to make interactive form-based tests. It also currently comes with support to add servers from which you can fetch tests from. Several languages supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/keduca">http://edu.kde.org/keduca</ulink></para></listitem> + <listitem><para><ulink url="help:/keduca">&keduca; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> +</variablelist> +</sect1> +<sect1 id="miscellaneous"> +<title>Miscellaneous</title> +<variablelist> +<varlistentry> + <term>&ktouch;</term> + <listitem><para>An application for learning touch-typing. &ktouch; displays the keyboard on the screen, and the color of the keys changes when they need to be depressed. Text appears on the screen, and the user is asked to type it out. A few default lectures are contained in the program by default, with various different difficulty levels.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/ktouch">http://edu.kde.org/ktouch</ulink></para></listitem> + <listitem><para><ulink url="help:/ktouch">&ktouch; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +<!-- Screeny! --> +</varlistentry> + +<varlistentry> + <term>&kwordquiz;</term> + <listitem><para>A flash card application, which allows you to make interactive form-based tests. It also currently comes with support to add servers from which you can fetch tests from. Several languages supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kwordquiz">http://edu.kde.org/kwordquiz</ulink></para></listitem> + <listitem><para><ulink url="help:/kwordquiz">&kwordquiz; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term>&kturtle;</term> + <listitem><para>An educational programming environment using the Logo programming language, with several languages currently supported.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/kturtle">http://edu.kde.org/kturtle</ulink></para></listitem> + <listitem><para><ulink url="help:/kturtle">&kturtle; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term><application>&kgeography;</application></term> + <listitem><para>&kgeography; is a geography learning tool for &tde;. You can browse the maps by clicking in a map division to see its name and you can also answer several types of questions where the program shows you a map division or a capital for example and you have to guess its name.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://kgeography.berlios.de/">http://kgeography.berlios.de/</ulink> and <ulink url="http://edu.kde.org/kgeography">http://edu.kde.org/kgeography</ulink></para></listitem> + <listitem><para><ulink url="help:/kgeography"><application>&kgeography;</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +<varlistentry> + <term><application>&blinken;</application></term> + <listitem><para>&blinken; is a Simon Says game for &tde;. The player should remember the sequence of lights in the correct order and is then presented with an identical sequence with one extra step.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://edu.kde.org/blinken">http://edu.kde.org/blinken</ulink></para></listitem> + <listitem><para><ulink url="help:/blinken"><application>&blinken;</application> Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> + +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="edu-related"> +<title>Related Information</title> +<itemizedlist> +<listitem><para>The &tde;-Edu website at <ulink +url="http://edu.kde.org">http://edu.kde.org</ulink> has news and +information about all the &tde; Edutainment applications.</para> +</listitem> +</itemizedlist> +</sect1> + + +</chapter> diff --git a/doc/khelpcenter/userguide/tde-office.docbook b/doc/khelpcenter/userguide/tde-office.docbook new file mode 100644 index 000000000..f8df13365 --- /dev/null +++ b/doc/khelpcenter/userguide/tde-office.docbook @@ -0,0 +1,321 @@ +<part id="tde-office"> +<partinfo> +<authorgroup> +<author> +<personname> +<firstname>Raphael</firstname> +<surname>Langerhorst</surname> +</personname> +<email>[email protected]</email> +</author> +<!-- +<othercredit role="reviewer"> +</othercredit> +--> +</authorgroup> +</partinfo> + +<!-- keep a copy of the desired structure here: +* TDE Office + * Introduction to KOffice + * Overview + * Features + * OASIS OpenDocument file format + * Document embedding + * KParts and KOffice + * Example document + * KOffice components overview + * ... [a short intro to all components] + * Further information + * Application manuals + * Internet resources + * Plugin development +--> + +<title>Office</title> + +<chapter id="tde-office-introduction"> +<title>Introduction to KOffice</title> + +<sect1 id="tde-office-overview"> +<title>Overview</title> +<para> +The &tde; project has also created a fully featured office suite +called &koffice; which adheres to standards and fits very well into +the &tde; desktop. This section was written with version 1.4 of +&koffice; in mind. +</para> +<para> +&koffice; is a highly integrated office suite that builds directly on the +TDE technology. This has many advantages in terms of integration, features, +performance, familiar look and feel and so on. All technologies like &DCOP;, +TDEIO, KParts are directly available. +</para> +<para> +In particular the KParts technology is extended for the &koffice; +components to allow very flexible embedding of documents inside documents. +</para> +<para> +Because much technology is already present inside &tde; itself, &koffice; is +a very lightweight office suite, which results in fast application startup +and low memory consumption. This makes &koffice; a very suitable office suite +for older hardware as well, which can save lots of costs in some cases. +</para> +<para> +&koffice; is also a very feature complete office suite. It is not limited to +word processing, spreadsheets or presentations, but has also components for +image manipulation, flow charts, business report generation, database +management and project management. Because of the flexible component +integration smaller utilities like the diagram and chart engine as well +as the formula editor are available as stand alone tools. +</para> +<para> +As you can see &koffice; brings a lot of features that can enrich your +office experience. Its straight forward and &tde; like approach in look +and feel as well as familiar usability makes &koffice; quite useful for +daily office work. +</para> +<!-- include this para at the end in further information +<para> +You can always take a look at the &koffice; +<ulink url="http://www.koffice.org">website</ulink> to check on the latest +state of the application. +</para> +--> +</sect1> + +<sect1 id="tde-office-features"> +<title>Features</title> +<para> +This list gives a general outline of the &koffice; features. +The &koffice; office suite is too large to list every detail. +</para> +<itemizedlist> +<title>&koffice; features:</title> +<listitem><para>Fully builds on &tde; which makes these technologies available at low costs.</para></listitem> +<listitem><para>Fully integrates into &tde; which is vital for business environments.</para></listitem> +<listitem><para>&tde; technologies include document location abstraction, DCOP scripting, parts and plugins,...</para></listitem> +<listitem><para>Full Component embedding.</para></listitem> +<listitem><para>Low memory footprint, fast startup, lightweight.</para></listitem> +<listitem><para>Feature complete: many components are offered.</para></listitem> +<listitem><para>Intuitive, good looking and easy to learn user interface.</para></listitem> +<listitem><para>Adheres to standards: OASIS OpenDocument file format.</para></listitem> +</itemizedlist> +</sect1> + +<sect1 id="tde-office-fileformat"> +<title>OASIS OpenDocument file format</title> +<para> +It is important for an office suite to use standards where possible, +especially for the file format. The OASIS OpenDocument file format +specification is an open standard for office applications. This +format is spreading more and more, it is also the same file format +OpenOffice.org uses, which means that file exchange with any +user of this office suite is easily possible. +</para> +<para> +Adhering to official standards is always a good thing. For business +environments it is even vital to exactly know about their documents. +</para> +<para> +&koffice; has more components to offer than what is covered by the +OASIS specification. Still, all components covered by the specifications +actually use the OASIS OpenDocument file format. +</para> +</sect1> +</chapter> + +<!-- comment out for final commit before freeze +<chapter id="tde-office-embedding"> +<title>Component Embedding</title> +<sect1 id="tde-office-tdeparts"> +<title>KParts and &koffice;</title> +<para>To be written</para> +</sect1> + +<sect1 id="tde-office-example"> +<title>Example</title> +<para>To be written</para> +</sect1> +</chapter> +--> + +<chapter id="tde-office-components"> +<title>&koffice; Components Overview</title> + +<para>Keep in mind that all these components can integrate very well into each other. So basically a spreadsheet can contain anything from charts to presentations, reports and even text documents. Likewise almost any component can contain almost any other.</para> + +<variablelist> + +<varlistentry> +<term>&kword;</term> + <listitem><para>The textprocessing component, but it includes many aspects of a desktop publishing application. This creates a rather unique mixture of features that makes interesting layouts easily possible.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kword/">http://www.koffice.org/kword/</ulink></para></listitem> + <listitem><para><ulink url="help:/kword">&kword; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kspread;</term> + <listitem><para>The spreadsheet component. &kspread; is a scriptable spreadsheet program which provides both table-oriented sheets and support for complex mathematical formulas and statistics. Features include Hyperlinks, cell data validity checking with configurable warnings/actions, scripting and specific cell customization.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kspread/">http://www.koffice.org/kspread/</ulink></para></listitem> + <listitem><para><ulink url="help:/kspread">&kspread; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kpresenter;</term> + <listitem><para>The presentation component. It can be used to create on-screen presentations or to design and print transparencies. Features include embedding images and clip-art, easy working with objects, and the ability to make &HTML; or &XML; slideshows.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kpresenter/">http://www.koffice.org/kpresenter/</ulink></para></listitem> + <listitem><para><ulink url="help:/kpresenter">&kpresenter; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kivio;</term> + <listitem><para>The flowcharting and diagramming component. Additional stencil sets can be used for custom needs, there is a plugin framework for additional functionality, and even <acronym>UML</acronym> diagrams are possible.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kivio/">http://www.koffice.org/kivio/</ulink></para></listitem> + <listitem><para><ulink url="help:/kivio">&kivio; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&karbon14;</term> + <listitem><para>A vector-drawing application.</para></listitem> +</varlistentry> + +<varlistentry> +<term>&chalk;</term> + <listitem><para>The painting and image manipulation component. &chalk; contains both ease-of-use, fun features like guided painting, as well as high-end features like support for 16-bit images, <acronym>CMYK</acronym> and even OpenEXR <acronym>HDR</acronym> images.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/krita/">http://www.koffice.org/krita/</ulink></para></listitem> + <listitem><para><ulink url="help:/chalk">&chalk; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kugar;</term> + <listitem><para>The appropriate component for creating business reports, which is accomplished with an advanced designer that it has. Features include report printing in postscript, full control of fonts, colors, text alignment and wrapping, as well as open report definition files (with the layout stored as &XML;).</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kugar/">http://www.koffice.org/kugar/</ulink></para></listitem> + <listitem><para><ulink url="help:/kugar">&kugar; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term><application>KPlato</application></term> + <listitem><para>The component for project management, allowing for the planning and scheduling of various projects.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kplato/">http://www.koffice.org/kplato/</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kexi;</term> + <listitem><para>The data management component. It can be used for creating database schemas, inserting data, performing queries, and processing data. Forms can be created to provide a custom interface to your data. All database objects -- mdash; tables, queries and forms -- mdash; are stored in the database, making it easy to share data and database design.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kexi/">http://www.koffice.org/kexi/</ulink> and <ulink url="http://kexi-project.org">http://kexi-project.org</ulink>.</para></listitem> + <listitem><para><ulink url="help:/kexi">&kexi; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kchart;</term> + <listitem><para>The chart drawing component; it is used to embed charts into one of the other &koffice; components. It's easy to use, highly customizable allowing all of the parameters to be changed, and has a flexible layout.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kchart/">http://www.koffice.org/kchart/</ulink></para></listitem> + <listitem><para><ulink url="help:/kchart">&kchart; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +<varlistentry> +<term>&kformula;</term> + <listitem><para> A formula editor which provides the basic input facilities and support functionality that appears in other &koffice; applications. Some of its features include intelligent cursor management, multi-level undo support and advanced syntax highlighting.</para> + + <itemizedlist> + <listitem><para>Website: <ulink url="http://www.koffice.org/kformula/">http://www.koffice.org/kformula/</ulink></para></listitem> + <listitem><para><ulink url="help:/kformula">&kformula; Handbook</ulink></para></listitem> + </itemizedlist> + + </listitem> +</varlistentry> + +</variablelist> + +<itemizedlist> +<title>Related Information</title> + <listitem><para>Main website: <ulink url="http://www.koffice.org">http://www.koffice.org</ulink>.</para></listitem> + <listitem><para><ulink url="help:/koffice">&koffice; Handbook</ulink></para></listitem> +</itemizedlist> + +</chapter> + +<chapter id="tde-office-furtherinfo"> + +<title>Further Information</title> +<sect1 id="tde-office-manuals"> +<title>Application Manuals</title> +<para>Each Koffice component comes with its own manual. +These manuals offer all the latest information about the +various components &koffice; has to offer and should be +read to learn more about &koffice;. The application manuals can be accessed by using the documentation TDEIO Slave in &konqueror; (that is, typing <userinput>help:/<replaceable>application</replaceable></userinput> into the Location toolbar) or by selecting the respective handbook from the &khelpcenter;. The website is +also a good place to find out more; it is at <ulink url="http://www.koffice.org">http://www.koffice.org</ulink>.</para> +</sect1> + +<sect1 id="tde-office-internet"> +<title>Internet Resources</title> +<para>The primary site on the internet is +<ulink url="http://www.koffice.org">http://www.koffice.org</ulink></para> +<para>You will also find information about the user and developer +mailing lists as well as additional developer resources.</para> +<para>The Kexi project has even an additional website, which can be +found at <ulink url="http://www.kexi-project.org">http://www.kexi-project.org +</ulink></para> +</sect1> + +<sect1 id="tde-office-plugininfo"> +<title>Plugin development</title> +<para>&koffice; can easily be extended with plugins. Plugin development is +not very difficult and can be used to optimize your everyday workflow. Such +capabilities are probably very interesting in business environments to +make &koffice; meet individual requirements. You can either take a look +at existing plugins or read a general introduction at +<ulink url="http://developer.kde.org/documentation/tutorials/developing-a-plugin-structure/index.html"> +the developer's site</ulink>. The general TDE developers website is available +at <ulink url="http://developer.kde.org/">http://developer.kde.org</ulink>. +</para> +</sect1> + +</chapter> +</part> diff --git a/doc/khelpcenter/userguide/tdm.png b/doc/khelpcenter/userguide/tdm.png Binary files differnew file mode 100644 index 000000000..1ad4fcce0 --- /dev/null +++ b/doc/khelpcenter/userguide/tdm.png diff --git a/doc/khelpcenter/userguide/the-filemanager.docbook b/doc/khelpcenter/userguide/the-filemanager.docbook new file mode 100644 index 000000000..20e4dedfe --- /dev/null +++ b/doc/khelpcenter/userguide/the-filemanager.docbook @@ -0,0 +1,256 @@ +<sect1 id="file-manager"> + +<title>The File Manager</title> +<indexterm><primary>&konqueror;</primary><secondary>File +Management</secondary></indexterm> +<indexterm><primary>File Management</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="konq-simple.png" format="PNG" /> +</imageobject> +<caption><para>&konqueror; with simple settings</para></caption> +</mediaobject> + +<sect2 id="filemanager-intro"> +<title>Introduction</title> + +<para>&tde; includes a versatile and powerful file manager called +&konqueror; that allows you to do everything you want with the files +stored on your computer, your network, and even the Internet. There +are too many features of &konqueror; to describe here, so we will just +take an overview. For more details about what &konqueror; can +do, refer to the <ulink url="help:/konqueror">&konqueror; Handbook</ulink>.</para> +</sect2> + +<sect2 id="folder-structure"> +<title>Folders</title> + +<para>When you first open &konqueror; in file management mode, you can +see two panes: on the right is the folder view; on the left is the +sidebar. The folder view contains icons for +each item inside the current folder. These items can be +folders or files. Many file types can be <quote>previewed</quote> +without opening a new application to edit them in.<indexterm><primary>Previews</primary></indexterm> To preview a file, +hold the mouse cursor over the name of the file for about a second: a +popup window will appear, showing the contents of the file and other some +useful information, like file's size and which user owns the file.</para> + +<para>You can open any item by clicking on the icon for the +file. Folders will be opened in the same window; files will either be +opened in the appropriate program, or the file manager will ask you +what program to use. For instance, if do not have a word-processor set up to +open &Microsoft; Word documents, the file manager will +ask you what to do.</para> + +<para>You can go back to the last-opened folder by clicking on the +<guiicon>Back</guiicon><!--screenie --> button or go up one folder by clicking +the <guiicon>Up</guiicon><!--screenie --> button.</para> +</sect2> + +<sect2 id="the-navigation-panel"> +<title>The Navigation Panel (aka <quote>The Sidebar</quote>)</title> + +<indexterm><primary>Navigation Panel</primary></indexterm> +<indexterm><primary>Sidebar</primary></indexterm> + +<mediaobject> +<imageobject> +<imagedata fileref="konq-sidebar.png" format="PNG" /> +</imageobject> +<caption><para>The &konqueror; sidebar</para></caption> +</mediaobject> + +<para>Navigating through the folders by using +the folder view can become impractical. The sidebar provides +shortcuts and special functions that make it easier to +find what you are searching for.</para> + +<para>On the left edge of the sidebar be several buttons, each + with a different icon, such as the following:</para> + +<!-- TODO: Add screenies of what each of these buttons looks like --> +<variablelist> + +<varlistentry> +<term><guilabel>Bookmarks</guilabel></term> + +<listitem> +<para>As &konqueror; (the file manager) also serves as a very powerful +web browser, it also has a bookmark functionality. Here you will find the +same structure as in your <guimenu>Bookmarks</guimenu> menu.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Devices</guilabel></term> + +<listitem> +<para>Next the sidebar provides a list of all known devices +on your computer. These devices can be either physical drives — +such as your hard disk, &CD-ROM; drive, or floppy disk drive — +or virtual <quote>drives</quote> — such as remote shares or hard disk partitions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>History</guilabel></term> + +<listitem> +<para>&konqueror; will remember the web pages you have visited and list them +either by date or alphabetically in a tree structure. You can select the +behavior by right clicking on the <guilabel>History</guilabel> item and +selecting <guimenu>Sort by</guimenu>. Left click on an item (⪚ +<guilabel>www.kde.org</guilabel>) and &konqueror; will show you the documents you have visited. Left +clicking on a document (⪚ <guilabel>index.html</guilabel>) will open +the web site in the folder view.</para> +<para>Right clicking on a history item, like <menuchoice><guimenu>www.kde.org</guimenu><guimenuitem>index.html</guimenuitem> +</menuchoice>, opens a slightly different popup menu: you will also find the +item <guimenuitem>New Window</guimenuitem>, which makes &konqueror; open the +site in a new window.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Home Directory</guilabel></term> + +<listitem> +<para>The <guilabel>Home Directory</guilabel> item is in the sidebar's navigation +panel. You will find your home directory as the first entry. Below you will +find all folders of your home directory. Left clicking on any +folder in this view opens the folder in the folder view. Alternatively, you can also +work with the folders' context menus, create subfolders, and so on.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Sidebar Media Player</guilabel></term> + +<listitem> +<!-- TODO: think of a better solution for marking up the file --> +<!-- formats. It should probably involve entities --> +<para>Try dragging a music file (like <acronym>MP3</acronym>, Ogg, or +<literal role="extension">.wav</literal> files) +on the sidebar. The file will immediately be played.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Newsticker</guilabel></term> +<!-- I don't have this button. Ought to check what it depends on --> +<listitem> +<para>Newsticker will display a customisable list of news sources. Right-click +either on the <guilabel>Configure button</guilabel> or on one of the +newssource buttons (e.g. TDE News, which is usually predefined) to add a new +newsticker source.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Network</guilabel></term> + +<listitem> +<para>Here you can browse the services provided by other computers on +the network. The &lisa;-Daemon has to be started in order to work +correctly. The network browser allows you to see a variety of services +provided by a computer. You can easily browse <acronym>SMB</acronym> +shares, &HTTP; sites, or transfer files via the secure FISH +layer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Root Directory</guilabel></term> + +<listitem> +<para>Everything on a &UNIX;-based system is organized in a file +system tree. This tree must have a root and here it is. The +<guilabel>Root Directory</guilabel> function is like the +<guilabel>Home Directory</guilabel> function. The only difference is +that every folder is being displayed, not only your home +directory.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Services</guilabel></term> + +<listitem> +<para>This is somehow the "rest". Try browsing through the different +items. If an Audio &CD; is in your &CD; or <acronym>DVD</acronym> +drive you will be able to find everything on it and even more in the +<guilabel>Audio CD Browser</guilabel> item (you can even compress +audio files and save them on your hard drive with this +function).</para> +</listitem> +</varlistentry> + +</variablelist> +</sect2> + +<sect2 id="filemanager-icons"> +<title>Icons</title> + +<para> +To select only one icon hold down the &Ctrl; key and click on the icon +you want to select. If you want to select more than one icon, hold +down &Ctrl; while you click on each of the items you want to select. +Once one or more icons are selected you can do what you want with +them. If you want to move or copy items, select them and then drag them +(with the left mouse button down) to the desired location. When +you release the mouse button a menu will come up offering you to +<guimenuitem>Move</guimenuitem><indexterm><primary>Moving +Files</primary></indexterm>, +<guimenuitem>Copy</guimenuitem><indexterm><primary>Copying +Files</primary></indexterm>, or <guimenuitem>Link</guimenuitem> the +selected items. You can also <guimenuitem>Cancel</guimenuitem> your +action. +</para> + +<para>Many other actions can be applied to the selected items by +right-clicking on one of the selected items, and choosing the action +from the menu which appears. (The exact contents of this menu depend on the +type of files selected, so it is called a <quote>context menu</quote>).</para> +</sect2> + +<sect2 id="links"> +<title>Links and Shortcuts</title> + +<para> +As already mentioned above you can link files or folders anywhere. It means +that the linked folder will appear and behave just like the original in +another location without consuming additional space on your harddrive. +So if you, for example, have a number of documents, and only a few are used +regularly, you can easily group them in a folder and create links in it. +</para> + +</sect2> + +<sect2 id="trash"> +<title>The Trash</title> + +<indexterm><primary>Trash</primary></indexterm> +<indexterm><primary><quote>Recycle Bin</quote></primary></indexterm> + +<para>Before a file is deleted in the &tde; file manager it will be +moved to the <filename>Trash</filename> folder to give you the +possibility of getting it back if you deleted it by accident. The +trash bin will show all deleted items. You can select the one to be +recovered and move it to its original place as described in <xref +linkend="filemanager-icons" />. If you right click on the trash bin and select +<guimenuitem>Empty trash bin</guimenuitem> the files in it will be +deleted permanently.</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> + +<listitem><para>The <ulink url="help:/konqueror">&konqueror; Handbook</ulink> +has much more information about the features available in +&konqueror;.</para> +</listitem> + +</itemizedlist> + +</sect2> +</sect1> diff --git a/doc/khelpcenter/userguide/titlebar-menu.png b/doc/khelpcenter/userguide/titlebar-menu.png Binary files differnew file mode 100644 index 000000000..d772e7995 --- /dev/null +++ b/doc/khelpcenter/userguide/titlebar-menu.png diff --git a/doc/khelpcenter/userguide/troubleshooting-network-x.docbook b/doc/khelpcenter/userguide/troubleshooting-network-x.docbook new file mode 100644 index 000000000..fd4610f2a --- /dev/null +++ b/doc/khelpcenter/userguide/troubleshooting-network-x.docbook @@ -0,0 +1,41 @@ +<sect1 id="troubleshooting-network-x"> +<sect1info> +<authorgroup> +<author>&J.Hall;</author> +</authorgroup> +</sect1info> +<title>Networking and X</title> +<para> +Misconfigured networking can often be the cause of &tde; applications launching slowly, or in the worst case not launching at all. Your &X-Server; has a very powerful client/server interface and is very network aware. +</para> +<para> + X uses the hostname to create both a unique key for authorization, and to figure out where (via $<envar>DISPLAY</envar>) to send + the actual windows it's drawing on screen. If your computer doesn't know it's own name, it will spend inordinate amounts of time + trying to look itself up, a fate you can avoid by simply teaching your computer what it's own name is. +</para> +<para> +Check your <filename>/etc/hosts</filename> file and ensure there is an entry for localhost that looks +something like this at the top of the file (after any comments). +</para> +<screen> +127.0.0.1 localhost +</screen> +<para> +You also should add your computers fully qualified domain name, short name, and it's usual ip address if it has a static ip. If your ip address is assigned dynamically using <acronym>DHCP</acronym> you can simply use the address for the loopback device. +</para> +<screen> +127.0.0.1 hal.btl hal (for dhcp) +192.168.0.1 hal.btl hal (static) +</screen> +<para> +Make sure that your firewall is not so restrictive that it stops packets to the loopback device. For example in iptables if the default rule on the <parameter>INPUT</parameter> chain for this device is set to anything other than <parameter>>ACCEPT</parameter> this will cause performance problems in X. To check this, you can type in: +</para> +<screen> +<prompt>%</prompt><userinput><command>iptables-save</command> <literal>|</literal> <command>grep</command> <option>lo</option></userinput> +<computeroutput><option>-A</option> <parameter>INPUT</parameter> <option>-i</option> <parameter>lo</parameter> <option>-j</option> <parameter>ACCEPT</parameter> +</computeroutput> +</screen> +<para> +The rule <computeroutput><option>-A</option> <parameter>INPUT</parameter> <option>-i</option> <parameter>lo</parameter> <option>-j</option> <parameter>ACCEPT</parameter></computeroutput> should always work, unless there are other misconfigured rules (Such as a <parameter>DROP</parameter> on the <parameter>OUTPUT</parameter> chain) +</para> +</sect1> diff --git a/doc/khelpcenter/userguide/troubleshooting-no-open.docbook b/doc/khelpcenter/userguide/troubleshooting-no-open.docbook new file mode 100644 index 000000000..80046478d --- /dev/null +++ b/doc/khelpcenter/userguide/troubleshooting-no-open.docbook @@ -0,0 +1,31 @@ +<sect1 id="troubleshooting-not-opening"> +<sect1info> +<authorgroup> +<author>&Lauri.Watts;</author> +</authorgroup> +</sect1info> +<title>When An Application Will Not Open</title> + +<para>Sometimes when you start an application, it does not open the expected +window. Here are some questions to answer and steps to help you figure out +what is wrong.</para> + +<variablelist> +<varlistentry> +<term>Did the application ever start, when launched in the same +manner?</term> +<listitem><para>If it did, for instance you have clicked an icon on your +desktop that previously worked, then it is unlikely to be a problem with the +launcher itself.</para> +<para>If, however, you normally start your application from an icon on +&kicker; and this time started it with a desktop icon, then it could simply +be that the launcher itself is wrong.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>But I can see the launch notification spinning cursor and taskbar entry. +</term> +<listitem><para>Foo</para></listitem> +</varlistentry> +</variablelist> +</sect1> diff --git a/doc/khelpcenter/userguide/under-the-hood.docbook b/doc/khelpcenter/userguide/under-the-hood.docbook new file mode 100644 index 000000000..0f7dbe111 --- /dev/null +++ b/doc/khelpcenter/userguide/under-the-hood.docbook @@ -0,0 +1,470 @@ +<chapter id="tinkering-under-the-hood"> + +<title>Tinkering Under the Hood of &tde;</title> + +<sect1 id="hand-editing-config-files"> + +<title>Hand-Editing Configuration Files</title> + +<sect2 id="hand-editing-intro"> +<title>Introduction</title> +<para>In &tde;, the configuration files are easy to edit with a simple +editor like &kate; as the configuration files are text files.</para> + +<para>An example of a text file:</para> + +<programlisting>[General] +AutoSave=1 +LastFile=/var/tmp/test.txt</programlisting> + +<para>The user-specific configuration files are stored in <filename +class="directory">.kde/share/config</filename> (replace +<filename>.kde</filename> with your $<envar>TDEHOME</envar> setting) and +the global ones are in the <filename +class="directory">share/config</filename> sub-directory of &tde;'s +installation path. (You can find this path by running the command +<command>tde-config --prefix</command>.) Their filenames typically +end in rc (without an initial period), for example <filename>kopeterc</filename>.</para> + +<warning><para> +Editing configuration files by hand can risk the stability of your +&tde; installation. Applications usually do not check what they read from the +configuration files. This means that they can be disturbed by what they +get as configuration and might even +crash.</para></warning> + +</sect2> + +<sect2 id="hand-editing-backups"> +<title>Backups</title> + +<para>So the first rule is to make a backup of your file before modifying +it. The backup is better stored outside any +<filename class="directory">.kde</filename> subdirectory +(or the corresponding $<envar>TDEHOME</envar> directory). Backups are anyway +a good idea in case of a major failure of &tde; that would +destroy important configuration files (for example your &kmail; settings, +which are in in the file <filename>kmailrc</filename>). +(Such a major failure should not happen but it still can happen.)</para> +</sect2> + +<sect2 id="hand-editing"> +<title>Editing</title> + +<para>So why would you want to touch the configuration files at all? Well, first you need it +when you want to enforce the KIOSK mode. Perhaps a developer has asked you +to add an entry to help him to solve a problem with the application. Perhaps you want to recover from +a problem without having to remove all the <filename +class="directory">.kde</filename> directory. Perhaps you want to learn more +about the depths of &tde;.</para> + +<para>Anyway, whatever your reason, you want to modify by hand a +configuration file.</para> + +<para>When planning to edit such a file, make sure that the application +using it is not running. If it is one of the basic configuration files, +consider editing the file while &tde; is not running at all.</para> + +<para>Ready? So make a backup of the file (Did I tell you this already?), +start you favorite editor (let us assume it is &kate;), load the file +(Be careful to load as UTF-8, &kate; displays it as +<quote>utf8</quote>).</para> + +<para>Now you have a file like:</para> + +<programlisting>[Group] +Key1=Value1 +Key2=Value2 +Key3=Value3</programlisting> + +<para>You can now modify it (with care!) and then save it (Be sure that it +is as <acronym>UTF-8</acronym> again).</para> + +<para>Now you can test the application and if the application does not run +correctly anymore, close the application and restore the backup of the +configuration file.</para> + +<!--<itemizedlist> +<title>Related Information</title> + + +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> has more +information about the &tde; directory structure, to help you find the +file you need to edit.</para> +</listitem> + +</itemizedlist>--> + +</sect2> + +</sect1> + +<sect1 id="scripting-the-desktop"> +<title>Scripting the Desktop</title> + +<para>&tde; provides a powerful interprocess communication system in +&DCOP;, the Desktop COmmunication Protocol. Using &DCOP;, you can +control a wide range of functions in &tde; from the command line or +from a script written in your favorite scripting language. You can +also get information out of &tde; applications: for example, several +&tde; media players provide methods to query the player for +information about the currently-playing track.</para> + +<para>Broadly speaking, each &tde; application provides one or more +&DCOP; <firstterm>interfaces</firstterm>, which in turn provide +methods (or, if you prefer, functions) that another application can +call. So, the first step in using &DCOP; is to find the appropriate +method for the task. The easiest way to do this is using the +<application>kdcop</application> frontend to the available &DCOP; +methods.</para> + +<para>Run <application>kdcop</application> from a &konsole; or the +mini-<acronym>CLI</acronym> (the window which pops up on <keycombo +action="simul">&Alt;<keycap>F2</keycap> </keycombo>). The +<application>kdcop</application> window shows the applications +currently running which provide &DCOP; interfaces, using a tree +view. +<!-- TODO: Describe the search lineedit thingy --> +In general, finding the correct method requires a little bit of +searching through the tree view, but a useful hint is that the +interface marked <quote>(default)</quote> usually contains the most +frequently-used functions.</para> + + + +<para>To test that the function does what we expect, double-click on +the <guilabel>setColor</guilabel> entry. To set the color +<varname>c</varname>, click on the color selector button, and choose a +color. Set whether the color should be color A with the +checkbox. Click <guilabel>OK</guilabel> and the background color is +set.</para> + +<para>To access the &DCOP; method from your favorite scripting +language, you can either use &DCOP; bindings, if available in the +tdebindings module, or call the <command>dcop</command> command-line +application. For simple usage, calling the +<command>dcop</command> command-line application is sufficient. To +call a &DCOP; method on the command line, we need to specify the +application and interface owning the method, the method itself, and +the arguments, in a form suitable for the shell.</para> + +<para>We specify the application, interface and method in that order, +followed by the arguments in the same order that they are shown in +<application>kdcop</application>. <command>dcop</command> +has plenty of other options: take a look at the output of +<userinput><command>dcop</command> +<option>--help</option></userinput>.</para> + +<para>That's enough theory: time for an example:</para> + +<example> +<title>A Background Color Changing Script with &DCOP;</title> + +<para>With the <command>dcop</command> command-line application and a +little bit of Perl, we're going to make a simple script which slowly +cycles the desktop background through the spectrum.</para> + +<para>Firstly, we look for the appropriate method with +<application>kdcop</application>. For this example, we'll short +circuit the searching, and go straight to it: the method we want is +<menuchoice><guimenu>kdesktop</guimenu><guisubmenu>KBackgroundIface</guisubmenu><guimenuitem>setColor</guimenuitem> +</menuchoice>. The arguments and return type of the function are shown +in the style of the C++ language. For +<methodname>setColor</methodname>, the arguments are a color, +<varname>c</varname>, which specifies the new background color, and a +boolean (true or false) value, <varname>isColorA</varname>, which +specifies whether the color is the first or second (this is useful for +setting gradients and so on).</para> + +<para>To use our <methodname>setColor</methodname> method on the +command line, we use the following: + +<screen> +<prompt>%</prompt> <userinput><command>dcop</command> kdesktop KBackgroundIface setColor '#ffffff' false</userinput> +</screen> +</para> + +<para>To specify the color, we used the +hexadecimal RGB value, as used in &HTML;. Note that it is enclosed in +single quotes to protect the <token>#</token> from the shell.</para> + +<para>To find the hexadecimal RGB value of a color, open any +color chooser dialog in a &tde; application (for example, in +&kcontrolcenter;, <menuchoice><guimenu>Appearance & Themes</guimenu><guimenuitem>Colors</guimenuitem> +</menuchoice>), select the color you want, and use the value given in +the <guilabel>HTML</guilabel> text box.</para> + + +<para>So, that's all we need from &DCOP;; now it's just a case of +writing a script around it. Here's a (very!) rough implementation: + +<programlisting> +<![CDATA[ +$min=49; # Minimum value of R, G, or B colour +$max=174; # Maximum value of R, G, or B colour +$step=5; # Amount to step colour by on each step +$sleeptime=15; # Interval in seconds between each step + +@start = ($max, $min, $min); +@colour = @start; + +while (1) { + foreach (0..5) { + my $which = $_ % 3; # Which colour (R, G or B) to change + my $updown = $_ % 2; # Whether to increase or decrease the colour value + do { + if ($updown == 0) { $colour[$which]+=$step; } + if ($updown == 1) { $colour[$which]-=$step; } + my $dcopcall=sprintf "dcop kdesktop KBackgroundIface setColor '#%x%x%x' true\n", @colour; + system($dcopcall); + sleep $sleeptime; + } while (($colour[$which] >= $min) and ($colour[$which] <= $max)); + } +} +]]> +</programlisting> +</para> + +<para>Just run the script with no arguments, and it will cycle the +background colour through a slightly muted spectrum until it is +killed. <foreignphrase>Voilà</foreignphrase>!</para> + +</example> + +<para>Of course, Perl isn't the only language you can use to write +scripts with &DCOP;—if you prefer shell scripting, that's +available too:</para> + +<example> +<title>Setting a background from the Internet</title> + +<para>The following script gets the main image from the <quote>User +Friendly</quote> comic strip and sets it as the desktop wallpaper, +using commonly available tools and a little bit of &DCOP;:</para> + +<programlisting> +<![CDATA[ +#!/bin/sh +COMICURL=`wget -qO - http://www.userfriendly.org/static/index.html | \ + grep Latest | sed -e "s,.*SRC=\",," -e "s,\">.*,,"` +TMPFILE=`mktemp /tmp/$0.XXXXXX` || exit 1 +wget -q -O $TMPFILE $COMICURL +dcop kdesktop KBackgroundIface setWallpaper $TMPFILE 1 +]]> +</programlisting> + +<para>The first line after the #!/bin/sh uses <command>wget</command> and some regular +expression magic to extract the image location from the main page's +&HTML; source. The second and third lines download the image, and +finally, <command>dcop</command> sets the downloaded image as +wallpaper.</para> + +</example> + + +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist> --> + + +</sect1> + + +<sect1 id="adding-extra-keys"> +<title>Adding Extra Keybindings to &tde;</title> + +<para>Many modern keyboards contain extra keys that are not by default +assigned to any action.</para> + +<para><quote>Multimedia</quote> keys often generate a signal, and can simply +be chosen as a keybinding within an application just like choosing any other +key. Some keys however, are not detected and pressing them in a +<guilabel>Configure Shortcuts</guilabel> has no effect.</para> + +<para>Some IBM laptops, for instance, have extra keys about the left and right +arrows, which look like <guiicon>page left</guiicon> and <guiicon>page +right</guiicon>.</para> + +<procedure> +<step><para>Use <command>xev</command> to find the code of the keys. In +this case, they are 233 and 234 <!-- TODO: Very briefly how to use xev here --> +</para></step> +<step><para>Choose key symbols. There are quite a range of these that are not +used by default, so many are free. You can find the list in +<filename>/usr/X11R6/include/X11/keysymdef.h</filename> (or its equivalent +on your system).</para></step> +<step><para>Create a file in your home directory called +<filename>.Xmodmap</filename>, and add to it the following:</para> +<screen>keycode 233 = Next_Virtual_Screen +keycode 234 = Prev_Virtual_Screen</screen> +</step> +<step><para>Run the command <userinput><command>xmodmap</command> +<filename>~/.Xmodmap</filename></userinput></para></step> +</procedure> + +<para>At this point, you should be able to run <command>xev</command> again +and see that the keys now generate the keysym that you assigned. You can now +simply assign them to any action as normal.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>The <command>xev</command> manpage. You can see this by typing +<userinput>man:/xev</userinput> into a &konqueror; window or by typing +<userinput><command>man</command> xev</userinput> into a terminal.</para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="keys-for-scripts"> +<title>Adding Keybindings for New Actions</title> + +<para>Most actions in either the desktop or in applications are readily +available to assign a keybinding to. If the action you want a +shortcut for is something you wrote yourself, or is otherwise not available, +you can still assign a shortcut.</para> + +<para>To bring together the two previous sections, perhaps you want to +assign an otherwise unused key on your keyboard to a script or dcop +command. Our example here will be to assign the two keys we added +in <xref linkend="adding-extra-keys"/> to go to the previous or +next virtual desktop, two functions for which you will need DCOP (as discussed in +<xref linkend="scripting-the-desktop"/>).</para> + +<para>This can be achieved easily using the following method:</para> + +<procedure> +<step> +<para>Open &kcontrol;, and in the <guilabel>Regional & Accessibility</guilabel> +section, select <guilabel>Input Action</guilabel></para> +</step> +<step> +<para>Choose <guibutton>New Action</guibutton></para> +</step> +<step> +<para>Name the new action, ⪚ <userinput>Next Virtual +Screen</userinput></para> +</step> +<step> +<para>Select <guilabel>Keyboard shortcut -> Command/URL (simple)</guilabel> +for the <guilabel>Action type:</guilabel></para> +</step> +<step> +<para>In the <guilabel>Keyboard Shortcut</guilabel> tab, click the button +you wish to use to trigger the command. For this example, you would press +the one with the <guiicon>Next Page</guiicon> picture on it. +<keysym>Next_Virtual_Screen</keysym> will appear in the key image.</para> +</step> +<step> +<para>In the <guilabel>Command/URL Settings</guilabel> tab, enter the +command to run in the field: <userinput><command>dcop twin default +nextDesktop</command></userinput></para> +</step> +</procedure> + +<para>Repeat the above with the <keysym>Prev_Virtual_Screen</keysym> key and +<userinput><command>dcop twin default +previousDesktop</command></userinput>.</para> + +<para>Now pressing the <keysym>Prev_Virtual_Screen</keysym> or +<keysym>Next_Virtual_Screen</keysym> will switch you to the previous or next +virtual desktop, respectively.</para> + +<para>Obviously you can assign any free key to any action.</para> + +<itemizedlist> +<title>Related Information</title> +<listitem><para>See the <application>KHotKeys</application> documentation by +looking it up in &khelpcenter;, or typing +<userinput>help:/khotkeys</userinput> in a &konqueror; +window.</para></listitem> +<listitem><para><xref linkend="adding-extra-keys"/></para></listitem> +<listitem><para><xref linkend="scripting-the-desktop"/></para></listitem> +</itemizedlist> + +</sect1> + +<sect1 id="tdedebugdialog"> + +<title>&tdedebugdialog; - Controlling &tde;'s Debugging Output</title> + +<sect2 id="tdedebugdialog-basic-usage"> +<title>Basic Usage</title> + +<para>&tdedebugdialog; is not in the &kmenu; by default. You will need to run +it from the shell or from the mini-CLI <!-- link to CLI, for sure --> with +the command <userinput><command>tdedebugdialog</command></userinput>. +&tdedebugdialog; pops up a window with a long list of debugging areas. Each +area has a checkbox that you can check or uncheck <!-- perhaps +select/deselect --> in order to enable or disable debugging output for +that part of &tde;.</para> + +<para>The list of debugging areas is sorted numerically, not alphabetically, +so tdeio (127) comes before artskde (400). The numbers go up to 200000 or so, +but there are really only 400 areas. You don't have to scroll through the +entire list to find the area you need, though. There is a line edit <!-- +text-entry ? --> box at the top of the dialog where you can enter a part of +the name of the area you want. The list of entries that is displayed is +filtered to include only those debug areas that contain the text you have +entered. ⪚ entering <userinput>k</userinput> does not filter very much at +all, but entering <userinput>kont</userinput> <!-- that's "butt" in dutch, +haha --> will show you just the &kontact; debugging areas. As an even +quicker way of enabling or disabling debugging output, there are also +<guibutton>select all</guibutton> and <guibutton>deselect all</guibutton> +buttons which will cause &tde; to produce a mountain of debugging output, or +very little.</para> +</sect2> + +<sect2 id="tdedebugdialog-fullmode"> +<title>TDEDebugDialog in full mode</title> + +<!-- this text partly taken from the tdedebugdialog handbook --> + +<para>In full mode, which is what you get when you start tdedebugdialog as +<userinput><command>tdedebugdialog</command> +<option>--fullmode</option></userinput>, the same list of debugging areas +as in plain mode is available, but you can select only one at a time from a +drop-down <!-- combo? --> box. You may then independently set the output +for various types of messages: Information, Warning, Error and Fatal Error. +For each of these types, you can choose where the messages are sent. The +choices are:</para> + +<para>File, in which case you can enter a filename. This file is written into your +$<envar>HOME</envar> directory.</para> + +<para>Message Box. Each debugging message is displayed in an information dialog, +which you must <guibutton>OK</guibutton> to continue with the +application.</para> + +<para>Shell, the default entry. Messages are printed to stderr, and will appear + either in the shell window where the application was started, or +in <filename>.xsession-errors</filename>.</para> + +<para>Syslog. This sends each debugging message to the system's syslog facility, +which can perform its own processing of the message.</para> + +<para>None. This suppresses the output of this type of message.</para> + +<para>For messages generated by fatal errors, it is generally a bad idea to choose +None or Syslog, since in both cases you most likely will not see the message +and the application that encounters the fatal error will vanish without +leaving a clue as to why it vanishes. Whether or not the application will +vanish on fatal errors can be controlled by the checkbox <guilabel>abort on +fatal errors</guilabel>, which is checked by default — but you might +expect an application to crash (in a messy fashion) if a fatal error is +encountered anyway.</para> + +<!-- Add links to "further reading" here --> +<!-- <itemizedlist> +<title>Related Information</title> +<listitem><para>to be written</para> +</listitem> +</itemizedlist>--> + + + +</sect2> +</sect1> +</chapter> diff --git a/doc/khelpcenter/userguide/usenet.docbook b/doc/khelpcenter/userguide/usenet.docbook new file mode 100644 index 000000000..a307e45f3 --- /dev/null +++ b/doc/khelpcenter/userguide/usenet.docbook @@ -0,0 +1,233 @@ +<chapter id="usenet"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Usenet News</title> + +<para>Usenet newsgroups are forums in which you can post messages to discuss +various topics: almost any subject you like (and many you don't!) can +be found there. Although usenet has become less popular than it once +was, because of the increasing use of web forums, &etc;, it is still a +useful tool. &tde; provides a powerful usenet news reader called &knode;.</para> + +<para>You can find &knode; in the <guimenu>TDE</guimenu> Menu under the +<guisubmenu>Internet</guisubmenu> entry: the menu entry +<guimenuitem>&knode; (News Reader)</guimenuitem> launches the program.</para> + + +<para>The main window of &knode; should now be displayed on your +desktop as shown; on the first start, the settings dialog will be +invoked.</para> + +<screenshot> +<screeninfo>Setting up &knode;</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-start.png" format="PNG"/> </imageobject> +<textobject> +<phrase>&knode; after first start</phrase> +</textobject> +<caption> +<para>&knode; after first start</para> +</caption> +</mediaobject> +</screenshot> + +<sect1 id="knode-setting-your-identity"> +<title>Personal settings</title> + +<para>The first page of the settings dialog is for personal settings: </para> +<screenshot> +<screeninfo>Dialog for entering personal information</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-identity.png" format="PNG"/> </imageobject> +<textobject> +<phrase>Entering personal information</phrase> +</textobject> +<caption> +<para>Entering personal information</para></caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term> +<guilabel>Name</guilabel></term> +<listitem> +<para>In the field <guilabel>Name</guilabel>, enter your name. This +name will later appear in the newsgroups as sender, and can be seen by +anyone.</para> + +<para>Filling out the field <guilabel>Name</guilabel> is +mandatory.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<guilabel>Email address</guilabel></term> +<listitem> +<para>The email address you enter here will be used as sender in news +articles, &ie; as actual address of the author, in conjunction with +the real name (set in the field <guilabel>Name</guilabel>).</para> + +<para>Filling out the <guilabel>Email Address</guilabel> field is +mandatory.</para> + +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="knode-setting-the-news-account"> +<title>Configuring the news account</title> + + +<para>Now we must tell &knode; about where we get the news from or +where to send the articles to later on. In the list on the +right, there is an <guilabel>Accounts</guilabel> entry; click on it and choose the +<guilabel>Newsgroup servers</guilabel> tab, because we first want to configure +the news account: the list of accounts is still empty.</para> + +<para>To create a new account click on <guibutton>Add...</guibutton>. The +following dialog appears:</para> + +<screenshot> +<screeninfo>The <guilabel>New Account</guilabel> dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-news-account.png" format="PNG"/> </imageobject> +<textobject> +<phrase>The <guilabel>New Account</guilabel> dialog</phrase> +</textobject> +<caption> +<para>The <guilabel>New Account</guilabel> dialog</para> +</caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Name</guilabel></term> +<listitem> +<para>The <guilabel>Name</guilabel> field can be filled in as you +like; the text you enter will later be visible in the folder view. You +could, for example, enter the name of your Internet Provider; for our example we +enter the name <userinput>My News Account</userinput>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Server</guilabel></term> +<listitem> + +<para>The next field is labelled <guilabel>Server</guilabel>. Unlike +the field <guilabel>Name</guilabel>, what you enter here is important. +The name of the news server is fixed and you should be able to get it +from your Internet service provider; if you do not know the name of +the news server, you should get it now: without this information you +cannot read any news. If your Internet service provider doesn't own a +news server you can use a public one (universities often provide +public news servers.)</para> + +<para>For our example configuration we enter the name +<userinput><systemitem +class="systemname">news.server.com</systemitem></userinput>; you will, +of course, enter the real name of your news server.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> +<para>You probably will not need to change this from the default in most +cases.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="knode-setting-the-mail-account"> +<title>Setting up the mail account</title> + +<para>Sometimes you need to answer to the author of an article +directly, without posting to the newsgroup; for example, when you want +to make a very personal comment or want to correct an error. If you +want to do this, select the <guilabel>Mail Server (SMTP)</guilabel> tab. The +following dialog box appears:</para> + +<screenshot> +<screeninfo>Dialog Box for setting up the mail account</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="knode-mail-account.png" format="PNG"/> </imageobject> +<textobject> +<phrase>Setting up the mail account</phrase> +</textobject> +<caption> +<para>Setting up the mail account</para> +</caption> +</mediaobject> +</screenshot> + +<variablelist> + +<varlistentry> +<term><guilabel>Server</guilabel></term> +<listitem> +<para>The name (address) of your mail server as provided by your +Internet service provider or system administrator; all you have to do +here is enter the mail server's name in the +<guilabel>Server</guilabel> field.</para> + +<para>In our example we enter <userinput><systemitem +class="systemname">mail.server.com</systemitem></userinput></para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guilabel>Port</guilabel></term> +<listitem> + +<para>Again, you probably will not need to change the +<guilabel>Port</guilabel> setting.</para> +</listitem> +</varlistentry> +</variablelist> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para>The comp.windows.x.kde newsgroup is the main user +support group for &tde; on usenet. You can find other resources for +getting help with &tde; in <xref linkend="getting-help"/>.</para> +</listitem> +<listitem><para><ulink url="http://gmane.org">Gmane</ulink> provides a +usenet frontend to many mailing lists, including most of the &tde; +lists, so you can read them with &knode;.</para> +</listitem> +</itemizedlist> + + +</sect1> + +</chapter> diff --git a/doc/khelpcenter/userguide/where-next.docbook b/doc/khelpcenter/userguide/where-next.docbook new file mode 100644 index 000000000..840bf3084 --- /dev/null +++ b/doc/khelpcenter/userguide/where-next.docbook @@ -0,0 +1,22 @@ +<chapter id="where-next"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<chapterinfo> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</chapterinfo> +--> + +<title>Where To Next?</title> + +<para>Web Sites</para> + +<para>Books</para> + +</chapter> diff --git a/doc/khelpcenter/userguide/windows-how-to.docbook b/doc/khelpcenter/userguide/windows-how-to.docbook new file mode 100644 index 000000000..25dc3ba80 --- /dev/null +++ b/doc/khelpcenter/userguide/windows-how-to.docbook @@ -0,0 +1,500 @@ +<sect1 id="windows-how-to-work"> + +<title>Windows, How To Work Them</title> + +<sect2 id="basic-window-management"> +<title>Basic Window Management</title> +<indexterm><primary>Window Management</primary></indexterm> + +<para>In computer terminology, a window is a rectangular area containing information +that can be moved around the desktop. +Each application running in &tde; uses at least one window and some +applications use more than one window. These windows are manipulated or controlled +in many ways to make the desktop useful. Here is a +typical window: +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="a-window.png" format="PNG"/> +</imageobject> +<textobject><phrase>A normal window</phrase> +</textobject> +</mediaobject> +</screenshot> +</para> + +<sect3 id="switching-between-windows"> +<title>Switching Between Windows</title> +<indexterm><primary>Focus (windows)</primary></indexterm> + +<para>A window must be active or receive the focus to be used. When first starting +an application the main window immediately receives the focus and is ready to use. +Only one window can be active at a time. The active window is the one that responds +to user actions and can be distinguished from other windows by the different colored +titlebar.</para> + +<para>The titlebar is the top bar of a window that displays the name and description +of the window. The default titlebar also contains the Minimize, Maximize, and Close buttons +on the far right side.</para> + +<para>With the &tde; default theme, the active window has a +<replaceable>light blue</replaceable> titlebar, and the inactive +windows have <replaceable>gray</replaceable> titlebars.</para> + +<para> +<indexterm><primary>Raising Windows</primary></indexterm> +To work in a different window requires activating that window. +There are two ways to do this: +<itemizedlist> + +<listitem> +<para>Use the mouse pointer to select a window. When selected the window receives the focus +and becomes active and will be raised to the foreground above other windows.</para> +</listitem> + +<listitem> +<para><indexterm><primary><keycombo +action="simul">&Alt;	</keycombo></primary></indexterm> +With the keyboard, press and hold either &Alt; key and press the 	 key. +A popup dialog appears with a list of available windows. The currently active window that +has the focus will be selected automatically in the list. While pressing the &Alt; key, +select a different window by again pressing the 	 key to scroll through the list. +Release the &Alt; key and the window that is selected in the list receives the focus +and becomes the active window.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<sect3 id="moving-windows"> +<title>Moving Windows</title> +<indexterm><primary>Moving Windows</primary></indexterm> + +<para>One way to organize the windows on a desktop is to move +them. There are three ways to move a window: +<itemizedlist> +<listitem> +<para>Select the window titlebar using the &LMB; and continue holding the &LMB;. When +selected in this manner, moving the mouse pointer moves the window. Release the mouse +button and the window remains at that position.</para> +</listitem> + +<listitem> +<para>Select the window titlebar using the &RMB;, which causes a popup menu to appear +as displayed in the following image. From the popup menu select <guimenuitem>Move</guimenuitem>. +The mouse pointer moves to the center of the window. Move the mouse pointer +to move the window. After moving the window to the desired +position, use the &LMB; to release the window.</para> +<indexterm><primary>Window Menu</primary></indexterm> + +<screenshot> +<screeninfo>The Window Menu</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="titlebar-menu.png" format="PNG" /> +</imageobject> +<textobject> +<phrase>The Window Menu</phrase> +</textobject> +</mediaobject> +</screenshot> +</listitem> + +<listitem> +<para>Place the mouse pointer over the window to move. Press and hold either &Alt; key +and the &LMB;. The mouse pointer changes to a +compass. Moving the mouse then moves the window. Release the mouse +button to release the window. This method is +useful when the window titlebar has moved off the +screen and the previous methods cannot be used.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<sect3 id="resizing-windows"> +<title>Resizing Windows</title> + +<indexterm><primary>Resizing Windows</primary></indexterm> + +<para>The window size can be changed: bigger, smaller, wider, or taller. There +are two ways to resize a window. +Use either method: +<itemizedlist> +<listitem> +<para>Move the mouse pointer over one of the side borders of the window. The mouse pointer changes +into a horizontal double-headed arrow. Press and hold the &LMB; and drag the window border, +making the window bigger or smaller. Similarly, selecting the top or bottom +borders of the window will change the height of the window. +To concurrently change both width and height of a window, +move the mouse pointer over the corner of the +window. When the pointer becomes a diagonal double-headed arrow, select the border corner +and drag.</para> +</listitem> +<listitem> +<para>Use the left-most button on the window titlebar to display the +window menu. Choose the <guimenuitem>Resize</guimenuitem> entry, and +the mouse pointer will become a double-headed arrow. Move the mouse +pointer around to resize, and use the &LMB; to release the window.</para> +</listitem> +<listitem> +<para>When the window border or the button for the window menu are not visible, +usethe &Alt; key and &RMB;: Press and hold the &Alt; key and drag with +the &RMB;. The window will resize. Release the &RMB; when finsihed resizing.</para> +</listitem> +</itemizedlist> +</para> + +<para>Windows may be maximized in size to use the entire screen. Use the +<guibutton>Maximize<indexterm><primary>Maximizing +Windows</primary></indexterm></guibutton> button, which is located on the window titlebar, +the second button from the right. Selecting that button with the mouse +will force the window to resize as large as the screen allows in both +directions. Alternately, selecting that button with the &MMB;<indexterm><primary>Maximizing +Windows</primary><secondary>Vertically</secondary></indexterm> or the +&RMB;<indexterm><primary>Maximizing Windows</primary><secondary>Horizontally</secondary></indexterm> +will increase the window's size in only the vertical or horizontal direction, respectively.</para> + +</sect3> + +<sect3 id="hiding-windows"> +<title>Hiding Windows</title> +<indexterm><primary>Hiding Windows</primary></indexterm> + +<!-- TODO: Screenshot of the minimize button --> +<para> +<indexterm><primary>Minimize</primary></indexterm> +A window can be made to shrink out of view without closing the application. +There are two ways to shrink a window: minimizing and shading. To +minimize a window, select the <guibutton>Minimize</guibutton> button, +which is located on the window titlebar, third button from the right. The window will +not be displayed, but the application remains running as can be seen +in the taskbar on the panel. To display the window again, +use the mouse to select the respective rectangular button in the taskbar or use the <keycombo +action="simul">&Alt;	</keycombo><indexterm><primary><keycombo +action="simul">&Alt;	</keycombo></primary></indexterm> as described in <xref +linkend="switching-between-windows" />.</para> + +<para> +<indexterm><primary>Shade</primary></indexterm> +Shading windows is similar to minimizing, but the titlebar of the window +remains on the screen. To shade a window, use the mouse to "double-click" +on the titlebar. To restore the window, again "double-click" on the titlebar.</para> +</sect3> + +<sect3 id="cascade-windows"> +<title>Cascading Windows</title> + +<para>Sometimes you might have a whole lot of windows open and all over the place. By selecting to cascade windows &tde; will automatically line them up as a succession from the top-left of your screen. To use this option use your &MMB; on the desktop, and then select <guimenuitem>Cascade Windows</guimenuitem>.</para> + +</sect3> + +<sect3 id="unclutter-windows"> +<title>Uncluttering Windows</title> + +<para>By selecting to unclutter your opened windows &tde; will attempt to use the maximum available space of the desktop in order to display as much of each window as possible. For example, should you have four windows open and you request that they be uncluttered, they will each be placed in a corner of the desktop, regardless of where they were originally. To use this option once again use your &MMB; on the desktop and then select <guimenuitem>Unclutter Windows</guimenuitem>.</para> + +</sect3> + +<sect3 id="closing-windows"> +<title>Closing Windows</title> + +<indexterm><primary>Closing Windows</primary></indexterm> + +<para>When you finish using an application, you will want to stop +the application and close its window. Once again, you have the choice +of a few options: +<itemizedlist> +<listitem> +<para>Click on the right-most button on the window titlebar.<!-- TODO: --> +<!-- Screenie --> If you are editing a document with that application, +you will be asked whether you want to <guibutton>Save</guibutton> your +changes, <guibutton>Discard</guibutton> them, or +<guibutton>Cancel</guibutton> your command to close the application.</para> +</listitem> +<listitem> +<para>Use the <menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem> +</menuchoice> option on the menubar. You will be presented with the +same choice of <guibutton>Save</guibutton>, +<guibutton>Discard</guibutton>, or +<guibutton>Cancel</guibutton>.</para> +</listitem> + +<listitem> +<para> <mousebutton>Right</mousebutton>-click on the respective window in &kicker;, the &tde; panel, and then select <guimenuitem>Close</guimenuitem>. You will be prompted with an option to save any documents that were being edited.</para> +</listitem> + +<listitem> +<para>Press <keycombo action="simul">&Alt;<keycap>F4</keycap></keycombo><indexterm><primary><keycombo action="simul">&Alt;<keycap>F4</keycap> +</keycombo></primary></indexterm> +. Once again, the confirmation dialog will be shown if you +were editing any documents.</para> +</listitem> +</itemizedlist> +</para> + +</sect3> + +<!-- Let's try organising this a different way +<para>The bar along the top is called the titlebar, and contains most +of the things you'll need to manipulate the window. Let's take a +closer look: +<screenshot> +<mediaobject> +<imageobject> +<imagedata fileref="titlebar.png" format="png"/> +</imageobject> +<textobject><phrase>A window titlebar</phrase> +</textobject> +</mediaobject> +</screenshot> +<note><para>This screenshot shows the titlebar which appears in the +default &tde; configuration. The exact appearance on your system may +be slightly different, but the functions are similar.</para> +</note> +--> + +<!-- TODO:Note &MMB; mouse button/&RMB mouse button on maximize for +vertical/horizontal maximization. Or is this advanced? --> + +</sect2> + +<sect2 id="advanced-window-management"> +<title>Advanced Window Management</title> + +<para>kstart</para> +<sect3 id="kstart"> + +<title>&kstart;</title> + +<para>The simplest way to access the advanced window management +facilities in &tde; is to use a little known +utility called &kstart;. &kstart; lets you control the way an application interacts with +the window manager. The command is usually +used to define special behavior for commonly-used applications, but +it can also be useful for integrating non-&tde; applications into your +desktop.</para> + +<para>Using &kstart; is easy: you simply put +<userinput><command>kstart</command></userinput> and some options +before a command. To begin, let's look at how we might use +&kstart; to customize the behaviour of a +&kcalc; window. The command we'll use is as follows: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--ontop</option> <option>--alldesktops</option> <option>kcalc</option></userinput></screen> +</para> + +<para>Hopefully the effect this command is +obvious - the kcalc window will stay on top of all +the others and be visible on every virtual desktop. A feature that is +less obvious is that this command will work with any NET compliant +environment, not just &tde;.</para> + +<para>We can pass arguments to programs we invoke with &kstart; as normal, for +example: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--skiptaskbar</option> <option>--desktop</option> 1 xmessage 'Hello World'</userinput></screen> + +</para> + +<para>This command displays <computeroutput>Hello +World</computeroutput> with <application>xmessage</application> and +ensures that the window will be shown on the first virtual desktop and +will be omitted from the taskbar. The fact that this program is +written using the Xt toolkit rather than being a native &tde; +application does not cause any problem for +&kstart;. Hopefully this illustrates how +&kstart; can be used to integrate foreign +applications into your &tde; desktop.</para> +</sect3> + +<sect3 id="special-window-settings"> +<title>Other Special Window Settings</title> +<para>While you can use &kstart; to assign particular window settings, &tde; also allows you to alter these — as well as other similar settings — from the program window itself. Simply select the left-most button in the window titlebar (or press <keycombo action="simul">&Alt;<keycap>F3</keycap></keycombo> after the window is focused), and then go to <menuchoice><guisubmenu>Advanced</guisubmenu><guimenuitem>Special Window Settings...</guimenuitem></menuchoice>. As you can see, from here you change various things from its geometry upon startup, to whether it should have a border or not.</para> +</sect3> + +<sect3 id="system-tray"> + +<title>The System Tray</title> + +<para>Now that we know how to customize the decoration of a window +let's take a look at another aspect of the desktop: the system +tray. The system tray is an area in which an application can display a +small window. It is used to display status information or provide +quick access to commands. A window that has an item in the system tray +usually disappears from the task manager when minimised with the tray +icon providing a replacement. Normally tray icons are specifically +developed as part of an application, but as with window decorations, +&tde; provides a tool for changing this: +<application>ksystraycmd</application>.</para> + +<para>To begin with, we'll take the standard application &kcalc; and turn +it into a system tray application. This is acheived with one simple +command: +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--title</option> 'kcalc' kcalc</userinput></screen> + +</para> + +<para>The icon shown in the tray is the one specified in the window +hints and will be updated if the icon changes. The window title is +shown as a tooltip if you hold the mouse pointer over the icon. +<application>ksystraycmd</application> follows standard &tde; +behaviour so the target window can be shown and hidden by clicking the +tray icon, and a standard context menu is available.</para> + +<screenshot> <mediaobject> <imageobject><imagedata +fileref="kcalc-systray.png"></imagedata></imageobject> +</mediaobject></screenshot> +</sect3> + +<sect3 id="more-complex-uses-of-ksystraycmd"> + +<title>More Complex Uses of +<application>ksystraycmd</application></title> + +<para>To illustrate the other features of +<application>ksystraycmd</application>, we'll use a more complicated example: a &konsole; window tracking the +<filename>.xsession-errors</filename> file (this is the log file that records what's +happening on your desktop). To begin with, we'll simply look at how +we can view this: +<screen><prompt>%</prompt> <userinput><command>konsole</command> <option>--icon</option> log <option>--caption</option> 'X Log' \ +<option>--nomenubar</option> <option>--notabbar</option> <option>--noframe</option> \ +<option>-e</option> tail -f ~/.xsession-errors</userinput></screen> +</para> + + <para>The <option>--caption</option> and <option>--icon</option> +arguments are provided as standard by &tde; applications. You can get +a full list of these global options by running an application with the +<option>--help-kde</option> and <option>--help-qt</option> +parameters. Here we give our &konsole; window the title 'X Log' and +the icon <quote>log</quote>. You can use these options with any &tde; application and +as mentioned above, <application>ksystraycmd</application> takes account of these when creating +the tray icon. The <option>-e</option> argument is specific to &konsole; and tells it +to run the <command>less</command> command. Despite its complexity, we can easily move +this window into the tray with <application>ksystraycmd</application>: + +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--hidden</option> <option>--title</option> 'X Log' \ +konsole --icon log --caption 'XLog' \ +--nomenubar --notabbar --noframe \ +-e tail -f .xsession-errors</userinput></screen> +</para> + + <para>In addition to being the +most complex command we've used, this example demonstrates the +<option>--hidden</option> option which starts the command with only the system tray +icon visible. This example achieves our aim of providing quick access +to the log file, but we can do things a little more efficiently if we +only run the konsole process when it is visible. The command we use +is +<screen><prompt>%</prompt> <userinput><command>ksystraycmd</command> <option>--startonshow</option> \ + --<option>icon</option> log <option>--tooltip</option> 'X Log' \ +konsole --icon log --caption 'X Log' \ +--nomenubar --notabbar --noframe \ +-e tail -f ~/.xsession-errors</userinput></screen> +</para> + +<para>The addition of the <option>--startonshow</option> parameter tells +<application>ksystraycmd</application> to start with only the tray +icon visible (like the <option>--hidden</option> parameter), and to wait until the user +activates the tray icon before running the target command. We've also +used the <option>--quitonhide</option> parameter which tells <application>ksystraycmd</application> to terminate +the target app whenever its window is hidden. Using both these +parameters ensures that our &konsole; tray icon doesn't waste resources +when we aren't using it. Creating and destroying the target window as +we do here prevents the standard icon and title handling of +<application>ksystraycmd</application> from working, so we now need to +specify the initial icon and tooltip explicitly +too.</para> +</sect3> + +<sect3 id="improving-reliability"> + +<title>Improving Reliability</title> + +<para>In all of our previous examples we've relied on +&kstart; and +<application>ksystraycmd</application> to figure out which window we +want to affect, and unless we say otherwise, they assume that the first +window to appear is the one we want. This policy is usually OK because +we are starting the application at the same time, but it can fail +badly when lots of windows are appearing (such as when you log on). To +make our commands more robust we can use the +<option>--window</option> parameter. This specifies the title +of the target window. The following example uses the <option>--window</option> parameter +to ensure that a particular konsole window is affected: + +<screen><prompt>%</prompt> <userinput><command>kstart</command> <option>--iconify</option> <option>--window</option> 'kstart_me' konsole --caption 'kstart_me' -e tail -f ~/.xsession-errors</userinput></screen> + +</para> + +<para>Here we've used the tried and tested technique of specifying a +title for both &kstart; and the target application. This is generally +the best way to use &kstart; and <application>ksystraycmd</application>. The <option>--window</option> argument is +supported by both &kstart; and <option>ksystraycmd</option> and can be regular expression +(⪚ <quote>window[0-9]</quote>) as well as a particular title. (Regular +expressions are a powerful pattern matching tool you'll find used +throughout &tde;.) </para> + +</sect3> + +</sect2> + +<sect2 id="using-multiple-desktops"> +<title>Using Multiple Desktops</title> + +<indexterm><primary>Virtual Desktops</primary></indexterm> +<indexterm><primary>Multiple Desktops</primary></indexterm> + +<para>Sometimes, one screen's worth is just not enough space. If you +use many applications at the same time, and find yourself drowning in +different windows, virtual desktops offer a solution. By default, +&tde; has four virtual desktops, each one of which is like a separate +screen: you can open windows, move windows around, and set backgrounds and +icons on each of the desktops. If you are familiar with the concept of +virtual terminals, you will have no trouble with &tde;'s virtual +desktops.</para> + +<sect3 id="switching-virtual-desktops"> +<title>Switching Virtual Desktops</title> +<para>One way to move to a different desktop is to use the desktop pager in the panel. +Use the mouse pointer and &LMB; to select the desired desktop.</para> +<para>Another way to move to a different virtual desktop, is using <keycombo action="simul">&Ctrl;	 +</keycombo> in the same way as you would use <keycombo action="simul">&Alt;	 +</keycombo> to switch between windows (refer to the <xref linkend="switching-between-windows"/>): +Hold down &Ctrl; and then press +	. A small popup window appears, showing the virtual desktops, +with one highlighted. When you release &Ctrl;, &tde; will switch to the +highlighted virtual desktop. To select a different desktop, hold down &Ctrl; +whle pressing 	 repeatedly. The selection moves +through the available desktops. When the desktop you want to switch to +is highlighted, release &Ctrl;.</para> + +<!-- TODO: Write about the desktop pager thing --> + +</sect3> + +<sect3 id="windows-and-virtual-desktops"> +<title>Windows and Virtual Desktops</title> +<para>You can move windows to different virtual desktops with the +<guisubmenu>To Desktop</guisubmenu> item in the window menu button. Use the &LMB; +to select the window menu button and select the desktop to which you want to move +the window. You can make the window appear on all desktops with the <guimenuitem>All +Desktops</guimenuitem><indexterm><primary>Sticky +Windows</primary></indexterm> item.</para> + +<!-- Add links to "further reading" here +<itemizedlist> +<title>Related Information</title> +<listitem><para></para> +</listitem> +</itemizedlist> + +--> +</sect3> + + +</sect2> + +</sect1> diff --git a/doc/khelpcenter/userguide/your-tde-account.docbook b/doc/khelpcenter/userguide/your-tde-account.docbook new file mode 100644 index 000000000..96ec4b713 --- /dev/null +++ b/doc/khelpcenter/userguide/your-tde-account.docbook @@ -0,0 +1,62 @@ +<sect1 id="account-intro"> +<!-- Uncomment the <*info> below and add your name to be --> +<!-- credited for writing this section. --> + +<!-- +<sect1info> +<authorgroup> +<author> +<firstname>Your First Name here</firstname> +<surname>Your Surname here </surname> +</author> +</authorgroup> +</sect1info> +--> + +<title>About Your &tde; Account</title> + +<para>&tde; stores information about your personal settings in a few +different places: + +<itemizedlist> +<listitem><para>The hidden directory <filename>.kde</filename> (note the +period at the beginning), located in your home directory, contains a +large number of files that store &tde; settings. Some subdirectories +you may find useful are:<filename>.kde/share/config</filename>, which +contains configuration files for individual applications; +<filename>.kde/Autostart</filename>, which contains links to +applications which should start each time you start &tde;; and +<filename>.kde/share/apps/tdeabc</filename>, where your address book is +stored.</para> +</listitem> +<!-- FIXME: Apparently TDEDIR and TDEDIRS are deprecated. I need to --> +<!-- get the truth on this --> +<listitem><para>The environment variables <envar>TDEDIR</envar> and +<envar>TDEDIRS</envar> tell &tde; where its files are stored. You will +usually only need to set <envar>TDEDIR</envar> to the directory in which +&tde; is installed, but sometimes you might have other &tde; +programs installed elsewhere: in this case, you can use the +<envar>TDEDIRS</envar> environment variable. Set +<envar>TDEDIRS</envar> to a list of all the directories containing +&tde; programs, separated by commas. For example, if you have &tde; +programs in both <filename>/usr/local/kde</filename> and +<filename>/home/phil/kde</filename>, you can use <userinput>export +TDEDIR=/usr/local/kde,/home/phil/kde</userinput> if you use +<application>bash</application> or <userinput>setenv +TDEDIR=/usr/local/kde,/home/phil/kde</userinput> if you use sh. +</para> +</listitem> +</itemizedlist> +</para> + +<!-- Add links to "further reading" here --> +<itemizedlist> +<title>Related Information</title> +<listitem><para><ulink url="help:/khelpcenter/adminguide">The &tde; +Administrator Guide</ulink> contains +more information about the directories that &tde; uses.</para> +</listitem> +</itemizedlist> + + +</sect1> diff --git a/doc/khelpcenter/visualdict/CMakeLists.txt b/doc/khelpcenter/visualdict/CMakeLists.txt new file mode 100644 index 000000000..82b6a9816 --- /dev/null +++ b/doc/khelpcenter/visualdict/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION khelpcenter/visualdict ) diff --git a/doc/khelpcenter/visualdict/Makefile.am b/doc/khelpcenter/visualdict/Makefile.am new file mode 100644 index 000000000..81064650f --- /dev/null +++ b/doc/khelpcenter/visualdict/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/visualdict + diff --git a/doc/khelpcenter/visualdict/index.docbook b/doc/khelpcenter/visualdict/index.docbook new file mode 100644 index 000000000..6d3312353 --- /dev/null +++ b/doc/khelpcenter/visualdict/index.docbook @@ -0,0 +1,348 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "The &tde; Visual Guide"> + <!ENTITY package "tdebase"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> + +<title>The &tde; Visual Guide</title> + +<authorgroup> +<author>&tde-authors;</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>&tde-release-date;</date> +<releaseinfo>&tde-release-version;</releaseinfo> + +<copyright> +<year>2000-2006</year> +<holder>The &kde; Team</holder> +</copyright> +<copyright> +<year>&tde-copyright-date;</year> +<holder>&tde-team;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>A visual guide to the &tde; interface.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>TDE</keyword> +<keyword>Visual</keyword> +<keyword>Dictionary</keyword> +<keyword>Guide</keyword> +</keywordset> + +</bookinfo> + +<chapter id="visual-dictionary"> + +<!-- Translators please note: If you have already translated the visual --> +<!-- dictionary on the i18n website, please make sure the translations here --> +<!-- match that file exactly. --> + +<title>&tde; Visual Dictionary of terms</title> + +<para>This handbook is intended help users understand the vocabulary used in &tde; +documentation.</para> + +<para>We provide this for you here as an aid to learning your way around the +&tde; Graphical User Interface. These names have been standardized within &tde; +documentation, so you will always find interface items referred to in the +same way.</para> + +<tip><para>The term <quote>Widget</quote> refers to the basic building +block of a computer program's interface.</para> +<para>Each widget operates in a +similar manner each time it is used, but the effect that the widget has depends on +its place within the program.</para></tip> + +<!-- TODO: +Widgets to add: combo buttons (eg, the 'back' button in konq), popup +menus/context menus, passive popups, navigation panel buttons? + +Perhaps list deprecated names, for search/replace purposes? +--> +<sect1 id="widget-table"> +<title>Listing of Common &tde; Widgets</title> +<para>Currently, this guide consists of a table of the names of the graphical +elements often found in &tde; documentation, and an example of each one.</para> +<para>Our hope, eventually, is to make this a much more complete document, +which will take you on a visual tour of &tde;.</para> + +<informaltable> +<tgroup cols="2"> +<tbody> + +<row> +<entry>Button</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict12.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Check Boxes</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict13.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Color Selector</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict9.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Combo Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict2.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Context Menu</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict21.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Dialog Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict6.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Drop Down Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict1.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Icon List</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict16.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>List Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict7.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict8.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Menubar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict4.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Progress Bar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict17.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Radio Buttons</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict10.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Scroll Bar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict18.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Slider</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict15.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Spin Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict11.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Status Bar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict20.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Tab</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict22.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Tabbed Window</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict23.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Text Box</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict14.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Toolbar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict3.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +<row> +<entry>Tree View</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict19.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + + +<row> +<entry>Window Titlebar</entry> +<entry> +<inlinemediaobject> +<imageobject> +<imagedata fileref="pict5.png" format="PNG"/> +</imageobject> +</inlinemediaobject> +</entry> +</row> + +</tbody> +</tgroup> +</informaltable> +</sect1> +</chapter> +<chapter id="credits"> +<title>Credits and Licenses</title> +<para>&kappname;</para> + +<para>Documentation by the &tde; Documentation Team.</para> + +&underFDL; +</chapter> + +</book> + diff --git a/doc/khelpcenter/visualdict/pict1.png b/doc/khelpcenter/visualdict/pict1.png Binary files differnew file mode 100644 index 000000000..2a0d11097 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict1.png diff --git a/doc/khelpcenter/visualdict/pict10.png b/doc/khelpcenter/visualdict/pict10.png Binary files differnew file mode 100644 index 000000000..ff0748ac7 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict10.png diff --git a/doc/khelpcenter/visualdict/pict11.png b/doc/khelpcenter/visualdict/pict11.png Binary files differnew file mode 100644 index 000000000..e2b33ea3d --- /dev/null +++ b/doc/khelpcenter/visualdict/pict11.png diff --git a/doc/khelpcenter/visualdict/pict12.png b/doc/khelpcenter/visualdict/pict12.png Binary files differnew file mode 100644 index 000000000..69e958c00 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict12.png diff --git a/doc/khelpcenter/visualdict/pict13.png b/doc/khelpcenter/visualdict/pict13.png Binary files differnew file mode 100644 index 000000000..f70b40a75 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict13.png diff --git a/doc/khelpcenter/visualdict/pict14.png b/doc/khelpcenter/visualdict/pict14.png Binary files differnew file mode 100644 index 000000000..491505064 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict14.png diff --git a/doc/khelpcenter/visualdict/pict15.png b/doc/khelpcenter/visualdict/pict15.png Binary files differnew file mode 100644 index 000000000..81deaace4 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict15.png diff --git a/doc/khelpcenter/visualdict/pict16.png b/doc/khelpcenter/visualdict/pict16.png Binary files differnew file mode 100644 index 000000000..acb85b32c --- /dev/null +++ b/doc/khelpcenter/visualdict/pict16.png diff --git a/doc/khelpcenter/visualdict/pict17.png b/doc/khelpcenter/visualdict/pict17.png Binary files differnew file mode 100644 index 000000000..c5bfab766 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict17.png diff --git a/doc/khelpcenter/visualdict/pict18.png b/doc/khelpcenter/visualdict/pict18.png Binary files differnew file mode 100644 index 000000000..eb7fc172f --- /dev/null +++ b/doc/khelpcenter/visualdict/pict18.png diff --git a/doc/khelpcenter/visualdict/pict19.png b/doc/khelpcenter/visualdict/pict19.png Binary files differnew file mode 100644 index 000000000..22c841137 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict19.png diff --git a/doc/khelpcenter/visualdict/pict2.png b/doc/khelpcenter/visualdict/pict2.png Binary files differnew file mode 100644 index 000000000..69c64624a --- /dev/null +++ b/doc/khelpcenter/visualdict/pict2.png diff --git a/doc/khelpcenter/visualdict/pict20.png b/doc/khelpcenter/visualdict/pict20.png Binary files differnew file mode 100644 index 000000000..fac840877 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict20.png diff --git a/doc/khelpcenter/visualdict/pict21.png b/doc/khelpcenter/visualdict/pict21.png Binary files differnew file mode 100644 index 000000000..70f148c4e --- /dev/null +++ b/doc/khelpcenter/visualdict/pict21.png diff --git a/doc/khelpcenter/visualdict/pict22.png b/doc/khelpcenter/visualdict/pict22.png Binary files differnew file mode 100644 index 000000000..cc29e0f14 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict22.png diff --git a/doc/khelpcenter/visualdict/pict23.png b/doc/khelpcenter/visualdict/pict23.png Binary files differnew file mode 100644 index 000000000..0d3844382 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict23.png diff --git a/doc/khelpcenter/visualdict/pict3.png b/doc/khelpcenter/visualdict/pict3.png Binary files differnew file mode 100644 index 000000000..6a053a7ac --- /dev/null +++ b/doc/khelpcenter/visualdict/pict3.png diff --git a/doc/khelpcenter/visualdict/pict4.png b/doc/khelpcenter/visualdict/pict4.png Binary files differnew file mode 100644 index 000000000..88f4b85c4 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict4.png diff --git a/doc/khelpcenter/visualdict/pict5.png b/doc/khelpcenter/visualdict/pict5.png Binary files differnew file mode 100644 index 000000000..ec4b70f7a --- /dev/null +++ b/doc/khelpcenter/visualdict/pict5.png diff --git a/doc/khelpcenter/visualdict/pict6.png b/doc/khelpcenter/visualdict/pict6.png Binary files differnew file mode 100644 index 000000000..e5e1da4a8 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict6.png diff --git a/doc/khelpcenter/visualdict/pict7.png b/doc/khelpcenter/visualdict/pict7.png Binary files differnew file mode 100644 index 000000000..bfe63c9e5 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict7.png diff --git a/doc/khelpcenter/visualdict/pict8.png b/doc/khelpcenter/visualdict/pict8.png Binary files differnew file mode 100644 index 000000000..805b07964 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict8.png diff --git a/doc/khelpcenter/visualdict/pict9.png b/doc/khelpcenter/visualdict/pict9.png Binary files differnew file mode 100644 index 000000000..d8a4be594 --- /dev/null +++ b/doc/khelpcenter/visualdict/pict9.png |
