From 4aed2c8219774f5d797760606b8489a92ddc5163 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdebase@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- doc/userguide/Makefile.am | 4 + doc/userguide/a-window.png | Bin 0 -> 86896 bytes doc/userguide/accessibility.docbook | 168 ++ doc/userguide/amarok-icon.png | Bin 0 -> 2647 bytes doc/userguide/amarok.png | Bin 0 -> 14673 bytes doc/userguide/base-kde-applications.docbook | 441 ++++ doc/userguide/browser-fine-tuning.docbook | 71 + doc/userguide/burning-cds.docbook | 38 + doc/userguide/control-center.docbook | 922 ++++++++ doc/userguide/creating-graphics.docbook | 48 + doc/userguide/credits-and-license.docbook | 315 +++ doc/userguide/customizing-desktop.docbook | 365 +++ doc/userguide/desktop.png | Bin 0 -> 38608 bytes doc/userguide/email.docbook | 254 +++ doc/userguide/extragear-applications.docbook | 199 ++ doc/userguide/file-sharing.docbook | 109 + doc/userguide/font-installation.docbook | 79 + doc/userguide/getting-help.docbook | 213 ++ doc/userguide/glossary.docbook | 38 + doc/userguide/groupware-kontact.docbook | 614 +++++ doc/userguide/index.docbook | 611 +++++ doc/userguide/internet-shortcuts.docbook | 80 + doc/userguide/juk-icon.png | Bin 0 -> 2599 bytes doc/userguide/juk.png | Bin 0 -> 74846 bytes doc/userguide/kaboodle-icon.png | Bin 0 -> 2070 bytes doc/userguide/kaboodle.png | Bin 0 -> 21032 bytes doc/userguide/kcalc-systray.png | Bin 0 -> 5311 bytes doc/userguide/kcontrol.png | Bin 0 -> 84846 bytes doc/userguide/kde-as-root.docbook | 52 + doc/userguide/kde-edutainment.docbook | 342 +++ doc/userguide/kde-for-admins.docbook | 2747 +++++++++++++++++++++++ doc/userguide/kde-office.docbook | 321 +++ doc/userguide/kmag.png | Bin 0 -> 24008 bytes doc/userguide/kmousetool.png | Bin 0 -> 30666 bytes doc/userguide/kmouth.png | Bin 0 -> 17835 bytes doc/userguide/kmouth2.png | Bin 0 -> 21497 bytes doc/userguide/kmouth3.png | Bin 0 -> 45978 bytes doc/userguide/knode-identity.png | Bin 0 -> 49777 bytes doc/userguide/knode-mail-account.png | Bin 0 -> 43215 bytes doc/userguide/knode-news-account.png | Bin 0 -> 25150 bytes doc/userguide/knode-start.png | Bin 0 -> 27701 bytes doc/userguide/konq-sidebar.png | Bin 0 -> 30404 bytes doc/userguide/konq-simple.png | Bin 0 -> 94848 bytes doc/userguide/konsole-intro.docbook | 126 ++ doc/userguide/kopete.png | Bin 0 -> 18060 bytes doc/userguide/kppp-dialer-tab.png | Bin 0 -> 13648 bytes doc/userguide/kppp-wizard.png | Bin 0 -> 22471 bytes doc/userguide/messaging-intro.docbook | 188 ++ doc/userguide/migrator-applications.docbook | 272 +++ doc/userguide/migrator-dictionary.docbook | 38 + doc/userguide/net-connection-setup.docbook | 238 ++ doc/userguide/networking-with-windows.docbook | 128 ++ doc/userguide/noatun-icon.png | Bin 0 -> 2767 bytes doc/userguide/noatun.png | Bin 0 -> 16375 bytes doc/userguide/oggfolder.png | Bin 0 -> 88475 bytes doc/userguide/open-file-dialog.png | Bin 0 -> 71366 bytes doc/userguide/panel-and-desktop.docbook | 325 +++ doc/userguide/pdf-files.docbook | 40 + doc/userguide/playing-audiocds.docbook | 142 ++ doc/userguide/playing-movies.docbook | 48 + doc/userguide/playing-music.docbook | 150 ++ doc/userguide/printer-setup.docbook | 47 + doc/userguide/printing-from-apps.docbook | 40 + doc/userguide/programs-and-documents.docbook | 565 +++++ doc/userguide/programs-controlling.docbook | 39 + doc/userguide/removable-disks.docbook | 140 ++ doc/userguide/rip.png | Bin 0 -> 20916 bytes doc/userguide/ripsettings.png | Bin 0 -> 52908 bytes doc/userguide/screen-captures.docbook | 38 + doc/userguide/services.png | Bin 0 -> 77067 bytes doc/userguide/shared-sessions.docbook | 46 + doc/userguide/splash-screen.png | Bin 0 -> 42044 bytes doc/userguide/standard-menu-entries.docbook | 319 +++ doc/userguide/switching-sessions.docbook | 92 + doc/userguide/the-filemanager.docbook | 291 +++ doc/userguide/titlebar-menu.png | Bin 0 -> 45043 bytes doc/userguide/troubleshooting-network-x.docbook | 41 + doc/userguide/troubleshooting-no-open.docbook | 49 + doc/userguide/under-the-hood.docbook | 521 +++++ doc/userguide/usenet.docbook | 251 +++ doc/userguide/where-next.docbook | 40 + doc/userguide/windows-how-to.docbook | 559 +++++ doc/userguide/your-kde-account.docbook | 79 + 83 files changed, 12883 insertions(+) create mode 100644 doc/userguide/Makefile.am create mode 100644 doc/userguide/a-window.png create mode 100644 doc/userguide/accessibility.docbook create mode 100644 doc/userguide/amarok-icon.png create mode 100644 doc/userguide/amarok.png create mode 100644 doc/userguide/base-kde-applications.docbook create mode 100644 doc/userguide/browser-fine-tuning.docbook create mode 100644 doc/userguide/burning-cds.docbook create mode 100644 doc/userguide/control-center.docbook create mode 100644 doc/userguide/creating-graphics.docbook create mode 100644 doc/userguide/credits-and-license.docbook create mode 100644 doc/userguide/customizing-desktop.docbook create mode 100644 doc/userguide/desktop.png create mode 100644 doc/userguide/email.docbook create mode 100644 doc/userguide/extragear-applications.docbook create mode 100644 doc/userguide/file-sharing.docbook create mode 100644 doc/userguide/font-installation.docbook create mode 100644 doc/userguide/getting-help.docbook create mode 100644 doc/userguide/glossary.docbook create mode 100644 doc/userguide/groupware-kontact.docbook create mode 100644 doc/userguide/index.docbook create mode 100644 doc/userguide/internet-shortcuts.docbook create mode 100644 doc/userguide/juk-icon.png create mode 100644 doc/userguide/juk.png create mode 100644 doc/userguide/kaboodle-icon.png create mode 100644 doc/userguide/kaboodle.png create mode 100644 doc/userguide/kcalc-systray.png create mode 100644 doc/userguide/kcontrol.png create mode 100644 doc/userguide/kde-as-root.docbook create mode 100644 doc/userguide/kde-edutainment.docbook create mode 100644 doc/userguide/kde-for-admins.docbook create mode 100644 doc/userguide/kde-office.docbook create mode 100644 doc/userguide/kmag.png create mode 100644 doc/userguide/kmousetool.png create mode 100644 doc/userguide/kmouth.png create mode 100644 doc/userguide/kmouth2.png create mode 100644 doc/userguide/kmouth3.png create mode 100644 doc/userguide/knode-identity.png create mode 100644 doc/userguide/knode-mail-account.png create mode 100644 doc/userguide/knode-news-account.png create mode 100644 doc/userguide/knode-start.png create mode 100644 doc/userguide/konq-sidebar.png create mode 100644 doc/userguide/konq-simple.png create mode 100644 doc/userguide/konsole-intro.docbook create mode 100644 doc/userguide/kopete.png create mode 100644 doc/userguide/kppp-dialer-tab.png create mode 100644 doc/userguide/kppp-wizard.png create mode 100644 doc/userguide/messaging-intro.docbook create mode 100644 doc/userguide/migrator-applications.docbook create mode 100644 doc/userguide/migrator-dictionary.docbook create mode 100644 doc/userguide/net-connection-setup.docbook create mode 100644 doc/userguide/networking-with-windows.docbook create mode 100644 doc/userguide/noatun-icon.png create mode 100644 doc/userguide/noatun.png create mode 100644 doc/userguide/oggfolder.png create mode 100644 doc/userguide/open-file-dialog.png create mode 100644 doc/userguide/panel-and-desktop.docbook create mode 100644 doc/userguide/pdf-files.docbook create mode 100644 doc/userguide/playing-audiocds.docbook create mode 100644 doc/userguide/playing-movies.docbook create mode 100644 doc/userguide/playing-music.docbook create mode 100644 doc/userguide/printer-setup.docbook create mode 100644 doc/userguide/printing-from-apps.docbook create mode 100644 doc/userguide/programs-and-documents.docbook create mode 100644 doc/userguide/programs-controlling.docbook create mode 100644 doc/userguide/removable-disks.docbook create mode 100644 doc/userguide/rip.png create mode 100644 doc/userguide/ripsettings.png create mode 100644 doc/userguide/screen-captures.docbook create mode 100644 doc/userguide/services.png create mode 100644 doc/userguide/shared-sessions.docbook create mode 100644 doc/userguide/splash-screen.png create mode 100644 doc/userguide/standard-menu-entries.docbook create mode 100644 doc/userguide/switching-sessions.docbook create mode 100644 doc/userguide/the-filemanager.docbook create mode 100644 doc/userguide/titlebar-menu.png create mode 100644 doc/userguide/troubleshooting-network-x.docbook create mode 100644 doc/userguide/troubleshooting-no-open.docbook create mode 100644 doc/userguide/under-the-hood.docbook create mode 100644 doc/userguide/usenet.docbook create mode 100644 doc/userguide/where-next.docbook create mode 100644 doc/userguide/windows-how-to.docbook create mode 100644 doc/userguide/your-kde-account.docbook (limited to 'doc/userguide') diff --git a/doc/userguide/Makefile.am b/doc/userguide/Makefile.am new file mode 100644 index 000000000..488634323 --- /dev/null +++ b/doc/userguide/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = khelpcenter/userguide + diff --git a/doc/userguide/a-window.png b/doc/userguide/a-window.png new file mode 100644 index 000000000..3a0072f99 Binary files /dev/null and b/doc/userguide/a-window.png differ diff --git a/doc/userguide/accessibility.docbook b/doc/userguide/accessibility.docbook new file mode 100644 index 000000000..e3195635a --- /dev/null +++ b/doc/userguide/accessibility.docbook @@ -0,0 +1,168 @@ + + + + + + +Gary +Cramblitt + + + + +Accessibility + +Accessibility + +KDEAP (the &kde; Accessibility Project) aims to ensure that &kde;, as a desktop environment, is accessible to all users, including those of us with physical disabilities. In addition to the accessibility aids in the Control Center, &kde; has several other accessibility tools, which are available in the &kde;-Accessibility package. This package may not be installed on your computer; if it is not, you can download it from here: + + +kdeaccessibility-1.0.0.tar.gz, or +kdeaccessibility-1.0.0.tar.bz2 +MD5 +lsm file + + +For more information on the project, visit the &kde; Accessibility Home Page. + + +<application>KMouseTool</application> + +Mouseclicking +automatically + + + KMouseTool is a &kde; program, which clicks the mouse for you, so you + do not have to. KMouseTool works with any mouse or pointing device. + + + + + + + + KMouseTool + + + + +Related Information + MouseTool Website: http://mousetool.com + KMouseTool Handbook + + + + + +KMagnifier + +Magnifier + +KMagnifier (or kmag, 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. + + + + + + + + + KMag + + + + +Related Information + Website: http://kmag.sourceforge.net + KMag Handbook + + + + + +<application>KMouth</application> + +Speech + +KMouth is a KDE 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. + + + + + + + + + First screenshot of KMouth + + + + + + + + + + Second screenshot of KMouth + + + + + + + + + + Third screenshot of KMouth + + + + +Related Information + Website: http://www.schmi-dt.de/kmouth/index.en.html + KMouth Handbook + + + + + +<application>KTTS</application> - Text-to-Speech + +KTTS is a &kde; application for the conversion of text into audible speech. Currently, since &kde; 3.4, you can use KTTS to speak any text from the &klipper;, the &kde; 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. + +To get KTTS up-and-running you will need to start by running kttsmgr, the &kde; Text-to-Speech manager. + + + +Related Information + Website: http://accessibility.kde.org/developer/kttsd/ + KTTSD Handbook + + + + + + + diff --git a/doc/userguide/amarok-icon.png b/doc/userguide/amarok-icon.png new file mode 100644 index 000000000..575d9a274 Binary files /dev/null and b/doc/userguide/amarok-icon.png differ diff --git a/doc/userguide/amarok.png b/doc/userguide/amarok.png new file mode 100644 index 000000000..ddcb285bc Binary files /dev/null and b/doc/userguide/amarok.png differ diff --git a/doc/userguide/base-kde-applications.docbook b/doc/userguide/base-kde-applications.docbook new file mode 100644 index 000000000..863271b37 --- /dev/null +++ b/doc/userguide/base-kde-applications.docbook @@ -0,0 +1,441 @@ + + + + + +&Francis.Giannaros; +&Francis.Giannaros.mail; + + + + +The Base &kde; Applications + +What follows is a brief description of a few of the base &kde; applications. For more information on any of the applications you should check the links recommended with each respective entry. + + + + + + +Fundamentals + + + +&konqueror; + &kde;'s file manager, web browser, FTP client and much more. &konqueror; is the canvas for all the latest &kde; technology, from KIO 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. + + + Website: http://konqueror.org + View the handbook by typing help:/konqueror in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;. + + + + + + +&kate; + &kde;'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 C++, PHP and XML 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. + + + Website: http://kate.kde.org + &kate; Handbook + + + + + + + + + +&konsole; + The X terminal emulator for &kde;. &konsole;, like many &kde; 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 root and sudo sessions. + + + Website: http://konsole.kde.org + &konsole; Handbook + User Guide + + + + + + + +&kicker; + The &kde; 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. + + + See for altering some of its settings. + &kicker; Handbook + + + + + + +kdcop + + A GUI front-end to the powerful &DCOP; (Desktop COmmunications Protocol). &DCOP; provides a comprehensive protocol for interprocess communication between &kde; applications. While this is increasingly useful to &kde; programmers, it is also beneficial to the ordinary user who would want to create a script, or, say, a SuperKaramba theme. + + + In the User Guide and + Other Documentation: http://developer.kde.org/documentation/library/kdeqt/dcop.html + + + + + + +&kcontrol; + The control center for the K Desktop Environment. You can alter a myriad of different things, ranging from themes, fonts and screensavers, to Internet, security and system administration. + + + See . + &kcontrol; Handbook + + + + + + +&khelpcenter; + The &kde; help system is used to provide access to the base &UNIX; help pages (man or info) as well as the native &kde; documentation provided by the &kde; documentation team or the application authors. You should be able to access all of the &kde; application handbooks from here. + + + &khelpcenter; Handbook + For information on the &kde; Documentation team, how to possibly join and help &kde;, see: http://kde.org/documentation + + + + + + + + +Related Information + http://kde-apps.org -- The largest directory of third-party &kde; applications. + 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 KIO slave in &konqueror; (that is, type help:/application in the Location toolbar), or by selecting it in the &khelpcenter;. + You can also likely find out quite a bit of information from the &kde; website, itself, at http://kde.org. + + + + + + + + +&Francis.Giannaros; +&Francis.Giannaros.mail; + + + + +Personal Information Management + +&kde; PIM (Personal Information Manager) is a sub-project of &kde;, 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 -- &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. + + + +&kontact; + This serves as the medium by which the rest of the applications in &kde; PIM can integrate with one another. All of the applications in &kde; PIM 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. + + + Website: http://kontact.kde.org + View the handbook by typing help:/kontact in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;. + + + + + + +&kmail; + The mail component. &kmail; comes with full IMAP, POP3 and SMTP 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. + + + Website: http://kmail.kde.org + &kmail; Handbook + + + + + + +&korganizer; + 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. + + + Website: http://korganizer.kde.org + &korganizer; Handbook + + + + + + +&kaddressbook; + 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;, &kde;'s multi-protocol instant messenger. Other features include support for all international character sets and advanced search functions. + + + Website: http://pim.kde.org/components/kaddressbook.php + &kaddressbook; Handbook + + + + + + +&knotes; + A handy component which can serve to handle all your digital sticky notes. You can have them displayed on your desktop, they can be dragged n' dropped into emails, printed, or even be displayed after &kontact; is closed down. + + + Website: http://pim.kde.org/components/knotes.php + &knotes; Handbook + + + + + + +&knode; + The newsreader component. It is GNSKA (The Good Net-Keeping Seal of Approval) compliant, has support for MIME and multiple servers. + + + Website: http://knode.sourceforge.net/ + &knode; Handbook + + + + + + +&akregator; + A lightweight and fast program to display news items provided by feeds, supporting all commonly used versions of RSS and Atom feeds. Useful features include searching in article titles, management of feeds in folders and setting archiving preferences. + + Website: http://akregator.sourceforge.net + &akregator; Handbook + + + + + + + +Related Information + See http://kontact.kde.org and http://kdepim.kde.org for more information. + &kontact; Handbook + + + + + + +Network + +There are several network-related applications in &kde;. Below is a description of a few of these. + + + +&kopete; + A fully-featured and advanced IM (Instant Messaging) client, which has a number of protocols including MSN, Yahoo, and AIM. &kopete; can fetch display pictures, set aliases for particular persons, as well as run multiple IM 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. + + Website: http://kopete.kde.org + &kopete; Handbook + + + + + +&kdict; + A &GUI; front-end to the DICT protocol. It enables you to search through dictionary databases for a word or phrase, then displays suitable definitions. + + &kdict; Handbook + The DICT Development Group: http://www.dict.org/bin/Dict. + + + + + +&kget; + 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. + + + Website: http://kget.sourceforge.net + &kget; Handbook + + + + + + + +Related Information + Several more &kde; network applications can be found in the &kde; Extragear; see , under . + + + + + + +Office + +This includes all applications in the &koffice; suite. See for a summary of the components. + + + + + +Graphics + +&kde; has several graphics-related applications, ranging from PDF viewers to applications enabling you to take screenshots. Below is a delineation, as well as some related links, for a few of them. + + + + +KColorEdit + A small and handy application for editing color palettes, as well as color choosing and naming. Colors can be chosen by giving the RGB 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. + + + KColorEdit Handbook + + + + + +KPDF + An advanced PDF viewer, based on xpdf, for &kde;. KPDF 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. + + + Website: http://kpdf.kde.org + KPDF Handbook + + + + + +KView + An image viewer program which supports a number of different image filetypes including JPEG, GIF, PNG, TIFF and many others. Kview has full integration with &kde; and it can be embedded into &konqueror; for viewing image files on your diskdrive as well as your FTP site or webserver, using its &URL; open support. Other features include a few image manipulations such as zoom, rotate, grayscale and flip. + + + Website: http://www.ph.unimelb.edu.au/~ssk/kde/kview/ + KView Handbook + + + + + +&ksnapshot; + 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 JPG and PNG. + + + Website: http://www.ipso-facto.demon.co.uk/ksnapshot/ + &ksnapshot; Handbook + + + + + +&kolourpaint; + A simple and easy-to-use paint program, with features such as basic painting (drawing diagrams and finger painting), image manipulation and icon editing. + + + Website: http://kolourpaint.sourceforge.net + &kolourpaint; Handbook + + + + + + +&kooka; + 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. + + + Website: http://kooka.kde.org + &kooka; Handbook + + + + + + + +Related Information + Several more advanced &kde; graphics applications can be found in the &kde; Extragear; under the , see for a list of a few of them. + + + + + +Multimedia + +A brief overview of a few of the multimedia-related applications below. + + + +&juk; + An easy-to-use music player for &kde;. &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 Google images, MusicBrainz integration for file identification over the Internet, and multiple audio backends, including &arts;, GStreamer and aKode. + + + Website: http://developer.kde.org/~wheeler/juk.html + &juk; Handbook + + + + + +&kmix; + 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. + + + &kmix; Handbook + + + + + +&noatun; + A media player capable of playing WAV, Ogg Vorbis, as well as DivX encoded AVIs and other media formats. &noatun; features audio effects, a six-band graphic equalizer, a full plugin architecture, network transparency, and various look and feels. + + + Website: http://noatun.kde.org + &noatun; Handbook + + + + + + + +Related Information + Several more advanced &kde; multimedia applications can be found in the &kde; Extragear; under the , see for a list of a few of them. + + + + + + + diff --git a/doc/userguide/browser-fine-tuning.docbook b/doc/userguide/browser-fine-tuning.docbook new file mode 100644 index 000000000..0a503b6bb --- /dev/null +++ b/doc/userguide/browser-fine-tuning.docbook @@ -0,0 +1,71 @@ + + + + + + +Fine Tuning your Browsing Experience + + +Using your own style for webpages + +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: + + +Open &konqueror; and go to +SettingsConfigure Konqueror.... + +In the configuration dialog that appears, select the +Stylesheets page on the left hand side. + +On this page, choose Use accessibility +stylesheet defined in "Customize" tab, then go to the +Customize tab, and choose the settings you prefer. + +Close all &konqueror; windows (you may need to restart +&kde; to be sure) and when you re-open them, your settings should be applied. + + + + + + + + + + + + diff --git a/doc/userguide/burning-cds.docbook b/doc/userguide/burning-cds.docbook new file mode 100644 index 000000000..901709ff4 --- /dev/null +++ b/doc/userguide/burning-cds.docbook @@ -0,0 +1,38 @@ + + + + + + +Burning CDs and DVDs + +Brief overview of k3b + + + + diff --git a/doc/userguide/control-center.docbook b/doc/userguide/control-center.docbook new file mode 100644 index 000000000..240046c73 --- /dev/null +++ b/doc/userguide/control-center.docbook @@ -0,0 +1,922 @@ + + + + + + +The &kcontrolcenter; + +&kcontrolcenter; +&kcontrol; +Configuration +Customization + + + + + +The &kcontrolcenter; +The &kcontrolcenter; + + +The &kcontrolcenter; is the place to go to change any settings that +affect the whole of your &kde; environment. You can open it using the +Control Center item in the &kmenu;, or with its +command-line name, kcontrol. + +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 + 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 +Apply button. If you decide, after making some +changes, that you want to leave the settings as they were, just click on +Reset. + +If you need more help with a page, visit that page, then click on the +Help tab. You might also want to look at the +&kcontrolcenter; Handbook, which you can open with the +Help&kcontrolcenter; +Handbook. + + + + + + +&J.Hall; +&J.Hall.mail; + + + + +Appearance & Themes + +Here you will find settings that change the way your &kde; desktop and +applications look. + + + +Background + +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 &kde; or you can supply your own. + + + + +Colors + +This is where you can modify the colors for your kde applications. +There are a variety of color schemes installed with &kde; 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 &kde; colors +to be applied to non-kde applications, for a more consistant overall +appearance. + + + + +Fonts + +Here you can control the various font settings for &kde; applications. +You can also modify here anti-aliasing settings, including what range of +fonts to exclude from anti-aliasing settings. + + + + +Icons + +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 &kde; and effects to apply to icons. + + + + +Launch Feedback + +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. + + + + +Screen Saver + +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. + + + + +Splash Screen + +This is where you can install, remove and test the splash screens that +display on &kde; startup. More splash screens can be downloaded from + + +http://www.kde-look.org. + + + + +Style + +This section allows you to modify your widget style. A variety of +styles come with &kde;, and more can be downloaded from http://www.kde-look.org. 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. + + + + +Theme Manager + +This is where you can create and manage themes that are made up of +personalized settings. They are a combination of desktop background, colors, &kde; widget styles, icons, fonts and what Screensaver you'd like to display . This allows you to save your favorite +looks and apply them with the click of a mouse button. + + + + +Window Decorations + +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. + + + + + + +Related Information If &kcontrolcenter; +doesn't have the setting you want, you may need to edit a configuration file +manually. See for more +information about how to do this. + + +If you enjoy modifying the appearance of your &kde; desktop, +you can find plenty of themes and styles at kde-look.org. + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + +Desktop + +This is where you will find settings to configure the appearance and +behavior of your &kde; desktop. + + + +Behavior + +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. + + + + +Multiple Desktops + +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 &kde; 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. + + + + +Panels + +Here you can modify options to do with &kicker; and other &kde; +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;. + + + + +Taskbar + +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. + + + + +Window Behavior + +This is where you would configure options related to the behavior of +&kde;'s window manager, &kwin;. &kwin; 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. + + + + +Window-Specific Settings + +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. + + + + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + +Internet & Network + +This section is where you would configure settings to do with internet +and networking under &kde;. + + + +Connection Preferences + +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. + + + + +Desktop Sharing + +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 &kde;'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. + +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. + + + + +File Sharing + +File sharing allows you to configure Samba (&Microsoft; &Windows;) and +NFS (&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. + + + + +Local Network Browsing + +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;, NFS +and SMB. + + + + +Local Network Chat + +This module allows you to configure options relating to the &UNIX; +talk 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. + + + + +Proxy + +This is where you would configure &kde; 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. + + + + +Samba + +The Samba Configuration module requires the +root 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. + + + + +Service Discovery + +You can set up services browsing with ZeroConf. You can for example browse +your local network using multicast DNS. + + + + +Web Browser + +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. + + + + +Wireless Network + +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 &kde; startup. + + + + + + + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + + +&kde; Components + +This section is where you can modify advanced &kde; options such as +file associations and default applications. + + + +Component Chooser + +The component chooser 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 +Xterm, Vim or +Mozilla, this is the place to specify those +preferences. + + + +File Associations + +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. + + + +File Manager + +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. + + + +KDE Performance + +Here are settings related to the memory usage of +&konqueror;. Minimize Memory Usage 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 &kde; startup, to reduce start times. + + + +KDE Resources Configuration + +To be written + + + +Service Manager + +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. + + + +Session Manager + +Here you can configure how you would like &kde; to handle +sessions. You can configure &kde; 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. + + + +Spell Checker + +This module allows you to configure the &kde; 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. &kde; supports +the use of both ASpell and +ISpell. + + + + +Vim Component Configuration + +This module allows you to configure the use of +Vim as an embeddable component. You need to have +a recent version of Gvim or +Kvim installed for this. You can configure the +appearance of the editor as well as which vim binary to +use. + + + + + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + +Peripherals + +This section is where you would change settings related to peripheral +devices such as keyboards and joysticks. + + +Display + +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 &kde; startup. On the Power +Control tab, you can configure your power management options for +this screen such as blanking. + + +Joystick + +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. + + + +Keyboard + +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 KDE startup. + + +Mouse + +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 Advanced tab allows you +to fine tune your mouse settings further. + + +Printers + + 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. + + + + + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + + +Power Control + +This section has a single module, Laptop Battery. +Here you can configure the appearance and behaviour of the Klaptopdaemon +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. + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + + +Regional & Accessibility +This section is where you can configure options to do with region +and locale, and also acessibility related options for disabled +persons. + + + +Accessibility + +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. + + +Country/Region & Language + +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 kde-i18n packages for your +distribution. + + +Input Actions + +Here is where you would configure input actions, such as +mouse gestures and keyboard shotcuts for launching applications and running +commands. + + +Keyboard Layout + +This module is where you would configure +Kxkb, 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. + + +Keyboard Shortcuts + +Here you can configure global &kde; 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. + + + + + + + + + + + + + + +&Anne-Marie.Mahfouf; +&Anne-Marie.Mahfouf.mail; + + +Javier +Martín Diez + + +Rocco Stanzione + + + + +Security & Privacy + +This section is where you can configure options related to +security and privacy such as the use of cryptography, enabling the KDE +wallet, setting your identity and managing caches. + + +Crypto +This module allows you to configure SSl for use with most +KDE applications, as well as manage your personal certificates +and the known certificate authorities. + + +KDE Wallet + +Here you can change your KDE Wallet Manager settings. + +KDE 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. + +KDE programs like Konqueror, Kmail and Kopete are fully compatible with +the KDE 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. + + + + Wallet Preferences + + To enable the KDE wallet subsystem, check the +Enable the KDE wallet subsystem box. +Unchecking this box will disable the KDE Wallet on your system. + +By default, KDE Wallet Manager is kept opened until the +user session is closed, but you can change that in the Close +Wallet section to close it when unused for a time, when a screen +saver starts or when the last application stops using it. + +As you can have several wallets, Automatic Wallet +Selection allows you start KDE with a given wallet. + +KDE Wallet will appear in your system tray by default, but you can hide +it. Uncheck Show manager in the system tray to keep it +always hidden, or check Hide system tray icon when last wallet +closes to hide it only when all wallets are closed. These items are +in the Wallet Manager section. + + + +Access Control + +You can set here what policy you want for your +KDE applications, regarding to the wallet use. + + + + + + + +Password & User Account +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 Change +Password... button. + + +Privacy +This module allows you to erase traces which +KDE leaves on your system such as command histories or +browser caches. + + + + + + + + + + + + +&J.Hall; +&J.Hall.mail; + + + + +System Administration +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. + + + +Boot Manager (LILO) +If you use the popular bootloader +LILO this section will allow you to configure it. +You can configure the location to install the bootloader to, set the timeout +on the LILO boot screen as well as add or modify +kernel images for the boot list. + + + + +Date & Time +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. + + + +Font Installer +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 Administrator Mode button. + + +IBM Thinkpad Laptop +This configuration module allows you to configure the special keys on an IBM thinkpad + laptop. You will need the nvram module to use these features. + + +Linux Kernel +If you run &kde; 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. + + +Login Manager +This module allows you to configure the &kde; login manager, &kdm;. &kdm; 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 &kdm; handbook. + + +Paths +This dialog allows you to configure the default locations where certain +important files are kept. The Desktop directory contains all the files on your desktop. The Autostart directory contains files or links to files that you want run when &kde; starts, and the Documents directory is the default location &kde; applications will open or save documents to. + + +Sony Vaio Laptop +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 sonypi +driver to use this section. + + + + + + + + + diff --git a/doc/userguide/creating-graphics.docbook b/doc/userguide/creating-graphics.docbook new file mode 100644 index 000000000..30407b0c4 --- /dev/null +++ b/doc/userguide/creating-graphics.docbook @@ -0,0 +1,48 @@ + + + + + + +Creating Graphics + +How to create graphics with &kde; apps.. (ok, maybe not) + + + + + + + + + + diff --git a/doc/userguide/credits-and-license.docbook b/doc/userguide/credits-and-license.docbook new file mode 100644 index 000000000..19c9b2641 --- /dev/null +++ b/doc/userguide/credits-and-license.docbook @@ -0,0 +1,315 @@ + +Credits + +&kde; is written by and copyright The &kde; Team. + + +This document is copyright 2006 The &kde; Documentation +Team. Individual credits are as follows: + + + +Tom Albers tomalbers@kde.nl + + + +Wrote . + + + + + + + +Waldo Bastian bastian@kde.org + + + +Wrote the notes which became . + + + + + + + +Gardner Bell gbell72@rogers.com + + + +Wrote . + +Wrote . + + + + + + + +Gary Cramblitt garycramblitt@comcast.net + + + +Wrote . + + + + + + + +David Faure faure@kde.org + + + +Wrote . + + + + + + + +Nicolas Goutte goutte@kde.org + + + +Wrote . + + + + + + + +&Francis.Giannaros; &Francis.Giannaros.mail; + + + + Proofreading and update on various parts. + Wrote . + Wrote . + Wrote . + Wrote . + Re-wrote . + Wrote . + + + + + + +Adriaan de Groot groot@kde.org + + + +Wrote . + +Wrote . + + + + + + + +J Hall jes.hall@kdemail.net + + + +Wrote . + +Wrote . + +Wrote . + +Wrote . + +Wrote . + +Wrote . + +Wrote . + +Wrote . + + + + + + + +&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; + + + + Proofreading and update on various parts. + + + + + + +&Richard.J.Moore; &Richard.J.Moore.mail; + + + +Wrote the kstart and +ksystraycmd sections. + + + + + + + + +Peter Nuttall p.s.nuttall@dur.ac.uk + + + +Wrote . + + + + + + + +Steven Robson s.a.robson@sms.ed.ac.uk + + + +Took the screenshots for , , and . + + + + + + +&Philip.Rodrigues; &Philip.Rodrigues.mail; + + + +Reviewing and proofreading. + +Wrote . + +Wrote . + +Wrote . + +Wrote . + +Marked up parts of . + + + + + + + +Deepak Sarda antrix@gmail.com + + + +Wrote . + + + + + + + +Robert Stoffers robert_angie@ozemail.com.au + + + +Wrote . + + + + + + + +Juan Carlos Torres carlosdgtorres@gmail.com + + + +Wrote . + + + + + + + +Simon Vermeersch titeuf@ph34rus.org + + + +Wrote . + + + + + + +&Lauri.Watts; &Lauri.Watts.mail; + + + +Wrote the outline. + +Wrote . + +Marked up parts of . + + + + + + +Christian Weickhmann +christian.weickhmann@gmx.de + + + +Wrote . + +Wrote . + + + + + + + + + + + diff --git a/doc/userguide/customizing-desktop.docbook b/doc/userguide/customizing-desktop.docbook new file mode 100644 index 000000000..eb427d599 --- /dev/null +++ b/doc/userguide/customizing-desktop.docbook @@ -0,0 +1,365 @@ + + + + +Juan Carlos +Torres + + + + +Customizing the Appearance of your &kde; Desktop + +Changing the appearance of your &kde; 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 &kde; and how to control their appearance. + + +Background +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 right-clicking +on the desktop and selecting Configure Desktop.... + +In &kde;, you have the option to use no picture, a single picture, or a +slideshow of images. If No picture is chosen to be the +desktop background, the Colors 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 All desktops or the +specific desktop name from the drop-down menu. + +Other background images can be downloaded using the +Get New Wallpapers button on the right or you can visit +the +Wallpapers section of the kde-look.org website. + + + +Colors +The Colors 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 +Save Scheme.... This will save your settings in a Color +Scheme file. Color schemes are text files, with a .kcsrc 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 +Import Scheme... and pointing to the .kcsrc 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. + +Additional color schemes can be downloaded from the Color Schemes +section of kde-look.org. + + + +Icons +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 Apply to switch to the new theme. To install new +icon themes, all you need to do is to click on Install New +Theme... 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 Remove Theme. +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 +(root) or by your distribution's +package manager. +Other icon themes can be found in the Icon Themes +subsection of kde-look.org. + + + +Splash Screen + + + + + +The default &kde; splash screen +The default &kde; splash screen + + +The splash screen is the animated image or screen that is displayed while +&kde; 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 Apply. You can also test what a splash +screen will look like by selecting the splash screen and clicking on +Test. Installing a new splash theme is very easy. Just +click on Add... 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 Remove. Note that you cannot remove splash screens +installed by the administrator (root) +or by your distribution's package manager. + +Splash screen themes can be found on kde-look.org, in the Splash Screens +section. Take note that some splash screens require a specific &ksplash; +engine to be installed. + + + +Window Decorations +You can change the appearance of window borders, titlebars and buttons in +&kde; 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 &kwin;, &kde;'s Window Manager, +how to display window frames. + +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 +Window Decoration 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 Apply. +Different window decorations have different capabilities and settings. Play +around with the different options available. The Buttons tab allows you to +control the buttons on the window titlebar. Enable the Use custom +titlebar button positions 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. + +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. &kde; ships with a pixmap-based window decoration called the IceWM +window decoration. Another pixmap-based window decoration is deKorator, +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. + +To add an IceWM theme, select IceWM as the window decoration and click on +the Open &kde;'s IceWM theme folder link in the window +decoration description area. This will open a &konqueror; window +to $KDEHOME/share/apps/kwin/icewm-themes. +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 +Apply. + +To add a deKorator theme after you've installed deKorator, select +deKorator from the window decorations list and go to the Themes +tab. Click on Install New Theme 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 Set Theme +Paths. Click on Apply for the changes to +take effect. + +Some more window decorations are available at kde-look.org under the +Native &kde; 3.x and the +Native &kde; 3.2+ subsections. Themes for the IceWM and +deKorator window +decorations have their own subsections under the Window Decorations +category. + + + +Style +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 &kde; 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. + +Once a widget style has been installed, it will be added to the list of +available styles in the Style module in the &kcontrolcenter;. +The Style tab allows +you to select a widget style from the list and to configure it if the style has +a Configure... feature. Different styles have different options. A preview of the +selected style is available at the lower portion of the tab. The +Effects tab +controls different visual effects for some widgets like comboboxes and tooltips. +The Toolbar tab gives some options on the general appearance of toolbars. + +Additional widget styles can be found in the different &kde; subsections of the +Themes/Styles of kde-look.org. Take note that styles come in source +code or binary package forms. They are not &kde; theme files. + + + +&kde; Theme +&kde; 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 Create New +Theme.... Enter the details you want to give your theme, such as theme +name, author, version, &etc;, then click OK when done. +This will add your theme to the list of available themes and save your settings +in a &kde; theme. A &kde; theme (.kth file) +instructs &kde; on what window decoration, style, or color scheme to use for +that particular theme. To add a &kde; theme from an outside source, click on +Install New Theme... and locate the &kde; theme file. +Removing a theme is easily done by clicking on Remove +Theme. 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. + +The following are the settings that are saved and indicated in a &kde; +Theme: + + + +Background + + + +Screen Saver + + + +Icon Theme + + + +System Notifications + + + +Color Scheme + + + +Cursor Theme + + + +Window Decoration + + + +&konqueror; background (File Management) + + + +Panel background + + + +Style + + + +Fonts + + + +One very important thing to consider when using or installing a &kde; +Theme is that it only indicates what settings to use for the above. A &kde; +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 +&kde;. + +&kde; Themes can be downloaded from the Theme-Manager +subsection of +kde-look.org, under the Themes/Styles section. + + + +Glossary + + + +Background +Background/wallpaper image or color for the +desktop + + + +Color Scheme +(.kcsrc) +Configuration file that indicates what colors to use +for certain widgets + + + +Icons +Images representing applications, files, +devices, &etc; + + + +Splash Screen +Animated image or screen that displays while &kde; +loads after logging in + + + +Window Decoration +Plugins or small programs that instruct the window +manager how to display window frames + + + +Style +Plugin or a small program that instructs &kde; +how widgets are displayed + + + +&kde; Theme +(.kth) +A file that contains instructions on what settings to use for +different GUI components + + + +Widgets +Basic elements that build up a graphical user +interface: buttons, scrollbars, menus, tabs, &etc; + + + + + + + + + diff --git a/doc/userguide/desktop.png b/doc/userguide/desktop.png new file mode 100644 index 000000000..c5e683f61 Binary files /dev/null and b/doc/userguide/desktop.png differ diff --git a/doc/userguide/email.docbook b/doc/userguide/email.docbook new file mode 100644 index 000000000..04e95c9b2 --- /dev/null +++ b/doc/userguide/email.docbook @@ -0,0 +1,254 @@ + + + + + +&Daniel.Naber; + + +&David.Rugge; + + + + + + +Getting Started with Email + +Emailgetting +started + +&kmail; + +&kde; 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. + + +Information you will need before you start + +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: + + + +Your email address +This should be provided by your ISP or system administrator. + + + +Your username and password for your email account +The username is often the same as the part before the +@ symbol in your email address, but not always: check +with your ISP. + + + + + + +EmailSMTP +server +Your outgoing email (SMTP) server name and +details +Again, your ISP should have provided +you with this information. If not, you can try the form smtp.your-isp-name.com. + + + + + +EmailIMAP +server + +EmailPOP3 +server + +Your incoming email (IMAP or +POP) server name and details +If you do not have this information to hand, you can +try imap.your-isp-name.com +for IMAP or pop.your-isp-name.com +if you use POP3. + + + + +Once you have that information, you are ready to start setting +up &kmail;. Open &kmail; from the K menu (you can +find it in the Internet submenu, or use one +of the methods described in .) Once +&kmail; has opened, select the menu entry +SettingsConfigure KMail... +. The next sections describe how to use the dialog that +appears to set up &kmail;. + + + + +Setting your Identity + + +The settings in the Identities page are fairly +straightforward. Select the default identity and +click Modify.... Fill in the Your +name field with your full name (⪚ John +Doe) and, optionally, the +Organization field with the appropriate +information. + + +Next, fill in the Email address field with +your email address (⪚ john@example.net). + + +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 OK button to close this +dialog, and move on to the next configuration page... + + + + +Setting up your Account + +Click on the Network 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: Sending and +Receiving. You need to set up both, so let us look +at them each in turn: + + +Sending Messages + +Emailsending + +The Sending tab provides a list of +ways to send messages. The first item in the list is the default +way to send messages. Using the Add... +button you can choose between two different ways of sending messages: +SMTP and +Sendmail. &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 +SMTP and fill in the Name +field with a descriptive name +(⪚ My Mail Account) +and the Host +field with the name and domain of your mail server +(⪚ smtp.provider.com). You will probably +not need to change the Port setting (the default is +25). + +A description of the other options can be found +in the full &kmail; manual. Click on OK to +close this dialog, and then click on the +Receiving tab. + + + + +Receiving Messages + +To set up an account so you can receive mail, press the +Add... button in the +Receiving tab. You will then be prompted for the +type of your email account; most users should select +POP3 or IMAP. If you wish to +use a different system, consult the &kmail; manual. + +You will then be presented with +the Add account window. First, fill in the +Name field to name your account. You can choose any name +you like. Login, Password, and +Host should be filled in with the information you +gathered earlier. You should not usually need to change the Port setting. + +You are now ready to send and receive mail. For +IMAP, 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 +FileCheck +Mail. + + + + + + +Testing your Setup + +Emailtesting + +First, you should send yourself a message to test your +configuration. To send a message, either hit &Ctrl;N, select the +New Message icon or select +the MessageNew +Message... menu item. The +composer window will appear. Fill in the +To: field with your email address and type +something in the Subject field. Send the message by +selecting Message Send +. + +To check your email, select +FileCheck +Mail. 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 +Settings Configure +&kmail;.... + + + +Related Information + +The &kmail; Handbook has full descriptions of advanced +email settings and so on. You can read it in the &khelpcenter; or by +entering help:/kmail in &konqueror;'s +Location bar. + + +The &kmail; website at http://kmail.kde.org contains +latest news, tips and tricks, and plenty more. + + + + + + + + + + + diff --git a/doc/userguide/extragear-applications.docbook b/doc/userguide/extragear-applications.docbook new file mode 100644 index 000000000..fd55985aa --- /dev/null +++ b/doc/userguide/extragear-applications.docbook @@ -0,0 +1,199 @@ + + + + + +&Francis.Giannaros; +&Francis.Giannaros.mail; + + + + +&kde; Extragear Applications + +These are applications that are directly associated with &kde;, the project, but do not appear and are not shipped with the main &kde; 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 &kde; distribution; choosing, rather, to handle their own release schedules. Nevertheless, the applications in Extragear are distinguished by &kde;, and many are increasingly popular. + + +Available in the &kde; Extragear + + + +Multimedia + + + +&amarok; + An advanced and comprehensive music player with the capability to play MP3, WAV, and OGG 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 &kde; 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 GStreamer, xine, NMM, MAS, aKode and &arts;. + + + Website: http://amarok.kde.org + View the handbook by typing help:/amarok 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 here. + + + + + + + + + +K3b + The definitive &CD;/DVD burning application for &kde;. With K3b you can create data, video, and audio (it comes with plugins for WAV, MP3, FLAC, and Ogg Vorbis) &CD;s. Projects can be saved and loaded, &CD;-ripping is supported, and you can appropriately make &CD;/DVD copies. + + + Extragear Summary: http://extragear.kde.org/apps/k3b/ + Website: http://k3b.org + K3b Handbook + + + + + + + + + + +Graphics + + +&digikam; + 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 KIPI (&kde; 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 &kde; (others include Gwenview, ShowImg and KimDaBa). + + + Website: http://digikam.org + &digikam; Handbook + + + + + + +Gwenview + Another advanced image viewer which can load and save all image formats supported by &kde;, as well as being able to display the GIMP (*.xcf) image filetype. Gwenview can perform a few graphical manipulations (rotate, mirroring) and has full support for KIO slaves (allowing you to use it via &FTP;). Other features also include file management operations, such as copy, paste, move and delete. + + + Website: http://gwenview.sourceforge.net/ + Gwenview Handbook + + + + + + + +ShowImg + A feature-rich image viewer, written for &kde;, which can display numerous formats, including JPEG, PNG, [animated] GIF and MNG. 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. ShowImg also features a full-screen mode, zooming, sorting, drag and drop with &konqueror;, and support for images in compressed archives. + + + Website: http://www.jalix.org/projects/showimg/ + ShowImg Handbook + + + + + + +KimDaBa + KimDaBa (&kde; 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, KimDaBa can help you locate an image in a matter of seconds. + + + Website: http://ktown.kde.org/kimdaba/ + KimDaBa Handbook + + + + + + + + + + + +Network + + +&konversation; + A fully-featured IRC 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 &kde;. + + + Website: http://konversation.kde.org + &konversation; Handbook + + + + + + +KMldonkey + A &kde; frontend for MLDonkey, a powerful P2P file-sharing tool. Highly configurable, real-time graphical bandwidth and network statistics, and much more. + + + Website: http://kmldonkey.org/ + KMldonkey Handbook + + + + + + +KNemo + 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. + + + &kde;-apps entry: http://www.kde-apps.org/content/show.php?content=12956 + + + + + + + + + + + +Utilities + + +Filelight + A simple, yet ideal, application for graphically displaying where your diskpace is being used. Filelight displays this information by representing your filesystem as a set of concentric segmented-rings. + + + Website: http://www.methylblue.com/filelight/ + Filelight Handbook + + + + + + + +Krecipes + A &kde; 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. + + + Website: http://http://krecipes.sourceforge.net + Krecipes Handbook + + + + + + + + + + + +Related Information + +Related Information and Links + It should be stressed that the above is but a preview of what is available in the &kde; extragear. To view all of the applications and utilities available there visit http://extragear.kde.org, where a briefer summary of each application is provided. + The handbooks for the majority of applications in extragear can be viewed from http://docs.kde.org. + Once again, you can find a plethora of other [third-party] &kde; applications at the popular http://kde-apps.org. + + + + \ No newline at end of file diff --git a/doc/userguide/file-sharing.docbook b/doc/userguide/file-sharing.docbook new file mode 100644 index 000000000..395e7b9e2 --- /dev/null +++ b/doc/userguide/file-sharing.docbook @@ -0,0 +1,109 @@ + + + + + +&Lauri.Watts; + + + + + +File Sharing + +How to share files with &kpf; + +File sharing +Shared Folders + +&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. + +&kpf; is designed to be used for sharing files with friends, not to +act like a fully-fledged web server such as +Apache. &kpf; was primarily conceived as an easy +way to share files with others while chatting on IRC +(Internet Relay Chat, or chat rooms.) + +&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, right click on &kicker; and choose +Add Applet to Panel... to open the Add +Applet dialog. Select Public File Server and +click the Add to Panel button. + +&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. + +Please be extremely careful about which folders you share. Remember +that all files in the folder and its subfolders, including +hidden files (dotfiles 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;. + +Once &kpf; is running, you will see a square applet with a thin sunken +bevel and an icon depicting an hot air balloon. The +balloon is visible when no folders are being shared. + +To share a folder, right click on the +balloon icon and a pop-up menu will appear, containing only one item, +New Server.... Selecting this entry will cause a +wizard to appear, which will ask you a few simple +questions. Completing the questions will set up a folder for sharing. + +There is an alternative to using the applet directly when you want to +share a folder. &kpf; is integrated with &konqueror;. + +With &konqueror; open and displaying a folder, +right click on the background and bring up the +Properties dialog. On install, &kpf; added a +Sharing tab to this dialog. You will be offered the +option of starting &kpf; if it is not running. Choosing +Ok will send a signal to the &kpf; applet, asking it +to add a new share. + +For more detailed information, such as how to share different +directories to different people, see the &kpf; handbook. + + + + + + + + + + diff --git a/doc/userguide/font-installation.docbook b/doc/userguide/font-installation.docbook new file mode 100644 index 000000000..bca1a2308 --- /dev/null +++ b/doc/userguide/font-installation.docbook @@ -0,0 +1,79 @@ + + + + + + +Simon +Vermeersch + +titeuf@ph34rus.org + + + + +Fonts - Installing and Configuring + +Fonts + +Fonts are really easy to configure in &kde;. Open up the Control +Center (with K-MenuControl +Center) and choose +Font Installer in System +Administrationin the tree view. + +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 Font +Installer, you're in Personal mode (you can see this in +the Location bar). When you click on the Administrator Mode +button, and put the root password, +you can access global mode, where you can change the fonts for every user on +this computer. + +For the rest, there is no difference between those two kind of fonts. + +Fontspreviewing + +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. + +If you want to, you can organise your fonts in multiple directories, so that +you can easily find them later. + +Fontsinstalling + +To install a font, click on the Add +Fonts... button. A file open dialog will appear where you can +choose your font. + +Alternatively, you can drag fonts from &konqueror; to the +list. To remove a font, right click on it and +choose Delete. + + + +Configuration (anti-aliasing) + +kfontinst and kfontview should probably get a mention too, since +they don't seem to have any existing docs. + + + diff --git a/doc/userguide/getting-help.docbook b/doc/userguide/getting-help.docbook new file mode 100644 index 000000000..c3a872c7c --- /dev/null +++ b/doc/userguide/getting-help.docbook @@ -0,0 +1,213 @@ + + + + +&Lauri.Watts; + + + + + +Getting Help + + +User Manuals + +User Manual +Most applications come with a comprehensive user manualUser ManualHandbook, which you can +reach various ways: + + + +By pressing F1 inside the application. + + +From the menu bar: +HelpApplication name + + + +By browsing to it in &khelpcenter;&khelpcenter; + + +By using the help KIOslave in &konqueror;. So, in the Location Toolbar, simply type help:/Application name + + + +Online at http://docs.kde.org + + + + + + +Context and <quote>What's This</quote> Help + +Many applications also provide context help in two forms: +Tooltips, and What's This help. + + +Tooltips + +Tooltips +Tooltips are small informational windows or balloons that display when +you hover the mouse over an item on your screen without clicking. + +&kde; uses tooltips in many places to provide brief help or +information about an item on your screen. For instance, most toolbar buttons +inside applications will display their name in a tooltip if you rest or hover +your mouse over them. + +Tooltips have another function, which is not specifically tied to +help. In the &konqueror; file manager and on your Desktop, tooltips can +provide information about files. This is commonly referred to as meta information. + +You can find out more about meta-information tooltips in the section +about the &konqueror; file manager. + + + + +<quote>What's This?</quote> + +What's This? + +What's This? help is usually more detailed than tooltips. +You can access What's This? help in two ways: + + + +By pressing the ? button in the titlebar of the +window. + + +By pressing the key combination +&Shift;F1 + + + +The cursor will change to a pointer with a question mark next to it. +Click on the item you want to know about, and a small window will +pop up displaying information. + + + + + +Mailing Lists, Newsgroups and <acronym>IRC</acronym> + + +Mailing Lists + +Mailing Lists +&kde; provides many mailing lists which can provide you with help +and guidance in using and configuring your Desktop. + +Some of the lists you might find useful are: + + + +The &kde; User List +&kde; User Mailing List + +This mailing list focuses specifically on OS-independent questions +and discussions regarding using &kde;. Operating-system-specific questions and +discussion are off-topic here. For +example, the question How do I change the margin size for KWord +documents is appropriate for this list; whereas How do I set +up my printer using &kde; under UnixOS X.Y is not. Questions asked and +discussions here should apply to all &kde; users using the applicable &kde; +software, not just those using the same operating system. +You can subscribe to this list at https://mail.kde.org/mailman/listinfo/kde. +You can find archives at http://lists.kde.org/?l=kde. + + + + +The &kde;-&Linux; List +kde-linux Mailing List + +This mailing list focusses specifically on questions and discussions +regarding using &kde; on &Linux;. Questions and discussions can involve any +issue confronting desktop users who run &kde; on a &Linux; system. Hence, +questions such as How do I setup a networked printer for printing from +&kde; on LinuxDistro X.Y are appropriate here. If you prefer a list +limited to OS-independent questions and discussions +concerning &kde;, please use the general &kde; mailing list. +You can subscribe to this list at https://mail.kde.org/mailman/listinfo/kde-linux. +You can find archives at http://lists.kde.org/?l=kde-linux. + + + + + + +IRC + +There is a #kde channel on Freenode (irc.freenode.net) for support and other general talk about &kde;. As usual, you can access this channel by using any of &kde;'s popular IRC clients which include konversation, &ksirc;, as well as &kopete;. For more information, check the section. + + + + + + +More Resources + +There are many other resources which you may found useful; some of these are listed below: + + + +dot.kde.org +&kde; News Resource + +This website has a searchable &kde; news resource where you can find out about a superfluity of innovations in the world of &kde;. + + + + + + +kde-look.org +icandy for &kde; + +The paramount resource for &kde; icandy, including themes, window decorations, wallpapers, mouse themes and icons for your &kde; desktop. Note also that the site contains a howto section on how to install the most common of these. + + + + + + +wiki.kde.org +&kde; wiki + +The official &kde; Wiki. From here you can have access to a plethora of information ranging from frequently asked questions and HOWTOs to tips and tricks. The wiki should never, however, be used as a substitute for the respective application's handbook or the official &kde; documentation. + + + + + + + + + diff --git a/doc/userguide/glossary.docbook b/doc/userguide/glossary.docbook new file mode 100644 index 000000000..1e4b85d74 --- /dev/null +++ b/doc/userguide/glossary.docbook @@ -0,0 +1,38 @@ + + + + + + +Glossary of Terms + +KDE/GUI/UNIX terms that are worth explaining. + + + + diff --git a/doc/userguide/groupware-kontact.docbook b/doc/userguide/groupware-kontact.docbook new file mode 100644 index 000000000..beaf1f338 --- /dev/null +++ b/doc/userguide/groupware-kontact.docbook @@ -0,0 +1,614 @@ + + + + + + +Marco +Menardi + +gnu@kde.org + + + + + + +Sharing data with &kontact; via <acronym>IMAP</acronym> + + +Introduction + +For my small office, I was looking for a long time for a +PIM solution that let me share data, so my secretary and +I can share contacts, appointments and so on. Being a &kde; 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 +Kolab server 1.0 (the server side of the +project), I gave up, waiting for an easier to deploy +Kolab 2.0. In any case, the +Kolab stuff was clearly too much for my +needs. Fortunately in the &kde; wiki I've found some piece of +IRC conversation where they were talking about sharing +data without the Kolab infrastructure... mmm so +interesting! + +For small offices and needs, you can have &kontact; use shared data +without the need of installing the Kolab server +or another groupware backend. It can work with just an +IMAP server, that can be easily set up. + +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. + + + + +What is <acronym>IMAP</acronym> + +This definition is from the ComputerUser.com High-Tech Dictionary: +
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.
 + +So it can be considered a data storage. To use it you you need an +IMAP server, such as Cyrus, +Courier or UW. + + + + +<application>Kolab</application> or <acronym>IMAP</acronym>? + +Kolab brings the ability to share data +between different clients. It makes possible for your secretary to use +Outlook and you use &kontact;, for +instance. + +You will have a configuration interface which does user management, mail +account setup, a central LDAP 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; + +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 +IMAP. + + + + +How to set up <acronym>IMAP</acronym> server <application>Cyrus</application> + +My choice is Cyrus, that is part of the +Kolab set of software, so if l will go for +Kolab in the future, at least I'm acquainted with +it. Let's start the installation and the setup! + +Become root. + +# apt-get install cyrus21-imapd cyrus21-common cyrus21-admin cyrus21-client sasl-bin sasl2-bin +Installing cyrus21-imapd...The installer asks something I've not understood about an search address... I just pressed Enter. + +The installer also created the user cyrus that is in the (automatically created) +group sasl, that is the +owner of all cyrus files. At the end with ps + you can find the new processes: +cyrmaster and notifyd. + +The real problem in setting up Cyrus is the +authentication, just because it's not trivial and I'm a newbie, with limited +knowledge about what I'm doing. + +Cyrus can use different +SASL (Simple Authentication and Security Layer) +mechanisms, the default being sasldb (it stores usernames and passwords in +the SASL secrets file sasldb), but also getpwent, +kerberos4, kerberos5, PAM, rimap, shadow and LDAP are supported. + + Since I don't want to define users/passwords different than the ones +that access my &Linux; box I choose then shadow mechanism so +Cyrus will use &Linux; passwords for +authenticate. + +To do so we have to tell sasl to use saslauthd as +password authentication method, and then setup saslauthd +to use shadow (or getpwent) as the +authentication mechanism. + +OK, let's start! + +As root, change the Linux +password of cyrus user: + +# passwd + +Enter the password you like (and you will remember) we will use for +this example cyrus as the cyrus +administrator password. + +# vi /etc/imapd.conf + +sasl_pwcheck_method: saslauthd instead of the default auxprop + +remove the # remark from the line: + +#admins: cyrus + +this way you can administer cyrus logging +in as cyrus user (what a fantasy I +have!) + +# vi /etc/default/saslauthd + +Uncomment the line: + +# START=yes + +(otherwise the saslauthd will not start at +boot time, even if referenced in some /etc/rcx.d!) + +and instead of MECHANISMS="pam" put +MECHANISMS="shadow" this way at the boot a +saslauthd will be executed. + +Once exited from your editor, restart sasl +and cyrus. + +To test IMAP: + + su +$ imtest + +You are prompted for the cyrus (user) password, so enter it. + +If the user cyrus is +correctly authenticated, the following lines will appear: + +S: L01 OK User logged in +Authenticated. +To exit type . logout (&ie; dot space logout) + +Now add a user named groupware and set a password for it, using +your usual system tools. It should be in an unprivileged group such as +nobody and does not require a +login shell or a home directory. + +Now I have to create the user and an IMAP in +cyrus also: + +# cyradm +after entering the password for the admin user cyrus, you get the prompt localhost> +localhost> cm +localhost> lm lists the mailbox only just created +user.groupware (\HasNoChildren)) +localhost> quit + +You can type help for a list +of available commands. + +You can check what has happened with: + +# ls /var/spool/cyrus/mail/g/user/groupware +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 + +Now you should be able to connect with an IMAP client +as the groupware user and see the +INBOX. +In the IMAP protocol, selecting the mailbox +INBOX is a magic word, a sort of alias for +the above directory structure. The client sees INBOX, and +the IMAP server maps it in the /var/spool/cyrus/mail/... folder and file +structure. + + + + +How to setup &kontact; clients + +I connect to my GNU/Linux office server PC (a sort of "black box" +without monitor and keyboard) from 2 &Windows; 2000 PC with +Cygwin/X, 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 +Cyrus is installed and running +(localhost). + +To have &kontact; work with IMAP, there are these +steps to complete: + + + +Create an IMAP account on the +Cyrus for fake groupware user (already previously +done!) + +Create/configure an IMAP account in &kmail; +for login as that user Use kresources to make +&kontact; components work with data taken from IMAP +source + +Enable groupware functionality and make related subfolders of +that IMAP INBOX (if not +already) + +Enjoy &kontact; and shared data through +Cyrus IMAP + + + +So login to &kde; with the first real user account you +want to provide groupware functionality to. + +Let's create the IMAP account in &kmail;. + +Run &kontact; and select Mail (the &kmail; +component). From the menu choose +SettingsConfigure KMail +AccountsReceiving tab, press the Add... button. You will then be +prompted for the type of your email account, and select +disconnected IMAP (not just +IMAP). Then in the General tab +enter the following data: + + + +Account Name: office_gwdata + +A name that will be used for the local folder that +points to this IMAP account. + + + +Login: groupware + +The Cyrus user we have chosen as +owner of all of the office data + + +Password: + +The password of the groupware user. + + + +Host: localhost + +Remember for our example, the &kontact; client runs on the same +computer as the IMAP server + + + +Port: 143 + +The default + + + + +Check store IMAP password +so you will not be asked for it next time you run &kontact;. Check the +Enable interval mail checking and set a value in +minutes. + +Note that we have checked the disconnected IMAP +type account. This has the effect that a copy of the groupware data is +stored locally 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 +disconnected IMAP data is cached locally, and only the +delta (&ie; the data that has changed) is sent. + +On the other end, if your users run &korganizer; on the same PC that +runs the IMAP server, it seems reasonable to use +IMAP (that is called online IMAP) to save +space, since transfer speed should not be an issue. But unfortunately this +does not work because &kontact; does not update automatically the +Calendar folder in online IMAP, so you +are not updated when someone adds events (you must manually switch to +&kmail; application and click on the Calendar +folder). In addition, at start up when it does read +Calendar folders, you may see a tremendous flicker and +slow data updates. + +Now we have to tell &kontact; to use IMAP as the +data source for it's various components. From the &kmenu;, choose +Run command, run kcmshell +kresources. In the combo box select +Contacts, then press the Add... +button, and choose Addressbook on IMAP Server via KMail. Then select that new line and +press Use as Standard button. Do the same for +Calendar and Notes. + +Now we have to enable the &kmail; (and as a consequence, the whole +&kontact;) groupware functionality: + + + +Choose from the menu +SettingsConfigure +KMailMiscGroupware + + +Check Enable IMAP resource functionality + + +Choose English as Language of the +groupware folders (this is in case you already have the folders +in the IMAP server created by a different program in a +different language). + + +Now move to Resource folder are in account and +select the the Inbox subfolder of the +office_gwdata folder. +Leave Hide groupware folders unchecked for now, +so we can see that happens. You can return here and check it once everything +is clear. + + +When you press OK you are prompted with: +&kmail; will now create the required folders for the IMAP +resource as subfolders of Inbox +If you do not want this, press No, and the +IMAP resource will be disabled. Press +Yes (this happens only the first time with the first +real user). You will immediately see that in the &kmail; +folder tree, under +office_gwdataInbox +these subfolders are created: + +Calendar +Contacts +Notes +Tasks +Journal + +if you now do a: +# ls +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 + +As you see, the office_gwdata Inbox is stored not +local to the &kontact; current user home, but in the IMAP +groupware user's folders. + + + +Now &kontact; is ready to work and store data there. In the calendar +application, if &kmail; IMAP account was of type +disconnected, the resource window should +display the item Imap resource with 3 subitems, that +are paths to local home files. Instead, the Contacts +application does not show subitems below the Imap +resource. + +You can now login to &kde; with a different username and set up +his/her &kontact; client in a very similar manner: + + + +Open &kontact; and in the Mail component add an +IMAP account specifying as host the +computer where Cyrus server runs (in my case: +192.168.1.3). + +Remember to check the Enable interval mail +checking and set a value in minutes. When you confirm, you are +not prompted for the subfolder creation (since they are found in the +IMAP server), and you see them in the folder tree. + + +Activate the groupware functionality to be able to save data in the +IMAP server. + + +Beware that in disconnected IMAP, +data are transmitted from a client to IMAP server only +when the clients connects to check for new mail. So if you have your +&kontact; clients with an interval mail checking 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. + + +How to have Read Only Access + +Beware that I've been confirmed that Notes +IMAP 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. + +In the previous setup, we have the same fake user, named +groupware, that is used by all the +real &kontact; users (&ie; tony, rohn, amanda, &etc;) through the +IMAP 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 groupware to the IMAP +server. + +To limit access to some users (typically, providing read-only access), +we can use the ACL (Access Control Lists). + +Select in &kmail; a subfolder of office_gwdata +inbox, for instance Calendar, and right click the +mouse. Select PropertiesAccess +Control tab. Here you can enter the users you want give access to +this folder and what they can do. + +Just to experiment trying to exchange events, we give +All permission to the user mary + +At cyrus level (in the +PC that runs IMAP server cyrus, with +cyrus tools), we first need to add the user +mary, so it's an +IMAP recognized user, and create an +IMAP folder for her. + +Then we login to GNU/Linux as mary and enter &kontact;. As previously shown, +we will setup an IMAP account in &kmail; with the same +data but the one of the user (instead of the fake user groupware and it's password, we will use +mary and her password). + +In &kmail; folder tree, this time you will see this structure: +office_gwdatauser +groupwareCalendar and +Tasks. Check the mail +(FileCheck +Mail) and you will also have an +inbox folder under office_gwdata. + +Now enable &kmail; groupware functionality, and in Resource +folders are subfolders of put the +inbox that is subfolder of +office_gwdata. + +Now enable &kmail; groupware functionality, and in Resource +folders are subfolders of put the +inbox that is subfolder of +office_gwdata. + +Now you have two branches of folder under +office_gwdata: + + + +inbox with Calendar, Contacts, Notes, Tasks and +Journal, that are saved on mary +IMAP folders on the IMAP server + + +user, with the subfolder groupware and +the subfolders to which mary has +access to (in this example, Calendar and Tasks) + + +&RMB; click on the user Calendar and +check if it's of type Calendar (if not, set it to be), and also if +userTasks is of type Tasks. +Now in Calendar you have two available IMAP +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!). +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 +.groupware.directory path (see the tail part of each +resource path). + + + + +Credits + +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. + + +Special thanks to: + +For the Cyrus IMAP part +in #cyrus channel: + + +[protagonist] Andy Morgan morgan@orst.edu + + +[plixed] Okke Timm okke.timm@web.de + + + + +For the &kontact; part in #kontact channel: + + +[till] Till Adam adam@kde.org + + +[dfaure] David Faure faure@kde.org + + +[mdouhan] Matt Douhan matt@fruitsalad.org + + + + + +Thank a lot guys! + +Ah, and there is also me, [markit] Marco Menardi +mmenaz@mail.com + + + + +Further Reading + + +Reference +KDE: http://www.kde.org +&kontact; website: http://www.kontact.org +Kroupware project: http://www.kroupware.org +&kde; Community Wiki: http://wiki.kde.org +Wine project: http://www.winehq.org +Cygwin/X project http://x.cygwin.com +LTSP project: http://www.ltsp.org + + + + + + + diff --git a/doc/userguide/index.docbook b/doc/userguide/index.docbook new file mode 100644 index 000000000..b039979ce --- /dev/null +++ b/doc/userguide/index.docbook @@ -0,0 +1,611 @@ + + KApp"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]> + + + +The &kde; User Guide + + + +The &kde; Documentation Team + + + + + + +20042005 +The &kde; Documentation Team + + +&FDLNotice; + +2004-06-16 +0.0.1 + + +A general user guide to &kde; + + +Please report any problems with this document to +kde-doc-english@kde.org. + + + + +KDE +desktop +handbook +tutorial + + + + + +Introduction + + +Welcome to the &kde; User Guide + +This User Guide aims to provide an overview of the entire &kde; experience. We +assume here that you have a standard, working installation of a complete &kde; +desktop environment, and the accompanying packages. This book should be +your first point of reference for any simple &kde; configuration question, or +to find out how to perform a common task. + + +What this book aims to be + +The first place to look and a one stop shop for all questions you have +regarding your &kde; experience. + +A Quick Start Guide to commonly performed tasks - In most cases, you do not +need to know the details of how to configure every option in an application, +in order to get down to work. You will find step-by-step guides which +will work in most common situations, along with links to sources of +further information in case you have any problems. + +There are also some tips and tricks showing you the most useful and +impressive features of &kde;, and ways to save you time and effort. + + + + +What this book is not + +The User Guide is not intended to be a replacement for the application +manuals. You should turn to the handbook for help with specific program +configuration and troubleshooting issues not covered in this book. If the +answer is outside the scope of this book, we will tell you here precisely +where to look for further help. + +You may also have a variety of third party packages, and some of these +applications are mentioned briefly here, but we normally cover only the +applications provided as part of a &kde; release. This is not a judgment on +the value of third party applications, and in fact many of them are +excellent. + +The User Guide is not specific to a distribution, and covers a default &kde; +installation. Your local installation may be customized by your +distribution provider, or by yourself, and so our advice here is +generic. You may have to adjust paths in order to locate the files that are +discussed. + + + +Conventions used in this book + +We'll use the following formatting conventions to make it clear what +we're referring to: + + + + + +Type of Text +Style +Example + + + + + +Text appearing in the &GUI; (on buttons, &etc;) +Light gray background +Settings + + + +Names of keys +Bold font +&Ctrl; + + + +Menu entries +Menu Name->Menu Item +FileQuit + + + + +Key combinations (pressed simultaneously) +Modifier Key+Action Key +&Ctrl;Q + + + + +Text you should enter +Bold, fixed width font +ls -al kde/ + + + +Text you should replace as appropriate +Italic green font +user + + + + + + + + + + +System Locations + +You may need to know the following system locations: + + + + +&kde; prefix +&kde; installs into its own folder tree, which you can find by +running the command kde-config . This folder is referred to +by the environment variables $KDEDIRS and possibly +$KDEDIR. + + + + +&kde; user-specific settings +The environment variable $KDEHOME +points to the folder where &kde; should find user-specific settings. If it is not +set, the default value of ~/.kde is used. + + + + + + + + + +Overview, or <quote>Where to look in the User Guide</quote> + +Here's an overview of what's in the User Guide: + + contains an introduction to the basic +use of &kde;, such as , and the tools +that you'll be using in all &kde; applications, like . If you're new to &kde; or even +computers in general, you will probably find this section +helpful. + + explains some important components +of a &kde; installation and how they fit together: &kde;'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, you'll find a guide to tweaking &kde; +just that little bit more, in . + + highlights &kde;'s suite of +Internet applications. &kde; includes a powerful web browser, +&konqueror;, a full-featured email client, &kmail;, a news reader, +&knode;, and many more applications to make your Internet experience +easier and more productive. This part of the User Guide contains +information about setting up these applications. + + is a reference guide to +some &kde; features which will be useful to administrators setting up +multi-user systems. This part also has information that may be useful +to &kde; users with single-user systems: where configuration files are +stored, what environment variables affect &kde;, and so on. The KIOSK +framework is the &kde; system which allows administrators to limit +what users can do in &kde;. It is potentially useful in many +situations, but especially for running single-function kiosks with, +for example, just a web browser, hence the name. + + + + + + +The Desktop + + +The Basics +The desktopDesktop + is just the name for the layout of +the screen when you start &kde;. It looks something like this (on your +own system, it might look slightly different, but the main features +should be the +same): + + + + + + +A default desktop layout + + + + +Let us look at the most important parts: + +Most of the screen is +taken up by the backgroundBackground. At the moment, there is a picture making up +the background. This picture is usually referred to as the +wallpaper,Wallpaper and you can change it to make &kde; suit your +taste. + + +In the top left-hand corner are two icons: +Trash and Home. Clicking on +these will open your Trash folder and Home +folder, respectively. You can add more icons to the desktop so that +you can open your favorite programs, or access removable media, with +just one click. + + +At the bottom is the &kde; PanelPanel, also known as +&kicker;. The Panel contains several useful ways of +interacting with &kde;. It houses the &kmenu;, from where you can open +any &kde; application installed on your computer, it shows all the +programs that are currently running, as well as the time, and more. +Take a look at for more +information about the &kde; Panel. + + + + + + + + + + + +&Philip.Rodrigues; + + + + +Logging In and Logging Out +Basic KDM & startkde stuff. + + +There are two ways to log into &kde;: graphically and via the +command line. We'll look at them both briefly: + + +Logging in Graphically +login +&kdm; + +If you see a screen a little bit like the one below when you +start up your computer, then you are all set for logging in +graphically. Just enter your username in the +Login text box and your password in the +Password text box. Your password will not be shown +as you type it; it will probably be shown as asterisks. When you have +entered that information, click on the Login +button, and &kde; will start up. The &kde; splash screen will appear, +and keep you informed about the progress of &kde; startup, and when +it is done, &kde; will be ready to use. + + + +Logging in via the Command Line +startkde +startx + +If you prefer using the command line, you can log in to &kde; +with the startx command. Add the line +exec startkde to the +.xinitrc file in your home folder (create it +if it does not exist), save the file, and then run +startx. &kde; should start in the same way as if +you had logged in graphically. + + + +Logging Out +logout + +Once you have finished using &kde; for the moment, you will +want to log out until next time. The easiest way to do this is to +click on the &kmenu; at the bottom left of your screen, and then +select the Log Out... item. A dialog with the +text End session for +username will appear. To confirm +that you want to log out, click on the End Current Session +button. If you change your mind, and decide to carry on using &kde; +for now, hit Cancel. + + +Related Information +The &kdm; Handbook has information about using and setting up +the &kde; graphical login manager. You can read it in &khelpcenter; or +by entering help:/kdm in &konqueror;'s +Location bar. + + + + + + +&getting-help; +&windows-how-to; + +&the-filemanager; + + + + +&panel-and-desktop; + +&programs-and-documents; + + + + +&kde; Components + +&control-center; + +&base-kde-applications; + +&extragear-applications; + + +Multimedia With &kde; + +&removable-disks; + +&playing-music; + +&playing-audiocds; + +&playing-movies; + + + + +&kde; the Multiuser Desktop + +&your-kde-account; + +&kde-as-root; + +&switching-sessions; + + + +Networking with &kde; + +&file-sharing; + +&networking-with-windows; + +&shared-sessions; + + + +Graphics, Printing, and Fonts + +&printer-setup; + +&printing-from-apps; + +&pdf-files; + +&font-installation; + +&creating-graphics; + + +&customizing-desktop; + +&konsole-intro; + +&kde-edutainment; + +&accessibility; + +&under-the-hood; + + + +&kde; and the Internet + +&net-connection-setup; + +&email; + + +&konqueror; + +Intro to the browser + +&internet-shortcuts; + +&browser-fine-tuning; + + +&usenet; + +&messaging-intro; + + + +&kde-office; + +&kde-for-admins; + + +More Tools + +&migrator-applications; + +&migrator-dictionary; + +&standard-menu-entries; + +&glossary; + + +Troubleshooting Problems + +Problems that aren't + +Frozen apps (how to kill them) + +Things won't open + +That scary crash dialog + +Reporting Bugs + +More Resources + +&troubleshooting-network-x; + +&troubleshooting-no-open; + + + + +Contributing to &kde; + +Some basic information to get encourage people to contribute to +&kde;, information about what's available, and how to get +started. + + + + + + + +Credits and Licenses + +&credits-and-license; + + +License + + + +&underFDL; + + + + +&documentation.index; + + + + + diff --git a/doc/userguide/internet-shortcuts.docbook b/doc/userguide/internet-shortcuts.docbook new file mode 100644 index 000000000..f6705c292 --- /dev/null +++ b/doc/userguide/internet-shortcuts.docbook @@ -0,0 +1,80 @@ + + + + + +Simon +Vermeersch + +titeuf@ph34rus.org + + + + +Internet Shortcuts + +Web shortcuts +Internet Shortcuts +gg: + +Internet shortcuts are a really useful feature of &konqueror;: +once you get used to them, you'll wonder how you ever lived without them. + +To see what internet shortcuts are, open up &konqueror; and type +gg:kde in the Location +bar. + +You will go to Google, searching for &kde;. + +They are many such shortcuts like ggl: (Google +I'm feeling lucky), bug: (bugs.kde.org) and so +on. + +To get a full list, click on Settings in the +&konqueror; menu, and select Web Shortcuts. 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 Default +search engine, you don't have to type the shortcut anymore. For +instance if you set it to Google, you can just type +kde in the Location bar, +and it will search Google for &kde;. + +In Keyword delimiter you can choose if you want +to separate a shortcut with a colon (gg: kde) or a +space (gg kde). + +A nice tip with Internet shortcuts is that you can use them from the +Run Command dialog. Just open it (through the &kmenu; +or with &Alt;F2) and +type your shortcut, ⪚ gg: kde, and press +&Enter;. It will automatically open &konqueror; with a Google +search for &kde;. + + + + + + + + + diff --git a/doc/userguide/juk-icon.png b/doc/userguide/juk-icon.png new file mode 100644 index 000000000..2b58a33d3 Binary files /dev/null and b/doc/userguide/juk-icon.png differ diff --git a/doc/userguide/juk.png b/doc/userguide/juk.png new file mode 100644 index 000000000..9ec3ae91e Binary files /dev/null and b/doc/userguide/juk.png differ diff --git a/doc/userguide/kaboodle-icon.png b/doc/userguide/kaboodle-icon.png new file mode 100644 index 000000000..87ac58b8c Binary files /dev/null and b/doc/userguide/kaboodle-icon.png differ diff --git a/doc/userguide/kaboodle.png b/doc/userguide/kaboodle.png new file mode 100644 index 000000000..dbbcfd923 Binary files /dev/null and b/doc/userguide/kaboodle.png differ diff --git a/doc/userguide/kcalc-systray.png b/doc/userguide/kcalc-systray.png new file mode 100644 index 000000000..5e0ac5cc5 Binary files /dev/null and b/doc/userguide/kcalc-systray.png differ diff --git a/doc/userguide/kcontrol.png b/doc/userguide/kcontrol.png new file mode 100644 index 000000000..3de78f3f8 Binary files /dev/null and b/doc/userguide/kcontrol.png differ diff --git a/doc/userguide/kde-as-root.docbook b/doc/userguide/kde-as-root.docbook new file mode 100644 index 000000000..7e6bb6fe9 --- /dev/null +++ b/doc/userguide/kde-as-root.docbook @@ -0,0 +1,52 @@ + + + + + +&Francis.Giannaros; &Francis.Giannaros.mail; + + + + + +Using &kde; as Root + +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 /home/username, and then to also have a root account. The root, or Super User, account has system-wide privileges, being able to modify any file on the system. + +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. + +Some of the operating systems that run &kde; come with a graphical root login enabled. Despite this, you should never log in to &kde; as root, and you should never need to. Your system is far more open to attack, particularly if you are browsing the Internet as root, and you dramatically increase your chances of damaging your system. + +Some &Linux; distributions have tried to stress this point so much that they have disabled the root account altogether, and instead use the sudo model. Nevertheless, the basic security model in sudo is the same as su, and thus they share the same security strengths and weaknesses, essentially. + +If you should ever need to run a program with Super User privileges, then it is always recommend that you use &kdesu;. From &konsole; or from hitting &Alt;F2, enter kdesu application, and the application will be run with the appropriate Super User privileges. + +Even if you have set up your system to use sudo, or you are on a distribution that uses sudo, such as &kubuntu;, you should still use &kdesu;. The program will be appropriately modified by the developers to use the correct settings. You should not, however, ever use sudo application to run an application with root permissions; it can derange permissions of certain configuration files for a program. Running a graphical applications as root in general is not a good idea, but using &kdesu; will always be your safest bet with it. + + + +Related Information +&kdesu; Handbook + + + + + + + diff --git a/doc/userguide/kde-edutainment.docbook b/doc/userguide/kde-edutainment.docbook new file mode 100644 index 000000000..11c6faae7 --- /dev/null +++ b/doc/userguide/kde-edutainment.docbook @@ -0,0 +1,342 @@ + + + +&kde; Edutainment + +The &kde; 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 &kde; +educational software on the KDE-Edu +website. What follows is an overview of a few of them. + +View the handbook of each application by typing help:/<appname> in &konqueror;'s Location Toolbar, or by selecting it in &khelpcenter;. + + +Improve your language skills + + + +&khangman; + 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. + + + Website: http://edu.kde.org/khangman + &khangman; Handbook + + + + + + +&klettres; + 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. + + + Website: http://edu.kde.org/klettres + &klettres; Handbook + + + + + + +&kanagram; + 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. + + + Website: http://edu.kde.org/kanagram + &kanagram; Handbook + + + + + + +&kverbos; + 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. + + + Website: http://edu.kde.org/kverbos + &kverbos; Handbook + + + + + + +&kvoctrain; + Another advanced vocabulary training application, using the flash card approach. Vocabulary files and be downloaded and loaded into the application. + + + Website: http://edu.kde.org/kvoctrain + &kvoctrain; Handbook + + + + + + + +&kiten; + A Japanese reference and learning tool. Words from both English and Japanese can be looked up, and filtered, using the Edict and Kanjidic 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. + + + Website: http://edu.kde.org/kiten + &kiten; Handbook + + + + + + +&klatin; + 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. + + + Website: http://edu.kde.org/klatin + &klatin; Handbook + + + + + + + + + + +Mathematics + +Several applications to help you with Mathematics and Geometry. + + + +&kbruch; + 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. + + + Website: http://edu.kde.org/kbruch + &kbruch; Handbook + + + + + + +&kig; + 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. + + + Website: http://edu.kde.org/kig + &kig; Handbook + + + + + + +&kpercentage; + 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. + + + Website: http://edu.kde.org/kpercentage + &kpercentage; Handbook + + + + + + + +&kmplot; + 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. + + + Website: http://edu.kde.org/kmplot + &kmplot; Handbook + + + + + + + + + + +Science + + + +&kstars; + A desktop Planetarium for &kde;. 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. + + + Website: http://edu.kde.org/kstars + &kstars; Handbook + + + + + + + &kalzium; + 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. + + + Website: http://edu.kde.org/kalzium + &kalzium; Handbook + + + + + + + + + +Teaching Tools + + + &keduca; + 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. + + + Website: http://edu.kde.org/keduca + &keduca; Handbook + + + + + + + + + +Miscellaneous + + + &ktouch; + 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. + + + Website: http://edu.kde.org/ktouch + &ktouch; Handbook + + + + + + + + + &kwordquiz; + 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. + + + Website: http://edu.kde.org/kwordquiz + &kwordquiz; Handbook + + + + + + + + &kturtle; + An educational programming environment using the Logo programming language, with several languages currently supported. + + + Website: http://edu.kde.org/kturtle + &kturtle; Handbook + + + + + + + + &kgeography; + &kgeography; is a geography learning tool for &kde;. 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. + + + Website: http://kgeography.berlios.de/ and http://edu.kde.org/kgeography + &kgeography; Handbook + + + + + + + + &blinken; + &blinken; is a Simon Says game for &kde;. The player should remember the sequence of lights in the correct order and is then presented with an identical sequence with one extra step. + + + Website: http://edu.kde.org/blinken + &blinken; Handbook + + + + + + + + + + +Related Information + +The &kde;-Edu website at http://edu.kde.org has news and +information about all the &kde; Edutainment applications. + + + + + + + + diff --git a/doc/userguide/kde-for-admins.docbook b/doc/userguide/kde-for-admins.docbook new file mode 100644 index 000000000..f7d5d2ee0 --- /dev/null +++ b/doc/userguide/kde-for-admins.docbook @@ -0,0 +1,2747 @@ + + + + + +Waldo +Bastian + +bastian@kde.org + + +&Philip.Rodrigues; +&Philip.Rodrigues.mail; + + + + +&kde; for Administrators + + +&kde; Internals + + +Overview +to be written + + + +Directory Layout + +&kde; defines a filesystem hierarchy which is used by the &kde; +environment itself as well as all &kde; applications. In general &kde; +stores all its files in a directory tree with a fixed structure. + + +By default &kde; uses two directory trees: + + +One at the system level (for example /opt/kde3). +One at the user level in the user's home directory +(usually +~/.kde) + + +As a system administrator you can create additional trees. Such +additional trees can be used for profiles + +&SuSE; &Linux; for example uses: + + +$HOME/.kde +/opt/kde3. (This is +&SuSE;-specific; other distributions may use +/usr or /usr/kde3) +/etc/opt/kde3. (This was added by +&SuSE;). + + +If you have the KIOSK Admin tool v0.7 or later installed you can +check which directory trees are used with the following command: +kiosktool-kdedirs + + + +&kde; and &kde; applications look up files by scanning all the +&kde; 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. + + +For information about the text/plain &MIME; type +the following files are searched: + + +$HOME/.kde/share/mimelnk/text/plain.desktop +/opt/kde3/share/mimelnk/text/plain.desktop +/etc/opt/kde3/share/mimelnk/text/plain.desktop + + +If a user makes a change, the change is written to $HOME/.kde/share/mimelnk/text/plain.desktop + + +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. + + +For example, if the following two files exist, with these contents: + +$HOME/.kde/share/config/foobar + +Color=red +Shape=circle + + + + + +/etc/opt/kde3/share/config/foobar + +Color=blue +Position=10,10 + + + + + +The files will be merged to result in: + + +Color=red +Shape=circle +Position=10,10 + + + + + + +Specifying Directories + + + + +Environment Variable +Example Setting(s) +Comment + + +KDEHOME +~/.kde + + + + +KDEROOTHOME +/root/.kde +Different variable to prevent +root writing to $KDEHOME of the user after running +su. + + + +KDEDIR +/opt/kde3, /usr, /usr/kde3 +Vendor dependent. Used by &kde; 2. If not set, falls back to +compiled-in default. + + + +KDEDIRS +/opt/kde3, /usr, /usr/kde3 +New in &kde;3. Can list multiple locations separated by a +colon. If not set, falls back to $KDEDIR + + + + +Don't need to be set, defaults work just fine. +Running &kde;2 next to &kde;3? Point $KDEDIR to +&kde; 2 and $KDEDIRS to &kde; 3. + + +A staff member at a university could have the following +settings: + +KDEHOME='~/.kde3' +KDEROOTHOME='/root/.kde3' +KDEDIRS='/opt/kde_staff:/opt/kde3' + + + + + + + +User Profiles + +In the previous example /opt/kde_staff contained additional settings +and applications for staff members. User Profiles allow you +to add this directory only for certain users and not for others. Add the +following to /etc/kderc: + + +[Directories-staff] +prefixes=/opt/kde_staff + + +This creates a profile named staff that adds the +/opt/kde_staff directory +tree. (Note that &SuSE; &Linux; uses +/etc/kde3rc instead of +/etc/kderc. Now that we have a named profile it +can be assigned to users. + +To map profiles to users a mapping file needs to be specified in +/etc/kderc: + + +[Directories] +userProfileMapFile=/etc/kde-user-profile + + +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. + +To assign the staff profile to all users that are a member of the +&UNIX; group staff_members add the following to +/etc/kde-user-profile: + + +[General] +groups=staff_members +[Groups] +staff_members=staff + + +It is also possible to assign a profile to a single user: + + +[Users] +bastian=staff + + + + + +Directory Layout Revisited + +Each directory tree used by &kde; 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 $KDEHOME but not in any other +directory tree. + + + + +Architecture-specific Directories + +Architecture (OS and CPU type) specific directories: + + + +bin +Used for &kde; executables. + + + +lib +Used for &kde; libraries. + + + + +lib/kde3 +This directory contains components, plugins, and other +runtime loadable objects for use by &kde; 3.x +applications. + + + + + + +Shared Directories + +Shared: Not architecture specific, can be shared between different +archs. + + + +share/applnk +.desktop files for +&kde;-menu (old) + + + +share/applications +.desktop files for +&kde;-menu (since &kde; 3.2) + + + + +share/apps +Contains application-specific data files. Each +application has a sub-directory here for storing additional data +files. + + + +share/config +Configuration files. Configuration files are normally +named after the application they belong to plus the letters +rc. A special case is kdeglobals. +This file is read by all &kde; applications. + + + +share/config/session +This directory is used by session management and is +normally only available under $KDEHOME. At the end of a +session &kde; applications store their state here. The file names +consist of the name of the application followed by a number. The +session manager ksmserver stores references to +these numbers when saving a session in +ksmserverrc. + + + +share/doc/HTML +This directory contains documentation for &kde; +applications. Documentation is categorized by language and the +application it belongs to. Normally at least two files can be found in +a directory: index.docbook, which contains the +documentation in the unformatted DocBook format, and +index.cache.bz2, which contains the same +documentation formatted as bzip2-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. + + + + +share/icons +Under this directory icons are stored. Icons are +categorized by theme, dimension and usage category. + + + +share/mimelnk +In this directory,.desktop files that describe &MIME; types +are stored. &kde; uses &MIME; types to identify the type of a +file. + + + + +share/services +This directory contains .desktop 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 &kde; menu. + + + + +share/servicetypes +This directory contains .desktop files that describe +servicetypes. A servicetype usually represents a certain programming +interface. Applications and Services include in their >.desktop files the servicetypes that they +provide. + + +share/sounds +This directory contains sound files. + + + +share/templates +This directory contains templates for creating files +of various types. A template consists of a .desktop file that describes the file and +that includes a reference to a file in the .source sub-directory. The templates in +this directory appear in the Create New menu +available on the desktop and in the file browser. When a user selects +a template from the menu its source file is copied. + + + + +share/wallpapers +This directory contains images that can be used as +background picture + + + + + + + +Host-specific Directories + +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 +lnusertemp utility: + + + + +$KDEHOME/socket-$HOSTNAME +Usually /tmp/ksocket-$USER/, this +is used for various &UNIX; sockets. + + + + +$KDEHOME/tmp-$HOSTNAME +Usually /tmp/kde-$USER/, this is used for temporary files. + + + + +$KDEHOME/cache-$HOSTNAME +Usually /var/tmp/kdecache-$USER/, +this is used for cached files. + + + + +Since both /tmp and +/var/tmp 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 +lnusertemp utility will create a new directory with +an alternative name and link to that instead. + + + + +Configuration Files &kde; uses a simple +text-based file format for all its configuration files. It consists of +key-value pairs that are placed in groups. All &kde; configuration +files use UTF-8 encoding for text outside the +ASCII range. + +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. + +The following example shows a configuration +file that consists of two groups. The first group contains the keys +LargeCursor and SingleClick, the +second group contains the keys Show hidden files +and Sort by: + + +[KDE] +LargeCursor=false +SingleClick=true + + + +[KFileDialog Settings] +Show hidden files=false +Sort by=Name + + + +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: + + +entry=value + + +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 +s. + +There are several other backslash codes; here is a complete +list: + +\s can be used as space + +\t can be used to include a tab + +\r for a carriage return character + +\n for a linefeed character (new line) + +\\ to include the backslash itself + + + +In the following example the value of the +Caption entry starts with two spaces while the +Description entry contains three lines of +text. Linefeeds in backslash notation are used to separate the +different lines. + + +[Preview Image] +Caption=\s My Caption +Description=This is\na very long\ndescription. + + + +Empty lines in configuration files are ignored, as are lines that +start with a hash mark (#). The hash mark can be used to add +comments to configuration files. It should be noted that when a &kde; +application updates a configuration file the comments are +not preserved. + +There can be multiple configuration files with the same name in the +share/config sub-directory of the +various &kde; 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 $KDEHOME 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. + + +If $HOME/.kde/share/config/foobar +contains: + +[MyGroup] +Color=red +Shape=circle + +and /etc/opt/kde3/share/config/foobar contains + +[MyGroup] +Color=blue +Position=10,10 + +the result will be: + +[MyGroup] +Color=red +Shape=circle +Position=10,10 + + + + + +If + $HOME/.kde/share/config/foobar + contains + +[MyGroup] +Color=red +Shape=circle +[MyGroup] +Color=green + +and /opt/kde_staff/share/config/foobar contains + +[MyGroup] +Color=purple +Position=20,20 + +and /etc/opt/kde3/share/config/foobar contains + +[MyGroup] +Color=blue +Position=10,10 + +the result will be: + +[MyGroup] +Color=green +Shape=circle +Position=20,20 + + + + +To prevent users being able to override default settings, +settings can be marked immutable. Settings can be made immutable +individually, per group or per file. An individual entry can be locked +down by adding [$i] behind the key, ⪚: + +Color[$i]=blue + + +A group of entries can be locked down by placing +[$i] behind the group name, ⪚: + +[MyGroup][$i] + + +To lock down the entire file, start the file with +[$i] on a single line, &ie;: + +[$i] + + + + +If + $HOME/.kde/share/config/foobar + contains: + +[MyGroup] +Color=red +Shape=circle + +and /etc/opt/kde3/share/config/foobar contains: + +[MyGroup][$i] +Color=blue +Position=10,10 + +the result will be: + +[MyGroup] +Color=blue +Position=10,10 + + + + +If + $HOME/.kde/share/config/foobar + contains: + +[MyGroup] +Color=red +Shape=circle + +and /opt/kde_staff/share/config/foobar contains + +[MyGroup] +Color=purple +Shape=rectangle + +and /etc/opt/kde3/share/config/foobar contains + +[MyGroup][$i] +Color=blue +Position=10,10 + +the result will be + +[MyGroup] +Color=purple +Shape=rectangle +Position=10,10 + + + + + +So-called Shell Expansion 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 [$e]. 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 [$ie]. The user can't change it then of course. + + +In the following example the value for the Host +entry is determined by the output of the hostname +program. This setting is also locked down to ensure that the value is always +determined dynamically. + +The value for the Email entry is determined by +filling in the values of the $USER and $HOST +environment variables. When joe is +logged in on joes_host this will +result in a value equal to joe@joes_host. The setting is +not locked down. + + +[Mail Settings] +Host[$ie]=$(hostname) +Email[$e]=${USER}@${HOST} + + + +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. + + +In the following example the value of the Caption +entry depends on the language. If the user has selected French as language +(language code fr) the value of the entry will be +Ma Légende. In all other cases the value My +Caption will be used. + + +[Preview Image] +Caption=My Caption +Caption[fr]=Ma Légende + + + + +In this example the value of the Caption entry +depends on the language. If the user has selected French as language +(language code fr) the value of the entry will be +Ma Légende. In all other cases the value My +Caption will be used. + + +[Preview Image] +Caption=My Caption +Caption[fr]=Ma Légende + + + +In general the entries that can appear in a configuration file are not +documented. With &kde; 3.2 a start has been made to change this. In +$KDEDIR/share/config.kcfg, files +can be found that provide a formal description of the possible entries in a +configuration file. These are used by the new &kde; Configuration Editor +when available. + + +Here is an example &XML; configuration file: + + +<?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> + + + +It has the same effect as: + +[General] +Auto Save=false +Auto Save Interval=25 + + + + + + + +&kde; Startup Sequence + + +&kdm; + +Always runs as root! Uses +$KDEDIR/share/config/kdmrc and +/etc/X11/xdm/Xservers. The latter contains entries +like: + + +:0 local /usr/X11R6/bin/X :0 vt07 + + +Relevant startup files are also: + + +[X-*-Core] section in kdmrc + + +Setup - /etc/X11/xdm/Xsetup + + +User enters username & password + + +Startup - /etc/X11/xdm/Xstartup - prepare as root + + +Session - /etc/X11/xdm/Xsession - starts session as user + + += For a KDE session: kde or startkde + + += If present ~/.xsession or ~/.xinitrc + + +Reset - /etc/X11/xdm/Xreset - after session finished + + + + + + +The &kde; Startup Script: <command>startkde</command> + +The &kde; startup sequence starts with the +startkde script. In most cases this script gets called +from the display manager (&kdm;) once the user has been authenticated. Their +are two very important lines in the startkde +script: + + +LD_BIND_NOW=true kdeinit +kcminit +knotify and kwrapper +ksmserver $KDEWM + + +The first line starts the kdeinit master process. +The kdeinit master process is used to start all other +&kde; processes. It show up in the output of ps + as kdeinit: +Running.... The arguments after kdeinit +are the names of additional processes to be started. The + +indicates that kdeinit needs to wait till the process has +finished. kdeinit also starts +dcopserver, klauncher and +kded. + +The second of the two lines asks kdeinit to start +the ksmserver session manager process. The session +manager determines the lifetime of the session. When this process exits, the +user is logged out. + + + + + +Background Processes + +All &kde; 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: + + + +dcopserver +Desktop communication + + + + +kded +Generic service daemon. +Triggers Sycoca database updates when +needed + + + + +kcminit +Initialization service +See for more information. + + + + +klauncher +Program launch (this is not the +&Alt;F2 +dialog!) +See for more information. + + + + +knotify +User notifications. +See for more information. + + + + +ksmserver +Session management +See for more information. + + + + + + +<command>kdeinit</command> +kdeinit is used to start all other &kde; +programs. kdeinit can start normal binary program files +as well as kdeinit loadable modules +(KLMs). KLMs work just like binary +program files but can be started more efficiently. KLMs +live in $KDEDIR/lib/kde3 + +The drawback is that programs started this way appear as +kdeinit in the output of +top and ps. Use top + or ps +to see the actual program name: + + +%ps + +waba 23184 0.2 2.1 23428 11124 ? S 21:41 0:00 kdeinit: Running... +waba 23187 0.1 2.1 23200 11124 ? S 21:41 0:00 kdeinit: dcopserver --nosid +waba 23189 0.2 2.4 25136 12496 ? S 21:41 0:00 kdeinit: klauncher +waba 23192 0.7 2.8 25596 14772 ? S 21:41 0:00 kdeinit: kded +waba 23203 0.8 3.4 31516 17892 ? S 21:41 0:00 kdeinit: +knotify + + + +kdeinit: Running... indicates the +master kdeinit process. The other processes listed are +programs started as KLMs. + +When kdeinit starts for the first time it will +launch dcopserver, klauncher, and +kded, as well as any additional programs specified on its +command line in the startkde script, normally +kcminit and knotify. + + + + +<command>dcopserver</command> + +dcopserver is a daemon which provides inter-process +communication (&DCOP;) facilities to all &kde; applications. The &DCOP; +facilities are accessible from the command shell via the +dcop command line tool. &DCOP; is essential for all &kde; +applications. + +Some related files: + + + +$HOME/.DCOPserver_$HOSTNAME_$DISPLAY +⪚ .DCOPserver_linux__0. Controlled by $DCOPAUTHORITY + + + + +/tmp/.ICE-unix/dcoppid-number +⪚ dcop7634-1069677856. This is +the file that the DCOPserver file above points to. + + + + +$HOME/.ICEauthority +Authorization information controlled by +$ICEAUTHORITY + + + + + + + +kcminit + +kcminit executes initialization services during +startup. Initialization services are specified in the .desktop files of +applications or services via the X-KDE-Init line: + + +[Desktop Entry] +Encoding=UTF-8 +Exec=kcmshell energy +Icon=energy_star +Type=Application +X-KDE-Library=energy +X-KDE-Init=energy + + +Initialization services are typically used for initializing +hardware based on user-specified settings. + +kcminit + can be used to show all +initialization services and kcminit +service can be used to +execute a single service explicitly. This can be useful when investigating +startup problems. + + + + +<command>klauncher</command> + +klauncher is a daemon which is responsible for +service activation within &kde;. It operates in close connection with the +kdeinit master process to start new processes. &kde; +applications communicate with klauncher over &DCOP; in +order to start new applications or services. + +Best known from the error message: +KLauncher could not be reached via DCOP which +either indicates a serious problem with the dcopserver or +that klauncher crashed. + +klauncher can be restarted by restarting +kdeinit from a console window. Make sure that +$HOME, $DISPLAY and the various +$KDEDIR(S) are set correctly when doing so! + + + + +<command>knotify</command> + +The primary task of knotify is to relay sound +notifications to the sound server, it also provides alternative notification +methods. + + + + + + + +KSMServer + +ksmserver is &kde;'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 .desktop files in the +$KDEDIR/share/autostart +directory. Whether or not to auto-start an application can be made +conditional upon some configuration entry determined by the +X-KDE-autostart-condition entry in the .desktop file. + + +The ktip.desktop file for example +contains: + + +X-KDE-autostart-condition=ktiprc:TipOfDay:RunOnStart:true + + +This means that the ktiprc configuration +file is checked for a RunOnStart entry in the +[TipOfDay] section. If no such entry is found, +true is assumed, which means that +ktip is one of the applications that is +auto-started by default. + + +Some of the applications auto-started by ksmserver +are: + + + + +kdesktop +The &kde; desktop + + + + +&kicker; +The &kde; panel + + + + +ktip +A tip of the day program + + + + +kwrited +A utility to receive system messages sent to the user + + + + +&klipper; +A clipboard utility that docks in the panel + + + + +kalarm +A utility that warns about upcoming events and appointments + + + + + +kdesktop in its turn automatically starts +applications stored in $KDEHOME/Autostart. kdesktop +will automatically open any files stored in this directory including +documents, binary files or applications in the form of .desktop files. + +The &kde; 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 +ksmserverrc configuration file which contains +references to application-specific state information. The +application-specific state information is saved in $KDEHOME/share/config/session. +The state information of &kwin; contains the location of the application +windows of all the other applications in the session. + + + + + +Environment variables + +Some important environment variables used by &kde;: + + + + +$KDEDIR +Has to be set if +KDEDIRS is not set and has to point to the root of the +&kde; installation tree. Allows &kde; to find its data like icons, +menus and libraries. + + + +$KDEDIRS +Overrides KDEDIR and allows you to specify +multiple directories where &kde; searches for its data. Useful if you want +or have to install some programs to a different prefix than the rest of +&kde;. + + + +$KDEHOMEIf +not set, &kde; uses ~/.kde as +the directory where personal data is stored. + + + +$KDEROOTHOMEIf +not set, &kde; uses ~root/.kde +as the directory for root's +personal data. Was introduced to prevent &kde; from accidently +overwriting user data with root permissions when the user runs a &kde; +program after switching with su to root. + + + +$KDEWMIf the +KDEWM environment variable has been set, then it will +be used as &kde;'s window manager within the +startkde script instead of &kwin;. + + + +$KDE_LANGOverrides +the &kde; language configuration, ⪚ KDE_LANG=fr kprogram +& starts a program with French translation if the +necessary files are installed. + + + +$KDE_MULTIHEADSet +this variable to true to indicate that &kde; is running +on a multi-head system. + + + +$KDE_FORK_SLAVES +(Since &kde; 3.2.3) Set this variable to spawn +KIO-slaves directly from the application process +itself. By default KIO-slaves are spawned using +klauncher/kdeinit. This option is +useful if the KIO-slave should run in the same +environment as the application. This can be the case with +Clearcase. + + + +$KDE_HOME_READONLY +Set this variable to indicate that your home directory is +mounted as read-only. + + + +$KDE_NO_IPV6 +(Since &kde; 3.2.3) - Set this variable to disable IPv6 +support and IPv6 DNS +lookups. + + + +$KDE_IS_PRELINKED +(Since &kde; 3.2) - Set this variable to indicate that you have prelinked +your &kde; binaries and libraries. This will turn off +kdeinit. + + + +$KDE_UTF8_FILENAMESIf +this environment variable is set, &kde; assumes all filenames are in +UTF-8 encoding regardless of the current C +locale. + + + +$KDE_FULL_SESSION +(Since &kde; 3.2) Automatically set to true by &kde; 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 (⪚ &kdesu; does that, it's also useful for +debugging). + + + +$KDESYCOCAAllows +you to specify the path and the name of the generated &kde; system +configuration cache file. + + + +$KDETMPAllows +to specify another path than /tmp where &kde; stores its temporary +files. + + + +$KDEVARTMPAllows +to specify another path than /var/tmp where &kde; stores its variable +files. + + + +$XDG_DATA_HOME +(Since &kde; 3.2) Defines the base directory relative to which user-specific +data files should be stored. Default is $HOME/.local/share + + + +$XDG_DATA_DIRS +(Since &kde; 3.2) Defines the preference-ordered set of base directories to +search for data files in addition to the $XDG_DATA_HOME base +directory. Default is +/usr/local/share/:/usr/share/ + +&kde; adds locations from $KDEDIRS and profiles +as well. Used for .desktop and +.directory menu files. .desktop files under $XDG_DATA_DIRS/applications. +.directory files under +$XDG_DATA_DIRS/desktop-directories + + + + +$XDG_CONFIG_HOME +(&kde; 3.2) - Defines the base directory relative to which user +specific configuration files should be stored. Default is +$HOME/.config. + + + +$XDG_CONFIG_DIRS +(&kde; 3.2) - Defines the preference-ordered set of base directories +to search for configuration files in addition to the $XDG_CONFIG_HOME +base directory. The default is /etc/xdg &kde; adds locations from +$KDEDIRS and profiles as well. Used by .menu descriptions in +$XDG_CONFIG_DIRS/menus. + + + + + + + + +The kdeinit Mystery + + + +kdeinit is used to start all other &kde; +programs. kdeinit can start normal binary program f iles +as well as kdeinit loadable modules +(KLMs). KLMs work just like binary +program files but can be started more efficiently. KLMs +live in $KDEDIR/lib/kde3 + +The drawback is that programs started this way appear as +kdeinit in the +output of top and ps. Use +top or ps + to see the actual program name: + + +% ps aux | grep bastian + +bastian 26061 0.0 2.2 24284 11492 ? S 21:27 0:00 kdeinit: Running... +bastian 26064 0.0 2.2 24036 11524 ? S 21:27 0:00 kdeinit: dcopserver +bastian 26066 0.1 2.5 26056 12988 ? S 21:27 0:00 kdeinit: klauncher +bastian 26069 0.4 3.2 27356 16744 ? S 21:27 0:00 kdeinit: kded +bastian 26161 0.2 2.7 25344 14096 ? S 21:27 0:00 kdeinit: ksmserver +bastian 26179 1.1 3.4 29716 17812 ? S 21:27 0:00 kdeinit: kicker +bastian 26192 0.4 3.0 26776 15452 ? S 21:27 0:00 kdeinit: klipper +bastian 26195 1.0 3.5 29200 18368 ? S 21:27 0:00 kdeinit: kdesktop + + +As you might have noticed, this has another side effect, making it +difficult to kill a process that is causing trouble: + +% killall kdesktop +kdesktop: no process killed + +You might be tempted to try killall +kdeinit, but killing all kdeinit processes will have +the effect of shutting down all of &kde;. In effect, total +destruction! + +There are two simple solutions to this: + +% kdekillall kdesktop +or good old +% kill 26195 +kdekillall is part of the &kde; SDK +package. + + + + + + +Customizing &kde; + + + +Desktop Icons + +&kde; uses several types of icons: + +Documents + +Links to Websites (using .desktop file) + +Links to Applications (using .desktop file) + +Devices - Disks, Partitions & Peripherals: + +Explicit using .desktop file + +Automatic via devices:// io-slave + + + + +Vendor-specific (⪚ &SuSE;'s My Computer) + + + + +Websites + +Links to Websites using .desktop +file: Create +NewFileLink to +Location (URL). Change Icon using +Properties dialogs. The resulting .desktop file: + +[Desktop Entry] +Encoding=UTF-8 +Icon=/opt/kde3/share/apps/kdesktop/pics/ksslogo.png +Type=Link +URL=http://www.kde.org/ + + + + + +Applications + +Links to Applications using .desktop file: Create +NewFileLink to +Application. You must provide details +yourself. Drag from &kde; Menu: Either copy or link (creates symlink), +much easier + + + + + + +[Desktop Entry] +Encoding=UTF-8 +GenericName=IRC Client +GenericName[af]=Irc Kliët +GenericName[de]=IRC Programm +... +GenericName[zu]=Umthengi we IRC +SwallowExec= +Name=KSirc +Name[af]=Ksirc +Name[de]=KSirc +... + + + +Boiler plate + +Translated generic description, not used on desktop + +Legacy, can be removed + +Translated name as it appears on desktop + + + +Desktop Icons + +... +Name[zu]=Ksirc +MimeType= +Exec=ksirc %i %m +Icon=ksirc +TerminalOptions= +Path= +Type=Application +Terminal=0 +X-KDE-StartupNotify=true +X-DCOP-ServiceType=Multi +Categories=Qt;KDE;Network + + + +Supported &MIME; types, not used on +desktop + +The command line to execute + +The icon, from icon theme or full path + +Only used if terminal is +needed + +Working directory for command + +More boiler plate + +Use true if terminal is needed, +text application + +Show bouncy cursor, +disable if it doesn't work. + +Has app started ok? +Remove if it doesn't work + +Categories for &kde; Menu, not +used on desktop + + + + + + + + +The <varname>Exec</varname> option in <literal +role="extension">.desktop</literal> files + +Following the command, you can have several place holders which will +be replaced with the actual values when the actual program is run: + + +%f A single file name; used when dropping +file on icon, or with file associations. + + + + +%F +A list of files; use for applications that can +open several local files at once. + + + + +%u +A single &URL;: if the app can +handle ⪚ &FTP; or &HTTP; &URL;s itself, otherwise &kde;. + + + + +%U +A list of +&URL;s; will download the file first and pass a local file to the app +(!!) + + + + +%d +The folder of the file to open; useful if app needs to +have file in current working directory. + + + + +%D +A list of folders, not very practical. + + + + +%i +The icon; option; &kde; app +will use icon from Icon= line in taskbar. + + + + +%m +The mini-icon; legacy. + + + + +%c +The caption; option; &kde; +app will use name from Name= line in +taskbar. + + + + + + + +Examples: + +Exec line +Command executed +ksirc %iksirc --icon ksirc + +cd %d; kedit $(basename %f)cd /tmp; kedit file.txt + + + + + + + + + + + +Devices + +Links to Devices using .desktop file: +o Create New -> Device + + + + + +Where to Define + +Many places to define Desktop Icons: + + +~/Desktop: +copied from /etc/skel/Desktop + +$KDEDIR/apps/kdesktop/Desktop +(merged) + +$KDEDIR/apps/kdesktop/DesktopLinks +(copied) + +Device Icons (dynamically +merged) + +Distribution Specific SUSE Linux copies certain icons +in startkde.theme from /opt/kde3/share/config/SuSE/default/ + + + + + + + +&kde; Menu + + +How it Works + +In &kde; 3.2 a common menu format is introduced at +http://freedesktop.org/Standards/menu-spec/ +Before &kde; 3.2: + + +Directory structure under share/applnk + +Directory structure represents menu +structure + +Each .desktop file +represents a single application + + + + +It was difficult to rearrange the structure in &kde; 3.2 so the +new menu format: + +Defines structure in a single .menu file +Is based on categories +is shared between GNOME and &kde; +Supports applnk style menus as well + + + + +Example from applications.menu: + + + <Menu> + <Name>Office</Name> + <Directory>suse-office.directory</Directory> + <Include> + <Filename>Acrobat Reader.desktop</Filename> + <Filename>kde-kpresenter.desktop</Filename> + <Filename>kde-kword.desktop</Filename> + </Include> + <Menu> + + + +Menu entry with 3 applications: + + +/usr/share/applications/Acrobat +Reader.desktop + +/opt/kde3/share/applications/kde/kpresenter.desktop + +/opt/kde3/share/applications/kde/kword.desktop + + + + + + + +Stored Where? + +.menu files describing the +menu structure. The files are stored in $KDEDIR/etc/xdg/menus and +/etc/xdg/menus. These store the +system-wide menu structure and are controlled by +$XDG_CONFIG_DIRS. $HOME/.config/menus stores +user-specific changes to the menu structure and is controlled by +$XDG_CONFIG_HOME. For more information, see http://www.freedesktop.org/Standards/basedir-spec. + +.desktop files describe the +applications and are stored in: $KDEDIR/share/applications, +/usr/share/applications, +/usr/local/share/applications. These are +the system-wide application .desktop files which are controlled by +$XDG_DATA_DIRS. + +$HOME/.local/applications +contains user-specific .desktop +files and user-specific changes. It is controlled by +$XDG_DATA_HOME. For more information, see http://www.freedesktop.org/Standards/basedir-spec + + +.directory files describing +the sub-menus are stored in: $KDEDIR/share/desktop-directories, +/usr/share/desktop-directories, /usr/local/share/desktop-directories. +These are the system-wide menu .directory files, controlled by +$XDG_DATA_DIRS. The user-specific changes are stored in $HOME/.local/desktop-directories. +These are controlled by $XDG_DATA_HOME. For more +information, see http://www.freedesktop.org/Standards/basedir-spec + + +Example from applications.menu: + + + <Menu> + <Name>Art</Name> + <Directory>suse-edutainment-art.directory</Directory> + <Include> + <Category>X-SuSE-Art</Category> + </Include> + </Menu> + + + + +Art is the internal name for this +menu. suse-edutainment-art.directory defines the +name and icon for this menu, and the menu includes all applications +that have X-SuSE-Art listed as a category, ⪚: + +Categories=Qt;KDE;Education;X-SuSE-Art + + +suse-edutainment-art.directory defines the +name and icon for this menu: + +[Desktop Entry] +Name=Art and Culture +Icon=kcmsystem + + + + + + +Common Pitfalls + +Applications not in the menu do +not exist with regard to other applications or +file associations: If you remove an application from the menu, &kde; assumes you don't want to use it. + +When applications are unwanted in the menu, either place them in +.hidden menu or a dedicated menu with + +NoDisplay=true + in the .directory file + + + +Essential Menus + +$KDEDIR/etc/xdg/menus/applications-merged/ +contains kde-essential.menu which includes some +essential menus that are normally not shown in the &kde; menu itself: + +Control Center has a hidden Settings menu whose +contents are defined by kde-settings.menu and +whose icon and name are defined by kde-settings.directory + +Info Center has a hidden Information menu whose +contents are defined by kde-information.menu and +whose icon and name are defined by kde-information.directory. + + +Screensavers contains a hidden System/Screensavers menu, +whose contents are defined by +kde-screensavers.menu and whose icon and name +are defined by +kde-system-screensavers.directory. +$KDEDIR/share/desktop-directories/kde-system-screensavers.directory +contains: + +NoDisplay=true + + + + + + + +Old-Style Menus + +&kde; continues to support old-style menus that are defined by +the directory structures in $KDEDIR/share/applnk +(system wide) and $HOME/.kde/share/applnk +(user specific). This is observed unless the .desktop file has a Categories= line. In that case the categories determine the location in the menu. + + + +<application>KSycoca</application> +KSycoca caches menu structure and +information about all available applications. You can rebuild the +database with +kbuildsycoca. The database +which is built lives in /var/tmp/kdecache-${USER}/ksycoca. +It is automatically updated by KDED, +checked during &kde; login, and KDED +watches for changes while logged in. + +To disable watching for changes (since it may hurt over NFS) add +the following to kdedrc: + +[General] +CheckSycoca=false + + + +To force regeneration, run touch $KDEDIR/share/services/update_ksycoca. + + + + +&kmenuedit; + +&kmenuedit; is aimed at a single user setup. Changes to menu +structure are saved to +~/.config/menus/applications-kmenuedit.menu, +changes to applications are saved in ~/.local/share/applications/ and changes +to sub-menus (icon, name) are saved in ~/.local/share/desktop-directories/. The +KIOSK Admin Tool uses &kmenuedit; and copies the above changes to +profile- or system-wide locations. + + + + + + + + +&kde; Panel + +The &kde; panel is also known as &kicker;. It is modular and +consists of the following components: + +Applets +Application buttons +Special Buttons + + + +By default, the panel contains the following applets: + +Pager - shows the virtual desktops +Taskbar +System Tray +Clock + +and the following special buttons: + +&kde; menu +Desktop Button + + + +Various application buttons are also added, space permitting: + +Home Button +Browser Button +KMail Button + + + + + +File Associations + +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 &kde; are stored in $KDEDIR/share/mimelnk and +each application's .desktop file +contains a list of &MIME; types supported by that application. + + +kview.desktop: + +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 + + + +kuickshow.desktop: + +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 + + + +Both can open image/gif Which one is used to open a .gif file? + +The application with highest +preference!. kview.desktop contains + +InitialPreference=3 + +whereas kuickshow.desktop contains + +InitialPreference=6 + +Therefore, &kuickshow; will be used to open .gif files. + + +How can we make &kview; default? + +A user can change file association in the +&kcontrolcenter;. These changes are stored in +$HOME/.kde/share/config/profilerc. +To use the same settings for multiple users, store these settings in +user profile directory or the global &kde; config directory to use as +default for multiple users. + + + + + + + + +Locking Down &kde; + + +How It Works - The Basics + +&kde;'s lock down features are centered around the following +options: + + +Make +configuration options immutable +Restriction of specific +actions +Restrict access to certain +&URL;s +Restrict access to +certain configuration modules + + + + + +Immutable Configuration Options +Locking Down &kde; + +Immutable options allow system administrator to provide default +settings that can not be changed by the user. + +Pre-existing configuration options of the user will be ignored once a +configuration option is made immutable. + +Options can be controlled either on a per entry basis, per group of +entries or on a file by file basis. + +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. + +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. + + + + +Action Restrictions + +&kde; 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. Save Document 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 Save +Document action is . 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 restriction which disables all +functionality that would offer the user access to a &UNIX; shell. + + +Restrict User Access to Shells + +In order to prevent the user access to a command shell we can restrict +the action by adding the following to +kdeglobals: + + +[KDE Action Restrictions] +shell_access=false + +Since this affects the &kde; menu and the available applications, we +must force an update of the sycoca database: + +touch $KDEDIR/share/services/update_ksycoca + +Now re-login to &kde; and check the following points: + + +The &kmenu; +In &konqueror;, +ToolsOpen +Terminal +The &Alt;F2 run +command + + +Full documentation about available actions can be found on http://www.kde.org/areas/sysadmin/. + +A few of the more interesting actions are listed below: + + + + +The Configure option form the +Settings menu + + + +The Report Bug option from the +Help menu. + + + +&RMB; mouse button menu on the desktop. + + + +&RMB; mouse button menu on the panel. + + + +Hide all actions or applications that require root access. + + + +Hides all actions or applications that provide shell +access. + + + +Disables the option to select the printing system +(backend). + + + +Whether the user will be able to lock the +screen + + + +Whether the user may start a second X session (see also +&kdm;) + + + +Whether OpenGL screensavers are allowed to be +used. + + + +Permit screensavers that do not hide the entire +screen + + + + + + +&URL; Restrictions + +There are three types of restrictions that can be applied to +&URL;s: + + + +list +To control whether a directory listing is +allowed. + + +open +To control whether certain &URL;s can be +opened + + +Redirect +To control whether one &URL; can open another &URL;, either +automatically or via a hyperlink. + + + +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. + +The following rules disable opening http and https &URL;s outside +.ourcompany.com: + + + + + + +[KDE URL Restrictions] +rule_count=2 +rule_1=open,,,,http,,,false +rule_2=open,,,,http,*.ourcompany.com,,true + + + +The first four commas skip over the selection criteria with respect to +the originating &URL;. This part is only needed with redirect type +rules. + + forbids the +opening of any http or https &URL; + allows the +opening of any http and https &URL; in the .ourcompany.com domain. Note the wildcard +* is only allowed at the start of a domain. + + +The following rules makes that the user can no longer browse +directories on the local file system that are outside his +$HOME directory: + + + + + +[KDE URL Restrictions] +rule_count=2 +rule_1=list,,,,file,,,false +rule_2=list,,,,file,,$HOME,true + + + forbids the +listing of any local directory + allows listing +directories under the users own $HOME +directory. + + +$HOME and $TMP are special values to +indicate the users home directory and the &kde; temporary directory of the +user, ⪚ /tmp/kde-bastian + +The following rules makes that the user can no longer open local files +that are outside his $HOME directory: + + + + + + +[KDE URL Restrictions] +rule_count=3 +rule_1=open,,,,file,,,false +rule_2=open,,,,file,,$HOME,true +rule_3=open,,,,file,,$TMP,true + + + forbids the +opening of any local file + allows opening +files under the users own $HOME directory. + allows opening +files in the &kde; temporary directory of the user. This is needed by +certain &kde; applications that first download a file or document to the +temporary directory and then open it in an application. + + + +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. + +For example, if we want to give the intranet-server www.mycompany.com the possibility to refer +to local files we could add the following rule: + +[KDE URL Restrictions] +rule_count=1 +rule_1=redirect,http,www.mycompany.com,,file,,,true + +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: + + + +:local +Protocols that access locally stored information, examples +are file:/, man:/, fonts:/, floppy:/ + + +:internet +Common internet protocols such as http and +ftp + + + +Information about protocols is stored in *.protocol files stored in +$KDEDIR/share/services. + +The = entry defines the group a protocol is part +of: +grep +$KDEDIR/share/services/*.protocol + +General rules: + + +The :local protocols may refer to any other +protocol +It's always allowed to refer to an :internet +protocol +Not all protocols are part of a group, fish:/ for +example. + + + + + +Configuration Modules + +&kde; has configuration modules to configure various aspects of the +&kde; environment. Configuration modules appear in the Control Center, in the +Configuration dialog of an application or in both. + + +The proxy configuration module appears in the Control Center but also +as part of the Configure Konqueror dialog in +&konqueror; + +Individual configuration modules can be started with +kcmshell module + +To start the Proxy module use: + +kcmshell +kde-proxy.desktop +kcmshell proxy + + +Not all applications use configuration modules, often the +configuration dialog is an integral part of the application +itself. + + +All configuration modules are strictly speaking part of the &kde; +menu. + + + +The modules that are visible in the Control Center normally +have a .desktop file in $KDEDIR/share/applications/kde +and are sorted under the hidden Settings-Modules menu by +the kde-settings.menu, included from +kde-essential.menu +kbuildsycoca 2> /dev/null | grep Settings-Modules + + +Application specific modules normally have a .desktop file under +$KDEDIR/share/applnk/.hidden which +corresponds to the hidden .hidden menu, included as a result of +<KDELegacyDirs/> +kbuildsycoca 2> /dev/null | grep .hidden + +In &kde; 3.3 it is possible to edit the Control Center with +kcontroledit. +kcontroledit works just like +kmenuedit, changes for current user only. Use +kiosktool to make changes for +everyone. + + +Individual configuration modules can be disables by adding the +following to kdeglobals: + +[KDE Control Module Restrictions] +module-id=false +For example, to disable the proxy module use +[KDE Control Module Restrictions] +kde-proxy.desktop=false +Check the Control Center and the Configure +Konqueror dialog if the proxy configuration is still +there. + + + + + + +The Lazy Admin + + + + + + + +Remote Desktop Sharing + +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. + +Remote desktop sharing involves two applications: &krfb; (&kde; remote +frame buffer, a VNC server) and &krdc; (&kde; remote desktop connection; a +VNC client.) + +&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. + +Incoming connections are handled by the kinetd kded module. You can +use the command dcop kded kinetd +services 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. + + + + + + +&kde; DIY - Building Your Own Tools + + +DCOP + + +Desktop COmmunication Protocol, DCOP, is a lightweight mechanism for inter-process communication. +DCOP allows the user to interact with programs that are currently running. +&kde; supplies two programs to utilitize DCOP: +dcop, a command-line program, and +kdcop, a GUI program. + + +A few notes about using dcop: + + + + + + +dcop [options] [application [object [function [arg1] [arg2] ... ] ] ] + + + + +Applications that can open more than one window at a time will be listed as +<application>-PID + + + + +All the arguments are case-sensitve. setFullScreen and setfullscreen are two different functions. + + + + +The regular expression token * can be used in the application and object arguments. +% dcop +konqueror-16006 +konsole-8954 + + + + + + + + +Some example commands and their output are below: + + + +% dcop +konsole-8954 + +One &konsole; is running with a PID of 8954. + +% dcop +KBookmarkManager-.../share/apps/kfile/bookmarks.xml +KBookmarkManager-.../share/apps/konqueror/bookmarks.xml +KBookmarkNotifier +KDebug +MainApplication-Interface +konsole (default) +konsole-mainwindow#1 +ksycoca +session-1 +session-2 +session-3 +session-4 + +Here you see that there are four sessions running. + +% dcop +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() + +Here are the options for the main &konsole; program. + + +% dcop +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) + +Here are the options for the first session, session-1. + +% dcop true + +This sets &konsole; to full screen. + + + + +When there is more than one application/object, which one should you use? + Got a reference? + +% echo +DCOPRef(konsole-7547,konsole) + +% dcop +session-6 + +% dcopstart +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' + + + + + + +KDialog +&kde; DIY - Building Your Own Tools + +You can use &kde; dialogs from your own scripts, to combine the power +of &UNIX; shell scripting with the ease of use of &kde;. + +kdialog + +kdialog + +The KDialog part can be replaced via + option + +kdialog + +Saves whether to show again in +$KDEHOME/share/config/myfile (by writing +into this file the following lines: + +[Notification Messages] +mykey=false + +Instead of you can also use + and , as appropriate. For +instance, you might use kdialog or kdialog +. + +It is also possible to create message boxes that accept a yes or no +answer. + +kdialog echo $? + + + + + +Return Value +Meaning + + + +0Yes, OK, Continue +1No +2Cancel + + + + +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 + here as well, it will remember the users choice +and returns it the next times without showing the dialog any more. + +Further variations are: + + + + + +like but with a different +icon + + + + +With Continue and +Cancel buttons. + + + + +With Yes, No +and Cancel button. For example: +kdialog + + + + +kdialog + +The result is printed to stdout, to put it in a variable you can use +name=$(kdialog --inputbox "Enter your name:" +"YourName"). The last argument is optional, it is used to +pre-fill the dialog. + +password=$(kdialog ) + +The option does not work with + or + +There are two dialogs that let the user make a choice from a +list: + + + + + +Lets the user select a single item from a list. + + + + + +Lets the user select one or more items from a list. + + + + +city=$(kdialog ) + +$city will a, b, c or d. + +city=$(kdialog ) + +Madrid and Paris will be pre-selected. The result with Madrid and +Paris selected will be "b" +"c". + +If you add the option, it will put +b and c each on a line +of its own, making the result easier to process. + +file=$(kdialog --getopenfilename $HOME) +file=$(kdialog --getopenfilename $HOME "*.png *.jpg|Image Files") +file=$(kdialog --getsavefilename $HOME/SaveMe.png) +file=$(kdialog --getexistingdirectory $HOME) + + + + + + + +&groupware-with-kontact; + + + + diff --git a/doc/userguide/kde-office.docbook b/doc/userguide/kde-office.docbook new file mode 100644 index 000000000..176180294 --- /dev/null +++ b/doc/userguide/kde-office.docbook @@ -0,0 +1,321 @@ + + + + + +Raphael +Langerhorst + +raphael.langerhorst@kdemail.net + + + + + + + +Office + + +Introduction to KOffice + + +Overview + +The &kde; project has also created a fully featured office suite +called &koffice; which adheres to standards and fits very well into +the &kde; desktop. This section was written with version 1.4 of +&koffice; in mind. + + +&koffice; is a highly integrated office suite that builds directly on the +KDE technology. This has many advantages in terms of integration, features, +performance, familiar look and feel and so on. All technologies like &DCOP;, +KIO, KParts are directly available. + + +In particular the KParts technology is extended for the &koffice; +components to allow very flexible embedding of documents inside documents. + + +Because much technology is already present inside &kde; 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. + + +&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. + + +As you can see &koffice; brings a lot of features that can enrich your +office experience. Its straight forward and &kde; like approach in look +and feel as well as familiar usability makes &koffice; quite useful for +daily office work. + + + + + +Features + +This list gives a general outline of the &koffice; features. +The &koffice; office suite is too large to list every detail. + + +&koffice; features: +Fully builds on &kde; which makes these technologies available at low costs. +Fully integrates into &kde; which is vital for business environments. +&kde; technologies include document location abstraction, DCOP scripting, parts and plugins,... +Full Component embedding. +Low memory footprint, fast startup, lightweight. +Feature complete: many components are offered. +Intuitive, good looking and easy to learn user interface. +Adheres to standards: OASIS OpenDocument file format. + + + + +OASIS OpenDocument file format + +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. + + +Adhering to official standards is always a good thing. For business +environments it is even vital to exactly know about their documents. + + +&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. + + + + + + + +&koffice; Components Overview + +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. + + + + +&kword; + 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. + + + Website: http://www.koffice.org/kword/ + &kword; Handbook + + + + + + +&kspread; + 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. + + + Website: http://www.koffice.org/kspread/ + &kspread; Handbook + + + + + + +&kpresenter; + 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. + + + Website: http://www.koffice.org/kpresenter/ + &kpresenter; Handbook + + + + + + +&kivio; + The flowcharting and diagramming component. Additional stencil sets can be used for custom needs, there is a plugin framework for additional functionality, and even UML diagrams are possible. + + + Website: http://www.koffice.org/kivio/ + &kivio; Handbook + + + + + + +&karbon14; + A vector-drawing application. + + + +&krita; + The painting and image manipulation component. &krita; contains both ease-of-use, fun features like guided painting, as well as high-end features like support for 16-bit images, CMYK and even OpenEXR HDR images. + + + Website: http://www.koffice.org/krita/ + &krita; Handbook + + + + + + +&kugar; + 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;). + + + Website: http://www.koffice.org/kugar/ + &kugar; Handbook + + + + + + +KPlato + The component for project management, allowing for the planning and scheduling of various projects. + + + Website: http://www.koffice.org/kplato/ + + + + + + +&kexi; + 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 -- tables, queries and forms -- are stored in the database, making it easy to share data and database design. + + + Website: http://www.koffice.org/kexi/ and http://kexi-project.org. + &kexi; Handbook + + + + + + +&kchart; + 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. + + + Website: http://www.koffice.org/kchart/ + &kchart; Handbook + + + + + + +&kformula; + 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. + + + Website: http://www.koffice.org/kformula/ + &kformula; Handbook + + + + + + + + +Related Information + Main website: http://www.koffice.org. + &koffice; Handbook + + + + + + +Further Information + +Application Manuals +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 KIO Slave in &konqueror; (that is, typing help:/application 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 http://www.koffice.org. + + + +Internet Resources +The primary site on the internet is +http://www.koffice.org +You will also find information about the user and developer +mailing lists as well as additional developer resources. +The Kexi project has even an additional website, which can be +found at http://www.kexi-project.org + + + + +Plugin development +&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 + +the developer's site. The general KDE developers website is available +at http://developer.kde.org. + + + + + diff --git a/doc/userguide/kmag.png b/doc/userguide/kmag.png new file mode 100644 index 000000000..cba958528 Binary files /dev/null and b/doc/userguide/kmag.png differ diff --git a/doc/userguide/kmousetool.png b/doc/userguide/kmousetool.png new file mode 100644 index 000000000..371f041ae Binary files /dev/null and b/doc/userguide/kmousetool.png differ diff --git a/doc/userguide/kmouth.png b/doc/userguide/kmouth.png new file mode 100644 index 000000000..c5507eaba Binary files /dev/null and b/doc/userguide/kmouth.png differ diff --git a/doc/userguide/kmouth2.png b/doc/userguide/kmouth2.png new file mode 100644 index 000000000..6cf0e613e Binary files /dev/null and b/doc/userguide/kmouth2.png differ diff --git a/doc/userguide/kmouth3.png b/doc/userguide/kmouth3.png new file mode 100644 index 000000000..8bed5a532 Binary files /dev/null and b/doc/userguide/kmouth3.png differ diff --git a/doc/userguide/knode-identity.png b/doc/userguide/knode-identity.png new file mode 100644 index 000000000..c9f63347f Binary files /dev/null and b/doc/userguide/knode-identity.png differ diff --git a/doc/userguide/knode-mail-account.png b/doc/userguide/knode-mail-account.png new file mode 100644 index 000000000..f2271662f Binary files /dev/null and b/doc/userguide/knode-mail-account.png differ diff --git a/doc/userguide/knode-news-account.png b/doc/userguide/knode-news-account.png new file mode 100644 index 000000000..e046870f1 Binary files /dev/null and b/doc/userguide/knode-news-account.png differ diff --git a/doc/userguide/knode-start.png b/doc/userguide/knode-start.png new file mode 100644 index 000000000..1057f946b Binary files /dev/null and b/doc/userguide/knode-start.png differ diff --git a/doc/userguide/konq-sidebar.png b/doc/userguide/konq-sidebar.png new file mode 100644 index 000000000..0e9328e3a Binary files /dev/null and b/doc/userguide/konq-sidebar.png differ diff --git a/doc/userguide/konq-simple.png b/doc/userguide/konq-simple.png new file mode 100644 index 000000000..a35133865 Binary files /dev/null and b/doc/userguide/konq-simple.png differ diff --git a/doc/userguide/konsole-intro.docbook b/doc/userguide/konsole-intro.docbook new file mode 100644 index 000000000..d42b4f59a --- /dev/null +++ b/doc/userguide/konsole-intro.docbook @@ -0,0 +1,126 @@ + + + + + +Gardner +Bell + + + + + +&konsole; Introduction + +Extremely brief intro to managing in a shell + +Emergency procedures: killing wild apps, etc + +SSH, sessions, envars, other fun things + +Some tips and tricks + + + + +&konsole; is a terminal emulator for the X Window System. It is +essentially based on the DEC's VT100 +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. + +Emergency Procedures: + +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 root privileges. +If a process in &kde; crashes due to a bug one should not need to worry +about it accessing any other active process. + +To keep track of all system processes use the top +command or ps in &konsole;. Using these utilities will +make it much easier to find and kill off rogue programs. + +An example of using signals in &konsole;, &konqueror; has crashed +leaving behind a running process of +nspluginviewer which is taking up 12% of your +memory and 10% of your cpu cycles. In top use the k +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 +man signal in a &konsole; or go to +#signal in &konqueror;). + +SSH, sessions, envars, other fun things. + +If you are using &konsole; for remote administration consider using +&konsole;'s Session feature. To use this click on the menu +entry +SettingsConfigure &konsole;. +From here choose the Sessions tab and fill in the +name for your new session. This will now become your default session when +you start &konsole;. + +When &konsole; is invoked bash specific +commands and &kde; specific variables are read and executed from +~/.bashrc or ~/.bash_profile. +The preferred configuration file for user environments is +~/.bash_profile, the commands +printenv or env can be used to +display all currently set variables. To set a variable in the shell use +VARNAME=value. For a full +list of variables that can be set in &kde; see the wiki +. + +Some tips and tricks + +To rename &konsole;'s session use &Ctrl;&Alt;S and enter the new +name. + +If you find the need to run any &kde; program with root privileges, you can use the &kdesu; command with the switch +from the command line like this: kdesu +, using +the switch will prevent &kde; from remembering your +passwords. + + + +Related Information + + +The &konsole; +Handbook has much more information about the features available in +&konsole;. You can read it in &khelpcenter; or by entering +help:/konsole in &konqueror;'s +Location bar. + + + + + + + + + + + diff --git a/doc/userguide/kopete.png b/doc/userguide/kopete.png new file mode 100644 index 000000000..446a26655 Binary files /dev/null and b/doc/userguide/kopete.png differ diff --git a/doc/userguide/kppp-dialer-tab.png b/doc/userguide/kppp-dialer-tab.png new file mode 100644 index 000000000..bb344979f Binary files /dev/null and b/doc/userguide/kppp-dialer-tab.png differ diff --git a/doc/userguide/kppp-wizard.png b/doc/userguide/kppp-wizard.png new file mode 100644 index 000000000..cbb731fcb Binary files /dev/null and b/doc/userguide/kppp-wizard.png differ diff --git a/doc/userguide/messaging-intro.docbook b/doc/userguide/messaging-intro.docbook new file mode 100644 index 000000000..8d042a451 --- /dev/null +++ b/doc/userguide/messaging-intro.docbook @@ -0,0 +1,188 @@ + + + + + +Peter +Nuttall + + + +Tom +Albers + + + + + + + +Introduction to messaging + + +The default way to send instant messages in &kde; is to use the IM +client, &kopete;. This is a multi-protocol IM client, meaning that it +handles several different protocols including MSN, +Jabber, AOL and IRC. It also has +useful features including support for &kaddressbook;, meta-contacts, +encryption support and lots more. + + +&kopete;, the &kde; IM client. + + + + +&kopete;, the &kde; IM client. + + +&kopete;, the &kde; IM client. + + + + + +How to get started + +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 +Settings menu and selecting the Configure +Kopete option. By selecting the Accounts +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 add new account 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. + + + + +Meta-contacts + +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 +MSN) 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 +MSN nick to something like +=EF=81=8A. + +You can do other useful things with meta-contacts like link them to +entries in your address book. See + + + + +<acronym>IRC</acronym> + +Internet Relay Chat (IRC) has been around far longer than most IM +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. + +The #kde channel is under Freenode, the IRC server, which provides an interactive environment for coordination and support of peer-directed projects, including -- and placing particular stress upon -- those relating to free software and open source projects, such as &kde;. + + +While &kopete; has a IRC plugin, and handles both channels and nicks well, +long time IRC users might prefer a client designed just +for that role, which is what Konversation 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 +IRC users expect. It also is far better at handling +large channels such as #debian. If you have used another +power-IRC client before, you should have no trouble using +Konversation. + + + + + +Linking email and messaging + +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 +&kde; 3.3 has made that a lot easier. A step-by-step manual: + +The requirements are &kmail;, &kaddressbook; and &kopete; +(Konversation 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. + +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 Add to Address +Book. + +If you know the nickname which the user uses on, for example, IRC, +go to &kopete;. Go to +FileAdd +contact . In the wizard, select the +checkbox at the bottom called Use the KDE address book for +this contact and choose Next. Select +the right Address Book entry for that contact and press +Next. 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. + +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 +EditProperties +. On the General tab check the box +labeled Has address book entry. Press +... and select the contact. Close these two +windows. + +Now go to your addressbook, if you select the contact you will +see that it shows an extra field Presence, 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. + +If you want to chat with this person, just right click the +address in &kmail; and choose Chat With.... Your +Instant Messenger will start a conversation with the contact. + + + + + + + + + + + diff --git a/doc/userguide/migrator-applications.docbook b/doc/userguide/migrator-applications.docbook new file mode 100644 index 000000000..fee1caacd --- /dev/null +++ b/doc/userguide/migrator-applications.docbook @@ -0,0 +1,272 @@ + + + + +&Francis.Giannaros; &Francis.Giannaros.mail; + + + + +Application Guide for Migrates + + + +&kde; 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 Microsoft Windows or Apple Macintosh 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. + +Sample Table + + + + + + + + + &kmenu; Location + &kde; Application + Windows Equivalent + Macintosh Equivalent + Notes + + + + + + File Manager + &konqueror; (Home Folder) + Windows Explorer + Integrated file manager, content +viewer/player and web browser + + + System and User Settings + &kcontrol; + Control Center + + + Office + Office Suite: + + Word Processing + Spreadsheets + Slide Presentations + Flowchart & Diagram Editing + Scalable Graphics + Image Manipulation + Report Generator + Chart + Database Creation + Formula Editor + + + + + + + &kword; + &kspread; + &kpresenter; + &kivio; + &karbon14; + &krita; + &kugar; + &kchart; + &kexi; + &kformula; + + + + + + + MS Word + MS Excel + MS Powerpoint + Adobe Illustrator + Adobe Photoshop + Report Generator + Chart + MS Access + + + + + + + + + + + + Personal Information Management: + + Mail + Address Book + Personal Organizer + News Reader + Pop-up Notes + RSS Reader + + + + + + &kmail; + &kaddressbook; + &korganizer; + &knode; + &knotes; + &akregator; + + + + + MS Outlook + + The Personal Information Manager is &kontact;; all other &kde; PIM applications integrate into it. + + + + + Internet + Web Browser + &konqueror; + MS Internet Explorer + Safari + Integrated file manager, web browser, FTP manager, and univerval viewing application. + + + + + + Instant Messaging + &kopete; + + AIM + MSN + ICQ + Jabber + Novell GroupWise + Yahoo + IRC + SMS + + + + MSN Messenger + Comprehensive multi-network compatible instant messaging software + + + + Chat (IRC) + &ksirc; + mIRC + + + + Multimedia + Music/Audio + &juk; + Windows Media Player + + + + &CD;/DVD Burner + K3b + Nero + + + + Video Player + &noatun; + Windows Media Player + + + + Audio &CD; Ripper + KAudioCreator + + + + Sound Controls + &kmix; + + + + System + System Info Center + &kinfocenter; + + + + Terminal + &konsole; + CMD + + + + User Manager + &kuser; + User Manager + + + + Package Manager + &kpackage; + Add/Remove Programs + + + + Utilities + Archiver + &ark; + WinZip + + + + Password Manager + KWallet + + + + Text Editor + &kate; + Notepad + + + + + + +
