From 1f545ddb0d249634fd78f4eb7bfd95ea98dbea40 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Tue, 3 Jul 2012 22:00:32 -0500 Subject: Update help handbooks. --- doc/faq/install.docbook | 477 ++++++++++++++++++------------------------------ 1 file changed, 182 insertions(+), 295 deletions(-) (limited to 'doc/faq/install.docbook') diff --git a/doc/faq/install.docbook b/doc/faq/install.docbook index 0192af04c..9b9bbbeb2 100644 --- a/doc/faq/install.docbook +++ b/doc/faq/install.docbook @@ -26,31 +26,25 @@ lists) or newsgroups. -So you have heard the rumors. Or you have seen the screenshots. -And you are dying to get hold of &tde;. But you know next to nothing -about this whole alternative operating system business. Don't worry! -You only need to do some (well, maybe not some) reading, that's -all! - -&tde; does not run on any version of &Microsoft; &Windows; or OS/2 (yet). To run -&tde;, you need to have a &UNIX; system. Please refer to You have heard rumors about &tde;. Or you have seen screenshots. +You want test &tde;. Yet you know next to nothing +about this whole alternate operating system business. Don't worry! +You only need to do some (well, maybe not some) reading, that's all! + +&tde; does not run on any version of &Microsoft; &Windows;. To run +&tde;, you need to have a &UNIX; operating system. Please refer to for more details. Decide on a platform and set it up for your system. This -FAQ can not help you with this, since &tde; runs on many &UNIX; platforms. - - +FAQ can not help you with this, since &tde; is intended +to run on many &UNIX; platforms. -Finally, you are ready to commence the &tde; installation. -Please start reading from the next section. To get &tde;, please -refer to . Last but not least, if -you encounter any problems while installing &tde;, please do not +To obtain &tde;, please refer to . If +you encounter problems while installing &tde;, please do not hesitate to make use of the &tde; mailing lists and newsgroups. But do bear this in mind: no -question is too silly to ask, but some are too silly to answer, -especially when they are already answered in this FAQ. +linkend="newsgroups">newsgroups. No question is too silly to ask, but +remember to first look for answers in this FAQ. Good luck and have fun! @@ -61,7 +55,7 @@ especially when they are already answered in this FAQ. What kind of hardware do I need to run &tde; ? -To run &tde; it is recommended that you have at least a pentium II processor, 64MB of memory and 500MB of free disk space for a basic installation. While &tde; may run on slower configurations than this, performance can be severely impaired. Generally, if your computer runs an &X-Server; already with other desktop environments or window managers it's probably fast enough to run &tde;. +To run &tde; consider at least a Pentium III processor, 512MB of memory, and 500MB of free disk space for a basic installation. A full installation will require about 3GB of hard drive storage space. While &tde; will run on slower hardware, performance likely will require some patience. Generally, if your computer runs other desktop environments then the hardware probably is capable of running &tde;. @@ -72,19 +66,15 @@ especially when they are already answered in this FAQ. -You can find several kinds of binary and source packages for -different distributions and operating systems on the &kde-ftp;. The -binary packages are not made by the &tde; Team, but by the -distributors themselves, or some dedicated individuals. Please refer to -&tde; Package Policy -Explained for information about the &tde; Package Policy. The -only official release is the source tar.bz2 +You can find binary and source packages for +different distributions and operating systems on the +Trinity web site. +The binary packages are made by dedicated members of the &tde; community. +The only official release is the source tarball packages. Please refer to the READMEs and -INSTALLs in the several binaries folders. For -a list of the available packages for a release, refer to the relevant -info page. For the latest release this is the &tde; 3.4.1 Info -Page. +INSTALLs in the several binaries folders. +Find the latest stable release +here. @@ -97,16 +87,16 @@ Page. -For &tde; 3.4.1, you need the &Qt; library version 3.3 or greater. -Please make sure you download the correct &Qt;. You will +You need the &Qt; library as provided by the &tde; developers. Previous +versions of &Qt; will not work with the latest &tde;. +Please ensure you download the correct &Qt;. You will also need the header files, if you want to compile &tde; -yourself. They are all available, at no cost, from http://www.trolltech.com/download. -In addition, there are optional libraries that might improve &tde; if +yourself. They are all available, at no cost, from the &tde; repository. +There are optional libraries that might improve &tde; if installed on your system. An example is OpenSSL which will enable -&konqueror; to browse web pages securely and is needed in a version ->=0.9.6. These should be provided by your distributor; if not, ask -for an update. +&konqueror; to browse web pages securely. These additional packages +should be provided by your distributor. @@ -116,10 +106,36 @@ for an update. Description of the base packages -The base distribution currently consists of twenty +The base distribution currently consists of several packages. Some are required, while others are optional. Each package is available in each of the aforementioned package formats. + + +tqt3 + +Required +This package contains the foundational widget support needed by all +&tde; applications. + + + + +tqtinterface + +Required +Necessary for supporting subsequent versions of Qt. + + + + +arts + +Required +The core sound system for &tde; + + + tdelibs @@ -128,6 +144,7 @@ is available in each of the aforementioned package formats. &tde; applications. + tdebase @@ -137,6 +154,7 @@ of the Trinity Desktop Environment like the window manager, the terminal emulator, the control center, the file manager, and the panel. + &arts; @@ -145,13 +163,15 @@ emulator, the control center, the file manager, and the panel. server. + tdeaddons -Optional +Optional but recommended Various plugins for &kate;, &kicker;, &knewsticker;, &konqueror; and &noatun; + tdeartwork @@ -159,6 +179,7 @@ server. Additional wallpapers, themes, styles, sounds ... + tdebindings @@ -166,6 +187,7 @@ server. Various bindings for other languages, including &Java;, Perl, Python, ... + tdegames @@ -174,29 +196,33 @@ server. &kpatience;. + tdegraphics -Optional +Optional but recommended Various graphics-related programs like &PostScript; previewer, &DVI; previewer, and a drawing program. + tdeutils -Optional +Optional but recommended Various desktop tools like a calculator, an editor and other nifty stuff. + tdemultimedia -Optional +Optional but recommended Multimedia applications like a &CD; player and a mixer. + tdenetwork @@ -205,20 +231,23 @@ nifty stuff. download manager &kget;, and several other network-related programs. + tdepim -Optional +Optional but recommended Personal information management tools. Contains the email client &kmail;, the newsreader &knode; and other related programs. + tdeadmin -Optional +Optional but recommended System administration programs. + tdeedu @@ -228,15 +257,17 @@ Educational and entertaining applications for &tde;'s younger users. + tdeaccessibility -Optional +Optional but recommended -KDE accessibility programs such as a screen magnifier and speech synthesizer front end. +&tde; accessibility programs such as a screen magnifier and speech synthesizer front end. + tdetoys @@ -244,13 +275,15 @@ KDE accessibility programs such as a screen magnifier and speech synthesizer fro Toys! + tdevelop Optional -A complete Integrated Development Environment for &tde; and Qt +A complete Integrated Development Environment for &tde; and &Qt; + tdewebdev @@ -258,18 +291,19 @@ KDE accessibility programs such as a screen magnifier and speech synthesizer fro Web development applications. Contains such applications as &quanta;, an integrated web development environment and other applications useful in web development + tdesdk Optional -KDE Software Development Kit. Contains a collection of applications and tools used by KDE Developers. +&tde; Software Development Kit. Contains a collection of applications and tools used by &tde; Developers. -&arts; and then tdelibs should be installed before everything -else, and tdeaddons last. The other packages can be installed in any -arbitrary order. +Information about compiling all packages is available at the + +Trinity wiki. Most package management tools will let you put all these packages in one folder and install them all at once, figuring out @@ -280,142 +314,84 @@ the dependencies as they go. -Installation instructions for the different package -formats +Installation instructions for the different package formats + + +As &tde; is intended for many &UNIX; systems, please consult the installtion +procedures and package management document for the system being used. + + + + + +Post-installation procedures - -Please do not forget to read the README and INSTALL files if they are available. - +There should be nothing to do after installing the packages except use them! +Nonetheless, should problems arise, there are some common problems to consider: + + -Installation of the Debian packages +System search path -The Debian packages install in accordance with the upcoming FHS (File -Hierarchy Standard). - -become superuser -run dpkg for -every package you want to install. - +Be sure all &tde; binary files are installed +in a location listed in your system's PATH. + -Installation of the RPM packages +Library files - -To install binary <acronym>RPM</acronym>s -become superuser -execute rpm - +Be sure the &tde; library files are installed in the expected locations for your +system. + -Installation of the source .tar.bz2 files +TDEDIR environment variable -Since there are always changes and updates to the way &tde; is compiled, please -refer to Download and Install from Source for the most up to date installation instructions for the source packages. - -The general approach should work in most cases though. - -The source .tar.bz2 package installs into /usr/local/kde by default. You can -override this setting by using the option of -the configure script. - -unpack the packages with tar -change folder to the package folder: cd -packagename -configure the package: ./configure -Some packages (notably tdebase) have special configuration -options that might be applicable to your installation. Type -./configure to see the -available options. -build the package: make -install the package: su (if you aren't already root). If you -already are, just type make -. - +Be sure the TDEDIR environment variable is correctly set. + + + + +starttde script installation + +Verify the starttde script is installed to $TDEDIR/bin and therefore in your +system's search path. + + + + +starttde script is run correctly + +Be sure the starttde script is being run from within the appropriate +xinitrc or xsession script. + - - - - -Post-installation procedures - - -First of all, please make sure that you have added &tde;'s binary -installation folder (⪚ /usr/local/kde/bin) to your PATH -and &tde;'s -library installation folder to your LD_LIBRARY_PATH (only -necessary on systems that do not support rpath; on &Linux; &ELF;, it -should work without). This environment variable may be called -differently on some systems, ⪚ it is called -SHLIB_PATH on &IRIX;. Then set the environment variable -TDEDIR to the base of your &tde; tree, ⪚ /usr/local/kde. - -Please bear in mind that it is unwise to set -LD_LIBRARY_PATH blindly. In the vast majority of cases it is -unnecessary and can do more harm than good. There is a web page -written by Dave -Barr explaining the evils of LD_LIBRARY_PATH and it can be -found at http://www.cis.ohio-state.edu/~barr/ldpath.html. - - -Even though you can use most of the &tde; applications simply by -calling them, you can only benefit fully from &tde;'s advanced -features if you use the &tde; window manager and its helper -programs. -In order to make it easy for you, we have provided a simple -script called starttde which gets installed in $TDEDIR/bin and is therefore in your -path. -Edit the file .xinitrc in your home folder (make a backup -copy first!), remove everything that looks like calling a window -manager, and insert starttde instead. Restart the &X-Server;. If you use -&tdm;/xdm, you will have to edit the file .xsession instead of -.xinitrc. And if there is no .xinitrc or .xsession in your home -folder, simply create a new one with just one line containing -starttde. - -Some systems (notably &RedHat; &Linux;) use .Xclients -instead. - -This should present you with a new shining &tde; desktop. You +This should present you with a new &tde; desktop. You can now start to explore the wonderful world of &tde;. In case you -want to read some documentation first, there is a highly recommended -Quick Start -guide available. Furthermore, every application has an online -help that is available via the help menu. +want to read some documentation first, there is a recommended +A Quick Start Guide to the Desktop +available. Furthermore, every application has an online +help that is available via the Help menu. - Should I remove old version xyz before installing a new one? -In principle, this is not necessary. RPM and Debian packages -should take care of all dependencies. -If you compile the source code yourself, you should take more care. -Instructions for running two different versions of &tde; on the same system are -given at http://developer.kde.org/build/kde2-and-trinity.html. -However, please note that running two different versions of &tde; from source -can lead to problems if you are not careful. +In principle, this is not necessary. The various distro package managers +should handle all dependencies. +If you compile the source code yourself, you should take more care. @@ -424,15 +400,10 @@ can lead to problems if you are not careful. How do I start &tde;? -The most comfortable method to start &tde; is to use the -starttde script. Simply put the line -starttde at the end of your .xsession -file (or your .xinitrc or .Xclients -file if you are not using &tdm; or xdm). Please -also remove the lines that start your previous window manager. If there is no -.xsession, .xinitrc, or -.Xclients in your home folder, simply create a new one -that contains just one line: starttde. +There are only two methods of starting &tde;: using a login +manager such as &tdm; or from the command line, using startx. +The respective startup scripts should contain a reference to the +starttde script. - - -Is it possible to install &tde; in my home directory? - - -Yes, you can install &tde; in any folder you want. What you -have to do depends on the kind of packages you want to install: -Source packages -Configure and install the package using configure -; -make; make install to install into /home/me. Replace /home/me with your home directory, generally defined in $HOME -Add the following to your init files. Please note that if -it is not necessary for you to set LD_LIBRARY_PATH, it -is better to leave it out. - -For csh or tcsh: - -setenv TDEDIR /home/me - -if ( $?LD_LIBRARY_PATH ) then - setenv LD_LIBRARY_PATH $TDEDIR/lib:$LD_LIBRARY_PATH -else - setenv LD_LIBRARY_PATH $TDEDIR/lib -endif - -if ( ! $?LIBRARY_PATH ) then - setenv LIBRARY_PATH $LD_LIBRARY_PATH -endif - -For bash: - -TDEDIR=/home/me -PATH=$TDEDIR/bin:$PATH -LD_LIBRARY_PATH=$TDEDIR/lib:$LD_LIBRARY_PATH -LIBRARY_PATH=$LD_LIBRARY_PATH -export TDEDIR PATH LD_LIBRARY_PATH LIBRARY_PATH - - -<acronym>RPM</acronym> packages -rpm allows you to use the - option to select the folder you want to -install to. For example, executing rpm will install the package -to /home/me. - - -Although &tde; will run from a user folder, there are some -problems with programs that require suid root, ⪚ the programs in -the tdeadmin package. But since they are not meant to be run by users -in the first place, this is nothing to worry about. -However, on systems using shadow passwords, the screensavers -have to be suid root to enable password access for unlocking the -screen, so this option will not work. - - - @@ -528,8 +440,9 @@ screen, so this option will not work. server. What is wrong? -You probably tried to start the X server with starttde. The X -server is started with startx. +You probably tried to start &tde; directly with starttde rather +than letting the login manager or startx process run that script. From the command +line the X server is started with startx. starttde is the script that should be run from your .xinitrc, .xsession, or .Xclients to activate the window manager and the necessary server @@ -537,27 +450,20 @@ daemons for &tde;. See also . - + IBM now officially support &tde; on &AIX;. You can find details at http://www.ibm.com/servers/aix/products/aixos/linux/index.html. There is also some older information at http://space.twc.de/~stefan/kde/aix.html. - +--> - + - + - + -Will I lose my current settings when I upgrade &tde;? +Will I lose my current settings when I update &tde;? - -No. In most cases &tde; will be able to transport your settings -intact. You may need to reenter passwords in some applications (such -as &kmail; or &knode;) but most other settings will be safe. - -There were mixed reports of results between some previous -versions of &tde;. To be safe, you may like to back up your entire -&tde; configuration. - -Settings are kept in the $HOME/.kde or $HOME/.kde2 subfolder in your home -folder. Copy your -old .kde/.kde2 folder to a backup location, -install &tde; 3.2, and then copy back any necessary mail and news -settings. That said, most people can make a direct upgrade, without -removing the old .kde folder, - without a hitch. -You can override the use of $HOME/.kde by setting the -$TDEHOME variable. +You shouldn't. &tde; should transport your settings +intact. All settings should be safe. -I upgraded &tde; and it seemed to go fine, but when I start it, +I updated &tde; and all seemed to go fine, but when I start &tde;, I get a blank gray screen, and nothing happens. There are errors in the console about DCOPserver. What's going on? @@ -655,18 +541,18 @@ the console about DCOPserver. What's going on? &tde; uses several temporary files during its operation. -These are usually to be found in the following locations: +Usually these directories and files are found in the following locations: -~/.DCOPserver-* (there are usually two of these; one is a symlink to the other) -~/.kde/socket-hostname -~/.kde/tmp-hostname which is normally a symlink to the next file: -/tmp/tmp-kde-USER -~/.kde/socket-hostname which is also normally a symlink to: -/tmp/tdesocket-USER +$HOME/.DCOPserver-* (there are usually two of these; one is a symlink to the other) +$HOME/.trinity/socket-hostname +$HOME/.trinity/tmp-hostname, which normally is a symlink to the next file: +$TMP/tde-USER +$HOME/.trinity/socket-hostname, which normally is a symlink to: +$TMP/tdesocket-USER -If the symlinks get broken, usually because a -cron or shutdown script is emptying out the +If the symlinks get broken, such as when +cron or a shutdown script is emptying the /tmp folder, then strange things will happen. These files, and the symlinks, will all be created automatically at the start of &tde; so you can safely remove @@ -674,7 +560,7 @@ them while &tde; is not running. If you are only getting a gray screen when you start &tde;, or if you get an error message telling you to Check your installation, then shut down X and delete all the files listed above, then try to restart X. -Normally (&ie; when not upgrading between &tde; versions) it's +Normally (&ie; when not updating between &tde; versions) it's quite safe to leave these files intact, and you may shave a few seconds off your &tde; startup time by doing so. @@ -682,32 +568,32 @@ seconds off your &tde; startup time by doing so. -Is TDE backwards or binary compatible with KDE 3? +Is &tde; backwards or binary compatible with KDE 3? -While many programs designed on KDE 3 will compile on Trinity, binary -compatibility with KDE 3 is not a goal of the TDE project. +While many programs originally designed for KDE 3 will compile on Trinity, binary +compatibility with KDE 3 is not a goal of &tde; developers. -Is TDE backwards or binary compatible with previous releases of TDE? +Is &tde; backwards or binary compatible with previous releases of &tde;? Possibly, but binary compatibility is not a project goal with major point -releases. A package that built on a previous version of TDE but no longer builds +releases. A package that built on a previous version of &tde; but no longer builds on the current release should be brought to the attention of the developers. -Is my KDE3 profile directory compatible with Trinity? +Is my KDE 3 profile directory compatible with Trinity? Not quite but don't worry. Some "scrubbing" cleanup is required to migrate -a KDE3 profile. For new users or those with little customization we recommend +a KDE 3 profile. For new users or those with little customization we recommend creating a fresh profile. For those long-time users who cringe at the thought of recreating their desktop, we provide a migratekde3 shell script. That script copies a $HOME/.kde3 profile directory to $HOME/.trinity and performs the required @@ -716,7 +602,7 @@ with no warranties or guarantees. (The script works really well, actually. :-))< - + - + - + + -- cgit v1.2.1