From fc2650816b4b95f21750c53c0d45daeff31510d6 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Fri, 24 Feb 2012 22:53:44 -0600 Subject: Update tdebase cmake files with STARTKDE->STARTTDE. Fix tdebase entities, text strings for future maintenance of handbook files. This partially resolves bug report 694. Update konqueror user agent strings. This partially resolves bug report 774. Update TDM help options. This resolves bug report 618. Fix KTips branding issues and obsolete web addresses. This resolves bug report 842. --- doc/userguide/kde-for-admins.docbook | 301 +++++++++++++++++------------------ 1 file changed, 143 insertions(+), 158 deletions(-) (limited to 'doc/userguide/kde-for-admins.docbook') diff --git a/doc/userguide/kde-for-admins.docbook b/doc/userguide/kde-for-admins.docbook index 466aba62b..6bf03c0db 100644 --- a/doc/userguide/kde-for-admins.docbook +++ b/doc/userguide/kde-for-admins.docbook @@ -1,24 +1,9 @@ - - - - -Waldo -Bastian - -bastian@kde.org - - -&Philip.Rodrigues; -&Philip.Rodrigues.mail; - - - - -&kde; for Administrators + +&tde; for Administrators -&kde; Internals +&tde; Internals Overview @@ -28,12 +13,12 @@ Directory Layout -&kde; defines a filesystem hierarchy which is used by the &kde; -environment itself as well as all &kde; applications. In general &kde; +&tde; defines a filesystem hierarchy which is used by the &tde; +environment itself as well as all &tde; applications. In general &tde; stores all its files in a directory tree with a fixed structure. -By default &kde; uses two directory trees: +By default &tde; uses two directory trees: One at the system level (for example --check -&kde; and &kde; applications look up files by scanning all the -&kde; directory trees. The directory trees are checked in order of +&tde; and &tde; applications look up files by scanning all the +&tde; directory trees. The directory trees are checked in order of precedence. When a file is present in multiple directory trees, the file from the last tree takes precedence. Normally, the tree located in the user's home directory has the highest precedence. This @@ -160,7 +145,7 @@ root writing to $TDEHOME of the user after running /opt/trinity, /usr, /usr/trinity -Vendor dependent. Used by &kde; 2. If not set, falls back to +Vendor dependent. Used by &tde; 2. If not set, falls back to compiled-in default. @@ -169,15 +154,15 @@ compiled-in default. /opt/trinity, /usr, /usr/trinity -New in &kde;3. Can list multiple locations separated by a +New in &tde;3. Can list multiple locations separated by a colon. If not set, falls back to $TDEDIR Don't need to be set, defaults work just fine. -Running &kde;2 next to &kde;3? Point $TDEDIR to -&kde; 2 and $TDEDIRS to &kde; 3. +Running &tde;2 next to &tde;3? Point $TDEDIR to +&tde; 2 and $TDEDIRS to &tde; 3. A staff member at a university could have the following @@ -222,7 +207,7 @@ 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. +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 @@ -247,7 +232,7 @@ bastian=staff Directory Layout Revisited -Each directory tree used by &kde; has a fixed directory structure. +Each directory tree used by &tde; has a fixed directory structure. Directories that are not relevant for a certain tree, or simply not used can be left out though. For example, directories used for temporary files are usually only found under bin -Used for &kde; executables. +Used for &tde; executables. lib -Used for &kde; libraries. +Used for &tde; libraries. lib/trinity This directory contains components, plugins, and other -runtime loadable objects for use by &kde; 3.x -applications. +runtime loadable objects for use by &tde; 3.x +applications. @@ -293,13 +278,13 @@ archs. share/applnk .desktop files for -&kde;-menu (old) +&tde;-menu (old) share/applications .desktop files for -&kde;-menu (since &kde; 3.2) +&tde;-menu (since &kde; 3.2) @@ -314,8 +299,8 @@ 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. +rc. A special case is kdeglobals. +This file is read by all &tde; applications. @@ -324,7 +309,7 @@ class="directory">share/config/session This directory is used by session management and is normally only available under $TDEHOME. At the end of a -session &kde; applications store their state here. The file names +session &tde; 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 @@ -333,7 +318,7 @@ these numbers when saving a session in share/doc/HTML -This directory contains documentation for &kde; +This directory contains documentation for &tde; applications. Documentation is categorized by language and the application it belongs to. Normally at least two files can be found in a directory: index.docbook, which contains the @@ -356,7 +341,7 @@ 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 +are stored. &tde; uses &MIME; types to identify the type of a file. @@ -366,7 +351,7 @@ file. 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. +of the user. Services do not appear in the &tde; menu. @@ -408,7 +393,7 @@ background picture -Host-specific Directories +Host-specific Directories There are three host-specific directories that are usually symlinked to other locations. If the directories do not already exist, @@ -451,9 +436,9 @@ an alternative name and link to that instead. -Configuration Files &kde; uses a simple +Configuration Files &tde; uses a simple text-based file format for all its configuration files. It consists of -key-value pairs that are placed in groups. All &kde; configuration +key-value pairs that are placed in groups. All &tde; configuration files use UTF-8 encoding for text outside the ASCII range. @@ -471,7 +456,7 @@ second group contains the keys Show hidden files and Sort by: -[KDE] +[TDE] LargeCursor=false SingleClick=true @@ -527,13 +512,13 @@ 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; +comments to configuration files. It should be noted that when a &tde; 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 +various &tde; directory trees. In this case the information of all these configuration files is combined on a key-by-key basis. If the same key within a certain group is defined in more than one place, the key value read from the directory tree with the highest precedence will be used. @@ -698,7 +683,7 @@ result in a value equal to joe@joes_host. The setting is not locked down. -[Mail Settings] +[Mail Settings] Host[$ie]=$(hostname) Email[$e]=${USER}@${HOST} @@ -739,11 +724,11 @@ 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 +documented. With &tde; 3.2 a start has been made to change this. In $TDEDIR/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 +configuration file. These are used by the new &tde; Configuration Editor when available. @@ -779,7 +764,7 @@ Auto Save Interval=25 -&kde; Startup Sequence +&tde; Startup Sequence &tdm; @@ -811,7 +796,7 @@ Startup - /etc/X11/xdm/Xstartup - prepare as root Session - /etc/X11/xdm/Xsession - starts session as user -= For a KDE session: kde or starttde += For a TDE session: kde or starttde = If present ~/.xsession or ~/.xinitrc @@ -824,9 +809,9 @@ Reset - /etc/X11/xdm/Xreset - after session finished -The &kde; Startup Script: <command>starttde</command> +The &tde; Startup Script: <command>starttde</command> -The &kde; startup sequence starts with the +The &tde; startup sequence starts with the starttde script. In most cases this script gets called from the display manager (&tdm;) once the user has been authenticated. Their are two very important lines in the starttde @@ -839,7 +824,7 @@ ksmserver $TDEWM The first line starts the tdeinit master process. The tdeinit master process is used to start all other -&kde; processes. It show up in the output of ps +&tde; processes. It show up in the output of ps as tdeinit: Running.... The arguments after tdeinit are the names of additional processes to be started. The + @@ -859,7 +844,7 @@ user is logged out. Background Processes -All &kde; background services are user-specific: unlike system daemons +All &tde; background services are user-specific: unlike system daemons they are not shared between users. As well as being unique per user they are also unique per X-server display. The processes are: @@ -912,7 +897,7 @@ needed <command>tdeinit</command> -tdeinit is used to start all other &kde; +tdeinit is used to start all other &tde; programs. tdeinit can start normal binary program files as well as tdeinit loadable modules (KLMs). KLMs work just like binary @@ -954,9 +939,9 @@ command line in the starttde script, normally <command>dcopserver</command> dcopserver is a daemon which provides inter-process -communication (&DCOP;) facilities to all &kde; applications. The &DCOP; +communication (&DCOP;) facilities to all &tde; applications. The &DCOP; facilities are accessible from the command shell via the -dcop command line tool. &DCOP; is essential for all &kde; +dcop command line tool. &DCOP; is essential for all &tde; applications. Some related files: @@ -1018,8 +1003,8 @@ startup problems. <command>klauncher</command> klauncher is a daemon which is responsible for -service activation within &kde;. It operates in close connection with the -tdeinit master process to start new processes. &kde; +service activation within &tde;. It operates in close connection with the +tdeinit master process to start new processes. &tde; applications communicate with klauncher over &DCOP; in order to start new applications or services. @@ -1050,7 +1035,7 @@ methods. KSMServer -ksmserver is &kde;'s session manager. On startup +ksmserver is &tde;'s session manager. On startup the session manager launches auto-start applications and restores applications from the previous session. The applications to auto-start are indicated by .desktop files in the @@ -1084,13 +1069,13 @@ are: kdesktop -The &kde; desktop +The &tde; desktop &kicker; -The &kde; panel +The &tde; panel @@ -1127,7 +1112,7 @@ 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 +The &tde; session manager also restores one of the previous sessions. A session contains a collection of applications as well as application-specific information that reflects the state of the applications at the time the session was saved. Sessions are stored in the @@ -1144,7 +1129,7 @@ windows of all the other applications in the session. Environment variables -Some important environment variables used by &kde;: +Some important environment variables used by &tde;: @@ -1152,30 +1137,30 @@ windows of all the other applications in the session. $TDEDIR Has to be set if TDEDIRS is not set and has to point to the root of the -&kde; installation tree. Allows &kde; to find its data like icons, +&tde; installation tree. Allows &tde; to find its data like icons, menus and libraries. $TDEDIRS Overrides TDEDIR and allows you to specify -multiple directories where &kde; searches for its data. Useful if you want +multiple directories where &tde; searches for its data. Useful if you want or have to install some programs to a different prefix than the rest of -&kde;. +&tde;. $TDEHOMEIf -not set, &kde; uses ~/.kde as +not set, &tde; uses ~/.kde as the directory where personal data is stored. $TDEROOTHOMEIf -not set, &kde; uses ~root/.kde +not set, &tde; 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; +personal data. Was introduced to prevent &tde; from accidently +overwriting user data with root permissions when the user runs a &tde; program after switching with su to root. @@ -1183,25 +1168,25 @@ class="username">root. $TDEWMIf the TDEWM environment variable has been set, then it will -be used as &kde;'s window manager within the +be used as &tde;'s window manager within the starttde script instead of &twin;. -$KDE_LANGOverrides -the &kde; language configuration, ⪚ KDE_LANG=fr kprogram +$TDE_LANGOverrides +the &tde; language configuration, ⪚ TDE_LANG=fr kprogram & starts a program with French translation if the necessary files are installed. $TDE_MULTIHEADSet -this variable to true to indicate that &kde; is running +this variable to true to indicate that &tde; is running on a multi-head system. -$KDE_FORK_SLAVES +$TDE_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 @@ -1212,35 +1197,35 @@ environment as the application. This can be the case with -$KDE_HOME_READONLY +$TDE_HOME_READONLY Set this variable to indicate that your home directory is mounted as read-only. -$KDE_NO_IPV6 +$TDE_NO_IPV6 (Since &kde; 3.2.3) - Set this variable to disable IPv6 support and IPv6 DNS lookups. -$KDE_IS_PRELINKED +$TDE_IS_PRELINKED (Since &kde; 3.2) - Set this variable to indicate that you have prelinked -your &kde; binaries and libraries. This will turn off +your &tde; binaries and libraries. This will turn off tdeinit. -$KDE_UTF8_FILENAMESIf -this environment variable is set, &kde; assumes all filenames are in +$TDE_UTF8_FILENAMESIf +this environment variable is set, &tde; assumes all filenames are in UTF-8 encoding regardless of the current C locale. $TDE_FULL_SESSION -(Since &kde; 3.2) Automatically set to true by &kde; startup, it is used +(Since &kde; 3.2) Automatically set to true by &tde; startup, it is used by ⪚ &konqueror; to know if it should consider remaining in memory for future re-use when being closed. If not set, &konqueror; will exit after being closed (⪚ &tdesu; does that, it's also useful for @@ -1248,22 +1233,22 @@ debugging). -$KDESYCOCAAllows -you to specify the path and the name of the generated &kde; system +$TDESYCOCAAllows +you to specify the path and the name of the generated &tde; system configuration cache file. $TDETMPAllows to specify another path than /tmp where &kde; stores its temporary +class="directory">/tmp where &tde; stores its temporary files. $TDEVARTMPAllows to specify another path than /var/tmp where &kde; stores its variable +class="directory">/var/tmp where &tde; stores its variable files. @@ -1282,11 +1267,11 @@ class="directory">$XDG_DATA_HOME base directory. Default is /usr/local/share/:/usr/share/ -&kde; adds locations from $TDEDIRS and profiles +&tde; adds locations from $TDEDIRS and profiles as well. Used for .desktop and .directory menu files. .desktop files under $XDG_DATA_DIRS/applications. +class="directory">$XDG_DATA_DIRS/applications. .directory files under $XDG_DATA_DIRS/desktop-directories @@ -1295,16 +1280,16 @@ $XDG_DATA_DIRS/desktop-directories $XDG_CONFIG_HOME -(&kde; 3.2) - Defines the base directory relative to which user +(&tde; 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 +(&tde; 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 +base directory. The default is /etc/xdg &tde; adds locations from $TDEDIRS and profiles as well. Used by .menu descriptions in $XDG_CONFIG_DIRS/menus. @@ -1319,7 +1304,7 @@ $TDEDIRS and profiles as well. Used by -tdeinit is used to start all other &kde; +tdeinit is used to start all other &tde; programs. tdeinit can start normal binary program f iles as well as tdeinit loadable modules (KLMs). KLMs work just like binary @@ -1354,7 +1339,7 @@ difficult to kill a process that is causing trouble: You might be tempted to try killall tdeinit, but killing all tdeinit processes will have -the effect of shutting down all of &kde;. In effect, total +the effect of shutting down all of &tde;. In effect, total destruction! There are two simple solutions to this: @@ -1362,7 +1347,7 @@ destruction! % kdekillall kdesktop or good old % kill 26195 -kdekillall is part of the &kde; SDK +kdekillall is part of the &tde; SDK package. @@ -1370,13 +1355,13 @@ package. -Customizing &kde; +Customizing &tde; Desktop Icons -&kde; uses several types of icons: +&tde; uses several types of icons: Documents @@ -1423,7 +1408,7 @@ URL=http://www.kde.org/ role="extension">.desktop file: Create NewFileLink to Application. You must provide details -yourself. Drag from &kde; Menu: Either copy or link (creates symlink), +yourself. Drag from &tde; Menu: Either copy or link (creates symlink), much easier @@ -1496,7 +1481,7 @@ disable if it doesn't work. Has app started ok? Remove if it doesn't work -Categories for &kde; Menu, not +Categories for &tde; Menu, not used on desktop @@ -1528,7 +1513,7 @@ open several local files at once. %u A single &URL;: if the app can -handle ⪚ &FTP; or &HTTP; &URL;s itself, otherwise &kde;. +handle ⪚ &FTP; or &HTTP; &URL;s itself, otherwise &tde;. @@ -1554,8 +1539,8 @@ have file in current working directory. -%i -The icon; option; &kde; app +%i +The icon; option; &tde; app will use icon from Icon= line in taskbar. @@ -1567,8 +1552,8 @@ will use icon from Icon= line in taskbar. -%c -The caption; option; &kde; +%c +The caption; option; &tde; app will use name from Name= line in taskbar. @@ -1635,15 +1620,15 @@ class="directory">/opt/trinity/share/config/SuSE/default/ -&kde; Menu +&tde; Menu How it Works -In &kde; 3.2 a common menu format is introduced at +In &tde; 3.2 a common menu format is introduced at http://freedesktop.org/Standards/menu-spec/ -Before &kde; 3.2: +Before &tde; 3.2: Directory structure under -It was difficult to rearrange the structure in &kde; 3.2 so the +It was difficult to rearrange the structure in &tde; 3.2 so the new menu format: Defines structure in a single .menu file Is based on categories -is shared between GNOME and &kde; +is shared between GNOME and &tde; Supports applnk style menus as well @@ -1781,10 +1766,10 @@ Icon=kcmsystem 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. +file associations: If you remove an application from the menu, &tde; 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 +.hidden menu or a dedicated menu with NoDisplay=true in the .directory file $TDEDIR/etc/xdg/menus/applications-merged/ contains kde-essential.menu which includes some -essential menus that are normally not shown in the &kde; menu itself: +essential menus that are normally not shown in the &tde; menu itself: Control Center has a hidden Settings menu whose contents are defined by kde-settings.menu and @@ -1826,7 +1811,7 @@ NoDisplay=true Old-Style Menus -&kde; continues to support old-style menus that are defined by +&tde; continues to support old-style menus that are defined by the directory structures in $TDEDIR/share/applnk (system wide) and /var/tmp/kdecache-${USER}/ksycoca. It is automatically updated by KDED, -checked during &kde; login, and KDED +checked during &tde; login, and KDED watches for changes while logged in. To disable watching for changes (since it may hurt over NFS) add @@ -1878,9 +1863,9 @@ profile- or system-wide locations. -&kde; Panel +&tde; Panel -The &kde; panel is also known as &kicker;. It is modular and +The &tde; panel is also known as &kicker;. It is modular and consists of the following components: Applets @@ -1898,7 +1883,7 @@ consists of the following components: and the following special buttons: -&kde; menu +&tde; menu Desktop Button @@ -1917,7 +1902,7 @@ and the following special buttons: 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 $TDEDIR/share/mimelnk and each application's .desktop file contains a list of &MIME; types supported by that application. @@ -1962,7 +1947,7 @@ role="extension">.gif files. &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 +user profile directory or the global &tde; config directory to use as default for multiple users. @@ -1972,12 +1957,12 @@ default for multiple users. -Locking Down &kde; +Locking Down &tde; How It Works - The Basics -&kde;'s lock down features are centered around the following +&tde;'s lock down features are centered around the following options: @@ -1995,7 +1980,7 @@ certain configuration modules Immutable Configuration Options -Locking Down &kde; +Locking Down &tde; Immutable options allow system administrator to provide default settings that can not be changed by the user. @@ -2020,7 +2005,7 @@ presented with an user interface option to make such change. Action Restrictions -&kde; applications are built around the action-concept. Actions can be +&tde; applications are built around the action-concept. Actions can be activated in various ways, typically via the menu-bar, one of the toolbars or a keyboard shortcut. Save Document is an example of an action. If you know the internal action name it is possible to restrict an @@ -2038,17 +2023,17 @@ functionality that would offer the user access to a &UNIX; shell. 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] +[TDE Action Restrictions] shell_access=false -Since this affects the &kde; menu and the available applications, we +Since this affects the &tde; menu and the available applications, we must force an update of the sycoca database: touch $TDEDIR/share/services/update_ksycoca -Now re-login to &kde; and check the following points: +Now re-login to &tde; and check the following points: The &kmenu; @@ -2159,7 +2144,7 @@ accessed. -[KDE URL Restrictions] +[TDE URL Restrictions] rule_count=2 rule_1=open,,,,http,,,false rule_2=open,,,,http,*.ourcompany.com,,true @@ -2168,7 +2153,7 @@ 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. +rules. forbids the opening of any http or https &URL; @@ -2186,7 +2171,7 @@ $HOME directory: -[KDE URL Restrictions] +[TDE URL Restrictions] rule_count=2 rule_1=list,,,,file,,,false rule_2=list,,,,file,,$HOME,true @@ -2200,7 +2185,7 @@ directory. $HOME and $TMP are special values to -indicate the users home directory and the &kde; temporary directory of the +indicate the users home directory and the &tde; temporary directory of the user, ⪚ /tmp/kde-bastian The following rules makes that the user can no longer open local files @@ -2211,7 +2196,7 @@ that are outside his $HOME directory: -[KDE URL Restrictions] +[TDE URL Restrictions] rule_count=3 rule_1=open,,,,file,,,false rule_2=open,,,,file,,$HOME,true @@ -2223,8 +2208,8 @@ 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 +files in the &tde; temporary directory of the user. This is needed by +certain &tde; applications that first download a file or document to the temporary directory and then open it in an application. @@ -2239,7 +2224,7 @@ refer to locally stored documents. class="systemname">www.mycompany.com the possibility to refer to local files we could add the following rule: -[KDE URL Restrictions] +[TDE URL Restrictions] rule_count=1 rule_1=redirect,http,www.mycompany.com,,file,,,true @@ -2286,8 +2271,8 @@ example. Configuration Modules -&kde; has configuration modules to configure various aspects of the -&kde; environment. Configuration modules appear in the Control Center, in the +&tde; has configuration modules to configure various aspects of the +&tde; environment. Configuration modules appear in the Control Center, in the Configuration dialog of an application or in both. @@ -2310,7 +2295,7 @@ configuration dialog is an integral part of the application itself. -All configuration modules are strictly speaking part of the &kde; +All configuration modules are strictly speaking part of the &tde; menu. @@ -2319,7 +2304,7 @@ menu. have a .desktop file in $TDEDIR/share/applications/kde and are sorted under the hidden Settings-Modules menu by -the kde-settings.menu, included from +the kde-settings.menu, included from kde-essential.menu kbuildsycoca 2> /dev/null | grep Settings-Modules @@ -2330,12 +2315,12 @@ 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 +In &tde; 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. +everyone. Individual configuration modules can be disables by adding the @@ -2351,12 +2336,12 @@ Konqueror dialog if the proxy configuration is still there. -