From 504dfac148d5fdaaa88c7b932284329bc5d4e6a8 Mon Sep 17 00:00:00 2001 From: Darrell Anderson Date: Mon, 24 Mar 2014 17:45:49 -0500 Subject: Update Admin Guide. --- doc/adminguide/groupware-kontact.docbook | 2 +- doc/adminguide/index.docbook | 265 +++++++++++++------------------ 2 files changed, 114 insertions(+), 153 deletions(-) diff --git a/doc/adminguide/groupware-kontact.docbook b/doc/adminguide/groupware-kontact.docbook index b18313931..273ba4f54 100644 --- a/doc/adminguide/groupware-kontact.docbook +++ b/doc/adminguide/groupware-kontact.docbook @@ -38,7 +38,7 @@ 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 &tde; 3.4. I access +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, diff --git a/doc/adminguide/index.docbook b/doc/adminguide/index.docbook index 720db0ba2..dd24a1cdc 100644 --- a/doc/adminguide/index.docbook +++ b/doc/adminguide/index.docbook @@ -41,8 +41,8 @@ -KDE TDE +administration desktop handbook tutorial @@ -58,11 +58,11 @@ This handbook is a reference guide to some &tde; features that are useful to administrators configuring -multi-user systems. This part also has information that might be useful +multi-user systems. This guide also has information useful to &tde; users with single-user systems: where configuration files are stored, what environment variables affect &tde;, and so on. The KIOSK -framework is the &tde; system which allows administrators to limit -what users can do in &tde;. That framework is potentially useful in many +framework is the &tde; system that allows administrators to limit +what users can do in &tde;. That framework is useful in many situations, but especially for running single-function kiosks with, for example, only a web browser, hence the name. @@ -90,31 +90,30 @@ class="directory">/opt/trinity). additional trees can be used for profiles -&SuSE; &Linux; for example uses: +For example: $HOME/.trinity /opt/trinity. (This is -&SuSE;-specific; other distributions may use +class="directory">/opt/trinity. (This location is a +typical default. Some distributions might use /usr or /usr/trinity) /etc/opt/trinity. (This was added by -&SuSE;). +class="directory">/etc/trinity. -If you have the KIOSK Admin tool v0.7 or later installed you can +If you have the KIOSK Admin tool installed you can check which directory trees are used with the following command: kiosktool-tdedirs &tde; and &tde; applications look up files by scanning all the -&tde; directory trees. The directory trees are checked in order of +&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 +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. @@ -128,7 +127,7 @@ class="directory">$HOME/.trinity/share/mimelnk/text/plain.desktop /opt/trinity/share/mimelnk/text/plain.desktop /etc/opt/trinity/share/mimelnk/text/plain.desktop +class="directory">/etc/trinity/share/mimelnk/text/plain.desktop If a user makes a change, the change is written to -/etc/opt/trinity/share/config/foobar +/etc/trinity/share/config/foobar Color=blue Position=10,10 @@ -203,7 +202,7 @@ root writing to $TDEHOME of the user after running /opt/trinity, /usr, /usr/trinity -Vendor dependent. Used by &tde; 2. If not set, falls back to +Vendor dependent. If not set, falls back to compiled-in default. @@ -212,15 +211,13 @@ compiled-in default. /opt/trinity, /usr, /usr/trinity -New in &tde;3. Can list multiple locations separated by a +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 &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 @@ -228,7 +225,7 @@ settings: TDEHOME='~/.trinity' TDEROOTHOME='/root/.trinity' -TDEDIRS='/opt/kde_staff:/opt/trinity' +TDEDIRS='/opt/tde_staff:/opt/trinity' @@ -239,21 +236,19 @@ TDEDIRS='/opt/kde_staff:/opt/trinity' User Profiles In the previous example /opt/kde_staff contained additional settings +class="directory">/opt/tde_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 +to add this directory only for certain users and not for others. Add the following to /etc/tderc: [Directories-staff] -prefixes=/opt/kde_staff +prefixes=/opt/tde_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/tderc. Now that we have a named profile it +/opt/tde_staff directory +tree. 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 @@ -261,7 +256,7 @@ can be assigned to users. [Directories] -userProfileMapFile=/etc/kde-user-profile +userProfileMapFile=/etc/tde-user-profile It is now possible to assign a profile based on either the user name @@ -269,7 +264,7 @@ 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: +/etc/tde-user-profile: [General] @@ -319,8 +314,7 @@ directory tree. lib/trinity This directory contains components, plugins, and other -runtime loadable objects for use by &tde; 3.x -applications. +runtime loadable objects for use by &tde; applications. @@ -336,7 +330,7 @@ archs. share/applnk .desktop files for -&tde;-menu (old) +&tde;-menu (legacy) @@ -471,7 +465,7 @@ is used for various &UNIX; sockets. $TDEHOME/tmp-$HOSTNAME Usually /tmp/kde-$USER/, this is used for temporary files. +class="directory">/tmp/tde-$USER/, this is used for temporary files. @@ -496,7 +490,7 @@ an alternative name and link to that instead. 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 &tde; configuration +key-value pairs that are placed in groups. All &tde; configuration files use UTF-8 encoding for text outside the ASCII range. @@ -528,7 +522,7 @@ 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 +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: @@ -577,12 +571,12 @@ application updates a configuration file the comments are There can be multiple configuration files with the same name in the share/config sub-directory of the various &tde; directory trees. In this case the information of all these -configuration files is combined on a key-by-key basis. If the same key +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 $TDEHOME always have the highest -precedence. If a key in a certain group is defined multiple times in a +precedence. If a key in a certain group is defined multiple times in a single file, the value of the last entry is used. @@ -593,7 +587,7 @@ contains: Color=red Shape=circle -and /etc/opt/trinity/share/config/foobar contains +and /etc/trinity/share/config/foobar contains [MyGroup] Color=blue @@ -620,13 +614,13 @@ Shape=circle [MyGroup] Color=green -and /opt/kde_staff/share/config/foobar contains +and /opt/tde_staff/share/config/foobar contains [MyGroup] Color=purple Position=20,20 -and /etc/opt/trinity/share/config/foobar contains +and /etc/trinity/share/config/foobar contains [MyGroup] Color=blue @@ -643,7 +637,7 @@ Position=20,20 To prevent users being able to override default settings, -settings can be marked immutable. Settings can be made immutable +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, ⪚: @@ -672,7 +666,7 @@ Color[$i]=blue Color=red Shape=circle -and /etc/opt/trinity/share/config/foobar contains: +and /etc/trinity/share/config/foobar contains: [MyGroup][$i] Color=blue @@ -695,13 +689,13 @@ Position=10,10 Color=red Shape=circle -and /opt/kde_staff/share/config/foobar contains +and /opt/tde_staff/share/config/foobar contains [MyGroup] Color=purple Shape=rectangle -and /etc/opt/trinity/share/config/foobar contains +and /etc/trinity/share/config/foobar contains [MyGroup][$i] Color=blue @@ -721,11 +715,11 @@ 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 +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. +using [$ie]. The user can't change it then of course. In the following example the value for the Host @@ -782,9 +776,7 @@ Caption[fr]=Ma Légende In general the entries that can appear in a configuration file are not -documented. With &tde; 3.2 a start has been made to change this. In -$TDEDIR/share/config.kcfg, files +documented. 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 &tde; Configuration Editor when available. @@ -827,7 +819,7 @@ Auto Save Interval=25 &tdm; -Always runs as root! Uses +&tdm; always runs as root. &tdm; uses $TDEDIR/share/config/tdmrc and /etc/X11/xdm/Xservers. The latter contains entries like: @@ -854,7 +846,7 @@ Startup - /etc/X11/xdm/Xstartup - prepare as root Session - /etc/X11/xdm/Xsession - starts session as user -= For a TDE session: kde or starttde += For a TDE session: tde or starttde = If present ~/.xsession or ~/.xinitrc @@ -872,27 +864,27 @@ Reset - /etc/X11/xdm/Xreset - after session finished 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 +are two important lines in the starttde script: -LD_BIND_NOW=true tdeinit +kcminit +knotify and kwrapper -ksmserver $TDEWM +LD_BIND_NOW=true $TDEDIR/bin/start_tdeinit_wrapper --new-startup +kcminit_startup +$TDEDIR/bin/tdeinit_phase1 The first line starts the tdeinit master process. The tdeinit master process is used to start all other -&tde; processes. It show up in the output of ps +&tde; processes. It shows up in the output of ps as tdeinit: Running.... The arguments after tdeinit -are the names of additional processes to be started. The + +are the names of additional processes to be started. The + indicates that tdeinit needs to wait till the process has -finished. tdeinit also starts +finished. tdeinit also starts dcopserver, tdelauncher and kded. The second of the two lines asks tdeinit to start -the ksmserver session manager process. The session +the ksmserver session manager process. The session manager determines the lifetime of the session. When this process exits, the user is logged out. @@ -957,10 +949,9 @@ needed <command>tdeinit</command> 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 -program files but can be started more efficiently. KLMs -live in tdeinit loadable modules. Loadable modules +work just like binary program files but can be started more efficiently. +Loadable modules live in $TDEDIR/lib/trinity The drawback is that programs started this way appear as @@ -983,7 +974,7 @@ knotify tdeinit: Running... indicates the master tdeinit process. The other processes listed are -programs started as KLMs. +programs started as loadable modules. When tdeinit starts for the first time it will launch dcopserver, tdelauncher, and @@ -1095,11 +1086,11 @@ methods. 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 +applications from the previous session. The applications to auto-start are indicated by .desktop files in the $TDEDIR/share/autostart -directory. Whether or not to auto-start an application can be made +directory. Whether or not to auto-start an application can be made conditional upon some configuration entry determined by the X-TDE-autostart-condition entry in the .desktop file. @@ -1150,7 +1141,7 @@ are: -&klipper; +&klipper; A clipboard utility that docks in the panel @@ -1173,7 +1164,7 @@ role="extension">.desktop files. 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 +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 /usr/local/share/:/usr/share/ &tde; adds locations from $TDEDIRS and profiles -as well. Used for .desktop and +as well. Used for .desktop and .directory menu files. .desktop files under $XDG_DATA_DIRS/applications. @@ -1338,14 +1329,14 @@ $XDG_DATA_DIRS/desktop-directories $XDG_CONFIG_HOME -(&tde; 3.2) - Defines the base directory relative to which user + - Defines the base directory relative to which user specific configuration files should be stored. Default is $HOME/.config. $XDG_CONFIG_DIRS -(&tde; 3.2) - Defines the preference-ordered set of base directories +- 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 &tde; adds locations from $TDEDIRS and profiles as well. Used by .menu descriptions in @@ -1364,9 +1355,8 @@ $TDEDIRS and profiles as well. Used by 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 -program files but can be started more efficiently. KLMs +as well as tdeinit loadable modules. Loadable modules work just like binary +program files but can be started more efficiently. Loadable modules live in $TDEDIR/lib/trinity @@ -1412,7 +1402,7 @@ package. - + Customizing &tde; @@ -1436,7 +1426,7 @@ package. -Vendor-specific (⪚ &SuSE;'s My Computer) +Vendor-specific @@ -1447,14 +1437,14 @@ Links to Websites using .desktop file: Create NewFileLink to Location (URL). Change Icon using -Properties dialogs. The resulting Properties dialogs. The resulting .desktop file: [Desktop Entry] Encoding=UTF-8 Icon=/opt/trinity/share/apps/kdesktop/pics/ksslogo.png Type=Link -URL=http://www.kde.org/ +URL=http://www.trinitydesktop.org/ @@ -1658,19 +1648,17 @@ copied from /etc/skel/Desktop $TDEDIR/apps/kdesktop/Desktop +class="directory">$TDEDIR/share/apps/kdesktop/Desktop (merged) $TDEDIR/apps/kdesktop/DesktopLinks +class="directory">$TDEDIR/share/apps/kdesktop/DesktopLinks (copied) Device Icons (dynamically merged) -Distribution Specific SUSE Linux copies certain icons -in starttde.theme from /opt/trinity/share/config/SuSE/default/ +Distribution Specific @@ -1683,36 +1671,21 @@ class="directory">/opt/trinity/share/config/SuSE/default/ How it Works -In &tde; 3.2 a common menu format is introduced at +A common menu format is used as defined at http://freedesktop.org/Standards/menu-spec/ -Before &tde; 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 &tde; 3.2 so the -new menu format: +The menu format: Defines structure in a single .menu file Is based on categories -is shared between GNOME and &tde; +is shared between &tde;, &kde;, GNOME, and Xfce Supports applnk style menus as well -Example from kde-applications.menu: +Example from tde-applications.menu: <Menu> @@ -1747,7 +1720,7 @@ Reader.desktop .menu files describing the menu structure. The files are stored in $TDEDIR/etc/xdg/menus and +class="directory">$TDEDIR/xdg/menus and /etc/xdg/menus. These store the system-wide menu structure and are controlled by $XDG_CONFIG_DIRS. XDG_DATA_HOME. For more information, see http://www.freedesktop.org/Standards/basedir-spec -Example from kde-applications.menu: +Example from tde-applications.menu: <Menu> @@ -1838,25 +1811,20 @@ role="extension">.directory file Essential Menus $TDEDIR/etc/xdg/menus/applications-merged/ -contains kde-essential.menu which includes some +class="directory">/etc/trinity/xdg/menus/applications-merged/ +contains tde-essential.menu which includes some 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 -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. +contents are defined by tde-settings.menu and +whose icon and name are defined by tde-settings.directory - Screensavers contains a hidden System/Screensavers menu, whose contents are defined by -kde-screensavers.menu and whose icon and name +tde-screensavers.menu and whose icon and name are defined by -kde-system-screensavers.directory. -$TDEDIR/share/desktop-directories/kde-system-screensavers.directory +tde-system-screensavers.directory. +$TDEDIR/share/desktop-directories/tde-system-screensavers.directory contains: NoDisplay=true @@ -1878,8 +1846,8 @@ class="directory">$HOME/.trinity/share/applnk -<application>KSycoca</application> -KSycoca caches menu structure and +<application>TDESycoca</application> +TDESycoca caches menu structure and information about all available applications. You can rebuild the database with tdebuildsycoca. The database @@ -1890,7 +1858,7 @@ checked during &tde; 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: +the following to tdedrc: [General] CheckSycoca=false @@ -2014,7 +1982,7 @@ default for multiple users. - + Locking Down &tde; @@ -2066,10 +2034,10 @@ presented with an user interface option to make such change. &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 +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 +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 @@ -2103,8 +2071,9 @@ action="simul">&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: @@ -2190,7 +2159,7 @@ automatically or via a hyperlink. -Rules are checked in the order in which they are defined. The last +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. @@ -2217,7 +2186,7 @@ rules. opening of any http or https &URL; allows the opening of any http and https &URL; in the .ourcompany.com domain. Note the wildcard +class="domainname">.ourcompany.com domain. Note the wildcard * is only allowed at the start of a domain. @@ -2244,7 +2213,7 @@ directory. $HOME and $TMP are special values to indicate the users home directory and the &tde; temporary directory of the -user, ⪚ /tmp/kde-bastian +user, ⪚ /tmp/tde-bastian The following rules makes that the user can no longer open local files that are outside his $HOME directory: @@ -2266,7 +2235,7 @@ opening of any local file allows opening files under the users own $HOME directory. allows opening -files in the &tde; temporary directory of the user. This is needed by +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. @@ -2274,7 +2243,7 @@ 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 +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. @@ -2345,6 +2314,8 @@ as part of the Configure Konqueror dialog in tdecmshell tde-proxy.desktop +tdecmshell +tde-proxy tdecmshell proxy @@ -2362,8 +2333,8 @@ menu. have a .desktop file in $TDEDIR/share/applications/tde and are sorted under the hidden Settings-Modules menu by -the kde-settings.menu, included from -kde-essential.menu +the tde-settings.menu, included from +tde-essential.menu tdebuildsycoca 2> /dev/null | grep Settings-Modules @@ -2373,15 +2344,15 @@ corresponds to the hidden .hidden menu, included as a result of <KDELegacyDirs/> tdebuildsycoca 2> /dev/null | grep .hidden -In &tde; 3.3 it is possible to edit the Control Center with +It is possible to edit the Control Center with kcontroledit. -kcontroledit works just like +kcontroledit works like kmenuedit, changes for current user only. Use kiosktool to make changes for everyone. -Individual configuration modules can be disables by adding the +Individual configuration modules can be disabled by adding the following to kdeglobals: [TDE Control Module Restrictions] @@ -2394,17 +2365,7 @@ Konqueror dialog if the proxy configuration is still there. - @@ -2455,7 +2416,7 @@ http://www.suse.de/~nashif/autoinstall/index.html 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 +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 @@ -2467,13 +2428,13 @@ 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, +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 +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 +on port 5900 by default. When an incoming connection is made, a dialog will appear to ask for confirmation by the current user. @@ -2512,7 +2473,7 @@ Applications that can open more than one window at a time will be listed as -All the arguments are case-sensitve. setFullScreen and setfullscreen are two different functions. +All the arguments are case-sensitve. setFullScreen and setfullscreen are two different functions. @@ -2654,7 +2615,7 @@ into this file the following lines: mykey=false Instead of you can also use - and , as appropriate. For + and , as appropriate. For instance, you might use kdialog or kdialog . @@ -2705,7 +2666,7 @@ icon With Yes, No -and Cancel button. For example: +and Cancel button. For example: kdialog @@ -2716,7 +2677,7 @@ to save the changes?' 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 +"YourName"). The last argument is optional, it is used to pre-fill the dialog. password=$(kdialog ) @@ -2748,7 +2709,7 @@ list: city=$(kdialog ) -Madrid and Paris will be pre-selected. The result with Madrid and +Madrid and Paris will be pre-selected. The result with Madrid and Paris selected will be "b" "c". -- cgit v1.2.1