+ + +Related Information +Many more &kde; applications are available from the &kde; extragear (see for more information) or from http://kde-apps.org. +Reference: http://kudos.berlios.de/kf/kf1.html#pkgtablestock + + + \ No newline at end of file diff --git a/doc/userguide/migrator-dictionary.docbook b/doc/userguide/migrator-dictionary.docbook new file mode 100644 index 000000000..4bd2efa5d --- /dev/null +++ b/doc/userguide/migrator-dictionary.docbook @@ -0,0 +1,38 @@ + + + + + + +Dictionary for Migrators + +Tables of terminology differences + + + + diff --git a/doc/userguide/net-connection-setup.docbook b/doc/userguide/net-connection-setup.docbook new file mode 100644 index 000000000..cd44fda34 --- /dev/null +++ b/doc/userguide/net-connection-setup.docbook @@ -0,0 +1,238 @@ + + + + + +&Lauri.Watts; + + + + + +Setting up an Internet Connection + + + +&kde; 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 &kde;'s +advanced features, you'll need to get online. Here's how: + +If you're using dialup (that is, connecting to +the Internet with a modem connected to a telephone line), you'll want +to set up the &kde; 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. + +If you're using a broadband connection, or connecting via a +local network, things are easier (from the point of view of +&kde;). Once you've set up the connection with the tools provided by +your &Linux; or &UNIX; distribution, &kde; will use the connection +automatically. + + +Getting online the easy way + + +A few things you should have ready before you start + +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. + +Whether using the wizard or not, you should know the following information +before you begin: + + +Your ISP modem pool phone +number. +Your username and password for your +ISP. +Your ISP's DNS servers +(one is sufficient, but two is better). + + +Other optional information you should find out to fully access your +ISP's services are: + + +The incoming mail server address (often pop.yourisp.com or mail.yourisp.com).Also find out if +your ISP uses the POP3 protocol or IMAP. +The outgoing (SMTP) mail server address (it +could be the same as the incoming mail server, or it is often called something +like smtp.yourisp.com). +The Usenet News (NNTP) server address (possibly +news.yourisp.com or nntp.yourisp.com). +Any proxy servers your ISP has set +up. + + +All this information is probably available on any paperwork you received +from your ISP when you signed up with them, or you can find +it out from your ISP's support telephone line. + +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. + + + + + + + +The &kppp; wizard + + +Starting the Wizard. + +You can start the wizard from &kppp;'s initial screen. Start &kppp; from +your K menu, where you will find its entry in the +Internet as &kppp; (Internet Dial-Up +Tool. + +The following dialog will appear: + + +The &kppp; dialer startup dialog + + + + +The &kppp; dialer startup dialog + +The &kppp; dialer startup dialog + + + +It will probably not have any entries to begin with, and that's +what we're about to do now. + +Click the Configure... button to begin setting up a new +Internet connection. + +The wizard will offer you three choices, Wizard, +Dialog Setup and Cancel + + +The wizard asks you what you want to do... + + + + +The wizard asks you what you want to +do... +The wizard asks you what you want to do + + + + + +Cancel +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. + + + +Wizard +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. + + + +Dialog Setup +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. + + + + +For the purposes of this chapter, we'll assume you are choosing +Wizard, and the dialog based setup will be +described in a later chapter. + + + + +The Rest of the Wizard + +The first window you see contains just introductory text, explaining the +things you read about in the first section of this chapter. Click +Next to move on. + +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 Cancel, in which case the Dialog-based setup will start for you to continue +with. + +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 ISP is not +listed here, you will have to click Cancel and +do your setup in the Dialog-based setup + +You will now be asked to enter your username and password for your +internet connection. Please note, that for some ISPs this +differs from your mail account user name and password, so make sure you use the +right one. Choose Next to continue. + +On the next window, you have a chance to enter any special dial prefixes +you might have - for example, if you must dial 0 for an outside +line, or if you have a prefix you can dial to turn off call waiting. Choose +Next to continue. + +And that's all! If you want to revisit any of your choices, you can use +the Back and Next buttons to move +back and forth through the dialogs. When you're done with your settings, click the +Finish button, and you're all done. + +If you need more details, you can read the full &kppp; +manual in the &kde; Help Center, or by typing +help:/kppp in the Location +bar in &konqueror;. + + + + + + + + + + + + + + + diff --git a/doc/userguide/networking-with-windows.docbook b/doc/userguide/networking-with-windows.docbook new file mode 100644 index 000000000..ba8ef0596 --- /dev/null +++ b/doc/userguide/networking-with-windows.docbook @@ -0,0 +1,128 @@ + + + + +Gardner +Bell + + + + + +Networking With Windows + + This section is borrowed and modified from Alexander Neundorf's +README file on LISa. + +&kde; features two powerful servers called the Lan Information +Server (LISa) and Restricted Lan +Information Server (resLISa) which are used +to identify CIFS and other servers on your local network providing a +function similar to Network Neighbourhood in +&Microsoft; &Windows;. + + +How It Works + +&lisa; only depends on the TCP/IP stack so samba configuration is not +required to make it work but the samba 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 ICMP, +echo request message to all the IP addresses given in the configuration file +and await a response. + +The &lisa; daemon requires root privileges to open the socket, +but once the socket has been established root privileges are immediately +dropped. + +You can also execute &lisa; using nmblookup +.If you do not have the +nmblookup program it can be found at http://www.samba.org or through packages +provided by your distribution. The samba command +nmblookup 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. + + + +<application>resLISa</application> + +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. + +&reslisa; will only provide the information over a &UNIX; domain +socket, &ie; not over the network. The name of the socket is +/tmp/resLISa-YourLoginName, +so &reslisa; can be safely run on the same machine by more than one +user. + + + +Configuration + +At startup &lisa; first parses the configuration file in the users +home directory under $HOME/.lisarc. If +this file does not exist &lisa; will then look for a system wide +confiuration located at /etc/lisarc. Now for a sample +example configuration file: + + +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 resLISa) +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 + + +&lisa; can also be configured graphically in the +&kcontrolcenter;Internet +& NetworkLocal Network Browsing + item in the &kmenu;. However, to use this option &lisa; must +be started with the command line switch. + + + + + +Related Information +For a full list of command line switches and further +examples see the entire &lisa; manual by entering +help:/lisa in &konqueror;. + + + + + + + + diff --git a/doc/userguide/noatun-icon.png b/doc/userguide/noatun-icon.png new file mode 100644 index 000000000..c440d0924 Binary files /dev/null and b/doc/userguide/noatun-icon.png differ diff --git a/doc/userguide/noatun.png b/doc/userguide/noatun.png new file mode 100644 index 000000000..2f807e715 Binary files /dev/null and b/doc/userguide/noatun.png differ diff --git a/doc/userguide/oggfolder.png b/doc/userguide/oggfolder.png new file mode 100644 index 000000000..ac1527c32 Binary files /dev/null and b/doc/userguide/oggfolder.png differ diff --git a/doc/userguide/open-file-dialog.png b/doc/userguide/open-file-dialog.png new file mode 100644 index 000000000..38378aa0c Binary files /dev/null and b/doc/userguide/open-file-dialog.png differ diff --git a/doc/userguide/panel-and-desktop.docbook b/doc/userguide/panel-and-desktop.docbook new file mode 100644 index 000000000..1e92d3a82 --- /dev/null +++ b/doc/userguide/panel-and-desktop.docbook @@ -0,0 +1,325 @@ + + + + + +&Philip.Rodrigues; + + + + + +The Panel and the Desktop + + +&kicker;, the &kde; Panel + +Panel +&kicker; + +&kicker; is the application launcher panel of the K 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 &kicon; +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. + + + + + +Configuring &kicker; + + + +Customizing the icons on the panel + +When you first start &kde;, kicker displays some icons next to +the K 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. + +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 Remove application +name Button 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 Add Application to Panel +. This leads you to a copy of the +K menu, where you can find all of the &kde; +applications. For example, to add an icon for the &juk; music player, +follow through the menus to Add Application +to PanelMultimedia&juk; (Music +Player). The icon will appear on the +panel in the space that you right-clicked on. + + + + + +Adding extras and applets + +Applets + +&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 +Add Applet to Panel... +or +Add New Panel. +The items in the Add Applet window are small +programs that can reside on the panel. An example of an applet is the +Desktop Preview & PagerPager, which shows a small image of each of your virtual +desktops. (For more information about virtual desktops, see ). You can switch to a different +virtual desktop by clicking on its image in the desktop pager. + +You can find information about the other applets available for +&kicker; in the &kicker; manual. Just enter +help:/kicker in the +Location bar in &konqueror;. + + + + + + + +Simon +Vermeersch + +titeuf@ph34rus.org + + + + +The System Tray + + +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. + +When you right 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). +When you left 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, ... + +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 . + + + + +Removing Panel Items + + + + +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 Remove applet +name. + + + + + +The Taskbar + +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. + + + + + + +&Philip.Rodrigues; + + + + +Using the Clipboard + +Clipboard + +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 +clipboard. There are two slightly different ways to use this system, +known technically as the selection and the +clipboard. We'll look at them separately: + + + + + +The Selection +Selection + +This method uses the mouse to copy text from one place to +another. The method is: + + +Select the text you want to copy. + + +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. + + +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;. + + + + + +The Clipboard +Cut +Paste +With this method, you can copy text, or cut 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: + +&Ctrl;X + +EditCut + + + +Moving (<quote>Cutting</quote>) Text +Select the text you want to cut. + +From the menu, select +&Ctrl;X + +EditCut +, and the text will be removed from its current location. + +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 +&Ctrl;V + +EditPaste +, and the text will appear at the point where you placed +the cursor. + + + + + +Copying text from one place to another is very similar: + +Copying Text +Select the text you want to copy. + +From the menu, select +&Ctrl;C + +EditCopy +, and the text will be copied in the clipboard. + +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 +&Ctrl;V + +EditPaste + + + + + + + + +More Advanced Clipboard Use +&klipper; +ClipboardHistory + +The instructions above describe the default clipboard +behavior. The &klipper; application, which you can add as an applet in +the panel (see 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. + + + +Related Information + +You can find more information about &kicker;, the +&kde; Panel, in &khelpcenter; or by entering +help:/kicker in &konqueror;'s +Location bar. + + +The &klipper; +Handbook has information about the advanced clipboard management +features in &kde;. You can read it in &khelpcenter; or by entering +help:/klipper in &konqueror;'s +Location bar. + + + + + + + + + + +Related Information + +Related Information +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 help:/kicker in the &konqueror; Location toolbar. + + + + + + + + diff --git a/doc/userguide/pdf-files.docbook b/doc/userguide/pdf-files.docbook new file mode 100644 index 000000000..0dd83c2e3 --- /dev/null +++ b/doc/userguide/pdf-files.docbook @@ -0,0 +1,40 @@ + + + + + + +PDF Files + +How to print to a pdf file + +Viewing pdf files + + + + diff --git a/doc/userguide/playing-audiocds.docbook b/doc/userguide/playing-audiocds.docbook new file mode 100644 index 000000000..3f96a6056 --- /dev/null +++ b/doc/userguide/playing-audiocds.docbook @@ -0,0 +1,142 @@ + + + + +Deepak +Sarda + +antrix@gmail.com + + + +Audio CD Ripping in &kde; + +The conventional way of ripping Audio CDs to MP3 or Ogg files is to +use a standalone program such as iTunes, Winamp or &kde;'s own +KAudioCreator. 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. ;-) + + +Ingredients + +What do we need to be cool? Vanilla &kde;, 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. + +Once you have your favourite codec(s) installed, open &kcontrolcenter; and navigate your way to Sound & +MultimediaAudio CDs +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 +Sound & MultimediaCDDB +Retrieval and change anything that's not to your +liking. CDDB, in case you didn't know, stands for CD DataBase (or Compact +Disc DataBase in it's more free flowing form). This functionality enables +&kde; 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. + + + + + + + + + + + +Recipe + +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 Services 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 F9 key. + + + + + + + + + +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. + +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? + + + + + + + + + +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 as if 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. + + +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! &kde; will start +ripping and encoding the files on the fly! If you copy any of the files in +the Full CD folder, you'll be ripping the entire CD as +one continuous stream. + + + + + + + + + + + +Related Information +The amaroK website at +http://amarok.sf.net has the +latest news and information about amaroK. + + + + + + + + + diff --git a/doc/userguide/playing-movies.docbook b/doc/userguide/playing-movies.docbook new file mode 100644 index 000000000..89e986cbb --- /dev/null +++ b/doc/userguide/playing-movies.docbook @@ -0,0 +1,48 @@ + + + + + + +Playing Movies + +Intro to xine plugin to aRts + +Alternatives (kaffeine, kmplayer) + + + + + + + + diff --git a/doc/userguide/playing-music.docbook b/doc/userguide/playing-music.docbook new file mode 100644 index 000000000..22c129f1e --- /dev/null +++ b/doc/userguide/playing-music.docbook @@ -0,0 +1,150 @@ + + + + + + +&Lauri.Watts; + + + +Playing Music +Music +Sound +Audio +&arts; + +Intro to &arts; + +Performance tuning, sharing devices + + +Music Players + +There are several &kde; music players with somewhat overlapping +feature sets, however, each is quite different in style. + + + + + + + + +&noatun; +&noatun; + + +Noatun is the default &kde; 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. +&noatun; is part of the kdemultimedia package. + + + + + + + + + + + + + + + +&juk; +&juk; + +&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. +It is equally useful as your primary music player, or managing +playlists and files for use in another application. +&juk; is part of the kdemultimedia package. + + + + + + + + + + + + + + + +&kaboodle; +&kaboodle; + +&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. +&kaboodle; is part of the kdemultimedia package. + + + + + + + + + + + + + + + +amaroK + +amaroK is a popular third party application. You should be able to +find packages from your normal distribution source. + + + + + + + + + + +Most of the &kde; based movie players such as +Kaffeine and kmplayer +also make useful music players. + + + + + + + + + diff --git a/doc/userguide/printer-setup.docbook b/doc/userguide/printer-setup.docbook new file mode 100644 index 000000000..658be16ac --- /dev/null +++ b/doc/userguide/printer-setup.docbook @@ -0,0 +1,47 @@ + + + + + + +Setting Up a Printer + +Assume everything is pre-configured, how to set up a printer, refer to +big manual if there is trouble + + + + + + + + diff --git a/doc/userguide/printing-from-apps.docbook b/doc/userguide/printing-from-apps.docbook new file mode 100644 index 000000000..975149cdb --- /dev/null +++ b/doc/userguide/printing-from-apps.docbook @@ -0,0 +1,40 @@ + + + + + + +Printing From Applications + +Printing from &kde; apps + +Printing from non-kde apps + + + + diff --git a/doc/userguide/programs-and-documents.docbook b/doc/userguide/programs-and-documents.docbook new file mode 100644 index 000000000..c5eef682d --- /dev/null +++ b/doc/userguide/programs-and-documents.docbook @@ -0,0 +1,565 @@ + + +Programs and Documents + + + + + +Robert +Stoffers + + + +Launching Programs + +&kde; offers a varying number of ways to launch programs. You may: + + + Simply select the relevant item in the &kmenu;. + + + Run the program from &konsole;, or by clicking the &kmenu; and choosing Run Command... (while you still might prefer the quick keyboard shortcut, which is simply &Alt;F2). + + + Create a shortcut on the desktop or use &kicker;'s quick launcher. + + + +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 Multimedia and +Office. Under these category menus there are +subcategory menus, such as Sound, +Video and Graphics. Under +the subcategory menus lie program launchers, which, when clicked on, launch +the associated application. + +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 +Run Command and type +kappfinder. In +&kappfinder;, click Scan, and the hard drive will be +searched for programs. Click the checkbox next to each program to be added +to the &kmenu;, and click Apply and +Close. The &kmenu; now will have new program +launchers under the relevant category menus. + +Launchers to programs may also be placed on the desktop. To create a +new launcher, right click on the desktop, and +choose Create +NewLink to +Application. On the &kdesktop; properties dialog +box, type in the name of the program on the General +tab. You may also wish to choose a custom icon by clicking on the gear icon. +Click the Application tab and type a short sentence +about the program in the Description textbox. In the +Command textbox, type the name of the program (case +sensitive), and any command line options you wish to use. Choose +OK, 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. + +To launch a program using &konsole;, click the &kmenu; and choose +SystemTerminals +Konsole. Once &konsole; +appears on the screen, simply type the name of the program you wish to +launch (remembering that bash, the command language interpreter that &konsole; uses by default, is case-sensitive) and press +Enter. If you are unsure about the name of a program, type +the first few letters then press the key on your keyboard. By pressing + , bash (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 Enter to launch. + +Whichever way you choose, launching a program is a simple affair with +&kde;. From the &kmenu;, to &konsole;, all your programs are just a few +clicks or key-presses away. + + + +Related Information +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 help:/kicker in the Location toolbar. + + + + + + + +&programs-controlling; + + + + + + +Christian +Weickhmann + +christian.weickhmann@gmx.de + + + + +Opening and Saving Files + + + + +&kde; provides a unified way to open or save files via the file +dialog. In almost every &kde; program you will find a +FileOpen + and File +Save (and/or Save +As...) entry. + + +The File Dialog + + + + + + + + + + + + + + + + + + + + +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 Save or +Open. + +In addition to that you can add two even more sophisticated areas: +the Quick Access Navigation Panel and +the Preview Panel. + + + + + +Next to the three navigation buttons (one directory +up, back and +forward) and the new folder button +there is the bookmarks menu. Here you can mark any folder +you visit often to find it quickly. The wrench 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. + + + + + +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 right mouse +button. + + + + + + +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 +air by typing *air* into the filter +field. + + + + + + + +The Quick Access Panel (activate it by typing the +F9 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 Add Entry 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). + + + + + + +The Preview area (activate it by typing the F11 +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. + +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 Automatic Preview below the +preview. You can still preview individual files: just click Preview. You can also disable previews for files above a certain +size. Go to &kcontrolcenter;, choose KDE +componentsFile manager, go to +the Preview and Metafiles tab and change the +Maximum Filesize value. + + + + + + + + + + + + + + + + + +&Philip.Rodrigues; + + + + +Configuring Programs + + +Application Configuration + +Configuration +Customization + +&kde; applications are intended to be as useful and usable as +possible out of the box, but they also offer a wide +range of options which you can change to make &kde; work for you. As +well as the settings which affect the whole of &kde; (see ), each application has a set of +configuration options, which you can access using the menu option +SettingsConfigure +Application +. This is the same for all &kde; applications, which +makes it easy to find the configuration dialog for an +application. + + + +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. + +When you have made the changes you want, you can click on +OK 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 +Apply 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. + +If you decide that you don't want to keep the changes you've +made, just click Cancel to close the dialog +without saving your changes. + + + + +Configuring Keyboard Shortcuts + +Shortcuts +Keybindings + +Most &kde; 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 &kde;), you can +change them with the +SettingsConfigure +Shortcuts... + menu entry. This brings up the +Configure Shortcuts dialog for the +application. As an example of how to use this dialog, let's add a +shortcut for the Send Link Address... action to +&konqueror;, so that we can email the locations of interesting pages +to friends just by hitting a key (or two): + +Open the Configure Shortcuts +dialog in &konqueror;, as described above. + +Click on the Send Link Address... item +in the main listbox (it's near the bottom, in the +Konqueror section). + +In the Shortcut for Selected +Action panel, select Custom, since we +are going to give this action a keyboard shortcut that we have chosen. + +A small shortcut entry dialog pops up. Just hit +&Ctrl;E + (or whatever you want to change the shortcut to), and the +dialog disappears. The key icon in the +Configure Shortcuts dialog now shows the new +shortcut. + +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. + + + + + + + + +Configuring Notifications + +Notifications +Sounds + +Something about +SettingsConfigure Notifications... +. + + + + + + +Adriaan +de Groot + + +Configuring Toolbars + +Nearly every &kde; 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 New Message, Check Mail +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 (New +Message is under +MessageNew +Message, Check Mail is +FileCheck +Mail). + +Not everybody agrees on what actions are commonly used, though, (I +never use the New Message toolbar button or the menu +item, I use the keyboard shortcut &Ctrl;N). 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. + + +Customizing Toolbar Displays + +The easiest thing to customize with the toolbars of any given +application is whether they are displayed at all. Most applications have a +SettingsToolbars + menu where you can select which toolbars are displayed and +which are not. &konqueror; has four toolbars, Main, +Extra, Location and +Bookmark. It can be convenient to turn off the +Bookmark toolbar to save +screen space. To do so, click on the Settings menu, +choose Toolbars, and then uncheck the +Bookmark Toolbar entry (do this just by clicking +on the menu item). + +If there is no Settings menu, you can also +right click on the toolbar itself, and choose the +Toolbars sub-menu from the resulting context +menu. + +The same Toolbar context menu, accessed by +right clicking on the toolbar, allows you to +customize other properties of the toolbar: + + + +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. + + +Its orientation, so that the toolbar floats as a +separate window which you can move independently. + + +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). + + +The appearance of text alongside, underneath, or instead of the icons +on the toolbar. + + +The size of the icons (if they are not supplanted by +text). + + + + + +Customizing the Icons on the Toolbar + +The toolbar is intended for actions that you perform often, so what do +you do if there is some useless icon there, like Cut? Or +what if you really want a cut 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. + +Choose SettingsConfigure +Toolbars from the application's menu, or +Configure Toolbars from the context menu of the +toolbar itself. This displays the configure toolbars dialog, which consists +of a combobox with which you can select +which 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. + +Often there are many many more actions available ( activate +tab #12, 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 , 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 +OK in the dialog immediately updates the toolbar with +your new preferred actions. + +There are a few special items that can end up in the listbox for the +current toolbar: + + + +separators, which exist in two flavors: + +line separator appears as a line +between two action icons + +separator appears as a larger +space between two action icons + + + + + +<Merge>, 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. + + +ActionList:, 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. + + + +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. + +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 <Merge>, but I don't know what it +is. + + + + + + + + + + + + + diff --git a/doc/userguide/programs-controlling.docbook b/doc/userguide/programs-controlling.docbook new file mode 100644 index 000000000..a1f072e6f --- /dev/null +++ b/doc/userguide/programs-controlling.docbook @@ -0,0 +1,39 @@ + + + + + + +Controlling Programs + +Standard Toolbar layout + +Keybindings + + + diff --git a/doc/userguide/removable-disks.docbook b/doc/userguide/removable-disks.docbook new file mode 100644 index 000000000..7b07941e4 --- /dev/null +++ b/doc/userguide/removable-disks.docbook @@ -0,0 +1,140 @@ + + + + + +Edward +Haven +edward.haven@gmail.com + + + + +Removable Disks + +For &kde; to use any device, removable or not, the device must +first be mounted. When a device is mounted, &kde; gets all the needed +information about the device: how to read it, how to write information to +it, and much more. + +The use of a device is controlled by the operating +system and it is important your operating system has tools for managing +these devices. &kde; can also auto mount devices, working with +HAL (Hardware Abstraction Layer). Your distribution +should have set up HAL automatically; if not, +consult the documentation provided by your distribution. +There are several ways to find the list of media devices: use +whichever one suits you best: + + + +Enter media:/ or +system:/media into the &konqueror; location bar. + + + +Navigate to it by clicking on the Services +tab in &konqueror;'s Navigation Panel, then selecting Storage +Media. + + + +Select GoStorage Media + from the &konqueror; menus. + + + +Click the System desktop icon, then from +the window that appears, click on Storage +Media. + + + + + +The Storage Media location (also known as +the media:/ protocol) will show all devices which are recognized by +&kde;, including the hard drive and &CD; and DVD +drives, as well as USB and Firewire devices, +provided that your distribution is set up correctly to tell &kde; +about them. + + + You can also setup &kde; to display a device icon +on the desktop. To start or configure this feature in the &kcontrolcenter; go +to +DesktopBehavior +and select the Device Icons 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. + + +Automount + +With &kde; 3.5 and newer, devices can be automounted, meaning one only +has to insert the removable disk. &kde; will then open an automount prompt +asking the user What do you want to do? with the media. To +configure the list of options prompted for devices open the &kcontrolcenter; and +navigate to PeripheralsStorage +Media. Here you can add and remove programs from the +list of devices. + +The automount feature will only work if +dbus, hal and +udev are installed and the kernel is properly +configured. To find out if they are running on your system check the +Process Table in &ksysguard; for: +hald, dbus-deamon, and +udevd. &kde; does not provide any of these +components. You must check with you distribution. + + +Related Information +HOWTO: setting up D-BUS and HAL with KDE's media ioslave +edit (A community maintained HOWTO on the &kde; wiki) +The DBus page +HAL - Hardware Abstraction Layer + + + + + +Mounting + +If your system does not automount, &kde; 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; /), and you log in +to &kde; as a user, &kde; can not mount or unmount it without being given a +higher permission. To check a devices mount permission see the +/etc/fstab file. + +To mount and unmount devices manually in &kde; one only has to &RMB; +click the device icon in media:/ or on the desktop and select +Mount or Unmount, for +removable devices one can also unmount with Safely Remove. &kde; still requires the device to be setup in +/etc/fstab. + + + + + + + + diff --git a/doc/userguide/rip.png b/doc/userguide/rip.png new file mode 100644 index 000000000..0a044efb9 Binary files /dev/null and b/doc/userguide/rip.png differ diff --git a/doc/userguide/ripsettings.png b/doc/userguide/ripsettings.png new file mode 100644 index 000000000..21f53fbfd Binary files /dev/null and b/doc/userguide/ripsettings.png differ diff --git a/doc/userguide/screen-captures.docbook b/doc/userguide/screen-captures.docbook new file mode 100644 index 000000000..35d1a726a --- /dev/null +++ b/doc/userguide/screen-captures.docbook @@ -0,0 +1,38 @@ + + + + + + +Screen Captures + +Grabbing screen caps + + + + diff --git a/doc/userguide/services.png b/doc/userguide/services.png new file mode 100644 index 000000000..d281c88b7 Binary files /dev/null and b/doc/userguide/services.png differ diff --git a/doc/userguide/shared-sessions.docbook b/doc/userguide/shared-sessions.docbook new file mode 100644 index 000000000..688a4b93f --- /dev/null +++ b/doc/userguide/shared-sessions.docbook @@ -0,0 +1,46 @@ + + + + + + +Shared Sessions + +Sharing your desktop with krfb and pals + + + + + + + + diff --git a/doc/userguide/splash-screen.png b/doc/userguide/splash-screen.png new file mode 100644 index 000000000..ccc6a29ea Binary files /dev/null and b/doc/userguide/splash-screen.png differ diff --git a/doc/userguide/standard-menu-entries.docbook b/doc/userguide/standard-menu-entries.docbook new file mode 100644 index 000000000..cfa37b453 --- /dev/null +++ b/doc/userguide/standard-menu-entries.docbook @@ -0,0 +1,319 @@ + + + + +&Philip.Rodrigues; + + + + + +The Standard Menu Entries + + + +One of the main ways that you'll control programs in &kde; 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 &kde; program. Let's take a look at the standard +menus: + + + + +The <guimenu>File</guimenu> Menu + +&Ctrl;N + +New + +This entry will start a new, blank document that's +appropriate to the program you're using. For example, in &kate; (the +&kde; Advanced Text Editor) this entry creates a new text file. + + + + +&Ctrl;O + +Open... + +The Open... menu entry +displays the &kde; Open File dialog box, where you can +choose a file to open in the program you're using. The Open +File dialog is also standardized, so it's the same for all +&kde; programs. You can find out more about using this dialog +somewhere else in this guide . +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 +OK button in the dialog. You can always ignore +any changes you made, and close the dialog, by clicking on the +Cancel button. + + + + +&Ctrl;S + +Save + +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 &kde; Save File dialog +will appear, and ask you for a name and location for the file. + + + + + + +Save As... + +The Save As... menu entry +will save the file you're working on with a different name. The +Save File dialog appears, and you can choose a name and +location as usual. Note that after you save the file with +Save As.., you will be working on the +new file. If you save changes, they will be saved +under the new filename. To make this a bit clearer, let's take an +example: + + +You are working on a file called +hello.txt that contains the text Hello +World! + + +You use the Save As... menu +entry to save the file with the new name +newhello.txt. + + +You add the text Nice to see you! to +the file, and use the Save menu entry to +save these changes. + + + + + +Now, the file newhello.txt contains the text +Hello World! Nice to see you!, while the file +hello.txt contains only the text Hello +World!. + + + + + +&Ctrl;P + +Print... + +This menu entry displays the &kde; +Print dialog, read to print the current +document. Youcan find more information about the options available in +this dialog in . + + + + +&Ctrl;W + +Close + +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 +Save or Discard those +changes. If you didn't really want to close the file, just click +Cancel. + + + + +&Ctrl;Q + +Quit + +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. + + + + + + + + +The <guimenu>Edit</guimenu> Menu + + +&Ctrl;Z + +Undo + +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 Undo menu entry will +replace that line. + + + + +&Ctrl;&Shift;Z + +Redo + +Use this menu entry to perform the last action that +you removed with the Undo menu entry. For +example, if, as in the example above, you had replaced a deleted line +of text with Undo, the +Redo entry would redo the action of +deleting the line. + + + + +&Ctrl;X + +Cut + +This menu entry cuts the contents of the current +selection to the clipboard. See +for more information. + + + + + +&Ctrl;C + +Copy + +This menu entry copies the contents of the current +selection to the clipboard. See +for more information. + + + + + +&Ctrl;V + +Paste + +This menu entry inserts the contents of the clipboard +in the current document. The clipboard contents are inserted where the +cursor is currently positioned. + + + + +&Ctrl;A + +Select All + +Use this item to select the whole of the current +document. + + + + +&Ctrl;F + +Find... + +This menu entry displays the Find +Text dialog, which you can use to search for a particular +word or phrase in the current document. + + + + + +F3 + +Find Next + +Use this item to find the next occurrence of the most +recent text you searched for using Find.... + + + + + + + +The <guimenu>Settings</guimenu> Menu + + +Configure Shortcuts... +In the dialog displayed by this menu entry, you can +change the keyboard shortcuts used by the application. See . + + + + + +Configure +Toolbars... + +In the dialog displayed by this menu entry, you can +change which buttons appear on the application's toolbars. See . + + + + + +Configure Notifications... +In the dialog displayed by this menu entry, you can +change the notifications (sounds, error messages, &etc;) used by the +application. See . + + + + + +Configure Application +In the dialog displayed by this menu entry, you can +change settings relating to how the application works in general. + + + + + + + +&help.menu.documentation; + + + + diff --git a/doc/userguide/switching-sessions.docbook b/doc/userguide/switching-sessions.docbook new file mode 100644 index 000000000..d869d0808 --- /dev/null +++ b/doc/userguide/switching-sessions.docbook @@ -0,0 +1,92 @@ + + + + + +Christian +Weickhmann + +christian.weickhmann@gmx.de + + + + +Switching Sessions + +From version 3.3 onwards, &kde; 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. + +Now it's almost as easy as switching to another virtual desktop. + + +Switching Sessions: How it works + + +The Switch User Menu + +The &kmenu; now bears a new entry. Rather at the bottom of the menu +you will find a Switch User 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 KDM as always. The Start New Session entry +skips the activation of your screensaver. + +Once you have running more than one session you can either choose to +press &Ctrl;&Alt;F7 + or F8 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 Switch User +submenu. + + + + +Switch User with the screensaver +If you have activated your screensaver and another user +wants to log in she or he can simply press the Switch +User... button and log into another session. + + + + +Switch Session in &kdm; +If you are in &kdm; and want to switch to another active +session you can press the Menu button and choose +Switch User which is mainly the same as described +above. + + + + + + + + + + + + diff --git a/doc/userguide/the-filemanager.docbook b/doc/userguide/the-filemanager.docbook new file mode 100644 index 000000000..a56628cf8 --- /dev/null +++ b/doc/userguide/the-filemanager.docbook @@ -0,0 +1,291 @@ + + + + + +Christian +Weickhmann + + + + +The File Manager +&konqueror;File +Management +File Management + + + + + +&konqueror; with simple settings + + + +Introduction + +&kde; includes a versatile and powerful file manager called +&konqueror; which 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. If you want more details about what &konqueror; can +do, take a look at the &konqueror; Handbook&konqueror;Handbook by selecting +HelpKonqueror +Handbook in the &konqueror; menus; or, alternatively, you can use the help KIOslave in &konqueror; by entering help:/konqueror in the Location Toolbar. + + + +Folders + +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 previewed +without opening a new application to edit them in.Previews 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. + +You can open any item by clicking (just once – &kde; +does not use double-clicking in its default settings) 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. + +You can go back to the last-opened folder by clicking on the +Back button or go up one folder by clicking +the Up button. + + + +The Navigation Panel (aka <quote>The Sidebar</quote>) + +Navigation Panel +Sidebar + + + + + +The &konqueror; sidebar + + +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. + +On the left edge of the sidebar you will find a number of buttons, each + with a different icon: + + + + + +Bookmarks + + +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 Bookmarks menu. + + + + +Devices + + +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 drives — such as remote shares or hard disk partitions. + + + + +History + + +&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 History item and +selecting Sort by. Left click on an item (⪚ +www.kde.org) and &konqueror; will show you the documents you have visited. Left +clicking on a document (⪚ index.html) will open +the web site in the folder view. +Right clicking on a history item, like www.kde.orgindex.html +, opens a slightly different popup menu: you will also find the +item New Window, which makes &konqueror; open the +site in a new window. + + + + +Home Directory + + +The Home Directory 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. + + + + +Sidebar Media Player + + + + +Try dragging a music file (like MP3, Ogg, or +.wav files) +on the sidebar. The file will immediately be played. + + + + +Newsticker + + +Newsticker will display a customisable list of news sources. Right-click +either on the Configure button or on one of the +newssource buttons (e.g. KDE News, which is usually predefined) to add a new +newsticker source. + + + + +Network + + +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 SMB +shares, &HTTP; sites, or transfer files via the secure FISH +layer. + + + + +Root Directory + + +Everything on a &UNIX;-based system is organized in a file +system tree. This tree must have a root and here it is. The +Root Directory function is like the +Home Directory function. The only difference is +that every folder is being displayed, not only your home +directory. + + + + +Services + + +This is somehow the "rest". Try browsing through the different +items. If an Audio &CD; is in your &CD; or DVD +drive you will be able to find everything on it and even more in the +Audio CD Browser item (you can even compress +audio files and save them on your hard drive with this +function). + + + + + + + +Icons + + +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 +MoveMoving +Files, +CopyCopying +Files, or Link the +selected items. You can also Cancel your +action. + + +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 context menu). + + + +Links and Shortcuts + + +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. + + + + + +The Trash + +Trash +Recycle Bin + +Before a file is deleted in the &kde; file manager it will be +moved to the Trash 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 . If you right click on the trash bin and select +Empty trash bin the files in it will be +deleted permanently. + + + +Related Information + +As mentioned in the introduction, the &konqueror; +Handbook has much more information about the features available in +&konqueror;. You can read it in &khelpcenter; or by entering +help:/konqueror in &konqueror;'s +Location bar. + + + + + + + + + + + diff --git a/doc/userguide/titlebar-menu.png b/doc/userguide/titlebar-menu.png new file mode 100644 index 000000000..d9d672982 Binary files /dev/null and b/doc/userguide/titlebar-menu.png differ diff --git a/doc/userguide/troubleshooting-network-x.docbook b/doc/userguide/troubleshooting-network-x.docbook new file mode 100644 index 000000000..45c55196c --- /dev/null +++ b/doc/userguide/troubleshooting-network-x.docbook @@ -0,0 +1,41 @@ + + + +&J.Hall; + + +Networking and X + +Misconfigured networking can often be the cause of &kde; 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. + + + X uses the hostname to create both a unique key for authorization, and to figure out where (via $DISPLAY) 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. + + +Check your /etc/hosts file and ensure there is an entry for localhost that looks +something like this at the top of the file (after any comments). + + +127.0.0.1 localhost + + +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 DHCP you can simply use the address for the loopback device. + + +127.0.0.1 hal.btl hal (for dhcp) +192.168.0.1 hal.btl hal (static) + + +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 INPUT chain for this device is set to anything other than >ACCEPT this will cause performance problems in X. To check this, you can type in: + + +%iptables-save | grep + INPUT lo ACCEPT + + + +The rule INPUT lo ACCEPT should always work, unless there are other misconfigured rules (Such as a DROP on the OUTPUT chain) + + diff --git a/doc/userguide/troubleshooting-no-open.docbook b/doc/userguide/troubleshooting-no-open.docbook new file mode 100644 index 000000000..682f4b675 --- /dev/null +++ b/doc/userguide/troubleshooting-no-open.docbook @@ -0,0 +1,49 @@ + + + +&Lauri.Watts; + + +When An Application Will Not Open + +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. + + + +Did the application ever start, when launched in the same +manner? +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. +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. + + + +But I can see the launch notification spinning cursor and taskbar entry. + +Foo + + + + + diff --git a/doc/userguide/under-the-hood.docbook b/doc/userguide/under-the-hood.docbook new file mode 100644 index 000000000..094a01d63 --- /dev/null +++ b/doc/userguide/under-the-hood.docbook @@ -0,0 +1,521 @@ + + + + + + +Tinkering Under the Hood of &kde; + + + + + + +Nicolas +Goutte + +goutte@kde.org + + + +Hand-Editing Configuration Files + + +Introduction +In &kde;, the configuration files are easy to edit with a simple +editor like &kate; as the configuration files are text files. + +An example of a text file: + +[General] +AutoSave=1 +LastFile=/var/tmp/test.txt + +The user-specific configuration files are stored in .kde/share/config (replace +.kde with your $KDEHOME setting) and +the global ones are in the share/config sub-directory of &kde;'s +installation path. (You can find this path by running the command +kde-config --prefix.) Their filenames typically +end in rc (without an initial period), for example kopeterc. + + +Editing configuration files by hand can risk the stability of your +&kde; 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. + + + + +Backups + +So the first rule is to make a backup of your file before modifying +it. The backup is better stored outside any +.kde subdirectory +(or the corresponding $KDEHOME directory). Backups are anyway +a good idea in case of a major failure of &kde; that would +destroy important configuration files (for example your &kmail; settings, +which are in in the file kmailrc). +(Such a major failure should not happen but it still can happen.) + + + +Editing + +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 .kde directory. Perhaps you want to learn more +about the depths of &kde;. + +Anyway, whatever your reason, you want to modify by hand a +configuration file. + +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 &kde; is not running at all. + +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 +utf8). + +Now you have a file like: + +[Group] +Key1=Value1 +Key2=Value2 +Key3=Value3 + +You can now modify it (with care!) and then save it (Be sure that it +is as UTF-8 again). + +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. + + +Related Information + + + has more +information about &kde;'s directory structure, to help you find the +file you need to edit. + + + + + + + + + +Scripting the Desktop + +&kde; provides a powerful interprocess communication system in +&DCOP;, the Desktop COmmunication Protocol. Using &DCOP;, you can +control a wide range of functions in &kde; from the command line or +from a script written in your favorite scripting language. You can +also get information out of &kde; applications: for example, several +&kde; media players provide methods to query the player for +information about the currently-playing track. + +Broadly speaking, each &kde; application provides one or more +&DCOP; interfaces, 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 +kdcop frontend to the available &DCOP; +methods. + +Run kdcop from a &konsole; or the +mini-CLI (the window which pops up on &Alt;F2 ). The +kdcop window shows the applications +currently running which provide &DCOP; interfaces, using a tree +view. + +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 (default) usually contains the most +frequently-used functions. + + + +To test that the function does what we expect, double-click on +the setColor entry. To set the color +c, click on the color selector button, and choose a +color. Set whether the color should be color A with the +checkbox. Click OK and the background color is +set. + +To access the &DCOP; method from your favorite scripting +language, you can either use &DCOP; bindings, if available in the +kdebindings module, or call the dcop command-line +application. For simple usage, calling the +dcop 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. + +We specify the application, interface and method in that order, +followed by the arguments in the same order that they are shown in +kdcop. dcop +has plenty of other options: take a look at the output of +dcop +. + +That's enough theory: time for an example: + + +A Background Color Changing Script with &DCOP; + +With the dcop 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. + +Firstly, we look for the appropriate method with +kdcop. For this example, we'll short +circuit the searching, and go straight to it: the method we want is +kdesktopKBackgroundIfacesetColor +. The arguments and return type of the function are shown +in the style of the C++ language. For +setColor, the arguments are a color, +c, which specifies the new background color, and a +boolean (true or false) value, isColorA, which +specifies whether the color is the first or second (this is useful for +setting gradients and so on). + +To use our setColor method on the +command line, we use the following: + + +% dcop kdesktop KBackgroundIface setColor '#ffffff' false + + + +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 # from the shell. + +To find the hexadecimal RGB value of a color, open any +color chooser dialog in a &kde; application (for example, in +&kcontrolcenter;, Appearance & ThemesColors +), select the color you want, and use the value given in +the HTML text box. + + +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: + + += $min) and ($colour[$which] <= $max)); + } +} +]]> + + + +Just run the script with no arguments, and it will cycle the +background colour through a slightly muted spectrum until it is +killed. Voilà! + + + +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: + + +Setting a background from the Internet + +The following script gets the main image from the User +Friendly comic strip and sets it as the desktop wallpaper, +using commonly available tools and a little bit of &DCOP;: + + +.*,,"` +TMPFILE=`mktemp /tmp/$0.XXXXXX` || exit 1 +wget -q -O $TMPFILE $COMICURL +dcop kdesktop KBackgroundIface setWallpaper $TMPFILE 1 +]]> + + +The first line after the #!/bin/sh uses wget 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, dcop sets the downloaded image as +wallpaper. + + + + + + + + + + + +Adding Extra Keybindings to &kde; + +Many modern keyboards contain extra keys that are not by default +assigned to any action. + +Multimedia 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 +Configure Shortcuts has no effect. + +Some IBM laptops, for instance, have extra keys about the left and right +arrows, which look like page left and page +right. + + +Use xev to find the code of the keys. In +this case, they are 233 and 234 + +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 +/usr/X11R6/include/X11/keysymdef.h (or its equivalent +on your system). +Create a file in your home directory called +.Xmodmap, and add to it the following: +keycode 233 = Next_Virtual_Screen +keycode 234 = Prev_Virtual_Screen + +Run the command xmodmap +~/.Xmodmap + + +At this point, you should be able to run xev again +and see that the keys now generate the keysym that you assigned. You can now +simply assign them to any action as normal. + + +Related Information +The xev manpage. You can see this by typing +man:/xev into a &konqueror; window or by typing +man xev into a terminal. + + + + + +Adding Keybindings for New Actions + +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. + +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 to go to the previous or +next virtual desktop, two functions for which you will need DCOP (as discussed in +). + +This can be achieved easily using the following method: + + + +Open &kcontrol;, and in the Regional & Accessibility +section, select Input Action + + +Choose New Action + + +Name the new action, ⪚ Next Virtual +Screen + + +Select Keyboard shortcut -> Command/URL (simple) +for the Action type: + + +In the Keyboard Shortcut tab, click the button +you wish to use to trigger the command. For this example, you would press +the one with the Next Page picture on it. +Next_Virtual_Screen will appear in the key image. + + +In the Command/URL Settings tab, enter the +command to run in the field: dcop kwin default +nextDesktop + + + +Repeat the above with the Prev_Virtual_Screen key and +dcop kwin default +previousDesktop. + +Now pressing the Prev_Virtual_Screen or +Next_Virtual_Screen will switch you to the previous or next +virtual desktop, respectively. + +Obviously you can assign any free key to any action. + + +Related Information +See the KHotKeys documentation by +looking it up in &khelpcenter;, or typing +help:/khotkeys in a &konqueror; +window. + + + + + + + + + + + +Adriaan +de Groot + +groot@kde.org + + + + +&kdebugdialog; - Controlling &kde;'s Debugging Output + + +Basic Usage + +&kdebugdialog; is not in the &kmenu; by default. You will need to run +it from the shell or from the mini-CLI with +the command kdebugdialog. +&kdebugdialog; pops up a window with a long list of debugging areas. Each +area has a checkbox that you can check or uncheck in order to enable or disable debugging output for +that part of &kde;. + +The list of debugging areas is sorted numerically, not alphabetically, +so kio (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 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 k does not filter very much at +all, but entering kont will show you just the &kontact; debugging areas. As an even +quicker way of enabling or disabling debugging output, there are also +select all and deselect all +buttons which will cause &kde; to produce a mountain of debugging output, or +very little. + + + +KDebugDialog in full mode + + + +In full mode, which is what you get when you start kdebugdialog as +kdebugdialog +, 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 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: + +File, in which case you can enter a filename. This file is written into your +$HOME directory. + +Message Box. Each debugging message is displayed in an information dialog, +which you must OK to continue with the +application. + +Shell, the default entry. Messages are printed to stderr, and will appear + either in the shell window where the application was started, or +in .xsession-errors. + +Syslog. This sends each debugging message to the system's syslog facility, +which can perform its own processing of the message. + +None. This suppresses the output of this type of message. + +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 abort on +fatal errors, which is checked by default — but you might +expect an application to crash (in a messy fashion) if a fatal error is +encountered anyway. + + + + + + + + + + + diff --git a/doc/userguide/usenet.docbook b/doc/userguide/usenet.docbook new file mode 100644 index 000000000..2aba10a2b --- /dev/null +++ b/doc/userguide/usenet.docbook @@ -0,0 +1,251 @@ + + + + + + +Usenet News + +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. &kde; provides a powerful usenet news reader called &knode;. + +You can find &knode; in the K Menu under the +Internet entry: the menu entry +&knode; (News Reader) launches the program. + + +The main window of &knode; should now be displayed on your +desktop as shown; on the first start, the settings dialog will be +invoked. + + +Setting up &knode; + + + + +&knode; after first start + + +&knode; after first start + + + + + +Personal settings + +The first page of the settings dialog is for personal settings: + +Dialog for entering personal information + + + + +Entering personal information + + +Entering personal information + + + + + + + +Name + +In the field Name, enter your name. This +name will later appear in the newsgroups as sender, and can be seen by +anyone. + +Filling out the field Name is +mandatory. + + + + + +Email address + +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 Name). + +Filling out the Email Address field is +mandatory. + + + + + + + + + +Configuring the news account + + +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 Accounts entry; click on it and choose the +Newsgroup servers tab, because we first want to configure +the news account: the list of accounts is still empty. + +To create a new account click on Add.... The +following dialog appears: + + +The New Account dialog + + + + +The New Account dialog + + +The New Account dialog + + + + + + + +Name + +The Name 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 My News Account. + + + + +Server + + +The next field is labelled Server. Unlike +the field Name, 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.) + +For our example configuration we enter the name +news.server.com; you will, +of course, enter the real name of your news server. + + + + +Port + +You probably will not need to change this from the default in most +cases. + + + + + + + + +Setting up the mail account + +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 Mail Server (SMTP) tab. The +following dialog box appears: + + +Dialog Box for setting up the mail account + + + + +Setting up the mail account + + +Setting up the mail account + + + + + + + +Server + +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 +Server field. + +In our example we enter mail.server.com + + + + + +Port + + +Again, you probably will not need to change the +Port setting. + + + + + + +Related Information +The comp.windows.x.kde newsgroup is the main user +support group for &kde; on usenet. You can find other resources for +getting help with &kde; in . + +Gmane provides a +usenet frontend to many mailing lists, including most of the &kde; +lists, so you can read them with &knode;. + + + + + + + + + diff --git a/doc/userguide/where-next.docbook b/doc/userguide/where-next.docbook new file mode 100644 index 000000000..2da8d3e84 --- /dev/null +++ b/doc/userguide/where-next.docbook @@ -0,0 +1,40 @@ + + + + + + +Where To Next? + +Web Sites + +Books + + + + diff --git a/doc/userguide/windows-how-to.docbook b/doc/userguide/windows-how-to.docbook new file mode 100644 index 000000000..914e228da --- /dev/null +++ b/doc/userguide/windows-how-to.docbook @@ -0,0 +1,559 @@ + + + + +&Philip.Rodrigues; + + + + + +Windows, How To Work Them + + +Basic Window Management +Window Management + +Each application running in &kde; has its own window, and some +applications may use more than one window. You can manipulate these +windows in many ways to make your desktop work for you. Here is a +normal window: + + + + + +A normal window + + + + + + +Switching Between Windows +Focus (windows) + +If you want to use a window, it must be active. A window +automatically becomes active when you open it, so that the application +you opened is immediately ready to use. Only one window can be active +at a time. The active window is the one into which you can type, and can +be distinguished from the others because it has a different colored +titlebar. (With the &kde; default theme, the active window has a +light blue titlebar, and the inactive +windows have gray titlebars.) + + +Raising Windows +When you want to work in a different window, you need to make +it active. There are two ways to do this: + + + +&LMB;-click on the window that you want to make active. The +window will become active and will be raised above other windows if it +overlaps them. + + + +&Alt; +Hold down &Alt; and press (do not release the &Alt; +key). A popup dialog appears with a list of available windows, one of +which is highlighted. You can select a different window by pressing + again to move through the list, all the time holding down +&Alt;. When you release the &Alt; key, the window which was highlighted +is made active. + + + + + + + +Moving Windows +Moving Windows + +The first way to organize the windows on your desktop is to move +them around. You can move windows so that they overlap other windows, +or so that you can see the whole window. There are three ways to move +a window: + + +Click the &LMB; on the window titlebar and hold it down. Move +the mouse cursor and the window moves with it. Release the mouse +button, and the window remains where you left it. + + + + + + + +Open the window menu using the leftmost button on the window +titlebar (as displayed below), and select Move. The mouse cursor +moves to the center of the current window and by moving the mouse +around, you can move the window. Once you have moved the window to the +position you want, click the &LMB; to release it. +Window Menu + + +The Window Menu + + + + + +The Window Menu + + + + + + +Hold down &Alt; and the &LMB; when the mouse cursor is +above the window you want to move. The mouse cursor changes to a +compass, and by moving the mouse, you can move the window. Just +release the mouse button to release the window. This method is +particularly useful if the window titlebar has been moved off the +screen, so you cannot use the other methods. + + + + + + + +Resizing Windows + +Resizing Windows + +You can make windows bigger or smaller, wider, or taller in +one of two ways. Just use whichever you are most comfortable with: + + +Move the mouse cursor over the border of the window (it is light +blue in the screenshot above). The pointer will turn into a +double-headed arrow. Click and drag, and the edge of the window +follows the mouse cursor, making the window bigger or smaller. If you +click on the borders on the top or bottom of the window, you can +adjust the height on its own. If you click on the borders on the left +or right of the window, you can adjust the width. To change both at +the same time, move the mouse cursor over the corner of the +window. When the pointer becomes a diagonal double-headed arrow, click +and drag. + + +Use the leftmost button on the window titlebar to display the +window menu. Choose the Resize entry, and +the mouse pointer will become a double-headed arrow. Move the mouse +cursor around to resize, and click the &LMB; when you are done +to release the window. + + +If you cannot see the window border or the button for the window +menu, you can use &Alt; and the &RMB;: Hold down &Alt; and drag with +the &RMB;. The window will resize. You just release the &RMB; when +you are done. + + + + +If you just want to make a window as big as possible, so it +takes up the whole screen, use the +MaximizeMaximizing +Windows button, which is the second +button from the right on the window titlebar. Clicking with the &LMB; +on this button will make the window as big as possible in both +directions; while clicking with the &MMB;Maximizing +WindowsVertically or the +&RMB;Maximizing WindowsHorizontally +will increase the window's size in only the vertical or horizontal +direction, respectively. + + + + + +Hiding Windows +Hiding Windows + + + +Minimize +When you need to keep a program open, but you do not want it to +take up space on your desktop, you can minimize it or shade it. To +minimize a window, click the Minimize button, +which is third from the right on the window titlebar. The window will +not be displayed, but the program is still running, and an entry for +it appears in the taskbar on the panel. To display the window again, +click on its entry in the taskbar. You can also use &Alt; &Alt; : see . + + +Shade +Shading windows is very similar to minimizing them, but this +time, only the titlebar of the window is shown. To shade a window, +double-click on the titlebar. To restore the window, just double-click +on the titlebar again. + + + +Cascading Windows + +Sometimes you might have a whole lot of windows open and all over the place. By selecting to cascade windows &kde; 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 Cascade Windows. + + + + +Uncluttering Windows + +By selecting to unclutter your opened windows &kde; 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 Unclutter Windows. + + + + +Closing Windows + +Closing Windows + +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: + + +Click on the rightmost button on the window titlebar. + If you are editing a document with that application, +you will be asked whether you want to Save your +changes, Discard them, or +Cancel your command to close the application. + + +Use the FileQuit + option on the menubar. You will be presented with the +same choice of Save, +Discard, or +Cancel. + + + + Right-click on the respective window in &kicker;, the &kde; panel, and then select Close. You will be prompted with an option to save any documents that were being edited. + + + +Press &Alt;F4&Alt;F4 + +. Once again, the confirmation dialog will be shown if you +were editing any documents. + + + + + + + + + + + + + +Advanced Window Management + +kstart + + + +&Richard.J.Moore; +&Richard.J.Moore.mail; + + +&kstart; + +The simplest way to access the advanced window management +facilities in &kde; is to use a little known +utility called &kstart;, which is included in &kde; since version 2.1 &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-&kde; applications into your +desktop. + +Using &kstart; is easy: you simply put +kstart 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: + +% kstart + + +With luck, the effect this command has +should be fairly 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 &kde;. + +We can pass arguments to programs we invoke with &kstart; as normal, for +example: + +% kstart + +1 xmessage'Hello World' + + + +This command displays Hello +World with xmessage 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 &kde; +application does not cause any problem for +&kstart;, hopefully this illustrates how +&kstart; can be used to integrate foreign +applications into your &kde; desktop. + + + +Other Special Window Settings +While you can use &kstart; to assign particular window settings, &kde; also allows you to alter these -- as well as other similar settings -- from the program window itself. Simply select the leftmost button in the window titlebar (or just hit &Alt;F3 once the window is focued), and then go to AdvancedSpecial Window Settings.... As you can see, from here you change various things from its geometry upon startup, to whether it should have a border or not. + + + + + +&Richard.J.Moore; +&Richard.J.Moore.mail; + + + +The System Tray + +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, +&kde; provides a tool for changing this: +ksystraycmd. + +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: +% ksystraycmd 'kcalc' kcalc + + + +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 over the icon. +ksystraycmd follows standard &kde; +behaviour so the target window can be shown and hidden by clicking the +tray icon, and a standard context menu is available. + + + + + + + + +&Richard.J.Moore; +&Richard.J.Moore.mail; + + + +More Complex Uses of +<application>ksystraycmd</application> + +To illustrate the other features of +ksystraycmd, we'll use a more complicated example: a &konsole; window tracking the +.xsession-errors 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: +% konsole +log 'X Log' \ + + \ + tail -f ~/.xsession-errors + + + The and +arguments are provided as standard by &kde; applications. You can get +a full list of these global options by running an application with the + and +parameters. Here we give our &konsole; window the title 'X Log' and +the icon log. You can use these options with any &kde; application and +as mentioned above, ksystraycmd takes account of these when creating +the tray icon. The argument is specific to &konsole; and tells it +to run the less command. Despite its complexity, we can easily move +this window into the tray with ksystraycmd: + +% ksystraycmd + 'X Log' \ +konsole --icon log --caption 'XLog' \ +--nomenubar --notabbar --noframe \ +-e tail -f .xsession-errors + + + In addition to being the +most complex command we've used, this example demonstrates the + 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 +% ksystraycmd \ + -- log 'X Log' \ +konsole --icon log --caption 'X Log' \ +--nomenubar --notabbar --noframe \ +-e tail -f ~/.xsession-errors + + +The addition of the parameter tells +ksystraycmd to start with only the tray +icon visible (like the parameter), and to wait until the user +activates the tray icon before running the target command. We've also +used the parameter which tells ksystraycmd 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 +ksystraycmd from working, so we now need to +specify the initial icon and tooltip explicitly +too. + + + + + +&Richard.J.Moore; +&Richard.J.Moore.mail; + + + +Improving Reliability + +In all of our previous examples we've relied on +&kstart; and +ksystraycmd 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 + parameter. This specifies the title +of the target window. The following example uses the parameter +to ensure that a particular konsole window is affected: + +% kstart 'kstart_me' konsole +--caption 'kstart_me' -e tail -f +~/.xsession-errors + + + +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 ksystraycmd. The argument is +supported by both &kstart; and and can be regular expression +(⪚ window[0-9]) as well as a particular title. (Regular +expressions are a powerful pattern matching tool you'll find used +throughout &kde;.) + + + + + + +Using Multiple Desktops + +Virtual Desktops +Multiple Desktops + +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 the solution. By default, +&kde; 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 &kde;'s virtual +desktops. + + +Switching Virtual Desktops +To move to a different virtual desktop, you can use &Ctrl; + in the same way as you would use &Alt; + to switch between windows (see ): Hold down &Ctrl; and then press + . A small popup window appears, showing the virtual desktops, +with one highlighted. If you release &Ctrl;, &kde; will switch to the +highlighted virtual desktop. To select a different desktop, press + repeatedly, while holding down &Ctrl;. The selection moves +through the available desktops. When the desktop you want to switch to +is highlighted, release &Ctrl;. + + + + + + +Windows and Virtual Desktops +You can move windows around your virtual desktops with the +To Desktop item in the window menu: just +select the desktop to which you want to move the window. You can make the +window appear on all desktops with the All +DesktopsSticky +Windows item. + + + + + + + + + diff --git a/doc/userguide/your-kde-account.docbook b/doc/userguide/your-kde-account.docbook new file mode 100644 index 000000000..aa37dddac --- /dev/null +++ b/doc/userguide/your-kde-account.docbook @@ -0,0 +1,79 @@ + + + + + + +About Your &kde; Account + +&kde; stores information about your personal settings in a few +different places: + + +The hidden directory .kde (note the +period at the beginning), located in your home directory, contains a +large number of files that store &kde; settings. Some subdirectories +you may find useful are:.kde/share/config, which +contains configuration files for individual applications; +.kde/Autostart, which contains links to +applications which should start each time you start &kde;; and +.kde/share/apps/kabc, where your address book is +stored. + + + +The environment variables KDEDIR and +KDEDIRS tell &kde; where its files are stored. You will +usually only need to set KDEDIR to the directory in which +&kde; is installed, but sometimes you might have other &kde; +programs installed elsewhere: in this case, you can use the +KDEDIRS environment variable. Set +KDEDIRS to a list of all the directories containing +&kde; programs, separated by commas. For example, if you have &kde; +programs in both /usr/local/kde and +/home/phil/kde, you can use export +KDEDIR=/usr/local/kde,/home/phil/kde if you use +bash or setenv +KDEDIR=/usr/local/kde,/home/phil/kde if you use sh. + + + + + + + +Related Information + contains +more information about the directories that &kde; uses. + + + + + + + -- cgit v1.2.1