Trinity Desktop Project Wiki - User contributions [en]

Template:DistroTable

2025-09-13T16:39:51Z

Blu256: /* Example */ Add gentoo

This template provides a '''table with installation instructions''' per distribution/operating system. It also tells the latest available version of TDE for that system.

When there is a new release available for one of these systems, you only need to change the available version here; all the pages that use this template will show the updated data automatically.

Mark the latest release with <span style="background: lightgreen;">lightgreen</span>, the release before it with <span style="background: yellow;">yellow</span> and older releases with <span style="background: orange;">orange</span>.

If there is something important that should be noticed about packages (e.g. pending builds) consider adding them below the table in a [[:Template:TipBox|TipBox]] or a [[:Template:WarningBox|WarningBox]] appropriately.

= Example =

This is how it will look on the page:

<onlyinclude>{|
| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="2" | <big>Official Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
|-
| [[Debian Trinity Repository Installation Instructions|Debian]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Devuan Trinity Repository Installation Instructions|Devuan]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Fedora Trinity Repository Installation Instructions|Fedora]]
| style="background: lightgreen;" | R14.1.4
|-
| [[RedHat Trinity Repository Installation Instructions|RedHat]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Ubuntu Trinity Repository Installation Instructions|Ubuntu]]
| style="background: lightgreen;" | R14.1.4
|}

| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="4" | <big>Community Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
| '''Distribution'''
| '''Latest'''
|-
| [[Arch Trinity Repository Installation Instructions|Arch Linux]]
| style="background: lightgreen;" | R14.1.4
| [[MX Linux Trinity Repository Installation Instructions|MX Linux]]
| style="background: lightgreen;" | R14.1.4
|-
| [[FreeBSD Trinity Installation Instructions|FreeBSD]]
| style="background: lightgreen;" | R14.1.4 
| [[OpenSUSE Trinity Repository Installation Instructions|OpenSUSE]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Mageia Trinity Repository Installation Instructions|Mageia]]
| style="background: lightgreen;" | R14.1.4
| [[PCLinuxOS Trinity Repository Installation Instructions|PCLinuxOS]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Slackware Trinity Installation Instructions|Slackware]]
| style="background: lightgreen;" | R14.1.4
| [https://wiki.gentoo.org/wiki/Trinity_Desktop_Environment Gentoo]
| style="background: lightgreen;" | latest git
|-
| [[Raspbian Trinity Repository Installation Instructions|Raspbian]]
| style="background: lightgreen;" | R14.1.4
|}
|-
|colspan=2|
{| class="wikitable" style="width: 100%; margin: 0;"
|Building from source code: '''[[How to Build TDE Core Modules|base]]''' | '''[[How to Build Extra Applications|extra]]'''
|style="text-align: center;"|[[LiveCDs|Try a LiveCD]]
|}
|}
</onlyinclude>

Template:DistroTable

2025-05-02T17:37:17Z

Blu256: Update Slackware version to R14.1.4 (Ray-V slackbuilds)

This template provides a '''table with installation instructions''' per distribution/operating system. It also tells the latest available version of TDE for that system.

When there is a new release available for one of these systems, you only need to change the available version here; all the pages that use this template will show the updated data automatically.

Mark the latest release with <span style="background: lightgreen;">lightgreen</span>, the release before it with <span style="background: yellow;">yellow</span> and older releases with <span style="background: orange;">orange</span>.

If there is something important that should be noticed about packages (e.g. pending builds) consider adding them below the table in a [[:Template:TipBox|TipBox]] or a [[:Template:WarningBox|WarningBox]] appropriately.

= Example =

This is how it will look on the page:

<onlyinclude>{|
| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="2" | <big>Official Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
|-
| [[Debian Trinity Repository Installation Instructions|Debian]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Devuan Trinity Repository Installation Instructions|Devuan]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Fedora Trinity Repository Installation Instructions|Fedora]]
| style="background: yellow;" | R14.1.3
|-
| [[RedHat Trinity Repository Installation Instructions|RedHat]]
| style="background: yellow;" | R14.1.3
|-
| [[Ubuntu Trinity Repository Installation Instructions|Ubuntu]]
| style="background: lightgreen;" | R14.1.4
|}

| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="4" | <big>Community Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
| '''Distribution'''
| '''Latest'''
|-
| [[Arch Trinity Repository Installation Instructions|Arch Linux]]
| style="background: lightgreen;" | R14.1.4
| [[MX Linux Trinity Repository Installation Instructions|MX Linux]]
| style="background: yellow;" | R14.1.3
|-
| [[FreeBSD Trinity Installation Instructions|FreeBSD]]
| style="background: lightgreen;" | R14.1.4 
| [[OpenSUSE Trinity Repository Installation Instructions|OpenSUSE]]
| style="background: yellow;" | R14.1.3
|-
| [[Mageia Trinity Repository Installation Instructions|Mageia]]
| style="background: yellow;" | R14.1.3
| [[PCLinuxOS Trinity Repository Installation Instructions|PCLinuxOS]]
| style="background: yellow;" | R14.1.3
|-
| [[Slackware Trinity Installation Instructions|Slackware]]
| style="background: lightgreen;" | R14.1.4
|-
| [[Raspbian Trinity Repository Installation Instructions|Raspbian]]
| style="background: lightgreen;" | R14.1.4
|}
|-
|colspan=2|
{| class="wikitable" style="width: 100%; margin: 0;"
|Building from source code: '''[[How to Build TDE Core Modules|base]]''' | '''[[How to Build Extra Applications|extra]]'''
|style="text-align: center;"|[[LiveCDs|Try a LiveCD]]
|}
|}
</onlyinclude>

Slackware Trinity Installation Instructions

2025-05-02T17:36:25Z

Blu256: Update branch name

[[Category:Documentation]]
[[Category:Installation]]

Even though there is no official packaging of Trinity for Slackware, there are still to unofficial two ways to do so. Installation from binary packages is the easier solution, but installation from SlackBuilds offers a greater degree of control over the installation process.

== SlackBuilds ==
SlackBuilds are available in the [https://github.com/Ray-V/tde-slackbuilds Ray-V/tde-slackbuilds] repo on GitHub (also mirrored on TGW at [https://git.trinitydesktop.org/gitea/SlavekB/tde-packaging-slackware SlavekB/tde-packaging-slackware]).

To build Trinity run the `BUILD-TDE.sh` script and follow the on-screen instructions. An example of the process is available [https://ray-v.github.io/A_typical_TDE_SlackBuild.html here].

SlackBuilds for packages not included in Ray-V's repo can be built using an unofficial [https://github.com/blu256/tde-slackbuild-gen special SlackBuild generator], provided by a member of the Trinity team.

=== Notes on Ray-V's Slackbuilds ===
* By default you are presented with the choice between the archive of the last release and either the <tt>r14.1.x</tt> or the <tt>master</tt> development branches. If you want to test out another branch (e.g. as a developer) you can use the environment variable <tt>$FEAT</tt> to set the branch name.

== Binary packages ==

There are no official binary packages for Slackware at this time.

Unofficial packaging of TDE can be found in various places on the Internet, including the [https://sourceforge.net/projects/tde-slackware/files tde-slackware] project on SourceForge.

{{WarningBox
|text=Be careful when installing packages from an untrusted source!
}}

Trinity Desktop Environment

2025-01-28T12:03:57Z

Blu256: /* Current release */ float right the distro table

The '''[http://trinitydesktop.org Trinity Desktop Environment]''' (TDE) project is a feature rich desktop environment for Unix-like operating systems with a primary goal of retaining a traditional, efficient and productive user interface.

TDE was born as a fork of the K Desktop Environment version 3.5, which was originally written by the KDE Team, a world-wide network of software engineers committed to Free Software development. The name Trinity was chosen because the word means Three as in continuation of KDE 3. Since then, TDE has evolved to be an independent and standalone desktop environment project. Over time, continued development has polished off many rough edges that were present in the final release of KDE 3.5.10 and many new and useful features have been added to keep the environment up-to-date.

__TOC__

== Current release ==

<div style="float: right">{{DistroTable}}</div>

The current stable release of TDE is '''R14.1.3'''. The key highlights from this release are:
* initial integration with the XDG Desktop Portal API
* TDE Control Center module for touchpad settings
* new mallory twin theme
* support for window tiling through context menu
* tde-ebook-reader, a TQt port of FBReader
* Solarized color themes for Konsole
* support for back/forward history mouse buttons in various applications
* support for Python 3.13
* a TQt for of UniversalIndentGUI to ease source code formatting
* SFTP connection option for knetattach
* khotkeys running as a kded module rather than standalone
* ksirc functional again
* various enhancements or bug fixes to TQt3 and various applications
Refer to the [[Release_Notes_For_R14.1.3|full release notes]] for further details and screenshots.

== Contributing ==

The TDE development team is small but friendly. Anyone wanting to join the development process and help create the next TDE release is welcome!<br/>
You don't need to be a programmer to do so: you can contribute translations, artwork or other stuff! If you wish to participate, please take a look at the following links:
* [[TDE Gitea Workspace]]: this is the main place for developers and for contributing code.
* [[TDE Weblate Translation Workspace]] user guide: this is the main place for translations.
* [https://wiki.trinitydesktop.org/Category:Developers#New_to_Trinity_development.3F Developers] section on Wiki
* [https://www.trinitydesktop.org/helpwanted.php Get involved] page on the main TDE website.

If you want to contribute to this wiki please read the [[TDE Wiki Style Guideline|formatting guidelines]] first. Consider updating pages that contain [[:Category:Pages with outdated information (KDE3)|KDE3-specific]] or [[:Category:Pages with outdated information|outdated]] information.

== Donating ==

Please consider helping with a small donation on our [https://www.trinitydesktop.org/donate.php donations page] if you wish to support the TDE project and its infrastructure, Without your financial assistance, TDE would not be possible!

== Roadmap ==

{{:Project RoadMap}}

== Browse the TDE Wiki ==

{| style=width:100%

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Installation|Installation]]
| [[:Category:Community|Community]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Installation}}
| {{Category:Community}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Releases|Releases]]
| [[:Category:Developers|Developers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Releases}}
| {{Category:Developers}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[Tips And Tricks]]
| [[:Category:Packagers|Packagers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{:Tips And Tricks}}
| {{Category:Packagers}}

|- style=background:#A0CAEF;text-align:center;font-weight:bold;
| colspan=2 | [[Special:Categories|Show all Categories in the TDE Wiki]]

|}

Trinity Desktop Environment

2025-01-28T12:03:18Z

Blu256: μ

The '''[http://trinitydesktop.org Trinity Desktop Environment]''' (TDE) project is a feature rich desktop environment for Unix-like operating systems with a primary goal of retaining a traditional, efficient and productive user interface.

TDE was born as a fork of the K Desktop Environment version 3.5, which was originally written by the KDE Team, a world-wide network of software engineers committed to Free Software development. The name Trinity was chosen because the word means Three as in continuation of KDE 3. Since then, TDE has evolved to be an independent and standalone desktop environment project. Over time, continued development has polished off many rough edges that were present in the final release of KDE 3.5.10 and many new and useful features have been added to keep the environment up-to-date.

__TOC__

== Current release ==

{{DistroTable}}

The current stable release of TDE is '''R14.1.3'''. The key highlights from this release are:
* initial integration with the XDG Desktop Portal API
* TDE Control Center module for touchpad settings
* new mallory twin theme
* support for window tiling through context menu
* tde-ebook-reader, a TQt port of FBReader
* Solarized color themes for Konsole
* support for back/forward history mouse buttons in various applications
* support for Python 3.13
* a TQt for of UniversalIndentGUI to ease source code formatting
* SFTP connection option for knetattach
* khotkeys running as a kded module rather than standalone
* ksirc functional again
* various enhancements or bug fixes to TQt3 and various applications
Refer to the [[Release_Notes_For_R14.1.3|full release notes]] for further details and screenshots.

== Contributing ==

The TDE development team is small but friendly. Anyone wanting to join the development process and help create the next TDE release is welcome!<br/>
You don't need to be a programmer to do so: you can contribute translations, artwork or other stuff! If you wish to participate, please take a look at the following links:
* [[TDE Gitea Workspace]]: this is the main place for developers and for contributing code.
* [[TDE Weblate Translation Workspace]] user guide: this is the main place for translations.
* [https://wiki.trinitydesktop.org/Category:Developers#New_to_Trinity_development.3F Developers] section on Wiki
* [https://www.trinitydesktop.org/helpwanted.php Get involved] page on the main TDE website.

If you want to contribute to this wiki please read the [[TDE Wiki Style Guideline|formatting guidelines]] first. Consider updating pages that contain [[:Category:Pages with outdated information (KDE3)|KDE3-specific]] or [[:Category:Pages with outdated information|outdated]] information.

== Donating ==

Please consider helping with a small donation on our [https://www.trinitydesktop.org/donate.php donations page] if you wish to support the TDE project and its infrastructure, Without your financial assistance, TDE would not be possible!

== Roadmap ==

{{:Project RoadMap}}

== Browse the TDE Wiki ==

{| style=width:100%

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Installation|Installation]]
| [[:Category:Community|Community]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Installation}}
| {{Category:Community}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Releases|Releases]]
| [[:Category:Developers|Developers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Releases}}
| {{Category:Developers}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[Tips And Tricks]]
| [[:Category:Packagers|Packagers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{:Tips And Tricks}}
| {{Category:Packagers}}

|- style=background:#A0CAEF;text-align:center;font-weight:bold;
| colspan=2 | [[Special:Categories|Show all Categories in the TDE Wiki]]

|}

Trinity Desktop Environment

2025-01-28T12:02:46Z

Blu256: Add heading to categories table so that it shows up in TOC

The '''[http://trinitydesktop.org Trinity Desktop Environment]''' (TDE) project is a feature rich desktop environment for Unix-like operating systems with a primary goal of retaining a traditional, efficient and productive user interface.

TDE was born as a fork of the K Desktop Environment version 3.5, which was originally written by the KDE Team, a world-wide network of software engineers committed to Free Software development. The name Trinity was chosen because the word means Three as in continuation of KDE 3. Since then, TDE has evolved to be an independent and standalone desktop environment project. Over time, continued development has polished off many rough edges that were present in the final release of KDE 3.5.10 and many new and useful features have been added to keep the environment up-to-date.

== Current release ==

{{DistroTable}}

The current stable release of TDE is '''R14.1.3'''. The key highlights from this release are:
* initial integration with the XDG Desktop Portal API
* TDE Control Center module for touchpad settings
* new mallory twin theme
* support for window tiling through context menu
* tde-ebook-reader, a TQt port of FBReader
* Solarized color themes for Konsole
* support for back/forward history mouse buttons in various applications
* support for Python 3.13
* a TQt for of UniversalIndentGUI to ease source code formatting
* SFTP connection option for knetattach
* khotkeys running as a kded module rather than standalone
* ksirc functional again
* various enhancements or bug fixes to TQt3 and various applications
Refer to the [[Release_Notes_For_R14.1.3|full release notes]] for further details and screenshots.

== Contributing ==

The TDE development team is small but friendly. Anyone wanting to join the development process and help create the next TDE release is welcome!<br/>
You don't need to be a programmer to do so: you can contribute translations, artwork or other stuff! If you wish to participate, please take a look at the following links:
* [[TDE Gitea Workspace]]: this is the main place for developers and for contributing code.
* [[TDE Weblate Translation Workspace]] user guide: this is the main place for translations.
* [https://wiki.trinitydesktop.org/Category:Developers#New_to_Trinity_development.3F Developers] section on Wiki
* [https://www.trinitydesktop.org/helpwanted.php Get involved] page on the main TDE website.

If you want to contribute to this wiki please read the [[TDE Wiki Style Guideline|formatting guidelines]] first. Consider updating pages that contain [[:Category:Pages with outdated information (KDE3)|KDE3-specific]] or [[:Category:Pages with outdated information|outdated]] information.

== Donating ==

Please consider helping with a small donation on our [https://www.trinitydesktop.org/donate.php donations page] if you wish to support the TDE project and its infrastructure, Without your financial assistance, TDE would not be possible!

== Roadmap ==

{{:Project RoadMap}}

<hr/>

== Browse the TDE Wiki ==

{| style=width:100%

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Installation|Installation]]
| [[:Category:Community|Community]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Installation}}
| {{Category:Community}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Releases|Releases]]
| [[:Category:Developers|Developers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Releases}}
| {{Category:Developers}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[Tips And Tricks]]
| [[:Category:Packagers|Packagers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{:Tips And Tricks}}
| {{Category:Packagers}}

|- style=background:#A0CAEF;text-align:center;font-weight:bold;
| colspan=2 | [[Special:Categories|Show all Categories in the TDE Wiki]]

|}

Project RoadMap

2025-01-28T12:01:34Z

Blu256: Only include the roadmap table when transcluding page

[[Category:Developers]]

==Release Schedule and tentative objectives==
<onlyinclude>
{| class="wikitable"
|-
!Version
!Date
!Roadmap
!Release notes
|-
|R14.1.2
|2024-Apr-28
|
|style="text-align:center;" | [https://wiki.trinitydesktop.org/Release_Notes_For_R14.1.2 link]
|-
|R14.1.3
|2024-Oct-27
|
|style="text-align:center;" | [https://wiki.trinitydesktop.org/Release_Notes_For_R14.1.3 link]
|-
|R14.1.4
|2025-Apr-27
|style="text-align:center;" | [https://mirror.git.trinitydesktop.org/gitea/TDE/tde/wiki/General-roadmap-for-R14.1.4 link]
|
|-
|R14.2.0
|2028-Apr-30
|style="text-align:center;" | [https://mirror.git.trinitydesktop.org/gitea/TDE/tde/wiki/General-roadmap-for-R14.2.0 link]
|}
</onlyinclude>

Trinity Desktop Environment

2025-01-28T11:59:51Z

Blu256: /* Roadmap */ Transclude roadmap in page

The '''[http://trinitydesktop.org Trinity Desktop Environment]''' (TDE) project is a feature rich desktop environment for Unix-like operating systems with a primary goal of retaining a traditional, efficient and productive user interface.

TDE was born as a fork of the K Desktop Environment version 3.5, which was originally written by the KDE Team, a world-wide network of software engineers committed to Free Software development. The name Trinity was chosen because the word means Three as in continuation of KDE 3. Since then, TDE has evolved to be an independent and standalone desktop environment project. Over time, continued development has polished off many rough edges that were present in the final release of KDE 3.5.10 and many new and useful features have been added to keep the environment up-to-date.

== Current release ==

{{DistroTable}}

The current stable release of TDE is '''R14.1.3'''. The key highlights from this release are:
* initial integration with the XDG Desktop Portal API
* TDE Control Center module for touchpad settings
* new mallory twin theme
* support for window tiling through context menu
* tde-ebook-reader, a TQt port of FBReader
* Solarized color themes for Konsole
* support for back/forward history mouse buttons in various applications
* support for Python 3.13
* a TQt for of UniversalIndentGUI to ease source code formatting
* SFTP connection option for knetattach
* khotkeys running as a kded module rather than standalone
* ksirc functional again
* various enhancements or bug fixes to TQt3 and various applications
Refer to the [[Release_Notes_For_R14.1.3|full release notes]] for further details and screenshots.

== Contributing ==

The TDE development team is small but friendly. Anyone wanting to join the development process and help create the next TDE release is welcome!<br/>
You don't need to be a programmer to do so: you can contribute translations, artwork or other stuff! If you wish to participate, please take a look at the following links:
* [[TDE Gitea Workspace]]: this is the main place for developers and for contributing code.
* [[TDE Weblate Translation Workspace]] user guide: this is the main place for translations.
* [https://wiki.trinitydesktop.org/Category:Developers#New_to_Trinity_development.3F Developers] section on Wiki
* [https://www.trinitydesktop.org/helpwanted.php Get involved] page on the main TDE website.

If you want to contribute to this wiki please read the [[TDE Wiki Style Guideline|formatting guidelines]] first. Consider updating pages that contain [[:Category:Pages with outdated information (KDE3)|KDE3-specific]] or [[:Category:Pages with outdated information|outdated]] information.

== Donating ==

Please consider helping with a small donation on our [https://www.trinitydesktop.org/donate.php donations page] if you wish to support the TDE project and its infrastructure, Without your financial assistance, TDE would not be possible!

== Roadmap ==

{{:Project RoadMap}}

<hr/>

{| style=width:100%

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Installation|Installation]]
| [[:Category:Community|Community]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Installation}}
| {{Category:Community}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[:Category:Releases|Releases]]
| [[:Category:Developers|Developers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{Category:Releases}}
| {{Category:Developers}}

|- style=background:#A0CAEF;font-weight:bold;font-size:125%;
| [[Tips And Tricks]]
| [[:Category:Packagers|Packagers]]

|- style=background:#EFEFEF;height:3em;vertical-align:top;
| {{:Tips And Tricks}}
| {{Category:Packagers}}

|- style=background:#A0CAEF;text-align:center;font-weight:bold;
| colspan=2 | [[Special:Categories|Show all Categories in the TDE Wiki]]

|}

User:Blu256

2025-01-28T11:58:20Z

Blu256: Update

= Contact =
* [[User talk:Blu256|Wiki discussion page]]
* IRC nick: <tt>blu256</tt> (Libera.chat)
* Mail: blu256@proton.me

= TODO list =

Mostly for personal reference. Updated occasionally.

{| class="wikitable"
|+ Currently working on...
! Name
! Type
! Stage
! Target
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/pulls/576 Aesthetic Kicker improvements]
| Feature
| Working on this
| R14.1.4
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/pulls/550 KXkb: Fixes for issues #547 and #548 and other improvements]
| Feature
| Working on this
| R14.1.4
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/koffice/pulls/76 KOffice CMake port]
| Feature
| On hold
| R14.1.x
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/kaffeine/pulls/13 MPV backend for Kaffeine]
| Feature
| On hold
| R14.1.x
|}

{| class="wikitable"
|+ Misc. Planned Stuff
! Name
! Type
! Stage
! Target
|-
| Active borders and corners for TWin
| Feature
| Active borders support in [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/pulls/331 TDE/tdebase#331], more work needed for active corners)
| Active borders: R14.1.1
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/issues/271 Kate: fix font style checkboxes between different schema font tabs]
| Improvement
| On hold
| R14.1.1
|-
| tdeio-mtp
| Feature
| On hold
| R14.2.0
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdelibs/issues/151 Make KSSL use system root certificates]
| Improvement
| On hold
| R14.2.0
|}

== The Big Plans™ ==
Making no commitments here, but this is what I ultimately would like to work on:
* TQt: Misc. new useful APIs
** As soon as CMake port of TQt is complete (the current build system is an undocumented mess)
** TQJson
* TDE Emoji picker
** Not a priority, but an emoji picker would be nice and also very easy to implement after TQt support for Unicode is complete
* WebKit port
** Probably two libraries:
*** TQWebKit: the basic port
*** TDEWebKit: wrapper with TDE enhancements
* OAuth support in KMail
** Literally the only thing stopping me and many GMail users from using it
** Depends on the WebKit port
* A multimedia library for TDE
** Something like Phonon, maybe even Phonon itself

Category:Developers

2024-12-23T13:45:09Z

Blu256: /* Qt3 and TQt */ rename section to just TQt because a Qt3 section was added below

This category contains development-related and API documentation for the Trinity Desktop Environment.<noinclude>

==New to Trinity development?==

Take a look at the following pages:

* [http://trinitydesktop.org/helpwanted.php Getting Involved with Trinity Development]
* [[TDE Gitea Workspace]]
* [[TDE Weblate Translation Workspace]]
* [[Project GIT Information]]
* [[Project RoadMap]]
* [[DevelopmentSpecifications]]
* [https://www.trinitydesktop.org/apidocs.php TQt/TDE API documentation]
* [[Porting to TDE|Porting KDE3/Qt3 apps to Trinity]]

==Building and Distributing Trinity==
* [[Nightly Builds|Installing Nightly Builds]]
* [[How to Build TDE Core Modules]]
* [[How to Build Extra Applications]]

See also pages in [[:Category:Packagers]].

==Tutorials and Documentation==

===TQt===
* [https://www.trinitydesktop.org/docs/qt3 TQt API Documentation]

===Trinity===
* [https://www.trinitydesktop.org/docs/trinity/tdelibs/ TDELibs API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdebase/ TDEBase API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdepim/ TDEPIM API Documentation]
* [[DCOP]], the IPC system used by TDE applications.
* [[TDEParts]], a mechanism for reusing and embedding elaborate widgets into applications (e.g. Konqueror)
* [[TDEIO]], an abstraction that provides network transparency between local and remote filesystems.
* [[TDEConfig XT Tutorial]]
* [[TDEConfig Module HOWTO]]
* [[Debugging TDE applications]]
* [[Sample Applications]]

===Qt3===
Information in this section should be used with care, as it was not written for TQt. However, most of it still applies. If you know of any other interesting Qt3 documentation or tutorials, please add them to this section.

* [https://www.digitalfanatics.org/projects/qt_tutorial/index.html The Independent Qt tutorial] by digitalfanatics.org, an on-line book aiming to cover most topics involved in the process of developing professional quality Qt applications. The text is example driven and filled with lots of tips.

===KDE3===
Information in this section should be used with care, as it was not written for the current version of Trinity. However, much of it still applies. If you know of any other interesting KDE3 documentation or tutorials, please add them to this section.

* [http://api.kde.org/3.5-api/kdelibs-apidocs/index.html KDE 3.5 API Reference]
: The original API reference, at kde.org
* [[KDE3 Architecture]]
: The architecture pages detail how everything was originally supposed to fit together. Ported from the KDE wiki.
* [[KDE3 Tutorials]]
: On everything from using kdevelop to writing dcop-aware applications to creating window themes. Ported from the KDE wiki.
* [[KDE3 Filesystem Hierarchy]]
: Ported from the KDE wiki and verified against a working KDE3 instance.
* [http://www.kde.org/info/requirements/3.5.php KDE3 Compilation Requirements]
: Mandatory and optional packages for building KDE3, most of which are still used by Trinity.

===Books===
====C++ GUI Programming with Qt 3====
Blanchette, Jasmin & Summerfield, Mark. (2015). [https://www.researchgate.net/publication/245591968_C_GUI_Programming_with_Qt_3 C++ GUI Programming with Qt 3]. (ISBN 0-13-124072-2)

Things to note:
* Names changed from "Qt..." to "TQt..."
* compiling by hand needs something like <code>g++ a.cpp $(pkgconf tqt --cflags --libs) -lstdc++</code>
* <code>qmake -project ...</code> will not include the TDE folders, so you'll have to add them manually to the *.pro file
* When in doubt check against the [http://trinitydesktop.org/docs/qt3/ TQt API documentation]

<small>by [https://mail.trinitydesktop.org/mailman3/hyperkitty/list/users@trinitydesktop.org/thread/AY7MVBPGHOJJUHJEV4NSLSLXG7QKQOEF/ Dr. Nikolaus Klepp]</small>

====GUI Programming with Python: QT Edition====
Boudewijn Rempt - Copyright © 2001 by Commandprompt, Inc

The main topic of this book is [http://nclairon.free.fr/documentation/pyqt/book1.htm application development using PyQt.]

==== KDE 2.0 Development ====
David Sweet, et al. (2002). [http://andamooka.org/~dsweet/kde2dev.pdf KDE 2.0 Development].

Covers, among other things, KDE 2.0 widgets, Qt API, actions, icons, custom widget painting, internationalization, network transparency, KParts, DCOP, aRts/MCOP, ImageIO, OpenGL and Mesa, drag and drop, session management, image manipulation, spell checking, and documentation creation.

Mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.

==== KDE 2/Qt Programming Bible ====
Arthur Griffith (2000). [https://box.cs.istu.ru/public/docs/devel/qt/kde%202%20-%20QT.pdf KDE 2/Qt Programming Bible]

Covers KDE 2.x and Qt 2 widgets, mouse and keyboard handling, graphic file formats, fonts, colors, drawing and painting with QPainter, graphics manipulation, drag and drop, IPC and applets, internationalization etc.

Also mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.
</noinclude>

Category:Developers

2024-12-23T13:44:45Z

Blu256: Add Qt3 tutorial by digitalfanatics.org, remove link to TQt interface page

This category contains development-related and API documentation for the Trinity Desktop Environment.<noinclude>

==New to Trinity development?==

Take a look at the following pages:

* [http://trinitydesktop.org/helpwanted.php Getting Involved with Trinity Development]
* [[TDE Gitea Workspace]]
* [[TDE Weblate Translation Workspace]]
* [[Project GIT Information]]
* [[Project RoadMap]]
* [[DevelopmentSpecifications]]
* [https://www.trinitydesktop.org/apidocs.php TQt/TDE API documentation]
* [[Porting to TDE|Porting KDE3/Qt3 apps to Trinity]]

==Building and Distributing Trinity==
* [[Nightly Builds|Installing Nightly Builds]]
* [[How to Build TDE Core Modules]]
* [[How to Build Extra Applications]]

See also pages in [[:Category:Packagers]].

==Tutorials and Documentation==

===Qt3 and TQt===
* [https://www.trinitydesktop.org/docs/qt3 TQt API Documentation]

===Trinity===
* [https://www.trinitydesktop.org/docs/trinity/tdelibs/ TDELibs API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdebase/ TDEBase API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdepim/ TDEPIM API Documentation]
* [[DCOP]], the IPC system used by TDE applications.
* [[TDEParts]], a mechanism for reusing and embedding elaborate widgets into applications (e.g. Konqueror)
* [[TDEIO]], an abstraction that provides network transparency between local and remote filesystems.
* [[TDEConfig XT Tutorial]]
* [[TDEConfig Module HOWTO]]
* [[Debugging TDE applications]]
* [[Sample Applications]]

===Qt3===
Information in this section should be used with care, as it was not written for TQt. However, most of it still applies. If you know of any other interesting Qt3 documentation or tutorials, please add them to this section.

* [https://www.digitalfanatics.org/projects/qt_tutorial/index.html The Independent Qt tutorial] by digitalfanatics.org, an on-line book aiming to cover most topics involved in the process of developing professional quality Qt applications. The text is example driven and filled with lots of tips.

===KDE3===
Information in this section should be used with care, as it was not written for the current version of Trinity. However, much of it still applies. If you know of any other interesting KDE3 documentation or tutorials, please add them to this section.

* [http://api.kde.org/3.5-api/kdelibs-apidocs/index.html KDE 3.5 API Reference]
: The original API reference, at kde.org
* [[KDE3 Architecture]]
: The architecture pages detail how everything was originally supposed to fit together. Ported from the KDE wiki.
* [[KDE3 Tutorials]]
: On everything from using kdevelop to writing dcop-aware applications to creating window themes. Ported from the KDE wiki.
* [[KDE3 Filesystem Hierarchy]]
: Ported from the KDE wiki and verified against a working KDE3 instance.
* [http://www.kde.org/info/requirements/3.5.php KDE3 Compilation Requirements]
: Mandatory and optional packages for building KDE3, most of which are still used by Trinity.

===Books===
====C++ GUI Programming with Qt 3====
Blanchette, Jasmin & Summerfield, Mark. (2015). [https://www.researchgate.net/publication/245591968_C_GUI_Programming_with_Qt_3 C++ GUI Programming with Qt 3]. (ISBN 0-13-124072-2)

Things to note:
* Names changed from "Qt..." to "TQt..."
* compiling by hand needs something like <code>g++ a.cpp $(pkgconf tqt --cflags --libs) -lstdc++</code>
* <code>qmake -project ...</code> will not include the TDE folders, so you'll have to add them manually to the *.pro file
* When in doubt check against the [http://trinitydesktop.org/docs/qt3/ TQt API documentation]

<small>by [https://mail.trinitydesktop.org/mailman3/hyperkitty/list/users@trinitydesktop.org/thread/AY7MVBPGHOJJUHJEV4NSLSLXG7QKQOEF/ Dr. Nikolaus Klepp]</small>

====GUI Programming with Python: QT Edition====
Boudewijn Rempt - Copyright © 2001 by Commandprompt, Inc

The main topic of this book is [http://nclairon.free.fr/documentation/pyqt/book1.htm application development using PyQt.]

==== KDE 2.0 Development ====
David Sweet, et al. (2002). [http://andamooka.org/~dsweet/kde2dev.pdf KDE 2.0 Development].

Covers, among other things, KDE 2.0 widgets, Qt API, actions, icons, custom widget painting, internationalization, network transparency, KParts, DCOP, aRts/MCOP, ImageIO, OpenGL and Mesa, drag and drop, session management, image manipulation, spell checking, and documentation creation.

Mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.

==== KDE 2/Qt Programming Bible ====
Arthur Griffith (2000). [https://box.cs.istu.ru/public/docs/devel/qt/kde%202%20-%20QT.pdf KDE 2/Qt Programming Bible]

Covers KDE 2.x and Qt 2 widgets, mouse and keyboard handling, graphic file formats, fonts, colors, drawing and painting with QPainter, graphics manipulation, drag and drop, IPC and applets, internationalization etc.

Also mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.
</noinclude>

Kmail

2024-09-25T15:31:37Z

Blu256: Blu256 moved page Kmail to KMail: Fix capitalization

#REDIRECT [[KMail]]

KMail

2024-09-25T15:31:37Z

Blu256: Blu256 moved page Kmail to KMail: Fix capitalization

[[Image:Diego Vadell 3.jpg|right|thumb|200px|A user screenshot showing KMail]]

'''KMail''' is the e-mail client of Trinity Desktop. It is part of the <tt>tdepim</tt> package.

The Kontact suite integrates KMail as its embedded e-mail client.

__TOC__

== Tips ==

* You must install and set up the TDE Wallets subsystem to be able to use KMail, but you can make wallets open automatically without entering a password if you don't care about TDE Wallets.

* You can use a specific outgoing account for a specific identity. (see <code>Settings > Identities > Modify > Advanced > Special transport</code>).

== Filters ==

KMail supports e-mail filters. Filters are automated actions that are performed on a folder when new mail arrives, or manually by the user.

=== Advanced example: Automatically decrypt and sanitize incoming mail ===

This is an example how to create a filter in KMail that removes unwanted headers and automatically decrypts incoming mails, so that mail passes through the transport encrypted, but is stored decrypted on the disk.

1. Download [[File:Kmail-decrypt-and-sanitise-mail.gz]] and place it in your <tt>~/bin</tt> folder or any place else suitable for you, extract the archive and make the extracted script executeable.

<syntaxhighlight lang="shell-session">
$ wget https://wiki.trinitydesktop.org/images/c/c1/Kmail-decrypt-and-sanitise-mail.gz
$ tar xf Kmail-decrypt-and-sanitise-mail.gz
$ mv kmail-decrypt-and-sanitise-mail /path/to/destination
$ chmod a+x /path/to/destination/kmail-decrypt-and-sanitise-mail
</syntaxhighlight>

2. Open KMail, go to <code>Settings > Configure Filters</code>.

3. Create a new filter, name it as you like and move it to the top of the list.

4. On the "General" tab leave "Filter Criteria" empty.

5. Set "Filter Actions" to "Pipe Through" and set the program path to <tt>/path/to/destination/kmail-decrypt-and-sanitise-mail</tt>.

6. On the "Advanced" tab uncheck "If this filter matches, stop processing here"

Now all incoming mails get decrypted by default (if a key is present), and some tags (find them on line 45 of the script) are removed (X-UI-Filterresults:, X-GMX-Antivirus:, …).

You can further modify the script to include other automated actions.

== Caveats ==

* KMail does not support OAuth2 yet, which is required by Google and some other e-mail providers. You can try setting up an OAuth2 proxy or use another e-mail client meanwhile.

* Configuring a transport server with a reply address is bugged and doesn't work.

KMail

2024-09-25T15:28:28Z

Blu256: Improve page structure and wording, add screenshot, merge content from Kmail Sanitize and Decrypt Mails

Tips And Tricks

2024-08-15T20:30:06Z

Blu256: /* Application tricks */ Make Kate commands table collapsed by default

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

<code>kside.png</code> is the side image itself, while <code>kside_tile.png</code> is the image that fills the space above the side image if the latter does not fully fit the menu.

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{| class="wikitable"
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

=== Kate: Using the built-in command line ===
You can quickly apply some special settings to an open file without leaving your keyboard, by using the built-in command line in any application that uses the Kate editing part (e.g. Kate itself, KWrite, TDevelop). Press F7 to open it. It will show as a single text field below the document. When you enter a command, it will automatically offer completions, so no need to worry if you are not sure about a command's name (or sometimes even arguments!). Also, the prompt preserves the history of previous successful command runs, which can be navigated using Up/Down movement keys.

You can apply one command per time, the syntax is <code>COMMAND [ARGUMENTS...]</code>. You can set the values for all the variables that you can set through the modeline comment prefixed with "set-" (see the relevant section in the Kate documentation if unsure).

For example, to automatically replace tabs with spaces you can enter: <code>set-replace-tabs true</code>.
To set tab width to 4 spaces: <code>set-tab-width 4</code>.
To change the highlighting to Python: <code>set-highlighting Python</code>.

Of course, the built-in command line also comes with some more advanced commands. External tools and plugins can also add their own commands! You can get a full list of available commands by running <code>help list</code> and get help related to a command by running <code>help <command></code>.

See the table below for some useful commands:
{|class="wikitable mw-collapsible mw-collapsed" style="width: 100%"
!Command
!Arguments
!Description
|-
|help
|[command]
|Show a help message in a tooltip. If no argument is provided, shows a generic help message on using the command line. If the special argument <code>list</code> is specified, lists all available commands. If a command name is provided, tries to find help information related to that command.
|-
|char
|hex, octal or base 9+1
|Inserts a Unicode or ASCII character based on its numeric value (e.g. 0x1234, x1234, 01231, 1234).
|-
|date
|[format string]
|Inserts current date according to the specified format string. If invalid, the default (<code>yyyy-MM-dd hh:mm:ss</code>) is used instead.
|-
|find
|[:[bcerpsw]] string
|Finds the first occurrence of <code>string</code> in the document. Modifiers can be specified after the command by appending a ":", e.g. <code>find:se hello</code>. The meaning of the modifiers is: '''b''' for searching backwards, '''c''' for searching from the current cursor position, '''e''' for searching only inside the selection, '''r''' for evaluating <code>string</code> as a regular expression, '''p''' for showing a prompt each time an occurrence of <code>string</code> is about to be replaced (<code>replace</code> command only), '''s''' makes search case-sensitive and '''w''' makes search look for whole words only, not substrings.
|-
|ifind
|[:[bcrs]] string
|Finds the first occurrence of <code>string</code> interactively. It performs the search again each time a key is pressed.
|-
|replace
|[:[bcerpsw]] string [replacement]
|Replaces all occurrences of <code>string</code> with <code>replacement</code>. If <code>replacement</code> is omitted, it is assumed to be an empty string. For explanation of the modifiers see the description of <code>find</code>.
|-
|indent
|NONE
|Indent current line or selection by one tab stop
|-
|unindent
|NONE
|Unindent current line or selection by one tab stop
|-
|cleanindent
|NONE
|Reset identation of current line or selection
|-
|comment
|NONE
|Comment current line or selection
|-
|uncomment
|NONE
|Uncomment current line or selection
|-
|kill-line
|NONE
|Kills current line, regardless of selection.
|-
|set-indent-mode
|number > 0
|Sets the current indentation mode
|-
|set-highlight
|string
|Set highlighting mode for the current document
|-
|set-tab-width
|number > 0
|Set tab width to <code>number</code> spaces.
|-
|set-indent-width
|number > 0
|Set indentation width to <code>number</code>.
|-
|set-word-wrap-column
|number > 0
|Set column on which word wrapping should occur.
|-
|goto
|number > 0
|Go to line <code>number</code>.
|-
|set-icon-border
|boolean
|Whether to show icon border
|-
|set-folding-markers
|boolean
|Whether to show folding markers
|-
|set-line-numbers
|boolean
|Whether to show line numbers
|-
|set-show-indent
|boolean
|Whether to show indent lines
|-
|set-replace-tabs
|boolean
|Whether to replace tabs with spaces
|-
|set-remove-trailing-space
|boolean
|Whether to automatically remove trailing whitespaces.
|-
|set-remove-trailing-space-save
|boolean
|Whether to remove trailing whitespaces on saving.
|-
|set-show-tabs
|boolean
|Whether to show tab characters. Has no effect on space characters.
|-
|set-indent-spaces
|boolean
|Whether to use spaces instead of tabs for indentation.
|-
|set-mixed-indent
|boolean
|If enabled, enables <code>space-indent</code> and, if <code>indent-width</code> is zero, sets it to <code>tab-width / 2</code>.
|-
|set-word-wrap
|boolean
|Whether to enable word wrapping.
|-
|set-wrap-cursor
|boolean
|Whether the cursor wraps with the text or can assume arbitrary positions in the document. Lines are automatically compensated with the needed spaces.
|-
|run-myself
|NONE
|Execute the current document's text in the built-in Javascript interpreter
|}

Sed-like expressions are also accepted, e.g.:
<code>s/afternoon/abend/g</code>

== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

Tips And Tricks

2024-08-15T20:28:59Z

Blu256: /* Method 2: autostart TDE components from WM */ Added class="wikitable" to table

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

<code>kside.png</code> is the side image itself, while <code>kside_tile.png</code> is the image that fills the space above the side image if the latter does not fully fit the menu.

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{| class="wikitable"
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

=== Kate: Using the built-in command line ===
You can quickly apply some special settings to an open file without leaving your keyboard, by using the built-in command line in any application that uses the Kate editing part (e.g. Kate itself, KWrite, TDevelop). Press F7 to open it. It will show as a single text field below the document. When you enter a command, it will automatically offer completions, so no need to worry if you are not sure about a command's name (or sometimes even arguments!). Also, the prompt preserves the history of previous successful command runs, which can be navigated using Up/Down movement keys.

You can apply one command per time, the syntax is <code>COMMAND [ARGUMENTS...]</code>. You can set the values for all the variables that you can set through the modeline comment prefixed with "set-" (see the relevant section in the Kate documentation if unsure).

For example, to automatically replace tabs with spaces you can enter: <code>set-replace-tabs true</code>.
To set tab width to 4 spaces: <code>set-tab-width 4</code>.
To change the highlighting to Python: <code>set-highlighting Python</code>.

Of course, the built-in command line also comes with some more advanced commands. External tools and plugins can also add their own commands! You can get a full list of available commands by running <code>help list</code> and get help related to a command by running <code>help <command></code>.

See the table below for some useful commands:
{|class="wikitable mw-collapsible"
!Command
!Arguments
!Description
|-
|help
|[command]
|Show a help message in a tooltip. If no argument is provided, shows a generic help message on using the command line. If the special argument <code>list</code> is specified, lists all available commands. If a command name is provided, tries to find help information related to that command.
|-
|char
|hex, octal or base 9+1
|Inserts a Unicode or ASCII character based on its numeric value (e.g. 0x1234, x1234, 01231, 1234).
|-
|date
|[format string]
|Inserts current date according to the specified format string. If invalid, the default (<code>yyyy-MM-dd hh:mm:ss</code>) is used instead.
|-
|find
|[:[bcerpsw]] string
|Finds the first occurrence of <code>string</code> in the document. Modifiers can be specified after the command by appending a ":", e.g. <code>find:se hello</code>. The meaning of the modifiers is: '''b''' for searching backwards, '''c''' for searching from the current cursor position, '''e''' for searching only inside the selection, '''r''' for evaluating <code>string</code> as a regular expression, '''p''' for showing a prompt each time an occurrence of <code>string</code> is about to be replaced (<code>replace</code> command only), '''s''' makes search case-sensitive and '''w''' makes search look for whole words only, not substrings.
|-
|ifind
|[:[bcrs]] string
|Finds the first occurrence of <code>string</code> interactively. It performs the search again each time a key is pressed.
|-
|replace
|[:[bcerpsw]] string [replacement]
|Replaces all occurrences of <code>string</code> with <code>replacement</code>. If <code>replacement</code> is omitted, it is assumed to be an empty string. For explanation of the modifiers see the description of <code>find</code>.
|-
|indent
|NONE
|Indent current line or selection by one tab stop
|-
|unindent
|NONE
|Unindent current line or selection by one tab stop
|-
|cleanindent
|NONE
|Reset identation of current line or selection
|-
|comment
|NONE
|Comment current line or selection
|-
|uncomment
|NONE
|Uncomment current line or selection
|-
|kill-line
|NONE
|Kills current line, regardless of selection.
|-
|set-indent-mode
|number > 0
|Sets the current indentation mode
|-
|set-highlight
|string
|Set highlighting mode for the current document
|-
|set-tab-width
|number > 0
|Set tab width to <code>number</code> spaces.
|-
|set-indent-width
|number > 0
|Set indentation width to <code>number</code>.
|-
|set-word-wrap-column
|number > 0
|Set column on which word wrapping should occur.
|-
|goto
|number > 0
|Go to line <code>number</code>.
|-
|set-icon-border
|boolean
|Whether to show icon border
|-
|set-folding-markers
|boolean
|Whether to show folding markers
|-
|set-line-numbers
|boolean
|Whether to show line numbers
|-
|set-show-indent
|boolean
|Whether to show indent lines
|-
|set-replace-tabs
|boolean
|Whether to replace tabs with spaces
|-
|set-remove-trailing-space
|boolean
|Whether to automatically remove trailing whitespaces.
|-
|set-remove-trailing-space-save
|boolean
|Whether to remove trailing whitespaces on saving.
|-
|set-show-tabs
|boolean
|Whether to show tab characters. Has no effect on space characters.
|-
|set-indent-spaces
|boolean
|Whether to use spaces instead of tabs for indentation.
|-
|set-mixed-indent
|boolean
|If enabled, enables <code>space-indent</code> and, if <code>indent-width</code> is zero, sets it to <code>tab-width / 2</code>.
|-
|set-word-wrap
|boolean
|Whether to enable word wrapping.
|-
|set-wrap-cursor
|boolean
|Whether the cursor wraps with the text or can assume arbitrary positions in the document. Lines are automatically compensated with the needed spaces.
|-
|run-myself
|NONE
|Execute the current document's text in the built-in Javascript interpreter
|}

Sed-like expressions are also accepted, e.g.:
<code>s/afternoon/abend/g</code>

== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

Tips And Tricks

2024-08-15T20:26:51Z

Blu256: /* Using a custom side image for classic K-Menu */ added explanation of image files

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

<code>kside.png</code> is the side image itself, while <code>kside_tile.png</code> is the image that fills the space above the side image if the latter does not fully fit the menu.

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{|
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

=== Kate: Using the built-in command line ===
You can quickly apply some special settings to an open file without leaving your keyboard, by using the built-in command line in any application that uses the Kate editing part (e.g. Kate itself, KWrite, TDevelop). Press F7 to open it. It will show as a single text field below the document. When you enter a command, it will automatically offer completions, so no need to worry if you are not sure about a command's name (or sometimes even arguments!). Also, the prompt preserves the history of previous successful command runs, which can be navigated using Up/Down movement keys.

You can apply one command per time, the syntax is <code>COMMAND [ARGUMENTS...]</code>. You can set the values for all the variables that you can set through the modeline comment prefixed with "set-" (see the relevant section in the Kate documentation if unsure).

For example, to automatically replace tabs with spaces you can enter: <code>set-replace-tabs true</code>.
To set tab width to 4 spaces: <code>set-tab-width 4</code>.
To change the highlighting to Python: <code>set-highlighting Python</code>.

Of course, the built-in command line also comes with some more advanced commands. External tools and plugins can also add their own commands! You can get a full list of available commands by running <code>help list</code> and get help related to a command by running <code>help <command></code>.

See the table below for some useful commands:
{|class="wikitable mw-collapsible"
!Command
!Arguments
!Description
|-
|help
|[command]
|Show a help message in a tooltip. If no argument is provided, shows a generic help message on using the command line. If the special argument <code>list</code> is specified, lists all available commands. If a command name is provided, tries to find help information related to that command.
|-
|char
|hex, octal or base 9+1
|Inserts a Unicode or ASCII character based on its numeric value (e.g. 0x1234, x1234, 01231, 1234).
|-
|date
|[format string]
|Inserts current date according to the specified format string. If invalid, the default (<code>yyyy-MM-dd hh:mm:ss</code>) is used instead.
|-
|find
|[:[bcerpsw]] string
|Finds the first occurrence of <code>string</code> in the document. Modifiers can be specified after the command by appending a ":", e.g. <code>find:se hello</code>. The meaning of the modifiers is: '''b''' for searching backwards, '''c''' for searching from the current cursor position, '''e''' for searching only inside the selection, '''r''' for evaluating <code>string</code> as a regular expression, '''p''' for showing a prompt each time an occurrence of <code>string</code> is about to be replaced (<code>replace</code> command only), '''s''' makes search case-sensitive and '''w''' makes search look for whole words only, not substrings.
|-
|ifind
|[:[bcrs]] string
|Finds the first occurrence of <code>string</code> interactively. It performs the search again each time a key is pressed.
|-
|replace
|[:[bcerpsw]] string [replacement]
|Replaces all occurrences of <code>string</code> with <code>replacement</code>. If <code>replacement</code> is omitted, it is assumed to be an empty string. For explanation of the modifiers see the description of <code>find</code>.
|-
|indent
|NONE
|Indent current line or selection by one tab stop
|-
|unindent
|NONE
|Unindent current line or selection by one tab stop
|-
|cleanindent
|NONE
|Reset identation of current line or selection
|-
|comment
|NONE
|Comment current line or selection
|-
|uncomment
|NONE
|Uncomment current line or selection
|-
|kill-line
|NONE
|Kills current line, regardless of selection.
|-
|set-indent-mode
|number > 0
|Sets the current indentation mode
|-
|set-highlight
|string
|Set highlighting mode for the current document
|-
|set-tab-width
|number > 0
|Set tab width to <code>number</code> spaces.
|-
|set-indent-width
|number > 0
|Set indentation width to <code>number</code>.
|-
|set-word-wrap-column
|number > 0
|Set column on which word wrapping should occur.
|-
|goto
|number > 0
|Go to line <code>number</code>.
|-
|set-icon-border
|boolean
|Whether to show icon border
|-
|set-folding-markers
|boolean
|Whether to show folding markers
|-
|set-line-numbers
|boolean
|Whether to show line numbers
|-
|set-show-indent
|boolean
|Whether to show indent lines
|-
|set-replace-tabs
|boolean
|Whether to replace tabs with spaces
|-
|set-remove-trailing-space
|boolean
|Whether to automatically remove trailing whitespaces.
|-
|set-remove-trailing-space-save
|boolean
|Whether to remove trailing whitespaces on saving.
|-
|set-show-tabs
|boolean
|Whether to show tab characters. Has no effect on space characters.
|-
|set-indent-spaces
|boolean
|Whether to use spaces instead of tabs for indentation.
|-
|set-mixed-indent
|boolean
|If enabled, enables <code>space-indent</code> and, if <code>indent-width</code> is zero, sets it to <code>tab-width / 2</code>.
|-
|set-word-wrap
|boolean
|Whether to enable word wrapping.
|-
|set-wrap-cursor
|boolean
|Whether the cursor wraps with the text or can assume arbitrary positions in the document. Lines are automatically compensated with the needed spaces.
|-
|run-myself
|NONE
|Execute the current document's text in the built-in Javascript interpreter
|}

Sed-like expressions are also accepted, e.g.:
<code>s/afternoon/abend/g</code>

== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

KDesktop

2024-08-15T20:18:39Z

Blu256: /* Drop shadows */ add TDE default

= KDesktop =
'''KDesktop''' is the Trinity component responsible for drawing the desktop: the wallpaper and the icons on it.

== Customization ==

=== Drop shadows ===
Shadows on the desktop icon labels can be configured in great detail since KDE 3.1 to produce results different than the default "halo" effect. Unfortunately, there is yet no GUI provided for tweaking the drop shadow, but you can still do so by editing the appropriate configuration file.

Inside the file <code>$TDEHOME/share/config/kdesktoprc</code> in the [FMSettings] section, you'll want to place a line containing something like the following:

<syntaxhighlight lang="ini">
ShadowParameters=<comma-separated parameters>
</syntaxhighlight>

The option accepts a string of comma-separated parameters in the following format:

{| class="wikitable"
! Parameter<br>number !! Description
|-
| 1, 2
| '''The first two entries are the X and Y offsets'''<br>(0,0 means right behind the text)
|-
| 3, 4
| '''The following two determine the halo (factor, max opacity)'''<br>0-255 (0 = transparent, 255 = opaque)
|-
| 5
| '''Thickness (how large the halo is).'''<br>Usually 3-5 pixels, though most seem to prefer a thickness of about 2
|-
| 6
| '''Selected algorithm'''
{| class="wikitable"
! Value
! Algorithm
! Description
|-
| 1
| DefaultDecay
| the default AXIS/DIAGONAL_FACTOR based algorithm,<br>a simple algorithm with 3 pixels thickness
|-
| 2
| DoubleLinearDecay
| the decay factor is 1/dx+dy '''(!!! not yet implemented !!!)''',<br>a slower algorithm where the influence of a pixel is qGray(px)/(abs(dx) + abs(dy) +1)
|-
| 3
| RadialDecay
| decay factor is 1/sqrt(dx*dx + dy*dy) '''(!!! not yet implemented !!!)'''<br>a very slow algorithm where the influence of a pixel is qGray(px)/(sqrt(sqr(dx) + sqr(dy)) +1)
|-
| 4
| NoDecay
| decay factor is 1 always,<br>a nice/fast algorithm proposed by Bernardo Hung
|}
|-
| 7
| '''Selection (inverse video or use the background text, boolean 0/1)'''<br>This setting affects how the text/halo is drawn when the icon is selected
{| class="wikitable"
! Value
! Meaning
! Description
|-
| 0
| Inverse Video
| Invert the text and shadow color to draw the icon's dropshadow
|-
| 1
| Background Text
| Use the current text and shadow color to draw the icon's dropshadow
|}
|}

Also, the following options are aliases of existing options:
ShadowTextColor - (Simply an alias for NormalTextColor)
ShadowTextBackground - (Simply an alias for ItemTextBackground)

Some premade examples you can just copy-paste:

{|class="wikitable"
! Value
! Description
|-
| <tt>0, 0, 4.0, 120.0, 2, 1, 1</tt> || TDE (default*)
|-
| <tt>2, 2, 4.0, 100.0, 2, 2, 1</tt> || KDE 3.2
|-
| <tt>0, 0, 4.0, 255.0, 3, 0, 0</tt> || KDE 3.1
|-
| <tt>0, 1, 16.0, 192.0, 2, 4, 0</tt> || OS X
|-
| <tt>1, 1, 32.0, 139.0, 2, 4, 0</tt> || Windows XP
|-
| <tt>0, 0, 4.0, 170.0, 1, 4, 0</tt> || Soft outline
|-
| colspan=2 | * used if <code>ShadowParameters</code> is not specified
|}

So, for a Windows XP style drop shadow, you'd put in your desktop config:

<syntaxhighlight lang="ini">
ShadowParameters=1,1,32.0,139.0,2,4,0
</syntaxhighlight>

For these new settings to take effect, you can disable then re-enable the either desktop drop shadows or the desktop icons.

A quick way to do so is to copy-paste the following command into a terminal emulator:
<syntaxhighlight lang="shell-session">
$ dcop kdesktop default setIconsEnabled false ; dcop kdesktop default setIconsEnabled true
</syntaxhighlight>

<small>Original author: Abby <abby@evilhack.com> ([https://web.archive.org/web/20041011181636/http://www.datiku.com/documents/kdesktopshadows.txt source])</small>

KDesktop

2024-08-15T20:10:36Z

Blu256: /* Drop shadows */ some wording fixes

= KDesktop =
'''KDesktop''' is the Trinity component responsible for drawing the desktop: the wallpaper and the icons on it.

== Customization ==

=== Drop shadows ===
Shadows on the desktop icon labels can be configured in great detail since KDE 3.1 to produce results different than the default "halo" effect. Unfortunately, there is yet no GUI provided for tweaking the drop shadow, but you can still do so by editing the appropriate configuration file.

Inside the file <code>$TDEHOME/share/config/kdesktoprc</code> in the [FMSettings] section, you'll want to place a line containing something like the following:

<syntaxhighlight lang="ini">
ShadowParameters=<comma-separated parameters>
</syntaxhighlight>

The option accepts a string of comma-separated parameters in the following format:

{| class="wikitable"
! Parameter<br>number !! Description
|-
| 1, 2
| '''The first two entries are the X and Y offsets'''<br>(0,0 means right behind the text)
|-
| 3, 4
| '''The following two determine the halo (factor, max opacity)'''<br>0-255 (0 = transparent, 255 = opaque)
|-
| 5
| '''Thickness (how large the halo is).'''<br>Usually 3-5 pixels, though most seem to prefer a thickness of about 2
|-
| 6
| '''Selected algorithm'''
{| class="wikitable"
! Value
! Algorithm
! Description
|-
| 1
| DefaultDecay
| the default AXIS/DIAGONAL_FACTOR based algorithm,<br>a simple algorithm with 3 pixels thickness
|-
| 2
| DoubleLinearDecay
| the decay factor is 1/dx+dy '''(!!! not yet implemented !!!)''',<br>a slower algorithm where the influence of a pixel is qGray(px)/(abs(dx) + abs(dy) +1)
|-
| 3
| RadialDecay
| decay factor is 1/sqrt(dx*dx + dy*dy) '''(!!! not yet implemented !!!)'''<br>a very slow algorithm where the influence of a pixel is qGray(px)/(sqrt(sqr(dx) + sqr(dy)) +1)
|-
| 4
| NoDecay
| decay factor is 1 always,<br>a nice/fast algorithm proposed by Bernardo Hung
|}
|-
| 7
| '''Selection (inverse video or use the background text, boolean 0/1)'''<br>This setting affects how the text/halo is drawn when the icon is selected
{| class="wikitable"
! Value
! Meaning
! Description
|-
| 0
| Inverse Video
| Invert the text and shadow color to draw the icon's dropshadow
|-
| 1
| Background Text
| Use the current text and shadow color to draw the icon's dropshadow
|}
|}

Also, the following options are aliases of existing options:
ShadowTextColor - (Simply an alias for NormalTextColor)
ShadowTextBackground - (Simply an alias for ItemTextBackground)

Some premade examples you can just copy-paste:

{|class="wikitable"
! Value
! Description
|-
| 2, 2, 4.0, 100.0, 2, 2, 1 || KDE 3.2
|-
| 0, 0, 4.0, 255.0, 3, 0, 0 || KDE 3.1
|-
| 0, 1, 16.0, 192.0, 2, 4, 0 || OS X
|-
| 1, 1, 32.0, 139.0, 2, 4, 0 || Windows XP
|-
| 0, 0, 4.0, 170.0, 1, 4, 0 || Soft outline
|}

So, for a Windows XP style drop shadow, you'd put in your desktop config:

<syntaxhighlight lang="ini">
ShadowParameters=1,1,32.0,139.0,2,4,0
</syntaxhighlight>

For these new settings to take effect, you can disable then re-enable the either desktop drop shadows or the desktop icons.

A quick way to do so is to copy-paste the following command into a terminal emulator:
<syntaxhighlight lang="shell-session">
$ dcop kdesktop default setIconsEnabled false ; dcop kdesktop default setIconsEnabled true
</syntaxhighlight>

<small>Original author: Abby <abby@evilhack.com> ([https://web.archive.org/web/20041011181636/http://www.datiku.com/documents/kdesktopshadows.txt source])</small>

KDesktop

2024-08-15T20:09:40Z

Blu256: Create page for KDesktop and add documentation for customizing the icons' drop shadow

= KDesktop =
'''KDesktop''' is the Trinity component responsible for drawing the desktop: the wallpaper and the icons on it.

== Customization ==

=== Drop shadows ===
Shadows on the desktop icon labels can be configured in great detail since KDE 3.1 to produce results different than the default "halo" effect. Unfortunately, there is yet no GUI provided for tweaking the drop shadow, but you can still do so by editing the appropriate configuration file.

Inside the file <code>$TDEHOME/share/config/kdesktoprc</code> in the [FMSettings] section, you'll want to place a line containing something like the following:

<syntaxhighlight lang="ini">
ShadowParameters=<insert_string_from_the_examples_below>
</syntaxhighlight>

The option accepts a string value in the following format:

{| class="wikitable"
! Parameter<br>number !! Description
|-
| 1, 2
| '''The first two entries are the X and Y offsets'''<br>(0,0 means right behind the text)
|-
| 3, 4
| '''The following two determine the halo (factor, max opacity)'''<br>0-255 (0 = transparent, 255 = opaque)
|-
| 5
| '''Thickness (how large the halo is).'''<br>Usually 3-5 pixels, though most seem to prefer a thickness of about 2
|-
| 6
| '''Selected algorithm'''
{| class="wikitable"
! Value
! Algorithm
! Description
|-
| 1
| DefaultDecay
| the default AXIS/DIAGONAL_FACTOR based algorithm,<br>a simple algorithm with 3 pixels thickness
|-
| 2
| DoubleLinearDecay
| the decay factor is 1/dx+dy '''(!!! not yet implemented !!!)''',<br>a slower algorithm where the influence of a pixel is qGray(px)/(abs(dx) + abs(dy) +1)
|-
| 3
| RadialDecay
| decay factor is 1/sqrt(dx*dx + dy*dy) '''(!!! not yet implemented !!!)'''<br>a very slow algorithm where the influence of a pixel is qGray(px)/(sqrt(sqr(dx) + sqr(dy)) +1)
|-
| 4
| NoDecay
| decay factor is 1 always,<br>a nice/fast algorithm proposed by Bernardo Hung
|}
|-
| 7
| '''Selection (inverse video or use the background text, boolean 0/1)'''<br>This setting affects how the text/halo is drawn when the icon is selected
{| class="wikitable"
! Value
! Meaning
! Description
|-
| 0
| Inverse Video
| Invert the text and shadow color to draw the icon's dropshadow
|-
| 1
| Background Text
| Use the current text and shadow color to draw the icon's dropshadow
|}
|}

Also, the following options are aliases of existing options:
ShadowTextColor - (Simply an alias for NormalTextColor)
ShadowTextBackground - (Simply an alias for ItemTextBackground)

Some premade examples you can just copy-paste:

{|class="wikitable"
! Value
! Description
|-
| 2, 2, 4.0, 100.0, 2, 2, 1 || KDE 3.2
|-
| 0, 0, 4.0, 255.0, 3, 0, 0 || KDE 3.1
|-
| 0, 1, 16.0, 192.0, 2, 4, 0 || OS X
|-
| 1, 1, 32.0, 139.0, 2, 4, 0 || Windows XP
|-
| 0, 0, 4.0, 170.0, 1, 4, 0 || Soft outline
|}

So, for a Windows XP style drop shadow, you'd put in your desktop config:

<syntaxhighlight lang="ini">
ShadowParameters=1,1,32.0,139.0,2,4,0
</syntaxhighlight>

For these new settings to take effect, you can disable then re-enable the either desktop drop shadows or the desktop icons.

A quick way to do so is to copy-paste the following command into a terminal emulator:
<syntaxhighlight lang="shell-session">
$ dcop kdesktop default setIconsEnabled false ; dcop kdesktop default setIconsEnabled true
</syntaxhighlight>

<small>Original author: Abby <abby@evilhack.com> ([https://web.archive.org/web/20041011181636/http://www.datiku.com/documents/kdesktopshadows.txt source])</small>

Tips And Tricks

2024-06-10T14:40:24Z

Blu256: /* Kate: Quickly apply settings to a document */ Some improvements

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{|
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

=== Kate: Using the built-in command line ===
You can quickly apply some special settings to an open file without leaving your keyboard, by using the built-in command line in any application that uses the Kate editing part (e.g. Kate itself, KWrite, TDevelop). Press F7 to open it. It will show as a single text field below the document. When you enter a command, it will automatically offer completions, so no need to worry if you are not sure about a command's name (or sometimes even arguments!). Also, the prompt preserves the history of previous successful command runs, which can be navigated using Up/Down movement keys.

You can apply one command per time, the syntax is <code>COMMAND [ARGUMENTS...]</code>. You can set the values for all the variables that you can set through the modeline comment prefixed with "set-" (see the relevant section in the Kate documentation if unsure).

For example, to automatically replace tabs with spaces you can enter: <code>set-replace-tabs true</code>.
To set tab width to 4 spaces: <code>set-tab-width 4</code>.
To change the highlighting to Python: <code>set-highlighting Python</code>.

Of course, the built-in command line also comes with some more advanced commands. External tools and plugins can also add their own commands! You can get a full list of available commands by running <code>help list</code> and get help related to a command by running <code>help <command></code>.

See the table below for some useful commands:
{|class="wikitable mw-collapsible"
!Command
!Arguments
!Description
|-
|help
|[command]
|Show a help message in a tooltip. If no argument is provided, shows a generic help message on using the command line. If the special argument <code>list</code> is specified, lists all available commands. If a command name is provided, tries to find help information related to that command.
|-
|char
|hex, octal or base 9+1
|Inserts a Unicode or ASCII character based on its numeric value (e.g. 0x1234, x1234, 01231, 1234).
|-
|date
|[format string]
|Inserts current date according to the specified format string. If invalid, the default (<code>yyyy-MM-dd hh:mm:ss</code>) is used instead.
|-
|find
|[:[bcerpsw]] string
|Finds the first occurrence of <code>string</code> in the document. Modifiers can be specified after the command by appending a ":", e.g. <code>find:se hello</code>. The meaning of the modifiers is: '''b''' for searching backwards, '''c''' for searching from the current cursor position, '''e''' for searching only inside the selection, '''r''' for evaluating <code>string</code> as a regular expression, '''p''' for showing a prompt each time an occurrence of <code>string</code> is about to be replaced (<code>replace</code> command only), '''s''' makes search case-sensitive and '''w''' makes search look for whole words only, not substrings.
|-
|ifind
|[:[bcrs]] string
|Finds the first occurrence of <code>string</code> interactively. It performs the search again each time a key is pressed.
|-
|replace
|[:[bcerpsw]] string [replacement]
|Replaces all occurrences of <code>string</code> with <code>replacement</code>. If <code>replacement</code> is omitted, it is assumed to be an empty string. For explanation of the modifiers see the description of <code>find</code>.
|-
|indent
|NONE
|Indent current line or selection by one tab stop
|-
|unindent
|NONE
|Unindent current line or selection by one tab stop
|-
|cleanindent
|NONE
|Reset identation of current line or selection
|-
|comment
|NONE
|Comment current line or selection
|-
|uncomment
|NONE
|Uncomment current line or selection
|-
|kill-line
|NONE
|Kills current line, regardless of selection.
|-
|set-indent-mode
|number > 0
|Sets the current indentation mode
|-
|set-highlight
|string
|Set highlighting mode for the current document
|-
|set-tab-width
|number > 0
|Set tab width to <code>number</code> spaces.
|-
|set-indent-width
|number > 0
|Set indentation width to <code>number</code>.
|-
|set-word-wrap-column
|number > 0
|Set column on which word wrapping should occur.
|-
|goto
|number > 0
|Go to line <code>number</code>.
|-
|set-icon-border
|boolean
|Whether to show icon border
|-
|set-folding-markers
|boolean
|Whether to show folding markers
|-
|set-line-numbers
|boolean
|Whether to show line numbers
|-
|set-show-indent
|boolean
|Whether to show indent lines
|-
|set-replace-tabs
|boolean
|Whether to replace tabs with spaces
|-
|set-remove-trailing-space
|boolean
|Whether to automatically remove trailing whitespaces.
|-
|set-remove-trailing-space-save
|boolean
|Whether to remove trailing whitespaces on saving.
|-
|set-show-tabs
|boolean
|Whether to show tab characters. Has no effect on space characters.
|-
|set-indent-spaces
|boolean
|Whether to use spaces instead of tabs for indentation.
|-
|set-mixed-indent
|boolean
|If enabled, enables <code>space-indent</code> and, if <code>indent-width</code> is zero, sets it to <code>tab-width / 2</code>.
|-
|set-word-wrap
|boolean
|Whether to enable word wrapping.
|-
|set-wrap-cursor
|boolean
|Whether the cursor wraps with the text or can assume arbitrary positions in the document. Lines are automatically compensated with the needed spaces.
|-
|run-myself
|NONE
|Execute the current document's text in the built-in Javascript interpreter
|}

Sed-like expressions are also accepted, e.g.:
<code>s/afternoon/abend/g</code>

== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

Tips And Tricks

2024-06-10T14:31:03Z

Blu256: Add documentation about kate commands

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{|
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

=== Kate: Quickly apply settings to a document ===
You can quickly apply some special settings to an open file without leaving your keyboard, by using the built-in command line. Press F7 to open it. It will show as a single text field below the document. When you enter a command, it will automatically offer completions, so no need to worry if you are not sure about a command's name (or sometimes even arguments!). Also, the prompt preserves the history of previous successful command runs, which can be navigated using Up/Down movement keys.

You can apply one command per time, the syntax is <code>COMMAND [ARGUMENTS...]</code>. You can set the values for all the variables that you can set through the modeline comment prefixed with "set-" (see the relevant section in the Kate documentation if unsure).

For example, to automatically replace tabs with spaces you can enter: <code>set-replace-tabs true</code>.
To set tab width to 4 spaces: <code>set-tab-width 4</code>.
To change the highlighting to Python: <code>set-highlighting Python</code>.

Of course, the built-in command line also comes with some more advanced commands, see the table below for a full list:
{|class="wikitable mw-collapsible"
!Command
!Arguments
!Description
|-
|char
|hex, octal or base 9+1
|Inserts a Unicode or ASCII character based on its numeric value (e.g. 0x1234, x1234, 01231, 1234).
|-
|date
|[format string]
|Inserts current date according to the specified format string. If invalid, the default (<code>yyyy-MM-dd hh:mm:ss</code>) is used instead.
|-
|find
|[:[bcerpsw]] string
|Finds the first occurrence of <code>string</code> in the document. Modifiers can be specified after the command by appending a ":", e.g. <code>find:se hello</code>. The meaning of the modifiers is: '''b''' for searching backwards, '''c''' for searching from the current cursor position, '''e''' for searching only inside the selection, '''r''' for evaluating <code>string</code> as a regular expression, '''p''' for showing a prompt each time an occurrence of <code>string</code> is about to be replaced (<code>replace</code> command only), '''s''' makes search case-sensitive and '''w''' makes search look for whole words only, not substrings.
|-
|ifind
|[:[bcrs]] string
|Finds the first occurrence of <code>string</code> interactively. It performs the search again each time a key is pressed.
|-
|replace
|[:[bcerpsw]] string [replacement]
|Replaces all occurrences of <code>string</code> with <code>replacement</code>. If <code>replacement</code> is omitted, it is assumed to be an empty string. For explanation of the modifiers see the description of <code>find</code>.
|-
|indent
|NONE
|Indent current line or selection by one tab stop
|-
|unindent
|NONE
|Unindent current line or selection by one tab stop
|-
|cleanindent
|NONE
|Reset identation of current line or selection
|-
|comment
|NONE
|Comment current line or selection
|-
|uncomment
|NONE
|Uncomment current line or selection
|-
|kill-line
|NONE
|Kills current line, regardless of selection.
|-
|set-indent-mode
|number > 0
|Sets the current indentation mode
|-
|set-highlight
|string
|Set highlighting mode for the current document
|-
|set-tab-width
|number > 0
|Set tab width to <code>number</code> spaces.
|-
|set-indent-width
|number > 0
|Set indentation width to <code>number</code>.
|-
|set-word-wrap-column
|number > 0
|Set column on which word wrapping should occur.
|-
|goto
|number > 0
|Go to line <code>number</code>.
|-
|set-icon-border
|boolean
|Whether to show icon border
|-
|set-folding-markers
|boolean
|Whether to show folding markers
|-
|set-line-numbers
|boolean
|Whether to show line numbers
|-
|set-show-indent
|boolean
|Whether to show indent lines
|-
|set-replace-tabs
|boolean
|Whether to replace tabs with spaces
|-
|set-remove-trailing-space
|boolean
|Whether to automatically remove trailing whitespaces.
|-
|set-remove-trailing-space-save
|boolean
|Whether to remove trailing whitespaces on saving.
|-
|set-show-tabs
|boolean
|Whether to show tab characters. Has no effect on space characters.
|-
|set-indent-spaces
|boolean
|Whether to use spaces instead of tabs for indentation.
|-
|set-mixed-indent
|boolean
|If enabled, enables <code>space-indent</code> and, if <code>indent-width</code> is zero, sets it to <code>tab-width / 2</code>.
|-
|set-word-wrap
|boolean
|Whether to enable word wrapping.
|-
|set-wrap-cursor
|boolean
|Whether the cursor wraps with the text or can assume arbitrary positions in the document. Lines are automatically compensated with the needed spaces.
|-
|run-myself
|NONE
|Execute the current document's text in the built-in Javascript interpreter
|}

Sed-like expressions are also accepted, e.g.:
<code>s/afternoon/abend/g</code>
== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

Tips And Tricks

2024-06-09T16:08:38Z

Blu256: Add tip for overcoming the application/octet-stream error

This page is meant as a container of tips and tricks collected over time, addressing topics and issues brought up by TDE users.<noinclude>

Also see the users' [[User FAQ | Frequently Asked Questions]] page.

__TOC__


== Installing Trinity ==
Tips and tricks relevant to obtaining a well-functioning Trinity installation.

=== Upgrading from older versions or KDE3 ===

==== Upgrading from KDE3 or from TDE 3.5.x to R14.0.x ====
If you are migrating from KDE3 or upgrading from TDE 3.5.x, you can reuse your own settings in TDE R14.0.x.
When logging into R14.0.x for the first time, TDE will automatically execute a script which will migrate as many of your KDE3/TDE3.5.x settings as possible. At the end of the process, your KDE3/TDE3.5.x profile will still exist (unchanged) and a new TDE profile will have been created inside the <tt>'''~/.trinity'''</tt> folder.

{{TipBox
|caption=Note
|text=Please refrain from renaming your <tt>.kde</tt> into <tt>.trinity</tt> before running R14.0.x. If you do so, the migration process will not take part and some applications may not run smoothly after that. See [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2356 here] for an example of problems that may arise if you rename your <tt>.kde</tt> folder manually.
}}

==== Upgrading from an old version (pre Dec/2014) ====
Depending on your previous version of TDE, the file /etc/trinity/tdm/tdmrc may change from a script-generated file to a config file.
It is advisable to accept the newer file if you are upgrading from an old version to TDE >= R14.0.0.


== Configuring Trinity ==
Tips and tricks for custom fine-tuning and configurations.

=== Using sudo and tdesudo ===
If you use sudo or a sudo-based distribution (such as Ubuntu), it is highly recommended that you install the <tt>tdesudo-trinity</tt> package as well. This allows to run programs that require root priviledge from the TDE menu using your own password.
If <tt>tdesudo-trinity</tt> is not installed, you will be asked for the root password instead.
More details can be found [http://bugs.pearsoncomputing.net/show_bug.cgi?id=2563 here].

=== Un-Bogging down an older system ===
Your system runs pretty well until Firefox, an office application, or some other application with high CPU usage demands too many cycles and your system then ‘freezes’ for seconds or minutes until the application gets finished.

A simple, but somewhat tedious, solution is to add <code>nice</code> to the launcher for each. Using LibreOffice as an example, add <code>nice -n 2</code> before the command:

<code>TDE Menu >> Office >> LibreOffice >> {right click} >> Edit Item</code>

Change the ‘Command’ entry from <code>libreoffice %U</code> to <code>nice -n 2 libreoffice %U</code>.

Then find every other entry for LibreOffice (LibreOffice Base, LibreOffice Draw, LibreOffice Math, LibreOffice Impress, etc.) and do the same.

Other ‘usual suspects’ to make nice are: browsers, BitTorrent clients, GUI Diff tools, and, occasionally, PDF viewers.

Generally anything ‘real-time’ you should leave alone (movies, games, editors).

These were used on a Core2 Duo (P7570 @ 2.26GHz, CPU Mark: 926):

{| class="wikitable" style="text-align: center;"
!Nice level
!Application Name
|-
|1
|Kmail
|-
|2
|LibreOffice
|-
|3
|Firefox
|-
|4
|qBittorrent
|-
|}

=== Assigning a mouse click as part of a keyboard shortcut ===
There are multiple ways to accomplish this. The best arguably was the first method, which has been lost to time.

In these examples we are trying to achieve:

<code>{Windows Key} + {left mouse click} = Minimize application under mouse cursor</code>

Change what you need to achieve what you want.

==== Method 1: Lost ====

As the name says it’s been lost. What is remembered is that:

* No additional software had to be installed
* The change was exceedingly minor.

==== Method 2: <tt>xbindkeys</tt> + <tt>xdotool</tt> ====

Buggy. This works, but the <tt>xdotool</tt> command used occasionally leaves an unfinished half-keystroke hanging.

'''Step 1.''' Go to:

<code>Trinity Control Center >> Regional & Accessibility >> Keyboard Shortcuts >> Shortcuts Schemes >> Global Shortcuts >> Windows</code>

Set "Minimize Window" to “Win+Space”.

'''Step 2.''' Issue these command(s) as root or using sudo:

<syntaxhighlight lang="shell-session">
# apt-get install xbindkeys
# apt-get install xdotool
# apt-get install xbindkeys-config # optional
</syntaxhighlight>

'''Step 3.''' Edit <tt>$HOME/.xbindkeysrc</tt>.

Add the following lines:


<syntaxhighlight lang="shell">
#MinimizeWindowUnderMouse
"xdotool click --clearmodifiers 1 key super+space"
m:0x40 + c:133 + b:1 + release</nowiki>
</syntaxhighlight>

{{Box
|caption=Note
|text=xbindkeys does not like superfluous comments within its definitions. Leaving prior entries commented out within the config definition caused odd and inconsistent results.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

'''Step 4.''' Issue these commands as yourself (not as root):

<syntaxhighlight lang="shell-session">
$ killall xbindkeys
$ xbindkeys
</syntaxhighlight>

'''Step 5.''' To minimize any window:

Move the cursor over a window, hold down the Windows key and click the left mouse button.

==== Method 3: <tt>xbindkeys</tt>, <tt>dcop</tt> and/or <tt>gdbus</tt> ====

Basically the same as <tt>xbindkeys</tt> + <tt>xdotool</tt> but replacing <tt>xdotool</tt> with either a <tt>dcop</tt> or <tt>gdbus</tt> command. This is probably less ‘buggy’ than <tt>xdotool</tt>, but unfortunately the writer doesn’t understand enough about either to make this work.

=== Enabling image thumbnails in Konqueror for external devices opened via popup after plugging in ===

When an external device (e.g. USB flash drive) is plugged in, choosing "Open in New Window" in the TDE popup window will open the device under the <tt>system:/</tt> path prefix. Image thumbnail display is not enabled per default for this location type in Konqueror. To enable image thumbnails for <tt>system:/</tt> paths, adhere to the following:

# In Konqueror from the menubar select <code>Settings >> Configure Konqueror...</code>.
# Select <code>Previews & Metadata</code> on the left.
# Under <code>Local Protocols</code> tick the checkbox for <code>system</code>.
# Press <code>Apply</code>.


== Look and feel ==
Tips and tricks concerning the appearance of Trinity desktop and applications.

=== Adding a separator between windows button in the title bar ===
Open <code>TDE Control Center >> Appearance & Themes >> Window Decorations</code> and then select the <code>Buttons</code> tab.

In the middle of the screen there is a list of available buttons. Drag a separator (<code>--- spacer ---</code>) on the title bar of the sample window, between the buttons where you want to space to appear.

Check the preview in the bottom part of the window and modify again as required.

Confirm when done.

=== Enlarging Kicker taskbar buttons to only occupy a single row ===

When the configured Kicker panel size surpasses a certain pixel count, the taskbar will start getting segmented into multiple rows, leading to taskbar buttons being placed in a grid.
To prevent this, the minimum height of taskbar buttons can be increased to enforce a single row of taskbar buttons.

To achieve this, you have to add the following line into section <tt>[General]</tt> in your <tt>$TDEHOME/share/config/ktaskbarrc</tt>:

<syntaxhighlight lang="ini">
MinimumButtonHeight=38
</syntaxhighlight>

Select a <tt>MinimumButtonHeight</tt> that matches the pixel size of the Kicker panel as configured in <code>Trinity Control Center >> Desktop >> Panels >> Arrangement</code> (when the size is set to "Custom").
Restart the Kicker panel after changing the configuration line.

As an example, for a panel height of 38 pixels this adjustment can be done via Konsole (or another terminal emulator) in the following manner:

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/ktaskbarrc --group General --key MinimumButtonHeight 38
$ dcop kicker kicker restart
</syntaxhighlight>

Hint: you may also additionally set <code>MinimumButtonWidth</code> in the same group to control how much minimum horizontal space (in pixels) a single taskbar button should occupy on its own.

=== Removing captions from K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
ShowMenuTitles=false
</syntaxhighlight>

You also have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key ShowMenuTitles false
$ dcop kicker kicker restart
</syntaxhighlight>

=== Increasing icon size in K-Menu ===
You have to add the following line into section <tt>[menus]</tt> in your <tt>$TDEHOME/share/config/kickerrc</tt>:

<syntaxhighlight lang="ini">
MenuEntryHeight=22
</syntaxhighlight>

You can adjust the number to any icon size you see fit. You have to restart Kicker for the change to take effect.

The quickest way to do all of this is via Konsole (or another terminal emulator):

<syntaxhighlight lang="shell-session">
$ kwriteconfig --file $TDEHOME/share/config/kickerrc --group menus --key MenuEntryHeight 22
$ dcop kicker kicker restart
</syntaxhighlight>

=== Using a custom side image for classic K-Menu ===

''The following only applies to the classic K-Menu enabled by setting "TDE menu style" to "Trinity Classic" in the "Menus" section of <code>Trinity Control Center >> Desktop >> Panels</code>.''

# Create <code>$TDEHOME/share/apps/kicker/pics/</code> if it doesn't exist.
# Place custom <code>kside.png</code> and <code>kside_tile.png</code> files into <code>$TDEHOME/share/apps/kicker/pics/</code>.
# In <code>Trinity Control Center >> Desktop >> Panels</code> under "Menus" enable "Show side image".

Hint: you may find the default <tt>kside.png</tt> and <tt>kside_tile.png</tt> files within <tt>$TDEDIR/share/apps/kicker/pics/</tt>.

Changes to the image files will only apply when the Kicker gets restarted. To trigger this, you can use <code>dcop kicker kicker restart</code>.

=== Using a custom image for the logout prompt ===

# Create <code>$TDEHOME/share/apps/ksmserver/pics/</code> if it doesn't exist.
# Place a custom <code>shutdownkonq.png</code> into <code>$TDEHOME/share/apps/ksmserver/pics/</code>.

Hint: you may find the default image within <tt>$TDEDIR/share/apps/ksmserver/pics/</tt>.

=== Use another window manager with TDE ===
It is possible to use TDE with a different window manager than the one which comes by default. There are a lot of window managers out there, though, so TDE might not recognize their presence and thus not offer them as a choice in the Control Center. This is the case when you can use the advanced methods mentioned here to use TDE with another WM.

[[File:TDE+E16 thumb.png|thumb|link=File:TDE+E16.png|Trinity Desktop with E16 as window manager]]

==== Method 1: the easy way ====
The easy way is, of course, to go to <code>TDE Control Center >> Desktop >> Window decorations</code>, switch to the Window Manager tab and then select your preferred window manager from the drop-down menu.

==== Method 2: autostart TDE components from WM ====
You can autostart Trinity and the components you need if your window manager supports autostart. In this case the window manager is started first. An <tt>.xinitrc</tt> file can also do the trick.

Make sure your window manager executes the first command (and any of the other ones for other desktop components you might want to use). For a more-or-less complete TDE session use all of them:

{|
!Command
!Description
|-
|<tt>starttde</tt>
|''(required) Initializes required Trinity components.<span style="color:#FF0000">*</span>''
|-
|<tt>kicker &</tt>
|''The Kicker panel.''
|-
|<tt>kdesktop --waitforkded &</tt>
|''The Desktop.''
|-
|<tt>khotkeys &</tt>
|''Keyboard shortcuts handler.''
|}

<span style="color:#FF0000">''(* Trinity apps would do this anyway, but it's nice to have it ready for them.)''</span>

As for starting the WM itself, you can choose to use your window manager's session via your display manager.

Note that this is not considered a full TDE session and that your mileage may vary. For a better way of handling this see Method 2 below.

==== Method 3: using WM as part of a TDE session ====
You can make TDE use your window manager instead of TWin by passing an environment variable to the <tt>starttde</tt> script. This variable is named <code>$TDEWM</code> and accepts the executable name (or full path) of your window manager. For example, to start TDE with Fluxbox as a window manager:

<syntaxhighlight lang="shell-session">
$ TDEWM=fluxbox startx /opt/trinity/starttde # adjust to your system
</syntaxhighlight>

{{Box
|caption=Note
|text=Due to a mistake, Trinity releases before R14.0.11 use the <code>$TWIN</code> variable instead.
|icon=Messagebox_info.png
|background=#E9F0FF
|highlight=#93B2FF
}}

To make this permanent:

* If you use a <tt>.xinitrc</tt> file, then the only thing to do is to put the line there.
* If you use a display manager, you'll need to create a script and an X session file.

Create a script like this one:

<syntaxhighlight lang="shell">
#!/bin/sh
export TDEWM=your_window_manager # for R14.0.11 and higher
export TWIN=your_window_manager # for pre-R14.0.11 TDE versions
exec starttde
</syntaxhighlight>

Replace <code>your_window_manager</code> with the correct value. Save it and make it executable.

Then, create a .desktop file in <tt>/usr/share/xsessions</tt>, like this one:

<syntaxhighlight lang="ini">
[Desktop Entry]
Encoding=UTF-8
Type=XSession
Name=(Session name)
Comment=(An optional session comment)
Exec=/path/to/the/script/you/just/saved
</syntaxhighlight>

Insert the values as needed. Save it and logout. From the sessions menu choose the session you just created. Login normally. TDE should start with the window manager of your choice.

=== Changing alternating row colors ===
Alternating row colors in Konqueror, KMail, and probably a lot more, can be set in the Colors section of Trinity Control Center:
<code>TCC >> Appearance & Themes >> Colors >> Widget Color >> [Dropdown] Alternate Background in Lists</code>


== Application tricks ==
Tips and tricks concerning Trinity applications (such as KMail, Kopete, Amarok etc.)

=== Kmail: Sanitize and Decrypt E-Mails ===
[[Kmail_Sanitize_and_Decrypt_Mails|Kmail Sanitize and Decrypt Mails]] shows an example on how to create a filter in kmail that removes unwanted headers and automaticly decrypts incomming mails.

== Useful scripts ==
A collection of snippets and useful scripts which can help in automating some tasks in TDE.

=== Lock session and turn off screen ===
This shell script locks the session and after 3 seconds turns the screen off:

<syntaxhighlight lang="bash">
#!/bin/bash
dcop kdesktop KScreensaverIface lock
sleep 3
xset dpms force standby
</syntaxhighlight>

For a ‘GUI’ you can add an Applet to your Panel that calls the shell script.

=== Log out of current TDE session ===

You can log out of the current TDE session and possibly shut down the system automatically (depending on your TDE configuration) using this command:

<syntaxhighlight lang="shell-session">
$ dcop kdesktop default logout <confirm> <type> <mode>
</syntaxhighlight>

You can append three parameters ("confirm", "type", "mode") to determine the
logout behaviour according to the following values:

'''First parameter: "confirm"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| ''Obey the user's confirmation setting''
|-
| 0
| ''Don't confirm, shutdown without asking''
|-
| 1
| ''Always confirm, ask even if the user turned it off''
|}

'''Second parameter: "type"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous action or the default if it's the first time
|-
| 0
| Only log out
|-
| 1
| Log out and reboot the machine
|-
| 2
| Log out and halt the machine
|}

'''Third parameter: "mode"'''
{| class="wikitable" width="600px"
|-
! Value
! Explanation
|-
| -1
| Select previous mode (or the default one, if it's the first time)
|-
| 0
| Schedule a shutdown (halt or reboot) for the time all active sessions have exited
|-
| 1
| Shut down, if no sessions are active. Otherwise do nothing
|-
| 2
| Force shutdown. Kill any possibly active sessions
|-
| 3
| Pop up a dialog asking the user what to do if sessions are still active
|}

'''Full stop example'''

This command will log out and halt the machine, killing any sessions and will never prompt the user:

<syntaxhighlight lang="shell-session">
$ dcop ksmserver default logout 0 2 2
</syntaxhighlight>

=== Hide suspension related buttons from the shutdown dialog ===
There is currently no GUI option for this, but it can be achieved by a simple configuration script.<br/>
Create the file '~/.trinity/share/config/power-managerrc' and put the
following two lines inside:

<syntaxhighlight lang="bash">
disableSuspend=true
disableHibernate=true
</syntaxhighlight>

The next time the shutdown dialog is displayed, only the Logout, Shutdown and Restart buttons will be shown.<br/>
Freeze, Suspend, Hybrid suspend, Hibernate buttons will not be displayed.

== Troubleshooting ==

=== Error: TDE mediamanager is not running ===
You might encounter this error if you try to run KDesktop, Konqueror or any other TDE application that tries to access storage media outside of a standard TDE session (e.g. from a window manager session).

To solve this, add the following lines to your window manager's autostart script:
<syntaxhighlight lang="shell">
tdeinit
dcop kded kded loadModule mediamanager
</syntaxhighlight>

=== Unable to change display brightness with NVidia cards ===
If you are unable to change the display brightness, the problem could be the nvidia driver in use.
The following tip works for some users and it is worth a try.

In <tt>/etc/default/grub</tt> add <code>acpi_backlight=vendor</code> and/or <code>nvidia.NVreg_EnableBacklightHandler=1</code> to
the variable <tt>GRUB_CMDLINE_LINUX_DEFAULT</tt> and reboot. Then controlling the display brightness using TDE
and multimedia (or Fn combination) keys should/may work.

Example:

<syntaxhighlight lang="shell">
GRUB_CMDLINE_LINUX_DEFAULT="quiet nvidia.NVreg_EnableBacklightHandler=1 acpi_backlight=vendor"
</syntaxhighlight>

=== Unable to find mime type application/octet-stream ===
This error can occur due to a known bug with the TDE MIME system.

There are two known methods to fix this:

==== Method 1: Graphical ====
# Go to <code>TDE Control Centre > TDE Components > File Associations</code>
# Click on the <code>Add...</code> button at the bottom
# Select the <code>application</code> group from the drop-down menu
# In the name field type: <tt>octet-stream</tt>
# Click OK to close the dialog
# Apply the settings

==== Method 2: Via CLI ====
<syntaxhighlight lang="shell-session">
$ cat > ~/.trinity/share/mimelnk/application/octet-stream.desktop << EOF
[Desktop Entry]
Comment=octet-stream
Hidden=false
Icon=
MimeType=application/octet-stream
Patterns=
Type=MimeType
EOF
</syntaxhighlight>

= See also =
* [http://web.archive.org/web/20060924164505/http://wiki.kde.org/tiki-index.php?page=Tips+and+Tricks Tips and Tricks on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924165408/http://wiki.kde.org/tiki-index.php?page=Performance+Tips KDE3 Performance Tips on the old KDE TikiWiki]
* [http://web.archive.org/web/20060924164932/http://wiki.kde.org/tiki-index.php?page=Secret+Config+Settings Secret config settings on the old KDE TikiWiki]

[[Category:Documentation]]
[[Category:Community]]
[[Category:TipsAndTricks]]
</noinclude>

Category:Developers

2024-06-09T16:02:11Z

Blu256: Fix noinclude to also cover the two last books

This category contains development-related and API documentation for the Trinity Desktop Environment.<noinclude>

==New to Trinity development?==

Take a look at the following pages:

* [http://trinitydesktop.org/helpwanted.php Getting Involved with Trinity Development]
* [[TDE Gitea Workspace]]
* [[TDE Weblate Translation Workspace]]
* [[Project GIT Information]]
* [[Project RoadMap]]
* [[DevelopmentSpecifications]]
* [https://www.trinitydesktop.org/apidocs.php TQt/TDE API documentation]
* [[Porting to TDE|Porting KDE3/Qt3 apps to Trinity]]

==Building and Distributing Trinity==
* [[Nightly Builds|Installing Nightly Builds]]
* [[How to Build TDE Core Modules]]
* [[How to Build Extra Applications]]

See also pages in [[:Category:Packagers]].

==Tutorials and Documentation==

===Qt3 and TQt===
* [[Understanding the TQT Interface]]
* [https://www.trinitydesktop.org/docs/qt3 TQt API Documentation]

===Trinity===
* [https://www.trinitydesktop.org/docs/trinity/tdelibs/ TDELibs API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdebase/ TDEBase API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdepim/ TDEPIM API Documentation]
* [[DCOP]], the IPC system used by TDE applications.
* [[TDEParts]], a mechanism for reusing and embedding elaborate widgets into applications (e.g. Konqueror)
* [[TDEIO]], an abstraction that provides network transparency between local and remote filesystems.
* [[TDEConfig XT Tutorial]]
* [[TDEConfig Module HOWTO]]
* [[Debugging TDE applications]]
* [[Sample Applications]]

===KDE3===
Information in this section should be used with care, as it was not written for the current version of Trinity. However, much of it still applies. If you know of any other interesting KDE3 documentation or tutorials, please add them to this section.

* [http://api.kde.org/3.5-api/kdelibs-apidocs/index.html KDE 3.5 API Reference]
: The original API reference, at kde.org
* [[KDE3 Architecture]]
: The architecture pages detail how everything was originally supposed to fit together. Ported from the KDE wiki.
* [[KDE3 Tutorials]]
: On everything from using kdevelop to writing dcop-aware applications to creating window themes. Ported from the KDE wiki.
* [[KDE3 Filesystem Hierarchy]]
: Ported from the KDE wiki and verified against a working KDE3 instance.
* [http://www.kde.org/info/requirements/3.5.php KDE3 Compilation Requirements]
: Mandatory and optional packages for building KDE3, most of which are still used by Trinity.

===Books===
====C++ GUI Programming with Qt 3====
Blanchette, Jasmin & Summerfield, Mark. (2015). [https://www.researchgate.net/publication/245591968_C_GUI_Programming_with_Qt_3 C++ GUI Programming with Qt 3]. (ISBN 0-13-124072-2)

Things to note:
* Names changed from "Qt..." to "TQt..."
* compiling by hand needs something like <code>g++ a.cpp $(pkgconf tqt --cflags --libs) -lstdc++</code>
* <code>qmake -project ...</code> will not include the TDE folders, so you'll have to add them manually to the *.pro file
* When in doubt check against the [http://trinitydesktop.org/docs/qt3/ TQt API documentation]

<small>by [https://mail.trinitydesktop.org/mailman3/hyperkitty/list/users@trinitydesktop.org/thread/AY7MVBPGHOJJUHJEV4NSLSLXG7QKQOEF/ Dr. Nikolaus Klepp]</small>

====GUI Programming with Python: QT Edition====
Boudewijn Rempt - Copyright © 2001 by Commandprompt, Inc

The main topic of this book is [http://nclairon.free.fr/documentation/pyqt/book1.htm application development using PyQt.]

==== KDE 2.0 Development ====
David Sweet, et al. (2002). [http://andamooka.org/~dsweet/kde2dev.pdf KDE 2.0 Development].

Covers, among other things, KDE 2.0 widgets, Qt API, actions, icons, custom widget painting, internationalization, network transparency, KParts, DCOP, aRts/MCOP, ImageIO, OpenGL and Mesa, drag and drop, session management, image manipulation, spell checking, and documentation creation.

Mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.

==== KDE 2/Qt Programming Bible ====
Arthur Griffith (2000). [https://box.cs.istu.ru/public/docs/devel/qt/kde%202%20-%20QT.pdf KDE 2/Qt Programming Bible]

Covers KDE 2.x and Qt 2 widgets, mouse and keyboard handling, graphic file formats, fonts, colors, drawing and painting with QPainter, graphics manipulation, drag and drop, IPC and applets, internationalization etc.

Also mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.
</noinclude>

Category:Developers

2024-05-07T08:20:19Z

Blu256: Added books: KDE 2.0 Development by David Sweet, et al. (2002) and KDE 2/Qt Programming Bible by Arthur Griffith (2000), freely available online.

This category contains development-related and API documentation for the Trinity Desktop Environment.<noinclude>

==New to Trinity development?==

Take a look at the following pages:

* [http://trinitydesktop.org/helpwanted.php Getting Involved with Trinity Development]
* [[TDE Gitea Workspace]]
* [[TDE Weblate Translation Workspace]]
* [[Project GIT Information]]
* [[Project RoadMap]]
* [[DevelopmentSpecifications]]
* [https://www.trinitydesktop.org/apidocs.php TQt/TDE API documentation]
* [[Porting to TDE|Porting KDE3/Qt3 apps to Trinity]]

==Building and Distributing Trinity==
* [[Nightly Builds|Installing Nightly Builds]]
* [[How to Build TDE Core Modules]]
* [[How to Build Extra Applications]]

See also pages in [[:Category:Packagers]].

==Tutorials and Documentation==

===Qt3 and TQt===
* [[Understanding the TQT Interface]]
* [https://www.trinitydesktop.org/docs/qt3 TQt API Documentation]

===Trinity===
* [https://www.trinitydesktop.org/docs/trinity/tdelibs/ TDELibs API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdebase/ TDEBase API Documentation]
* [https://www.trinitydesktop.org/docs/trinity/tdepim/ TDEPIM API Documentation]
* [[DCOP]], the IPC system used by TDE applications.
* [[TDEParts]], a mechanism for reusing and embedding elaborate widgets into applications (e.g. Konqueror)
* [[TDEIO]], an abstraction that provides network transparency between local and remote filesystems.
* [[TDEConfig XT Tutorial]]
* [[TDEConfig Module HOWTO]]
* [[Debugging TDE applications]]
* [[Sample Applications]]

===KDE3===
Information in this section should be used with care, as it was not written for the current version of Trinity. However, much of it still applies. If you know of any other interesting KDE3 documentation or tutorials, please add them to this section.

* [http://api.kde.org/3.5-api/kdelibs-apidocs/index.html KDE 3.5 API Reference]
: The original API reference, at kde.org
* [[KDE3 Architecture]]
: The architecture pages detail how everything was originally supposed to fit together. Ported from the KDE wiki.
* [[KDE3 Tutorials]]
: On everything from using kdevelop to writing dcop-aware applications to creating window themes. Ported from the KDE wiki.
* [[KDE3 Filesystem Hierarchy]]
: Ported from the KDE wiki and verified against a working KDE3 instance.
* [http://www.kde.org/info/requirements/3.5.php KDE3 Compilation Requirements]
: Mandatory and optional packages for building KDE3, most of which are still used by Trinity.

===Books===
====C++ GUI Programming with Qt 3====
Blanchette, Jasmin & Summerfield, Mark. (2015). [https://www.researchgate.net/publication/245591968_C_GUI_Programming_with_Qt_3 C++ GUI Programming with Qt 3]. (ISBN 0-13-124072-2)

Things to note:
* Names changed from "Qt..." to "TQt..."
* compiling by hand needs something like <code>g++ a.cpp $(pkgconf tqt --cflags --libs) -lstdc++</code>
* <code>qmake -project ...</code> will not include the TDE folders, so you'll have to add them manually to the *.pro file
* When in doubt check against the [http://trinitydesktop.org/docs/qt3/ TQt API documentation]

<small>by [https://mail.trinitydesktop.org/mailman3/hyperkitty/list/users@trinitydesktop.org/thread/AY7MVBPGHOJJUHJEV4NSLSLXG7QKQOEF/ Dr. Nikolaus Klepp]</small>

====GUI Programming with Python: QT Edition====
Boudewijn Rempt - Copyright © 2001 by Commandprompt, Inc

The main topic of this book is [http://nclairon.free.fr/documentation/pyqt/book1.htm application development using PyQt.]</noinclude>

==== KDE 2.0 Development ====
David Sweet, et al. (2002). [http://andamooka.org/~dsweet/kde2dev.pdf KDE 2.0 Development].

Covers, among other things, KDE 2.0 widgets, Qt API, actions, icons, custom widget painting, internationalization, network transparency, KParts, DCOP, aRts/MCOP, ImageIO, OpenGL and Mesa, drag and drop, session management, image manipulation, spell checking, and documentation creation.

Mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.

==== KDE 2/Qt Programming Bible ====
Arthur Griffith (2000). [https://box.cs.istu.ru/public/docs/devel/qt/kde%202%20-%20QT.pdf KDE 2/Qt Programming Bible]

Covers KDE 2.x and Qt 2 widgets, mouse and keyboard handling, graphic file formats, fonts, colors, drawing and painting with QPainter, graphics manipulation, drag and drop, IPC and applets, internationalization etc.

Also mind the changes that happened between Qt 2 and Qt 3, Qt3 and TQt, KDE 2.x and KDE 3.x and KDE 3.x and TDE.

Template:DistroTable

2024-05-01T08:14:24Z

Blu256: Ray-V slackbuilds updated to R14.1.2

This template provides a '''table with installation instructions''' per distribution/operating system. It also tells the latest available version of TDE for that system.

When there is a new release available for one of these systems, you only need to change the available version here; all the pages that use this template will show the updated data automatically.

Mark the latest release with <span style="background: lightgreen;">lightgreen</span>, the release before it with <span style="background: yellow;">yellow</span> and older releases with <span style="background: orange;">orange</span>.

If there is something important that should be noticed about packages (e.g. pending builds) consider adding them below the table in a [[:Template:TipBox|TipBox]] or a [[:Template:WarningBox|WarningBox]] appropriately.

= Example =

This is how it will look on the page:

<onlyinclude>{|
| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="2" | <big>Official Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
|-
| [[Debian Trinity Repository Installation Instructions|Debian]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Devuan Trinity Repository Installation Instructions|Devuan]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Fedora Trinity Repository Installation Instructions|Fedora]]
| style="background: lightgreen;" | R14.1.2
|-
| [[RedHat Trinity Repository Installation Instructions|RedHat]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Ubuntu Trinity Repository Installation Instructions|Ubuntu]]
| style="background: lightgreen;" | R14.1.2
|}

| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="4" | <big>Community Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
| '''Distribution'''
| '''Latest'''
|-
| [[Arch Trinity Repository Installation Instructions|Arch Linux]]
| style="background: lightgreen;" | R14.1.2
| [[MX Linux Trinity Repository Installation Instructions|MX Linux]]
| style="background: lightgreen;" | R14.1.2
|-
| [[FreeBSD Trinity Installation Instructions|FreeBSD]]
| style="background: lightgreen;" | R14.1.2 
| [[OpenSUSE Trinity Repository Installation Instructions|OpenSUSE]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Mageia Trinity Repository Installation Instructions|Mageia]]
| style="background: lightgreen;" | R14.1.2
| [[PCLinuxOS Trinity Repository Installation Instructions|PCLinuxOS]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Slackware Trinity Installation Instructions|Slackware]]
| style="background: lightgreen;" | R14.1.2
|-
| [[Raspbian Trinity Repository Installation Instructions|Raspbian]]
| style="background: lightgreen;" | R14.1.2
|}
|-
|colspan=2|
{| class="wikitable" style="width: 100%; margin: 0;"
|Building from source code: '''[[How to Build TDE Core Modules|base]]''' | '''[[How to Build Extra Applications|extra]]'''
|style="text-align: center;"|[[LiveCDs|Try a LiveCD]]
|}
|}
</onlyinclude>

User:Blu256

2024-03-13T14:49:05Z

Blu256: Just writing down some thoughts

= Contact =
* [[User talk:Blu256|Wiki discussion page]]
* Jabber: <tt>blu.256@jabb.im</tt>
* IRC nick: <tt>blu256</tt> (Libera.chat)

= TODO list =

Mostly for personal reference. Updated occasionally.

{| class="wikitable"
|+ Currently working on...
! Name
! Type
! Stage
! Target
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdemultimedia/pulls/31 KMix indicator]
| Feature
| Working on this
| R14.1.2
|}

{| class="wikitable"
|+ Misc. Planned Stuff
! Name
! Type
! Stage
! Target
|-
| Active borders and corners for TWin
| Feature
| Active borders support in [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/pulls/331 TDE/tdebase#331], more work needed for active corners)
| Active borders: R14.1.1
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdebase/issues/271 Kate: fix font style checkboxes between different schema font tabs]
| Improvement
| On hold
| R14.1.1
|-
| tdeio-mtp
| Feature
| On hold
| R14.2.0
|-
| [https://mirror.git.trinitydesktop.org/gitea/TDE/tdelibs/issues/151 Make KSSL use system root certificates]
| Improvement
| On hold
| R14.2.0
|}

== The Big Plans™ ==
Making no commitments here, but this is what I ultimately would like to work on:

* TQt: Support for latest Unicode including emoji
** As soon as CMake port of TQt is complete (the current build system is an undocumented mess)
** Probably look towards the ICU library, do not reinvent the wheel like Qt
ICU is a cross-platform Unicode based globalization library. It includes support for locale-sensitive string comparison, date/time/number/currency/message formatting, text boundary detection, character set conversion and so on.
** Not a priority, but an emoji picker would be nice and also very easy to implement after TQt support is complete
* TQt: Misc. new useful APIs
** TQJson
* WebKit port
** I'd really like to work on this one but my hardware is barely enough for building even just JSCOnly :-/<br>There really isn't much you can do with a Intel Core i3 with 8GB RAM.
** Probably two libraries:
***TQWebKit: the basic port
*** TDEWebKit: wrapper with TDE-specific enhancements?
* OAuth support in KMail
** Literally the only thing stopping me and many GMail users from using it
** Depends on the WebKit port
* A multimedia library for TDE
** Something like Phonon, maybe even Phonon itself

Category:Building from source code

2023-12-21T11:38:47Z

Blu256: Add category for convenicence

Template:DistroTable

2023-12-21T11:22:19Z

Blu256: Separate "Building from source" from the rest of the table, add link lo LiveCDs pagee

This template provides a '''table with installation instructions''' per distribution/operating system. It also tells the latest available version of TDE for that system.

When there is a new release available for one of these systems, you only need to change the available version here; all the pages that use this template will show the updated data automatically.

Mark the latest release with <span style="background: lightgreen;">lightgreen</span>, the release before it with <span style="background: yellow;">yellow</span> and older releases with <span style="background: orange;">orange</span>.

If there is something important that should be noticed about packages (e.g. pending builds) consider adding them below the table in a [[:Template:TipBox|TipBox]] or a [[:Template:WarningBox|WarningBox]] appropriately.

= Example =

This is how it will look on the page:

<onlyinclude>{|
| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="2" | <big>Official Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
|-
| [[Debian Trinity Repository Installation Instructions|Debian]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Devuan Trinity Repository Installation Instructions|Devuan]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Fedora Trinity Repository Installation Instructions|Fedora]]
| style="background: lightgreen;" | R14.1.1
|-
| [[RedHat Trinity Repository Installation Instructions|RedHat]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Ubuntu Trinity Repository Installation Instructions|Ubuntu]]
| style="background: lightgreen;" | R14.1.1
|}

| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="4" | <big>Community Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
| '''Distribution'''
| '''Latest'''
|-
| [[Arch Trinity Repository Installation Instructions|Arch Linux]]
| style="background: lightgreen;" | R14.1.1
| [[MX Linux Trinity Repository Installation Instructions|MX Linux]]
| style="background: lightgreen;" | R14.1.1
|-
| [[FreeBSD Trinity Installation Instructions|FreeBSD]]
| style="background: lightgreen;" | R14.1.1 
| [[OpenSUSE Trinity Repository Installation Instructions|OpenSUSE]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Mageia Trinity Repository Installation Instructions|Mageia]]
| style="background: lightgreen;" | R14.1.1
| [[PCLinuxOS Trinity Repository Installation Instructions|PCLinuxOS]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Slackware Trinity Installation Instructions|Slackware]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Raspbian Trinity Repository Installation Instructions|Raspbian]]
| style="background: lightgreen;" | R14.1.1
|}
|-
|colspan=2|
{| class="wikitable" style="width: 100%; margin: 0;"
|Building from source code: '''[[How to Build TDE Core Modules|base]]''' | '''[[How to Build Extra Applications|extra]]'''
|style="text-align: center;"|[[LiveCDs|Try a LiveCD]]
|}
|}
</onlyinclude>

Category:Documentation

2023-12-21T11:18:40Z

Blu256: /* Release Notes */ R14.1.1 is the latest version

=Release Notes=

; Latest release ([[Release Notes For R14.1.1|R14.1.1]])
<div class="R14_release_notes mw-collapsible mw-collapsed" style="width:400px; overflow:auto;">
; Older R14.0.x release notes.
<div class="mw-collapsible-content">
: [[Release Notes For R14.1.0|R14.1.0]]
: [[Release Notes For R14.0.13|R14.0.13]]
: [[Release Notes For R14.0.12|R14.0.12]]
: [[Release Notes For R14.0.11|R14.0.11]]
: [[Release Notes For R14.0.10|R14.0.10]]
: [[Release Notes For R14.0.9|R14.0.9]]
: [[Release Notes For R14.0.8|R14.0.8]]
: [[Release Notes For R14.0.7|R14.0.7]]
: [[Release Notes For R14.0.6|R14.0.6]]
: [[Release Notes For R14.0.5|R14.0.5]]
: [[Release Notes For R14.0.4|R14.0.4]]
: [[Release Notes For R14.0.3|R14.0.3]]
: [[Release Notes For R14.0.2|R14.0.2]]
: [[Release Notes For R14.0.1|R14.0.1]]
: [[Release Notes For R14.0.0|R14.0.0]]
</div>
</div>
<div class="v3.5_release_notes mw-collapsible mw-collapsed" style="width:400px; overflow:auto;">
; Older v3.5.x release notes.
<div class="mw-collapsible-content">
: [[Release Notes For 3.5.13.2|3.5.13.2]]
: [[Release Notes For 3.5.13.1|3.5.13.1]]
: [[Release Notes For 3.5.13|3.5.13]]
: [[Release Notes For 3.5.12|3.5.12]]
: [[Release Notes For 3.5.11|3.5.11]]
</div>
</div>

=Installation=

==Installing from a Package Manager==
To set up Trinity on your computer, you may wish to visit the appropriate installation page:

{{DistroTable}}

==Installing from Source==

[[How to Build TDE Core Modules]]

[[How to Build Extra Applications]] (K3B, amaroK, KOffice, Kaffeine...)

[[Notes on GIT Sources]]

[[Suggested Build Flags]] for specific distributions (currently Ubuntu and Debian, with a note on OpenSuSE)

=LiveCDs with Trinity=

{{:LiveCDs}}

=Tips and Tricks=
Make sure to check out the [[Tips_And_Tricks|Tips and Tricks]] page for contributions by TDE users.

=Other links in this category=

Suggested Build Flags

2023-12-21T11:17:16Z

Blu256: Add {{KDE3}} (outdated information)

==Suggested Build Flags==
[[Category:Documentation]]
[[Category:Installation]]

{{KDE3}}

Please note that you can find spec/dsc/PKGBUILD/emerge files [https://git.trinitydesktop.org/cgit/tde-packaging/ in our GIT repositories].

{| class="wikitable"
!Distribution Name
!Build Flags
!Prepackaged Binaries
|-
|Ubuntu
|
--prefix=/opt/kde3
--includedir=/opt/kde3/include/kde
--mandir=/opt/kde3/share/man
--infodir=/opt/kde3/share/info
--with-extra-libs=/opt/kde3/lib
--sysconfdir=/etc
--localstatedir=/var
--libexecdir="\${prefix}/lib/kdebase-kde3"
--disable-rpath
--with-xinerama
--enable-closure (when needed, which is most of the time)
|http://apt.pearsoncomputing.net
|-
|Debian
|
--prefix=/opt/trinity
--includedir=/opt/trinity/include/kde
--mandir=/opt/trinity/share/man
--infodir=/opt/trinity/share/info
--with-extra-libs=/opt/trinity/lib
--sysconfdir=/etc
--localstatedir=/var
--libexecdir="\${prefix}/lib/kdebase-kde3"
--disable-rpath
--with-xinerama
--enable-closure (when needed, which is most of the time)
|http://trinity.pearsoncomputing.net/debian_installation.html
|-
|SuSE
|Check the 'tde-filesystem' package for more information.
|N/A
|}

Template:DistroTable

2023-12-21T11:07:33Z

Blu256: Add "Building from source code" link

This template provides a '''table with installation instructions''' per distribution/operating system. It also tells the latest available version of TDE for that system.

When there is a new release available for one of these systems, you only need to change the available version here; all the pages that use this template will show the updated data automatically.

Mark the latest release with <span style="background: lightgreen;">lightgreen</span>, the release before it with <span style="background: yellow;">yellow</span> and older releases with <span style="background: orange;">orange</span>.

If there is something important that should be noticed about packages (e.g. pending builds) consider adding them below the table in a [[:Template:TipBox|TipBox]] or a [[:Template:WarningBox|WarningBox]] appropriately.

= Example =

This is how it will look on the page:

<onlyinclude>{|
| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="2" | <big>Official Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
|-
| [[Debian Trinity Repository Installation Instructions|Debian]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Devuan Trinity Repository Installation Instructions|Devuan]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Fedora Trinity Repository Installation Instructions|Fedora]]
| style="background: lightgreen;" | R14.1.1
|-
| [[RedHat Trinity Repository Installation Instructions|RedHat]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Ubuntu Trinity Repository Installation Instructions|Ubuntu]]
| style="background: lightgreen;" | R14.1.1
|-
| colspan=2 | [[How to Build TDE|Building from source code]]
|}

| style="vertical-align: top" | 
{|class="wikitable" style="margin: 0;"
! colspan="4" | <big>Community Instructions</big>
|-
| '''Distribution'''
| '''Latest'''
| '''Distribution'''
| '''Latest'''
|-
| [[Arch Trinity Repository Installation Instructions|Arch Linux]]
| style="background: lightgreen;" | R14.1.1
| [[MX Linux Trinity Repository Installation Instructions|MX Linux]]
| style="background: lightgreen;" | R14.1.1
|-
| [[FreeBSD Trinity Installation Instructions|FreeBSD]]
| style="background: lightgreen;" | R14.1.1 
| [[OpenSUSE Trinity Repository Installation Instructions|OpenSUSE]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Mageia Trinity Repository Installation Instructions|Mageia]]
| style="background: lightgreen;" | R14.1.1
| [[PCLinuxOS Trinity Repository Installation Instructions|PCLinuxOS]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Slackware Trinity Installation Instructions|Slackware]]
| style="background: lightgreen;" | R14.1.1
|-
| [[Raspbian Trinity Repository Installation Instructions|Raspbian]]
| style="background: lightgreen;" | R14.1.1
|}
|}
</onlyinclude>

How to Build Extra Applications

2023-12-21T11:01:55Z

Blu256: + Category:Building from source code

[[Category:Documentation]]
[[Category:Installation]]
[[Category:Developers]]
[[Category:Packagers]]
[[Category:Building from source code]]

This HowTo provides detailed notes and explanations for building the optional applications included in the
Trinity Desktop Environment code repository.

==Introduction and Requirements==

The optional applications are QT3 and KDE3 applications, some of them originally third-party, which have been
ported forward to TQT/TDE and are now maintained by the Trinity Project. All of them require TQT to be
installed, and many also require tdelibs, so they share the dependency list for the core packages.

Other than that, well, if this page looks awfully similar to [[How to Build TDE Core Modules]], that's
because they were both split from a single difficult-to-read mega-page on the old wiki, and some material
had to be common to both.

==Preparing the Source==

To use the release tarballs, just untar them somewhere.

To live dangerously and use the GIT sources, read [[Notes on GIT Sources]] first.

==Building==

===Building Packages with cmake===

====List of Packages Building with cmake====

cmake is the newer, easier, and more maintainable build system the Trinity Project is in the process of porting TDE source to.

The list of modules maintained as an [https://mirror.git.trinitydesktop.org/gitea/TDE/tde/issues/9 issue #9 in the TGW] indicates which application packages have already been converted, and their autotools build scripts are no longer maintained. Some other packages are in the process of conversion, but do not have complete cmake build scripts yet. Build everything not in the list above with autotools.

Read the notes for individual package requirements before trying to build anything.

====Performing a cmake Build====

The command listing below is only an example. You will wish to edit the exports if your distribution
puts things in unusual locations or if you wish to install to somewhere other than /opt/trinity . Not
all exports will be needed on all systems.

export PREFIX=/opt/trinity
export SYSCONFDIR=/etc/trinity
export LIBDIR=/opt/trinity/lib
export MANDIR=/opt/trinity/man
export QTDIR=/opt/trinity/lib/qt3-3.3.8.d
export PATH=/opt/trinity/qt3-3.3.8.d/bin:/opt/trinity/bin:$PATH
export LD_LIBRARY_PATH=/opt/trinity/lib:/opt/trinity/lib/trinity:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=:/opt/trinity/lib/pkgconfig:/opt/trinity/qt3-3.3.8.d/lib/pkgconfig:$PKG_CONFIG_PATH
# Enable only one of the following:
# export DEBUG_AUTOTOOL_OPT="--disable-debug"
export DEBUG_CMAKE_OPT=""

cmake path/to/trinity/module \
-DCMAKE_C_FLAGS:STRING="$CPUOPTIONS" \
-DCMAKE_CXX_FLAGS:STRING="$CPUOPTIONS $DEBUG_CMAKE_OPT" \
-DCMAKE_INSTALL_PREFIX=${PREFIX} \
-DSYSCONF_INSTALL_DIR=${SYSCONFDIR} \
-DLIB_SUFFIX=${LIBDIRSUFFIX} \
-DMAN_INSTALL_DIR=${MANDIR} \
-DBUILD_ALL=ON
make VERBOSE=1

====Notes====

*When building on 64-bit, the following (T)Qt3 configuration option might need to be explicitly declared in some distro build scripts:
-platform linux-g++-64 (rather than linux-g++ (notice the dash!))

*If class constructor issues surface during the build, please post the error to the trinity-users list.

===Building Packages with Autoconf===

====Introduction====

If the package you're trying to build is on the list of those that will build with cmake, try that first, because
its autotools files will be unmaintained, bit-rotted, and possibly outright broken.

Please read the notes for individual package requirements before trying to build anything.

For those packages that still need to be built with autotools, the following steps must be run for each affected
Trinity module, including tarball snapshots.

====Regenerate Autoconf/Automake files====

cd to the desired module to build, then run:

cp -Rp <path to your system's libtool.m4 file> admin/libtool.m4.in
cp -Rp <path to your system's ltmain.sh file> admin/ltmain.sh
make -f admin/Makefile.common

====Configure and Build====

export PREFIX=/opt/trinity
export SYSCONFDIR=/etc/trinity
export LIBDIR=/opt/trinity/lib
export MANDIR=/opt/trinity/man
export QTDIR=/opt/trinity/lib/qt3-3.3.8.d
export PATH=/opt/trinity/qt3-3.3.8.d/bin:/opt/trinity/bin:$PATH
export LD_LIBRARY_PATH=/opt/trinity/lib:/opt/trinity/lib/trinity:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=:/opt/trinity/lib/pkgconfig:/opt/trinity/qt3-3.3.8.d/lib/pkgconfig:$PKG_CONFIG_PATH
# Enable only one of the following:
# export DEBUG_AUTOTOOL_OPT="--enable-debug=full"
export DEBUG_AUTOTOOL_OPT="--disable-debug"

CFLAGS=$CPUOPT \
CXXFLAGS=$CPUOPT \
./configure \
--prefix=${PREFIX} \
--sysconfdir=${SYSCONFDIR} \
--libdir=${LIBDIR} \
--mandir=${MANDIR} \
--with-qt-dir=${QTDIR} \
--with-qt-includes=${QTDIR}/include \
--with-qt-libraries=${QTDIR}/lib \
$DEBUG_AUTOTOOL_OPT

View the Distribution Specific Builds page for additional configure options.

====Notes====

*Not well documented anywhere, but when building with automake several packages need the --enable-closure configure option:
**kaffeine
**kdiff3

*When building on 64-bit, the following (T)Qt3 configuration option might need to be explicitly declared in some distro build scripts:
-platform linux-g++-64 (rather than linux-g++ (notice the dash!))

===Build Times===

Building Trinity requires time and patience. Build times vary. Here are some guidelines from building
Trinity 3.5.12 on a dual core 2.3 GHz AM2 with 4GB of RAM, using tmpfs, 7200 rpm SATA II hard drives;
with Amarok, Firefox, Konsole, Konqueror, Kate, and other various apps often running concurrently. Compile
times will be faster without such overhead, but likely will be longer when building with support package hooks.
Packages using cmake will build faster than those still stuck on autotools.

*k3b: 8 minutes
*amarok: 10 minutes
*knemo: 2 minutes
*ktorrent: 7 minutes
*koffice: 109 minutes

==Installing==

The command is the same regardless of whether your package was built with cmake or autotools:

make install || exit 1

==Additional Functionality==

Some applications gain additional functionality when compiled with optional dependencies available.
What follows is an (incomplete) list.

===List of Optional Dependencies by Application===

====k3b====

*'''libsndfile''' C library for reading and writing sampled sound files
*'''libdvdcss''' library for transparent DVD device access with on-the-fly CSS decryption
*'''libdvdnav''' library support for DVD navigation features
*'''ffmpeg''' software to record, convert and stream audio and video
*'''lame''' MP3 encoding support
*'''libdv-''' quasar DV codec
*'''libdvdread''' read DVD video disks
*'''a52dec''' video decoder
*'''faac''' Advanced Audio Coder (MPEG2-AAC, MPEG4-AAC)
*'''faad2''' AAC decoder
*'''xvidcore''' MPEG-4 compliant video codec
*'''schroedinger''' C implementation of BBC's dirac codec
*'''openjpeg''' open-source JPEG 2000 codec
*'''x264''' H264/AVC video stream encoder
*'''speex''' an audio compression format designed for speech
*'''transcode''' video stream processor
*'''libquicktime''' library for reading and writing QuickTime? files
*'''mjpegtools''' video recording/playback tools
*'''libmpeg2''' mpeg-video decoding library
*'''vcdimager''' video CD and Super Video CD tools
*'''emovix''' video CD distribution tools
*'''musepack-tools''' Musepack decoder/encoder
*'''libmusicbrainz''' MusicBrainz? client library

====amarok====

*'''Ruby'''
*'''libmp4v2''' MP4V2 tagging

====koffice====

*'''wv2''' Microsoft Word conversion
*'''GraphicsMagick''' various image filters (chalk)
*'''PostgreSQL''' database server (kexi)

====kaffeine====

*'''cdparanoia''' digital audio extraction tool
*'''gst-plugins-base''' GStreamer plugins
*'''gstreamer''' streaming multimedia framework
*'''xine-lib''' xine multimedia playback engine libraries

====k9copy====

*'''ffmpeg''' software to record, convert and stream audio and video
*'''dvdauthor''' DVD authoring tools
*'''vamps''' DVD backup tool
*'''MPlayer''' movie player
*'''k3b''' CD and DVD creation and ripping

====digikam====

*'''lcms''' color management engine
*'''dcraw''' decode raw digital photos
*'''libgphoto2''' digital camera library
*'''jasper''' JPEG-2000 codec
*'''exiv2''' Exif and IPTC metadata library and tools
*'''libkdcraw''' dcraw C++ library wrapper
*'''libkexiv2''' exiv2 library wrapper
*'''libkipi''' image plugin interface structure
*'''kipi-plugins''' plugins for libKipi
*'''sqlite''' self contained SQL database engine

====gwenview====

*'''exiv2''' Exif and IPTC metadata library and tools
*'''libkexiv2''' exiv2 library wrapper
*'''libkipi''' image plugin interface structure
*'''kipi-plugins''' plugins for libKipi

==Quirks and Known Bugs==

===Krita Rename===

Koffice Krita has been renamed to Chalk.

===Third-party/LibreOffice===

This folder contains patches that add TDE support to the upstream LibreOffice
sources. The patches allow LibreOffice to use Trinity dialog boxes. The patches have not been merged into the upstream
LibreOffice GIT tree, but they work just fine as-is when applied to the stock LO sources. Obtaining the advantages of
these patches requires rebuilding LibreOffice from sources.

===OpenGL and nVidia===
Building many Trinity and related packages depend upon OpenGL, such as tdegraphics, k3b, koffice, tdenetwork, gwenview, digikam, etc.;

as well as dependency packages such as libkipi, libkdcraw, libkexiv2, avahi, etc.

If any of those packages are built when the proprietary nvidia drivers are installed, the dependent package will fail to build with an error about /usr/lib/libGL.la.

That file is installed by the proprietary nvidia package. When building for personal use only, then building those packages with nvidia installed will pose no harm.

When building packages for other users then build the entire suite of packages in a "clean" generic OpenGL environment.

Other users might not use the proprietary nvidia package. This is true of any package that has OpenGL dependencies.

===MSWord Support in KOffice===

The koffice package expects the wv2 package to provide MS Word import support. The older wv2-0.2.3 package is
somewhat broken. Users are encouraged to update wv2-0.2.3 to wv2-0.4.2. The newer version of wv2 is compiled with cmake
and ignores compiling with automake. The libwv2.la file provided upstream is broken with respect to automake and will
cause automake to fail. Basically, /usr/lib/libwv2.la is missing a proper header statement. This should be patched when
creating the wv2-0.4.2 package.

How to Build TDE Core Modules

2023-12-21T11:01:31Z

Blu256: + Category:Building from source code

[[Category:Documentation]]
[[Category:Installation]]
[[Category:Developers]]
[[Category:Packagers]]
[[Category:Building from source code]]
This HowTo provides detailed notes and explanations for building the Trinity Desktop Environment base
packages.

==Introduction and Requirements==

===Basic Building Requirements===

Individual Linux distributions might have different build requirements. If these are known they will be available
on the Distribution Specific Builds page.

There is an ongoing effort to convert the build process from autotools to cmake. Until the cmake conversion is
complete, both cmake and autotools are needed to build Trinity packages. cmake 2.8.12 or more recent is expected
when building with cmake.

To build the packages still using autotools, you will need a standard autotools setup (automake, autoconf, etc.)

You'll also need a C++ compiler. g++ from the GNU Compiler Collection is the most usual, the current GIT version of Trinity has been tested
against versions up to and including 4.6. clang++ is also supported.

===Other Requirements===

(NOTE: List compiled from old QT3/kdelibs/kde-base ebuilds--will someone please check these?)

Most of the non-build-related mandatory dependencies for the core Trinity packages are pretty basic:

*an X server
*openssl
*fontconfig
*freetype
*ghostscript
*xdg support
*libpng
*libmng

If your Linux distribution came with any kind of graphical environment at all, you should already have
this stuff.

To build tdepim, you will also need libical (standard on many distros).

See Additional Functionality for a list of optional dependencies and what they enable.

===About TQt===

Trinity uses the TQt widget toolkit. TQt is a fork of the last version of Qt3, with a significant amount of
bug-fixes and improvements. Since Trolltech, the original developer of Qt, dropped support for Qt3,
the Trinity Project has forked it and continued its maintenance and development.

===About libart===

libart-lgpl is another dependency package that the Trinity Project has taken over after it was
[https://bugzilla.gnome.org/show_bug.cgi?id=155472#c4 dropped] by its original maintainer, because
it needed several [http://git.trinitydesktop.org/cgit/libart-lgpl/diff/?id=150562b89b645c402f1bb837a09f8b84bf6e49ec patches]
to prevent crashes. The version of libart provided by the Trinity Project includes those patches and is
intended to be a replacement for any version of libart currently installed by any distro. Build this patched version
of libart and replace the stock libart installed with the distro.

===Coexisting with QT5/KDE Plasma===

Trinity is intended to be able to run on computers that also have KDE Plasma installed. Originally, a lot of
Trinity applications had the same names as their KDE4 counterparts, which was problematic. All of
those have been renamed. In general, this was accomplished by changing the old KDE "K" prefix to a
"T" ("kwin" -> "twin"). Applications that don't match anything currently part of KDE Plasma have retained
their old names.

To avoid stepping on KDE Plasma's toes, we ''strongly'' suggest picking a specific subdirectory prefix to install Trinity
to--the one used in these directions is $PREFIX=/opt/trinity.

==Preparing the Source==

To use the release tarballs, just untar them somewhere.

To live dangerously and use the GIT sources, read [[Notes on GIT Sources]] first.

==Building==

===Suggested Build Order===

A lot of the Trinity core packages depend on one another (in particular, everything depends on tdelibs).
Follow this build order to prevent problems.

Start with the required core packages:

#tqt3
#cmake-trinity
#tqtinterface
#arts
#dbus-tqt
#dbus-1-tqt
#tqca-tls (Recommended but required for some applications, such as the Kopete OTR add-on)
#libart-lgpl
#avahi-tqt (Recommended but required when supporting DNS discovery services)
#tdelibs
#tdebase

At this point, you should have a functioning TDE desktop with basic utilities (terminal, file manager,
text/source editors, etc.) If you're going to build tdebindings and want Python support available,
continue with the Python linking packages (or skip over them if you don't care about Python support):

#sip4-tqt
#python-tqt
#pytdeextensions
#python-trinity
#tqscintilla (if you want thr Scintilla editor component)

The following build order seems to work well for the remaining core packages when building the stable release.
You don't have to install everything, though, unless you're packaging TDE for your distribution--pick the packages
that suit your use case.

#tdebindings
#tdeaccessibility
#tdeutils
#tdemultimedia
#tdenetwork
#tdeadmin
#tdeartwork
#tdegames
#tdetoys
#tdeedu
#tdegraphics
#tdepim
#tdesdk (Build tdesdk after installing tdepim. tdepim provides libkcal (bugzilla) hooks for tdesdk.)
#tdevelop (Build tdevelop after tdesdk. tdesdk provides cvs support for tdevelop.)
#tdeaddons

Once that's done, you may want to add [[How to Build Extra Applications|some extra applications]] on top.

===Building Packages with cmake===

Starting from TDE version R14.0.11, the package cmake-trinity is mandatory prior to building, this package includes the required macros for the build.

====List of Packages Building with cmake====

cmake is the newer, easier, and more maintainable build system the Trinity Project is in the process of porting TDE source to.

The list of modules maintained as an [https://mirror.git.trinitydesktop.org/gitea/TDE/tde/issues/9 issue #9 in the TGW] indicates which core and dependency packages have already been converted, and their autotools build scripts are no longer maintained. Some other packages are in the process of conversion, but do not have complete cmake build scripts yet. Build everything not in the list above with autotools.

Read the notes section below for individual package requirements before trying to build anything.

====Performing a cmake Build with Ninja====

The command listing below is only an example. You will wish to edit the exports if your distribution
puts things in unusual locations or if you wish to install to somewhere other than /opt/trinity (tqtinterface
has special requirements--see the Notes). Not all exports will be needed on all systems.

export PREFIX=/opt/trinity
export SYSCONFDIR=/etc/trinity
export LIBDIR=$PREFIX/lib
export MANDIR=$PREFIX/man
export TQTDIR=$PREFIX/tqt3
export PATH=$TQTDIR/bin:$PREFIX/bin:$PATH
export LD_LIBRARY_PATH=$LIBDIR:$LIBDIR/trinity:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=:$LIBDIR/pkgconfig:$TQTDIR/lib/pkgconfig:$PKG_CONFIG_PATH
# for lib64:
# export LIBDIRSUFFIX=64
#
from the Trinity module:
mkdir -p build && cd build
cmake -G "Ninja" \
-DCMAKE_EXPORT_COMPILE_COMMANDS="ON" \
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-DCMAKE_SKIP_RPATH="OFF" \
-DCMAKE_INSTALL_PREFIX=${PREFIX} \
-DSYSCONF_INSTALL_DIR=${SYSCONFDIR} \
-DLIB_SUFFIX=${LIBDIRSUFFIX} \
-DMAN_INSTALL_DIR=${MANDIR} \
-DBUILD_ALL="ON" \
-DWITH_ALL_OPTIONS="ON" ..
cmake --build . -- -v

====Notes====

*Until the cmake migration is fully completed, tqtinterface should be built to install with a $PREFIX of /usr rather than /opt/trinity, even if you are installing everything else to /opt/trinity.

*tqtinterface requires the following additional QT-related build option:

-DQT_VERSION=3

*arts and tdelibs execute compiled binaries as part of the build process. Therefore they need to have -DCMAKE_SKIP_RPATH="OFF" set. All other modules do not need the RPATH set.

*When building on 64-bit, the following (T)Qt3 configuration option might need to be explicitly declared in some distro build scripts:

-platform linux-g++-64 (rather than linux-g++ (notice the dash!))

*If class constructor issues surface during the build, please post the error to the trinity-users list.

===Building Packages with Autoconf===

====Introduction====

If the package you're trying to build is on the list of those that will build with cmake, try that first, because
its autotools files will be unmaintained, bit-rotted, and possibly outright broken.

Please read the notes section below for individual package requirements before trying to build anything.

For those packages that still need to be built with autotools, the following steps must be run for each affected
Trinity module, including tarball snapshots.

====Regenerate Autoconf/Automake files====

cd to the desired module to build, then run:

cp -Rp <path to your system's libtool.m4 file> admin/libtool.m4.in
cp -Rp <path to your system's ltmain.sh file> admin/ltmain.sh
make -f admin/Makefile.common

====Configure and Build====

export PREFIX=/opt/trinity
export SYSCONFDIR=/etc/trinity
export LIBDIR=/opt/trinity/lib
export MANDIR=/opt/trinity/man
export QTDIR=/opt/trinity/lib/qt3-3.3.8.d
export PATH=/opt/trinity/qt3-3.3.8.d/bin:/opt/trinity/bin:$PATH
export LD_LIBRARY_PATH=/opt/trinity/lib:/opt/trinity/lib/trinity:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=:/opt/trinity/lib/pkgconfig:/opt/trinity/qt3-3.3.8.d/lib/pkgconfig:$PKG_CONFIG_PATH
# Enable only one of the following:
# export DEBUG_AUTOTOOL_OPT="--enable-debug=full"
export DEBUG_AUTOTOOL_OPT="--disable-debug"

CFLAGS=$CPUOPT \
CXXFLAGS=$CPUOPT \
./configure \
--prefix=${PREFIX} \
--sysconfdir=${SYSCONFDIR} \
--libdir=${LIBDIR} \
--mandir=${MANDIR} \
--with-qt-dir=${QTDIR} \
--with-qt-includes=${QTDIR}/include \
--with-qt-libraries=${QTDIR}/lib \
$DEBUG_AUTOTOOL_OPT

View the Distribution Specific Builds page for additional configure options.

====Notes====

*Certain modules will not build across multiple cores in parallel. That is, with a "make -j" flag set to anything greater than 1. These packages are:
**tdebindings (some people have no problems with this package and parallel processing)
**tdemultimedia (some people have no problems with this package and parallel processing)

*Not well documented anywhere, but when building with automake several packages need the --enable-closure configure option:
**tdeaccessibility
**tdeaddons
**tdeadmin
**tdebindings
**tdeedu
**tdegames
**tdemultimedia
**tdesdk

*When building on 64-bit, the following (T)Qt3 configuration option might need to be explicitly declared in some distro build scripts:

-platform linux=g++-64 (rather than linux-g++ (notice the dash!))

===Build Times===

Building Trinity requires time and patience. Build times vary. Here are some guidelines from building
Trinity 3.5.12 on a dual core 2.3 GHz AM2 with 4GB of RAM, using tmpfs, 7200 rpm SATA II hard drives;
with Amarok, Firefox, Konsole, Konqueror, Kate, and other various apps often running concurrently. Compile
times will be faster without such overhead, but likely will be longer when building with support package hooks.
Packages using cmake will build faster than those still stuck on autotools.

*tqtinterface: 2 minutes
*arts: 4 minutes
*tdelibs: 44 minutes
*tdebase: 33 minutes
*tdebindings: 36 minutes
*tdeaccessibility: 5 minutes
*tdeutils: 8 minutes
*tdemultimedia: 24 minutes
*tdenetwork: 23 minutes
*tdeadmin: 4 minutes
*tdeartwork: 3 minutes
*tdegames: 8 minutes
*tdetoys: 2 minutes
*tdeedu: 15 minutes
*tdegraphics: 17 minutes
*tdesdk: 14 minutes
*tdevelop: 27 minutes
*tdeaddons: 7 minutes
*tdewebdev: 12 minutes
*tdepim: 63 minutes

Approximate total time: 5 hours 51 minutes

Time to a functional system (basic desktop): 1 hour 23 minutes

==Installing==

The command is the same regardless of whether your package was built with cmake or autotools:

make install || exit 1

==Additional Functionality==

Certain Trinity packages gain additional functionality when compiled with additional dependencies available.
Also, we maintain some libraries which provide purely optional functionality.

===Optional Trinity Libraries===

None of these Trinity libraries are required but all provide additional functionality for a variety of packages.
These libraries must be built and installed before any packages using these libraries can take advantage of the
additional functionality.

*libkipi: required by kipi-plugins
*kipi-plugins: several high-end image viewers such as gwenview and digikam
*libkdcraw: several image viewers and graphics apps, such as chalk and digikam
*libkexiv2: several image viewers
*libksquirrel: required by ksquirrel (TDE swiss-army-knife for graphic file formats, also supports medical image formats if xmedcon is provided)
*libtqt-perl: adept add-on
*mlt: not required or supported at this time
*mlt++: not required or supported at this time
*pytdeextensions: replacement for PyQt3 and PyKDE3, and used by apps such as tdebindings and tde-guidance
*python-trinity: replacement for PyQt3 and PyKDE3, and used by apps such as tdebindings and tde-guidance

===List of Optional Dependencies by Trinity Package===

====tdelibs====

*'''avahi''' DNS discovery
*'''avahi-tqt''' Trinity TQt layer for avahi, available in Trinity libraries
*'''hspell''' Hebrew spell checking
*'''krb5''' Kerberos authentication
*'''openexr''' EXR image format

====tdebase====

*'''avahi''' DNS discovery
*'''avahi-tqt''' Trinity TQt layer for avahi, available in Trinity libraries
*'''krb5''' Kerberos authentication
*'''openexr''' EXR image format
*'''GraphicsMagick''' image filters

====tdebindings====

*'''Ruby'''
*'''JRE''' Java Runtime Environment
*'''JDK''' Java Development Kit
*'''Python'''
*'''python-trinity''', available in Trinity libraries
*'''pytdeextensions''', available in Trinity libraries

====tdeutils====

*'''xmms''' multimedia player (superkaramba)

====tdemultimedia====

*'''cdparanoia''' digital audio extraction tool (kaudiocreator)
*'''speex''' an audio compression format designed for speech

====tdenetwork====

*'''xmms''' multimedia player (kopete plugins)
*'''ortp''' real-time transport protocol stack under GPL (kopete plugins)
*'''speex''' audio compression format designed for speech (kopete plugins)

====tdeedu====

*'''facile''' functional constraint library (kalzium)
*'''ocaml''' A programming language (kalzium)
*'''boost''' boost C++ Libraries

====tdevelop====

*'''graphviz''' graph visualization

====tdeaddons====

*'''xmms''' multimedia player (kicker applets)

====tdewebdev====

*'''XSLT''' Extensible Stylesheet Language Transformations
*'''DocBook''' text markup

====tdepim====

*'''krb5''' Kerberos authentication
*'''ortp''' real-time transport protocol stack under GPL (kopete)
*'''gnokii''' Nokia mobile phone support
*'''opensync''' data synchronization support
*'''libcaldav''' online calendar support, available through Trinity web site (http://www.trinitydesktop.org/relatedprojects.php)
*'''libcarddav''' online address book support, available through Trinity web site (http://www.trinitydesktop.org/relatedprojects.php)

==Quirks and Known Bugs==

===Building Sip===

Sip is available on many/most distros. Sip requires Qt3 to build, but won't build on TQt3, which adds
the tqinterface layer to Qt3. More than likely down the road, Sip will be dumped or moved to Qt4 by distro
maintainers. All of the python-*-tqt-* packages need Sip to build. Build this TQt3 compatible version of Sip
and replace the stock Sip installed with the distro.

===OpenGL and nVidia===

Building many Trinity and related packages depend upon OpenGL, such as
tdegraphics, k3b, koffice, tdenetwork, gwenview, digikam, etc.;

as well as dependency packages such as
libkipi, libkdcraw, libkexiv2, avahi, etc.

If any of those packages are built when the proprietary nvidia drivers are installed, the dependent package will fail to build
with an error about /usr/lib/libGL.la.

That file is installed by the proprietary nvidia package. When building for personal use only, then building those packages with nvidia installed will pose no harm.

When building packages for other users then build the entire suite of packages in a "clean" generic OpenGL environment.

Other users might not use the proprietary nvidia package. This is true of any package that has OpenGL dependencies.

===Tdeartwork and xhack Screensavers===

Before building tdeartwork, install any and all xhack screensavers that might be uses, then

cd <tdeartwork>/kscreensaver/kxsconfig/
./update_hacks.sh

This will generate the TDE bindings required to allow installed screensavers show up in the Trinity
screensaver control panel, along with their configuration options. When adding a new screensaver the
update_hacks command needs to be rerun and tdeartwork recompiled/reinstalled. Distribution maintainers should
install all available screensavers from their distribution and then run update_hacks during the initial build
setup when building redistributable binary packages (see the Debian tdeartwork build scripts in GIT for an
example of how to do this).

===Poppler Support in Tdegraphics===

Building tdegraphics with poppler support requires building a Trinity poppler-tqt support package. With
many distros poppler no longer is built with Qt3 support. The Trinity poppler-tqt provides the necessary hooks for
tdegraphics without rebuilding poppler. The poppler-tqt dependency sources are located in the tdegraphics/kfile-plugins
dependencies directory and are built automatically with the tdegraphics build option -DWITH_PDF=ON.

===Tdesvn/Tdesdk svn-kio Conflict===

tdesvn and tdesdk provide conflicting files for svn-kio services. Neither package is a dependency of the other.
When tdesdk or tdesvn will be installed without the other, then no change is required. When both tdesdk and tdesvn
are to be installed, then to avoid filesystem conflicts the following files must be removed from one of the packages
before installing:

/opt/trinity/share/services/svn+file.protocol
/opt/trinity/share/services/svn+http.protocol
/opt/trinity/share/services/svn+https.protocol
/opt/trinity/share/services/svn+ssh.protocol
/opt/trinity/share/services/svn.protocol

Since tdesvn uses the ksvn kio exclusively, while tdesdk uses the svn kio, consider removing the conflicting files
from tdesdk to eliminate the same services relying on multiple kio service files.

TDM

2023-12-18T11:27:38Z

Blu256: fix formatting

'''TDM''' is the default graphical display manager of the Trinity Desktop Environment. It handles local and remote logins on a machine.

__TOC__

== Remote login ==
Remote login can be performed via the XDMCP protocol. Due to security concerns, the XDMCP host component is disabled by default in TDM (but you can still connect to XDMCP hosts as a client).

{{WarningBox|text=ArchWiki on the matter of [https://wiki.archlinux.org/title/XDMCP XDMCP]:
''XDMCP is, similarly to telnet, doing unencrypted authentication. If snooping is possible, this leaves the system vulnerable to attack. It is disabled by default, using an ssh tunnel for X traffic is preferred.''
As a matter of fact, you should only use it in a completely trusted and controlled environment.
}}

To be able to login into a machine remotely you should edit the <tt>tdmrc</tt> file. Find the section titled <tt>[Xdmcp]</tt> and set the <tt>Enable</tt> key to <tt>true</tt>. Then, restart the tdm service.

On the remote side select "Remote login" from the options menu of the TDM login screen. You should be presented with a dialog of the remote machines to which you can connect via XDMCP. If you don't see the machine you want to connect to in the list, enter its IP address and press "Add". It should appear in the list.

By default a host might not allow remote connections despite being open for XDMCP requests. In XDMCP terminology, the host must be "Willing" to accept the remote connection. If you see "Display not authorized to connect" in the remote login dialog next to the address/hostname of the machine you want to connect to, you have to configure which hosts are allowed to connect to the machine. Follow the instructions in the <tt>Xaccess</tt> file (it should be in the same directory as <tt>tdmrc</tt>) to set up authorized hosts. After that, restart TDM and repeat the process.

When you select the desired host in the remote login menu and press "Connect", assuming the configuration is correct, you will be presented with the login screen of the host you are trying to connect to. If you see the local login screen again, then something has gone wrong. Ensure you have configured both instances of TDM according to the above instructions.

== Technical details ==

=== TDM's file system layout ===

* <span style='color: darkorange'><tt>${tde_confdir}</tt> is usually <tt>${prefix}/share/config</tt></span>
* <span style='color: darkorange'><tt>${tde_datadir}</tt> is usually <tt>${prefix}/share/apps</tt></span>
* <tt>${tde_confdir}/tdm/{tdmrc,Xservers,Xaccess,Xwilling,...}</tt>
* <tt>${tde_datadir}/tdm/sessions/*.desktop</tt>
* <tt>/etc/X11/sessions/,/usr/share/xsessions/</tt>
* <tt>${tde_datadir}/tdm/pics/users/</tt>
* <tt>${tde_datadir}/tdm/pics/</tt>
* <tt>${tde_datadir}/tdm/faces/*.face{,.icon}</tt>
* <tt>/usr/share/faces/</tt>
* <tt>/var/run/xauth/A*</tt>
* <tt>/var/run/xdmctl/xdmctl*</tt>
* <tt>/var/run/tdm.pid</tt>
* <tt>/var/lib/tdm/tdmsts</tt>
* <tt><site-specific>/*.dmrc</tt>
* <tt>$HOME/.face{,.icon}</tt>
* <tt>$HOME/.dmrc</tt>

=== How to setup TDM ===

TDM's config files are all located in <tt>${tde_confdir}/tdm</tt>. "make install" will create a probably working configuration, either by deriving it from an already present TDM/XDM installation or by using defaults if no previous installation is found.

You can change the configuration from the Trinity Control Center. You will find the "Login Manager" module in the "System Administration" group.

Have a look at <tt>README.pam</tt> in the <tt>tdebase</tt> top level directory if your system uses PAM.

=== Configuring session types ===
Session types are represented by .desktop files in appropriate locations. The format of the .desktop files is (not yet) defined in the FreeDesktop.org desktop entry spec. Differences to "standard" .desktop files are:
* the <code>Type</code> is fixed to <tt>XSession</tt> and can be omitted.
* the <code>Encoding</code> is fixed to <tt>UTF-8</tt> and can be omitted.
* the <code>Exec</code> field will be passed to <tt>"eval exec"</tt> in a bourne shell; no macro expansion is performed on it. "default", "custom" and "failsafe" are magic constants that cause special actions.
* <code>Name</code>, <code>Comment</code>, <code>TryExec</code> and <code>Hidden</code> are supported.
* the remaining keys have no meaning currently.

Session types are internally identified by filename (without extension); that's what will be saved to <tt>~/.dmrc</tt> and what DESKTOP_SESSION will be set to. For every magic <code>Exec</code> constant a session type of the same name exists.

Unless your system is configured differently already, you should create a directory <tt>${tde_confdir}/tdm/sessions</tt> and add this to <tt>tdmrc</tt>:

<syntaxhighlight lang="ini">
[X-*-Core]
SessionsDirs=${tde_confdir}/tdm/sessions,${tde_datadir}/tdm/sessions
</syntaxhighlight>

{{WarningBox|text=Always keep in mind the following:
* You must use actual paths instead of variables, see the section about TDM's file system layout.
* Do any changes only in the config directory - any changes in the data directory will be lost after the next TDE update.}}

To override a session type, copy the .desktop file from the data directory to the config directory and edit it at will. Removing the shipped session types can be accomplished by "shadowing" them with .desktop files containing <code>Hidden=true</code>.

For the magic session types no .desktop files exist by default, but TDM pretends they would, so you can override them like any other type.

=== The command sockets ===
This is a feature you can use to remote-control TDM. It's mostly intended for use by ksmserver and kdesktop from a running session, but other applications are possible as well.

The sockets are UNIX domain sockets which live in subdirectories of the directory specified by <code>FifoDir=</code>. The subdir is the key to addressing and security; the sockets all have the file name "socket" and file permissions <tt>rw-rw-rw-</tt> (0666). This is because some systems don't care for the file permissions of the socket files.

There are two types of sockets: the global one (<tt>dmctl</tt>) and the per-display ones (<tt>dmctl-<display></tt>).

The global one's subdir is owned by root, the subdirs of the per-display ones' are owned by the user currently owning the session (root or the logged in user). Group ownership of the subdirs can be set via <code>FifoGroup=</code>, otherwise it's root. The file permissions of the subdirs are <tt>rwxr-x---</tt> (0750).

The fields of a command are separated by tabs (\t), the fields of a list are separated by spaces, literal spaces in list fields are denoted by "<tt>\s</tt>". The command is terminated by a newline (<tt>\n</tt>). The same applies to replies. The reply on success is "<tt>ok</tt>", possibly followed by the requested information. The reply on error is an errno-style word (e.g., "<tt>perm</tt>", "<tt>noent</tt>", etc.) followed by a longer explanation.

==== Global commands ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">login {display} ("now"|"schedule") {user} {password} [session_arguments]</syntaxhighlight>
| Login user at specified display. if "now" is specified, a possibly running session is killed, otherwise the login is done after the session exits.
<tt>session_arguments</tt> are printf-like escaped contents for <tt>.dmrc</tt>. Unlisted keys will default to previously saved values.
|}

==== Per-display commands ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">lock</syntaxhighlight>
| The display is marked as locked. If the X-Server crashes in this state, no auto-relogin will be performed even if the option is on.
|-
| <syntaxhighlight lang="shell">unlock</syntaxhighlight>
| Reverse the effect of "lock": re-enable auto-relogin.
|-
| <syntaxhighlight lang="shell">suicide</syntaxhighlight>
| The currently running session is forcibly terminated. No auto-relogin is attempted, but a scheduled "login" command will be executed.
|}

==== Commands for all sockets ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">caps</syntaxhighlight>
| Returns a list this socket's capabilities:
{|
|<code>tdm</code>
| identifies tdm, in case some other DM implements this protocol, too
|-
| <code>list</code>, <code>activate</code>, <code>lock</code>, <code>suicide</code>, <code>login</code>
| whether the respective command is supported
|-
| <code>bootoptions</code>
| whether the <tt>listbootoptions</tt> command and the "=" option to "<tt>shutdown</tt>" are supported
|-
| <code>shutdown {list}</code>
| whether "shutdown" is supported and allowed to the listed users (comma-separated), "*" means all authenticated users
|-
| <code>shutdown</code>
| whether "shutdown" is supported and allowed to everybody
|-
| <code>nuke {list}</code>
| whether forced shutdown is allowed to the listed users
|-
| <code>nuke</code>
| whether forced shutdown is allowed to everybody
|-
| <code>reserve {number}</code>
| whether reserve displays are configured and <number> are available at this time
|}
|-
| <syntaxhighlight lang="shell">list [all|alllocal]</syntaxhighlight>
| Return a list of running sessions. By default all active sessions are listed.

If "<tt>all</tt>" is specified, passive sessions are listed as well.

If "<tt>alllocal</tt>" is specified, passive sessions are listed as well, but all incoming remote sessions are skipped.

Each session entry is a comma-separated tuple of:
* Display or TTY name
* VT name for local sessions
* Logged in user's name, empty for passive sessions and outgoing remote sessions (local chooser mode)
* Session type or remote host for outgoing remote sessions, empty for passive sessions
* A flag field:
** "t" for tty sessions
** "*" for the display belonging to the requesting socket
** "!" for sessions that cannot be killed by the requesting socket
|-
| <syntaxhighlight lang="shell">reserve [timeout in seconds]</syntaxhighlight>
| Start a reserve login screen. If nobody logs in within the specified amount of time (one minute by default), the display is removed again. When the session on the display exits, the display is removed, too.
Permitted only on sockets of local displays and the global socket.
|-
| <syntaxhighlight lang="shell">activate (vt|display)</syntaxhighlight>
| Switch to a particular VT (virtual terminal). The VT may be specified either directly (e.g., vt3) or by a display using it (e.g., :2).
Permitted only on sockets of local displays and the global socket.
|-
| <syntaxhighlight lang="shell">listbootoptions</syntaxhighlight>
| List available boot options.
=> "ok" list default current
*default and current are indices into the list and are -1 if unset or undeterminable.
|-
| <syntaxhighlight lang="shell">shutdown (reboot|halt)[={bootchoice}] (ask|trynow|forcenow|schedule|start (-1|end (force|forcemy|cancel)))</syntaxhighlight>
| Request a system shutdown, either a reboot or a halt/poweroff.
An OS choice for the next boot may be specified from the list returned by "listbootoptions".

Shutdowns requested from per-display sockets are executed when the current session on that display exits. Such a request may pop up a dialog asking for confirmation and/or authentication.

* <tt>start</tt> is the time for which the shutdown is scheduled. If it starts with a plus-sign, the current time is added. Zero means immediately.
* <tt>end</tt> is the latest time at which the shutdown should be performed if active sessions are still running. If it starts with a plus-sign, the start time is added. Minus one means wait infinitely. If end is through and active sessions are still running, TDM can do one of the following:
** <tt>cancel</tt> - give up the shutdown.
** <tt>force</tt> - shut down nonetheless.
** <tt>forcemy</tt> - shut down nonetheless if all active sessions belong to the requesting user. Only for per-display sockets.
* <tt>trynow</tt> is a synonym for "0 0 cancel", <tt>forcenow</tt> for "0 0 force" and <tt>schedule</tt> for "0 -1".
* <tt>ask</tt> attempts an immediate shutdown and interacts with the user if active sessions are still running. Only for per-display sockets.
* <tt>start</tt> and end are specified in seconds since the UNIX epoch.
|-
| <syntaxhighlight lang="shell">shutdown cancel [local|global]</syntaxhighlight>
| Cancel a scheduled shutdown. The global socket always cancels the currently pending shutdown, while per-display sockets default to cancelling their queued request.
|-
| <syntaxhighlight lang="shell">shutdown status</syntaxhighlight>
| Return a list with information about shutdowns.
The entries are comma-separated tuples of:
* ("global"|"local") - pending vs. queued shutdown. A local entry can be returned only by a per-display socket.
* ("halt"|"reboot")
* start
* end
* ("ask"|"force"|"forcemy"|"cancel")
* Numeric user ID of the requesting user, -1 for the global socket.
* The next boot OS choice or "-" for none.
|}

There are two ways of using the sockets:
* Connecting them directly. FifoDir is exported as $DM_CONTROL; the name of per-display sockets can be derived from $DISPLAY.
* By using the <tt>tdmctl</tt> command (e.g., from within a shell script). Try "<tt>tdmctl -h</tt>" to find out more.

Here is an example bash script "reboot into FreeBSD":

<syntaxhighlight lang="shell">
if tdmctl | grep -q shutdown; then
IFS=$'\t'
set -- `tdmctl listbootoptions`
if [ "$1" = ok ]; then
fbsd=$(echo "$2" | tr ' ' '\n' | sed -ne 's,\\s, ,g;/freebsd/I{p;q}')
if [ -n "$fbsd" ]; then
tdmctl shutdown reboot "=$fbsd" ask > /dev/null
else
echo "FreeBSD boot unavailable."
fi
else
echo "Boot options unavailable."
fi
else
echo "Cannot reboot system."
fi
</syntaxhighlight>

== Troubleshooting ==
TDM accepts two command line options related to logging:

-debug <n>
<n> is a decimal or hexadecimal (prefix 0x) number.
The number is a bitfield, i.e., it is formed by summing up the
required values from this table:
1 (0x1) - core debugging. Probably the most useful one.
2 (0x2) - config reader debugging.
4 (0x4) - greeter debugging.
8 (0x8) - IPC debugging. This logs _all_ communication between the
core, the config reader and the greeter - including the
passwords you type, so edit the log before showing it to
somebody.
This attempts to synchronize the processes to interleave the
log messages optimally, but will probably fail unless you use
-debug 0x80 as well.
16 (0x10) - wait after forking session sub-daemon.
32 (0x20) - wait after starting config reader.
64 (0x40) - wait after starting greeter.
The wait options are only useful if you need to attach a debugger
to a process, but it crashes before you are able to do so without
the delay. See below.
128 (0x80) - don't use syslog for internally generated messages.
256 (0x100) - core Xauth debugging.
1024 (0x400) - run config reader and greeter through valgrind.
2048 (0x800) - run config reader and greeter through strace.

Logs from "-debug 7" are usually a good start.

-error <file>, -logfile <file>
<file> is the file to log various messages to. The default log file is
/var/log/tdm.log. For internal reasons there is no option in tdmrc to
permanently specify the log file location. If you redirect TDM's
standard error output to a file, TDM will log there.
If TDM is configured to use syslog (and it _very_ probably is on any
modern system), all internally generated messages are logged to the
"daemon" facility. The log usually can be found in /var/log/debug.log
and /var/log/daemon.log; make sure that daemon.* is logged (look at
/etc/syslog.conf).
If you have problems logging in and your system uses PAM (also quite
probable on modern systems), the "auth" and "authpriv" syslog facilities
are interesting, too.

When reporting bugs, send all the logs together with a detailed description of what you did and what happened. If your problem is related to a specific configuration, you should also attach a tar.gz archive of your TDM config directory.

=== Producing a backtrace ===
If a backtrace is requested from you and TDM didn't create one yet via the usual drkonqi procedure, you'll have to do that yourself. The keyphrase is "attaching gdb". How exactly this is done depends on the part that crashes:

==== Attaching gdb to the process ====
===== Master daemon =====
Actually you should never need to attach to it, as you can start it within the debugger already:

<syntaxhighlight lang="shell-session">
# gdb --args tdm -nodaemon -debug 7
(gdb) run
</syntaxhighlight>

===== Display subdaemon =====
Find (using ps) the process with a name like "-:0" (where :0 is actually the display this process is for). This process' PPID is the master daemon. Attach to it this way:

<syntaxhighlight lang="shell-session">
# gdb tdm <the PID you found>
(gdb) cont
</syntaxhighlight>

If the subdaemon crashes before you can attach, add 16 to the debug flags when you start TDM.

===== Config reader =====
You will have to add 32 to the debug flags almost certainly. The PPID will be the master daemon as well.

<syntaxhighlight lang="shell-session">
# gdb tdm_config $(pidof tdm_config)
(gdb) cont
</syntaxhighlight>

===== Greeter =====
If it's too fast, add 64 to -debug. The PPID will be the subdaemon.

<syntaxhighlight lang="shell-session">
# gdb tdm_greet $(pidof tdm_greet)
(gdb) cont
</syntaxhighlight>

The simplification with "pidof" works only if you have only one display, otherwise you have to find the PID manually (by using ps -fx).

==== Reproduce crash and create backtrace ====
Once you got gdb attached to the offending process, do whatever is needed to make it crash (probably nothing, if you had to use a delay parameter).

Once it crashed, gdb will tell you a signal name, like SIGSEGV - that's the first interesting part. Then you have to create the actual backtrace:

<syntaxhighlight lang="shell-session">
(gdb) bt
</syntaxhighlight>

The output of this command is interesting for the developer, so a backtrace might be useful even if nothing crashes, but instead hangs. In this case don't use "cont" after attaching, but use "bt" right away. If the process is already running, interrupt it with ctrl-c.

For obvious reasons you have to run gdb on a different virtual terminal than the X server. To get there, press alt-ctrl-f1 and log in as root. To switch to the X server's vt, press alt-ctrl-f7 (the exact function key may be different on your system). You may also use a remote login from a second machine. In any case it is advantageous to have mouse support on the debugging console for copying the backtrace.

Note that a backtrace is usually much more useful if the binary contains debugging info.

TDM

2023-12-18T11:26:19Z

Blu256: Add page about TDM (Remote login via XDMCP + some technical info from the README file)

''TDM'' is the default graphical display manager of the Trinity Desktop Environment. It handles local and remote logins on a machine.

__TOC__

== Remote login ==
Remote login can be performed via the XDMCP protocol. Due to security concerns, the XDMCP host component is disabled by default in TDM (but you can still connect to XDMCP hosts as a client).

{{WarningBox|text=ArchWiki on the matter of [https://wiki.archlinux.org/title/XDMCP XDMCP]:
''XDMCP is, similarly to telnet, doing unencrypted authentication. If snooping is possible, this leaves the system vulnerable to attack. It is disabled by default, using an ssh tunnel for X traffic is preferred.''
As a matter of fact, you should only use it in a completely trusted and controlled environment.
}}

To be able to login into a machine remotely you should edit the <tt>tdmrc</tt> file. Find the section titled <tt>[Xdmcp]</tt> and set the <tt>Enable</tt> key to <tt>true</tt>. Then, restart the tdm service.

On the remote side select "Remote login" from the options menu of the TDM login screen. You should be presented with a dialog of the remote machines to which you can connect via XDMCP. If you don't see the machine you want to connect to in the list, enter its IP address and press "Add". It should appear in the list.

By default a host might not allow remote connections despite being open for XDMCP requests. In XDMCP terminology, the host must be "Willing" to accept the remote connection. If you see "Display not authorized to connect" in the remote login dialog next to the address/hostname of the machine you want to connect to, you have to configure which hosts are allowed to connect to the machine. Follow the instructions in the <tt>Xaccess</tt> file (it should be in the same directory as <tt>tdmrc</tt>) to set up authorized hosts. After that, restart TDM and repeat the process.

When you select the desired host in the remote login menu and press "Connect", assuming the configuration is correct, you will be presented with the login screen of the host you are trying to connect to. If you see the local login screen again, then something has gone wrong. Ensure you have configured both instances of TDM according to the above instructions.

== Technical details ==

=== TDM's file system layout ===

* <span style='color: darkorange'><tt>${tde_confdir}</tt> is usually <tt>${prefix}/share/config</tt></span>
* <span style='color: darkorange'><tt>${tde_datadir}</tt> is usually <tt>${prefix}/share/apps</tt></span>
* <tt>${tde_confdir}/tdm/{tdmrc,Xservers,Xaccess,Xwilling,...}</tt>
* <tt>${tde_datadir}/tdm/sessions/*.desktop</tt>
* <tt>/etc/X11/sessions/,/usr/share/xsessions/</tt>
* <tt>${tde_datadir}/tdm/pics/users/</tt>
* <tt>${tde_datadir}/tdm/pics/</tt>
* <tt>${tde_datadir}/tdm/faces/*.face{,.icon}</tt>
* <tt>/usr/share/faces/</tt>
* <tt>/var/run/xauth/A*</tt>
* <tt>/var/run/xdmctl/xdmctl*</tt>
* <tt>/var/run/tdm.pid</tt>
* <tt>/var/lib/tdm/tdmsts</tt>
* <tt><site-specific>/*.dmrc</tt>
* <tt>$HOME/.face{,.icon}</tt>
* <tt>$HOME/.dmrc</tt>

=== How to setup TDM ===

TDM's config files are all located in <tt>${tde_confdir}/tdm</tt>. "make install" will create a probably working configuration, either by deriving it from an already present TDM/XDM installation or by using defaults if no previous installation is found.

You can change the configuration from the Trinity Control Center. You will find the "Login Manager" module in the "System Administration" group.

Have a look at <tt>README.pam</tt> in the <tt>tdebase</tt> top level directory if your system uses PAM.

=== Configuring session types ===
Session types are represented by .desktop files in appropriate locations. The format of the .desktop files is (not yet) defined in the FreeDesktop.org desktop entry spec. Differences to "standard" .desktop files are:
* the <code>Type</code> is fixed to <tt>XSession</tt> and can be omitted.
* the <code>Encoding</code> is fixed to <tt>UTF-8</tt> and can be omitted.
* the <code>Exec</code> field will be passed to <tt>"eval exec"</tt> in a bourne shell; no macro expansion is performed on it. "default", "custom" and "failsafe" are magic constants that cause special actions.
* <code>Name</code>, <code>Comment</code>, <code>TryExec</code> and <code>Hidden</code> are supported.
* the remaining keys have no meaning currently.

Session types are internally identified by filename (without extension); that's what will be saved to <tt>~/.dmrc</tt> and what DESKTOP_SESSION will be set to. For every magic <code>Exec</code> constant a session type of the same name exists.

Unless your system is configured differently already, you should create a directory <tt>${tde_confdir}/tdm/sessions</tt> and add this to <tt>tdmrc</tt>:

<syntaxhighlight lang="ini">
[X-*-Core]
SessionsDirs=${tde_confdir}/tdm/sessions,${tde_datadir}/tdm/sessions
</syntaxhighlight>

{{WarningBox|text=Always keep in mind the following:
* You must use actual paths instead of variables, see the section about TDM's file system layout.
* Do any changes only in the config directory - any changes in the data directory will be lost after the next TDE update.}}

To override a session type, copy the .desktop file from the data directory to the config directory and edit it at will. Removing the shipped session types can be accomplished by "shadowing" them with .desktop files containing <code>Hidden=true</code>.

For the magic session types no .desktop files exist by default, but TDM pretends they would, so you can override them like any other type.

=== The command sockets ===
This is a feature you can use to remote-control TDM. It's mostly intended for use by ksmserver and kdesktop from a running session, but other applications are possible as well.

The sockets are UNIX domain sockets which live in subdirectories of the directory specified by <code>FifoDir=</code>. The subdir is the key to addressing and security; the sockets all have the file name "socket" and file permissions <tt>rw-rw-rw-</tt> (0666). This is because some systems don't care for the file permissions of the socket files.

There are two types of sockets: the global one (<tt>dmctl</tt>) and the per-display ones (<tt>dmctl-<display></tt>).

The global one's subdir is owned by root, the subdirs of the per-display ones' are owned by the user currently owning the session (root or the logged in user). Group ownership of the subdirs can be set via <code>FifoGroup=</code>, otherwise it's root. The file permissions of the subdirs are <tt>rwxr-x---</tt> (0750).

The fields of a command are separated by tabs (\t), the fields of a list are separated by spaces, literal spaces in list fields are denoted by "<tt>\s</tt>". The command is terminated by a newline (<tt>\n</tt>). The same applies to replies. The reply on success is "<tt>ok</tt>", possibly followed by the requested information. The reply on error is an errno-style word (e.g., "<tt>perm</tt>", "<tt>noent</tt>", etc.) followed by a longer explanation.

==== Global commands ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">login {display} ("now"|"schedule") {user} {password} [session_arguments]</syntaxhighlight>
| Login user at specified display. if "now" is specified, a possibly running session is killed, otherwise the login is done after the session exits.
<tt>session_arguments</tt> are printf-like escaped contents for <tt>.dmrc</tt>. Unlisted keys will default to previously saved values.
|}

==== Per-display commands ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">lock</syntaxhighlight>
| The display is marked as locked. If the X-Server crashes in this state, no auto-relogin will be performed even if the option is on.
|-
| <syntaxhighlight lang="shell">unlock</syntaxhighlight>
| Reverse the effect of "lock": re-enable auto-relogin.
|-
| <syntaxhighlight lang="shell">suicide</syntaxhighlight>
| The currently running session is forcibly terminated. No auto-relogin is attempted, but a scheduled "login" command will be executed.
|}

==== Commands for all sockets ====

{|class="wikitable"
|-
| <syntaxhighlight lang="shell">caps</syntaxhighlight>
| Returns a list this socket's capabilities:
{|
|<code>tdm</code>
| identifies tdm, in case some other DM implements this protocol, too
|-
| <code>list</code>, <code>activate</code>, <code>lock</code>, <code>suicide</code>, <code>login</code>
| whether the respective command is supported
|-
| <code>bootoptions</code>
| whether the <tt>listbootoptions</tt> command and the "=" option to "<tt>shutdown</tt>" are supported
|-
| <code>shutdown {list}</code>
| whether "shutdown" is supported and allowed to the listed users (comma-separated), "*" means all authenticated users
|-
| <code>shutdown</code>
| whether "shutdown" is supported and allowed to everybody
|-
| <code>nuke {list}</code>
| whether forced shutdown is allowed to the listed users
|-
| <code>nuke</code>
| whether forced shutdown is allowed to everybody
|-
| <code>reserve {number}</code>
| whether reserve displays are configured and <number> are available at this time
|}
|-
| <syntaxhighlight lang="shell">list [all|alllocal]</syntaxhighlight>
| Return a list of running sessions. By default all active sessions are listed.

If "<tt>all</tt>" is specified, passive sessions are listed as well.

If "<tt>alllocal</tt>" is specified, passive sessions are listed as well, but all incoming remote sessions are skipped.

Each session entry is a comma-separated tuple of:
* Display or TTY name
* VT name for local sessions
* Logged in user's name, empty for passive sessions and outgoing remote sessions (local chooser mode)
* Session type or remote host for outgoing remote sessions, empty for passive sessions
* A flag field:
** "t" for tty sessions
** "*" for the display belonging to the requesting socket
** "!" for sessions that cannot be killed by the requesting socket
|-
| <syntaxhighlight lang="shell">reserve [timeout in seconds]</syntaxhighlight>
| Start a reserve login screen. If nobody logs in within the specified amount of time (one minute by default), the display is removed again. When the session on the display exits, the display is removed, too.
Permitted only on sockets of local displays and the global socket.
|-
| <syntaxhighlight lang="shell">activate (vt|display)</syntaxhighlight>
| Switch to a particular VT (virtual terminal). The VT may be specified either directly (e.g., vt3) or by a display using it (e.g., :2).
Permitted only on sockets of local displays and the global socket.
|-
| <syntaxhighlight lang="shell">listbootoptions</syntaxhighlight>
| List available boot options.
=> "ok" list default current
*default and current are indices into the list and are -1 if unset or undeterminable.
|-
| <syntaxhighlight lang="shell">shutdown (reboot|halt)[={bootchoice}] (ask|trynow|forcenow|schedule|start (-1|end (force|forcemy|cancel)))</syntaxhighlight>
| Request a system shutdown, either a reboot or a halt/poweroff.
An OS choice for the next boot may be specified from the list returned by "listbootoptions".

Shutdowns requested from per-display sockets are executed when the current session on that display exits. Such a request may pop up a dialog asking for confirmation and/or authentication.

* <tt>start</tt> is the time for which the shutdown is scheduled. If it starts with a plus-sign, the current time is added. Zero means immediately.
* <tt>end</tt> is the latest time at which the shutdown should be performed if active sessions are still running. If it starts with a plus-sign, the start time is added. Minus one means wait infinitely. If end is through and active sessions are still running, TDM can do one of the following:
** <tt>cancel</tt> - give up the shutdown.
** <tt>force</tt> - shut down nonetheless.
** <tt>forcemy</tt> - shut down nonetheless if all active sessions belong to the requesting user. Only for per-display sockets.
* <tt>trynow</tt> is a synonym for "0 0 cancel", <tt>forcenow</tt> for "0 0 force" and <tt>schedule</tt> for "0 -1".
* <tt>ask</tt> attempts an immediate shutdown and interacts with the user if active sessions are still running. Only for per-display sockets.
* <tt>start</tt> and end are specified in seconds since the UNIX epoch.
|-
| <syntaxhighlight lang="shell">shutdown cancel [local|global]</syntaxhighlight>
| Cancel a scheduled shutdown. The global socket always cancels the currently pending shutdown, while per-display sockets default to cancelling their queued request.
|-
| <syntaxhighlight lang="shell">shutdown status</syntaxhighlight>
| Return a list with information about shutdowns.
The entries are comma-separated tuples of:
* ("global"|"local") - pending vs. queued shutdown. A local entry can be returned only by a per-display socket.
* ("halt"|"reboot")
* start
* end
* ("ask"|"force"|"forcemy"|"cancel")
* Numeric user ID of the requesting user, -1 for the global socket.
* The next boot OS choice or "-" for none.
|}

There are two ways of using the sockets:
* Connecting them directly. FifoDir is exported as $DM_CONTROL; the name of per-display sockets can be derived from $DISPLAY.
* By using the <tt>tdmctl</tt> command (e.g., from within a shell script). Try "<tt>tdmctl -h</tt>" to find out more.

Here is an example bash script "reboot into FreeBSD":

<syntaxhighlight lang="shell">
if tdmctl | grep -q shutdown; then
IFS=$'\t'
set -- `tdmctl listbootoptions`
if [ "$1" = ok ]; then
fbsd=$(echo "$2" | tr ' ' '\n' | sed -ne 's,\\s, ,g;/freebsd/I{p;q}')
if [ -n "$fbsd" ]; then
tdmctl shutdown reboot "=$fbsd" ask > /dev/null
else
echo "FreeBSD boot unavailable."
fi
else
echo "Boot options unavailable."
fi
else
echo "Cannot reboot system."
fi
</syntaxhighlight>

== Troubleshooting ==
TDM accepts two command line options related to logging:

-debug <n>
<n> is a decimal or hexadecimal (prefix 0x) number.
The number is a bitfield, i.e., it is formed by summing up the
required values from this table:
1 (0x1) - core debugging. Probably the most useful one.
2 (0x2) - config reader debugging.
4 (0x4) - greeter debugging.
8 (0x8) - IPC debugging. This logs _all_ communication between the
core, the config reader and the greeter - including the
passwords you type, so edit the log before showing it to
somebody.
This attempts to synchronize the processes to interleave the
log messages optimally, but will probably fail unless you use
-debug 0x80 as well.
16 (0x10) - wait after forking session sub-daemon.
32 (0x20) - wait after starting config reader.
64 (0x40) - wait after starting greeter.
The wait options are only useful if you need to attach a debugger
to a process, but it crashes before you are able to do so without
the delay. See below.
128 (0x80) - don't use syslog for internally generated messages.
256 (0x100) - core Xauth debugging.
1024 (0x400) - run config reader and greeter through valgrind.
2048 (0x800) - run config reader and greeter through strace.

Logs from "-debug 7" are usually a good start.

-error <file>, -logfile <file>
<file> is the file to log various messages to. The default log file is
/var/log/tdm.log. For internal reasons there is no option in tdmrc to
permanently specify the log file location. If you redirect TDM's
standard error output to a file, TDM will log there.
If TDM is configured to use syslog (and it _very_ probably is on any
modern system), all internally generated messages are logged to the
"daemon" facility. The log usually can be found in /var/log/debug.log
and /var/log/daemon.log; make sure that daemon.* is logged (look at
/etc/syslog.conf).
If you have problems logging in and your system uses PAM (also quite
probable on modern systems), the "auth" and "authpriv" syslog facilities
are interesting, too.

When reporting bugs, send all the logs together with a detailed description of what you did and what happened. If your problem is related to a specific configuration, you should also attach a tar.gz archive of your TDM config directory.

=== Producing a backtrace ===
If a backtrace is requested from you and TDM didn't create one yet via the usual drkonqi procedure, you'll have to do that yourself. The keyphrase is "attaching gdb". How exactly this is done depends on the part that crashes:

==== Attaching gdb to the process ====
===== Master daemon =====
Actually you should never need to attach to it, as you can start it within the debugger already:

<syntaxhighlight lang="shell-session">
# gdb --args tdm -nodaemon -debug 7
(gdb) run
</syntaxhighlight>

===== Display subdaemon =====
Find (using ps) the process with a name like "-:0" (where :0 is actually the display this process is for). This process' PPID is the master daemon. Attach to it this way:

<syntaxhighlight lang="shell-session">
# gdb tdm <the PID you found>
(gdb) cont
</syntaxhighlight>

If the subdaemon crashes before you can attach, add 16 to the debug flags when you start TDM.

===== Config reader =====
You will have to add 32 to the debug flags almost certainly. The PPID will be the master daemon as well.

<syntaxhighlight lang="shell-session">
# gdb tdm_config $(pidof tdm_config)
(gdb) cont
</syntaxhighlight>

===== Greeter =====
If it's too fast, add 64 to -debug. The PPID will be the subdaemon.

<syntaxhighlight lang="shell-session">
# gdb tdm_greet $(pidof tdm_greet)
(gdb) cont
</syntaxhighlight>

The simplification with "pidof" works only if you have only one display, otherwise you have to find the PID manually (by using ps -fx).

==== Reproduce crash and create backtrace ====
Once you got gdb attached to the offending process, do whatever is needed to make it crash (probably nothing, if you had to use a delay parameter).

Once it crashed, gdb will tell you a signal name, like SIGSEGV - that's the first interesting part. Then you have to create the actual backtrace:

<syntaxhighlight lang="shell-session">
(gdb) bt
</syntaxhighlight>

The output of this command is interesting for the developer, so a backtrace might be useful even if nothing crashes, but instead hangs. In this case don't use "cont" after attaching, but use "bt" right away. If the process is already running, interrupt it with ctrl-c.

For obvious reasons you have to run gdb on a different virtual terminal than the X server. To get there, press alt-ctrl-f1 and log in as root. To switch to the X server's vt, press alt-ctrl-f7 (the exact function key may be different on your system). You may also use a remote login from a second machine. In any case it is advantageous to have mouse support on the debugging console for copying the backtrace.

Note that a backtrace is usually much more useful if the binary contains debugging info.

TDE Wiki Style Guideline

2023-12-18T10:26:09Z

Blu256: /* Code */ add mention of TDE class template

{{TipBox|title=Work in progress!|text=This document is a work-in-progress, you can help by discussing it on the [http://mail.trinitydesktop.org/mailman3/postorius/lists/users.trinitydesktop.org/ tde-users mailing list], the [[Talk:TDE Wiki Style Guideline|discussion page]], via Jabber/XMPP or [http://trinitydesktop.org/support.php IRC].}}

<div style="float: right">
__TOC__
</div>

This page is meant to provide a single guideline for styling pages on this Wiki.

The goal is to achieve consistency between pages as much as possible.

= Generic guidelines =

* Use visual styles to make it easier tell apart different kinds of information.
* Try to be consistent with how other pages look and the way they use styles and templates to achieve things.
* Create templates for things that can be reused on the wiki. Re-use [[Special:UncategorizedTemplates|existing templates]] as much as possible.

= Style Recommendations =

== Code ==

* To denote a non-Trinity class use the <code><nowiki><tt>...</tt></nowiki></code> tag.
** To denote a TQt class use [[:Template:TQt class]].
** To denote a TDE class use [[:Template:TDE class]].

* To denote a function signature or a function call use the <code><nowiki><code>...</code></nowiki></code> tag.
* To denote a source code block use <code><nowiki><syntaxhighlighting lang="...">...</syntaxhighlighting></nowiki></code> tag with the appropriate <code>lang</code> attribute.
** To denote commands to be run in a shell use the <code>shell-session</code>. Prepend the commands with the <tt>$</tt> sign for commands to be run with normal user privileges or <tt>#</tt> for commands to be run with root privileges.

== Files ==

* To denote a file, a directory or a path, use the <code><nowiki><tt>...</tt></nowiki></code> tag.
* To denote the (whole or partial) contents of a file use a space before each line '''unless''' it contains [[#Code|code]].

== Tables ==

* To make tables look better and be more readable, add <code>class="wikitable"</code> to your tables.
* Make sure tables don't stretch too much vertically or horizontally.

== Messages and boxes ==

=== Warnings ===

* If a page or section is unfinished, place [[:Template:TODO]] in the beginning of the page or section.
* If a page or section is being actively worked on, and only for that time span, you may use [[:Template:WIP]] to prevent other users from accidentally causing a save conflict.
* If a page or section contains outdated information, place [[:Template:Outdated]] inserting the appropriate date and justifying it.
** If a page or section contains information relevant to KDE3, use [[:Template:KDE3]] instead. When such a page is updated to be applicable to the Trinity Desktop, replace it with [[:Template:Applicable to TDE]].
* Denote spam pages with [[:Template:Spam]].
* For generic warnings use [[:Template:WarningBox]] with the appropriate arguments.
** The opposite template to <tt>WarningBox</tt> is [[:Template:SafeBox]].

=== Other boxes ===
* For generic type messages (notes, tips, etc.) use [[:Template:TipBox]].
* Avoid using [[:Template:Box]] directly if you can help it. If you really need to use it, consider proposing a new template.

Raspbian Trinity Repository Installation Instructions

2023-11-30T13:20:29Z

Blu256: Improve previous addition by User:User0

[[Category:Documentation]]
[[Category:Installation]]

This page provides instructions to '''install''', '''upgrade''' or '''remove''' Trinity Desktop Environment on your Raspbian system.
__FORCETOC__

=Available versions=

==TDE R14.x.y series==

===Stable versions===

Packages for stable versions are available for the following Raspbian distributions (green rows indicates latest version):

{| class="wikitable"
! Version
! Architectures
! Notes
|-style="background:lightgreen"
| bookworm
| armhf
|
|-style="background:lightgreen"
| bullseye
| armhf
|
|-style="background:lightgreen"
| buster
| armhf
|
|-
| stretch
| armhf
| up to R14.0.13
|-
| jessie
| armhf
| up to R14.0.10
|-
| 7.x - wheezy
| armhf
| up to R14.0.6
|}

===Rolling versions===

Rolling builds are also available.

* [[Preliminary_Stable_Builds|Preliminary Stable Builds]] - rolling version of current stable branch (maintenance releases)
* [[Preliminary_Testing_Builds|Preliminary Testing Builds]] - rolling version of main development branch (major/minor releases)

==v3.5.13.x series==

There is no support for this TDE branch in Raspbian.

=Configure the package manager=

Add the following lines to your /etc/apt/sources.list file.

{{WarningBox
|text=Make sure to replace <span style="color:#0000ff">'''<your-distribution-release-name>'''</span> with your actual distribution release name (for example 'bullseye' or 'buster')
}}

===TDE R14.1.x series===
<syntaxhighlight lang="sourceslist">
deb http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-r14.1.x <your-distribution-release-name> main deps

# Optional sources
deb-src http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-r14.1.x <your-distribution-release-name> main deps
</syntaxhighlight>

<div class="mw-collapsible mw-collapsed">
===TDE R14.0.x series===
<div class="mw-collapsible-content">
<syntaxhighlight lang="sourceslist">
deb http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-r14.0.x <your-distribution-release-name> main
deb http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-builddeps-r14.0.x <your-distribution-release-name> main

# Optional sources
deb-src http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-r14.0.x <your-distribution-release-name> main
deb-src http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-builddeps-r14.0.x <your-distribution-release-name> main
</syntaxhighlight>
</div></div>

=Import GPG signing key=

The best way to install GPG key is to manually download and install package <code>trinity-keyring</code>. The advantage is that this method of installation is not dependent on the availability of the key server. Another advantage is that the key is not integrated into the global apt keyring, but is installed as a separate file:

<syntaxhighlight lang="shell-session">
$ wget http://mirror.ppa.trinitydesktop.org/trinity/deb/trinity-keyring.deb
$ sudo dpkg -i trinity-keyring.deb
</syntaxhighlight>

=Install Trinity=
* If you are doing a '''fresh TDE installation''', please follow the steps listed below.<br>
* If you are '''upgrading''' from an existing version, please follow the instruction under the [[#TDEUpgrade|upgrading]] section.<br>

==Fresh installation==

The following steps are suggested for installing the latest version.

{{WarningBox
|text=<span style="color:#0000ff">''tde-trinity''</span> package is a comprehensive meta-package. To install a minimalist environment, replace <span style="color:#0000ff">''tde-trinity''</span> with <span style="color:#0000ff">''tdebase-trinity''</span> in the instructions below.
}}

<syntaxhighlight lang="shell-session">
$ sudo apt-get update
$ sudo aptitude install tde-trinity
</syntaxhighlight>

{{TipBox
| text = If you cannot run TDE, you might need to change your desktop environment via the alternatives system. To do so, run the following command in your Terminal:
<syntaxhighlight lang="shell-session">
$ sudo update-alternatives --config x-session-manager
</syntaxhighlight>
Select the option ending with "starttde" (usually <tt>/opt/trinity/bin/starttde</tt>), then logout or reboot. After logging in, TDE should start automatically.}}

===Localization===
{{TipBox|text=After installing the environment, it is also a good idea to install the localization packages so that you can switch the environment to your native language. For example, for Czech you would run: <syntaxhighlight lang="shell-session">$ sudo aptitude install tde-i18n-cs-trinity</syntaxhighlight>
}}

==<span id="TDEUpgrade"></span>Upgrading from an existing installation==

The following steps are suggested for upgrading to the latest version.

<syntaxhighlight lang="shell-session">
$ sudo apt-get update
$ sudo aptitude full-upgrade
</syntaxhighlight>

This will upgrade TDE to the newer version and should complete smoothly.

=Removing Trinity=

{{TipBox | caption = Note | text = Please read the following instructions completely before starting the removal process.}}

Removing the Trinity Desktop Environment involves the following four steps:

# Uninstalling packages
# Removing the Trinity repository from the list of available package sources
# Cleaning up the package cache
# Removing left-over files from your home directory

<div class="mw-collapsible mw-collapsed">
==Uninstalling packages==
<div class="mw-collapsible-content">

===Using aptitude===

If you have ''aptitude'' installed, you can simply run

<syntaxhighlight lang="shell-session">
$ sudo aptitude purge '~i~Otrinitydesktop'
</syntaxhighlight>

===Using apt-get===

Using the standard ''apt-get'' utility to uninstall TDE and its dependencies involves the following three steps:
# Generating a list of all packages available from the Trinity repository
# Using that list to uninstall all installed packages originating from that repository
# Uninstalling all packages that were installed as dependencies of Trinity

To generate a list of all packages available from the Trinity repository, you will need to filter out just the package names from two files in <code>/var/lib/apt/lists</code> and write the result to a new file. The names of these files depend on three factors: The Raspbian release in use, the processor type the system is running on, and whether you're using the stable series or rolling-release packages. So, for example, when running the R14.1.x series on the i386 variant of Raspbian bullseye, the names are as follows:
* <code>mirror.ppa.trinitydesktop.org_trinity_deb_trinity-r14.1.x_dists_bullseye_main_binary-i386_Packages</code>
* <code>mirror.ppa.trinitydesktop.org_trinity_deb_trinity-builddeps-r14.1.x_dists_bullseye_main_binary-i386_Packages</code>

First, let's create a new empty file in <code>/tmp</code>, using <code>mktemp</code>:

<syntaxhighlight lang="shell-session">
$ mktemp /tmp/tde.XXXX
/tmp/tde.fB6B
</syntaxhighlight>

Generating a list of all Trinity packages and writing it to that file now works as follows:

<syntaxhighlight lang="shell-session">
$ sed -n '/^Package: / s/^Package: //p' /var/lib/apt/lists/mirror.ppa.trinitydesktop.org_trinity_deb_trinity-*Packages > /tmp/tde.fB6B
</syntaxhighlight>

Be sure to replace the output file's name with the actual name of the file <code>mktemp</code> created on your system.

Now that we have a list of all TDE packages, we can hand that to <code>apt-get</code> for uninstallation:

<syntaxhighlight lang="shell-session">
$ sudo apt-get remove $(cat /tmp/tde.fB6B)
</syntaxhighlight>

Replace <code>apt-get remove</code> with <code>apt-get purge</code> to also remove the configuration files that came with those packages. And, as above, be sure to replace the output file's name with the actual name of the file <code>mktemp</code> created on your system.

Apt will figure out which of the packages in the list are actually installed and present them for uninstallation. It will also already notify the user of a bunch of packages that "were automatically installed and are not longer required" and suggest using <code>apt autoremove</code> to uninstall them. We will take care of that in the next step. So, for now, just confirm the uninstallation of the TDE packages.

If Apt asks whether to stop the tdm deamon, say yes. We're removing TDE, after all. This will land you on the TTY that TDM was running on before. Need to switch back to the one you ran <code>apt-get</code> from using Ctrl + F1..7.

Finally, to uninstall all remaining Trinity dependencies, you will need to run

<syntaxhighlight lang="shell-session">
$ sudo apt-get autoremove
</syntaxhighlight>

In case you also want to remove the configuration files that came with these packages, append <code>--purge</code> to the <code>autoremove</code> command.

{{WarningBox | caption = CAUTION | text = Beware that running <code>apt-get autoremove</code> without care can leave certain software on your system or the system as a whole in an unusable state. The command simply uninstalls all packages that were installed as dependencies of packages that are no longer installed, which might lead to the uninstallation of packages that you wanted to keep.

Be sure to read the list of packages that Apt will want to uninstall, carefully. If you want to continue to use any of the packages in that list, abort the operation, mark that package as manually installed, and then run the command again.

If you're not sure how to handle the situation, ask in the Trinity IRC channel or on the mailing list.}}
</div></div>

<div class="mw-collapsible mw-collapsed">
==Removing the Trinity repository from package sources==
<div class="mw-collapsible-content">

Open <code>/etc/apt/sources.list</code> and either remove the Trinity repository lines or comment them by adding a hash symbol (<code>#</code>) at the beginning of each line. Then save the file and run <code>sudo apt-get update</code>.
</div></div>

<div class="mw-collapsible mw-collapsed">
==Cleaning up the package cache==
<div class="mw-collapsible-content">

If you deactivated/removed the repo from source.list, at least run

<syntaxhighlight lang="shell-session">
$ sudo apt-get autoclean
</syntaxhighlight>

This will remove all Trinity packages from the local cache.

To get rid of other packages as well, you'll have to clean out the whole package cache using

<syntaxhighlight lang="shell-session">
$ sudo apt-get clean
</syntaxhighlight>
</div></div>

<div class="mw-collapsible mw-collapsed">
==Removing left-over files from your home directory==
<div class="mw-collapsible-content">

Remove TDE files in <tt>$HOME</tt>. Usually these are the <tt>.tderc</tt> file and the <tt>.trinity</tt> and <tt>.qt</tt> directories. (The latter is still mistakenly used by some applications.)
</div></div>

Images (for developers)

2023-11-25T22:05:08Z

Blu256: Remove WIP marking (still has a few TODOs)

Working with images is an important part of a graphical application, whether it's a simple application or a complex graphical suite. In TQt/TDE, this can be as simple as learning to use a few classes. This guide aims to be a good guide for developers who want to work with TQt/TDE.

__TOC__

== Image classes ==
* {{TQt class|TQPixmap}} is one of the two basic image classes provided by TQt.
: It is, essentially, a paint device, so it is optimized for drawing. You'll see this class used a lot (more than TQImage) because of this quality.
* {{TQt class|TQImage}} is the other basic image class.
: According to the API docs, it is "a hardware-independent pixmap representation" and it is optimized for I/O operations and direct pixel access and manipulation.
* {{TQt class|TQIconSet}} is a helper class for icons.
: Compared to the basic image classes, this class does not represent a single image, but a ''set'' of images which correspond to an icon. A folder icon can come in different sizes (a different image file corresponds to each size), but it is still considered to be the same icon.

Usually you won't need more advanced classes.

== Basic usage ==
=== Loading an image ===
The simplest way to load an image is to use the constructor of the {{TQt class|TQPixmap}} class with the path of the file you want to load. If the file is located in one of your application paths (e.g. the <tt>share</tt> folder) use the {{TDE class|tdelibs|tdecore|TDEStandardDirs}} class.

If you want to load an icon, the simplest (and by far the most preferred) way to do so is via the {{TDE class|tdelibs|tdecore|TDEIconLoader}} class. For TDE applications you don't even have to explicitly initialize this object. You can access an instance of this class through the `kapp` pointer of the {{TDE class|tdelibs|tdecore|TDEApplication}} class. The icon loader class makes sure that recommended settings are used for the kind of icon you are loading, so you usually need to provide a `group` parameter of type [http://trinitydesktop.org/docs/trinity/tdelibs/tdecore/html/classTDEIcon.html#a8d521faaf8f00ecbe33314a08d386f91 TDEIcon::Group] which defines the type of icon that you are loading and will decide its size and whether any effects will be applied to it. For example, to load a folder icon with the default settings for a toolbar icon:

<syntaxhighlight lang="c++">
TQPixmap icon = kapp->iconLoader()->loadIcon("folder", TDEIcon::Toolbar);
</syntaxhighlight>

If you want to let the user choose an image, you can make use of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}}. You might want to use '''KImageIO''' in your project to support more image formats.

=== Displaying an image ===
Images can be used in quite a few widgets, including labels, text views and buttons. These widgets offer constructors and/or functions where you can pass an image as an argument (usually as a {{TQt class|TQPixmap}} or a {{TQt class|TQIconSet}}.

The following example creates a push button with a folder icon from the icon theme:

<syntaxhighlight lang="c++">
TQIconSet icon = kapp->iconLoader()->loadIconSet("folder", TDEIcon::Toolbar);
TQPushButton *button = new TQPushButton(icon, i18n("Open folder..."), this);
</syntaxhighlight>

If you want to display an image as standalone, you first need a widget where you will display it. Usually, a {{TQt class|TQLabel}} should be enough.

=== Vector images (SVG) ===
{{TODO}}

=== Applying effects ===
{{TODO}}

== Advanced usage ==
=== Loading KImageIO ===
KImageIO is a library which allows applications that use the TQt library (i.e. TQImageIO, TQImage, TQPixmap and friends) to read and write images in extra formats. It essentially extends TQImageIO with support for more image formats.

To make use of KImageIO you only need to:
# link your application with the <tt>tdeio</tt> library
# Include the <kimageio.h> header
# call KImageIO::registerFormats() once, somewhere in your code, before you load an image.

=== Saving an image ===
Saving an image is a complex process which involves a lot of factors, such as image format, quality, remote vs. local destination etc. Fortunately it's made easy thanks to technologies such as [[TDEIO]] and KImageIO.

Let's start with the basics.

==== The Foundation: <tt>TQImage::save(...)</tt> ====
{{TQt class|TQImage}} provides a convenient <code>save(const TQString &fileName, const char *format, int quality = -1)</code> method which, as you can tell, saves the image in memory to the selected destination (<tt>fileName</tt>).

The <tt>format</tt> argument is a string that represents the image format in which the file will be saved. The allowed values are determined by the file formats for which {{TQt class|TQImageIO}} has write support.

TQt natively supports PNG, BMP, XBM, XPM, PNM, JPEG, MNG and GIF formats (support for the latter three formats is configured at compile-time). For details on these formats refer to the {{TQt class|TQImageIO}} API documentation.

'''KImageIO''' adds support for more file formats, such as JPEG2000, EPS and TGA.

For example, to save an image <code>TQImage img</code> in PNG format, you could use the following call:

<syntaxhighlight lang="c++">
img.save("/home/test/image.png", "PNG");
</syntaxhighlight>

The <tt>quality</tt> parameter is pretty self-explanatory. Its default value is -1, which will make TQt use the default quality when saving.

You can combine the above code with {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} to get a decent save dialog which can save your PNG image locally:

<syntaxhighlight lang="c++">
TQString saveFile = KFileDialog::getSaveFileName(TQString::null, "*.PNG|" + i18n("PNG image (*.png)"), this);
if (!saveFile.isEmpty()) {
img.save(saveFile, "PNG");
}
</syntaxhighlight>

But what if we want more? What if we want to support more file formats? And what about saving on another computer via (S)FTP or another protocol?

==== Better image saving (feat. KImageIO) ====
Let's improve the situation with file formats by making use of some features of KImageIO.

We shall start by querying KImageIO for all the image formats it can write to:

<syntaxhighlight lang="c++">
TQStringList mimeTypes = KImageIO::mimeTypes(KImageIO::Writing);
if (mimeTypes.isEmpty()) {
kdError() << "kimgio: no image formats support writing!" << endl;
}
</syntaxhighlight>

This example shows some basic error handling. You should probably properly inform the user about the failure and abort the save operation at that point.

Then we can construct a file dialog based on the MIME information that we obtained. It's worth noting that the convenient static methods of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} cannot take a <tt>TQStringList mimeTypes</tt> as argument, so we will have to construct the dialog more or less manually:

<syntaxhighlight lang="c++">
KFileDialog *saveDlg = new KFileDialog(TQString::null, TQString::null, this, "mysavedialog", true);
saveDlg->setOperationMode(KFileDialog::Saving);
saveDlg->setMimeFilter(mimeTypes);
</syntaxhighlight>

Then we can execute the dialog:

<syntaxhighlight lang="c++">
if (!saveDlg->exec()) {
// The dialog was canceled
}
</syntaxhighlight>

And finally, after it has been closed, we can obtain the URL where we will save the file. It's a good idea to check the input thoroughly. Once again, you should implement proper error handling for when something goes wrong. I cannot stress enough the importance of sane error handling.

<syntaxhighlight lang="c++">
KURL saveURL = saveDlg->selectedURL();

TQString type = KImageIO::type(saveURL.url());
if (!KImageIO::canWrite(type)) {
kdError() << "kimgio: writing to image format " << type << " is not supported" << endl;
}
</syntaxhighlight>

For simplicity's sake we will only accept local URLs for now.

<syntaxhighlight lang="c++">
if (!saveURL.isLocalFile()) {
kdError() << "Cannot save to remote location (yet!)" << endl;
return;
}
</syntaxhighlight>

So, now that we have the URL, what's next? Easy, we actually save the image:

<syntaxhighlight lang="c++">
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
</syntaxhighlight>

Note how we use <tt>path()</tt> on saveURL instead of <tt>url()</tt>. It is because the function accepts a file path. By design it will not accept even local <tt>file://</tt> URLs.

So how do we save to a remote location?

==== Even better image saving (feat. TDEIO) ====
At some point you might have wondered how TDE applications are able to save to a remote or network location almost as seamlessly as to a directory on your hard drive. The TDEIO component is responsible for all the behind-the-scenes magic. In other word, you don't need to make your application speak FTP in order to be able to save an image to a remote FTP server. TDEIO automatically infers the protocol from the URL and starts a subprogram which handles all the needed communication and hides the protocol specifics behind well-known file operations, such as copy or delete.

Most TDE applications do not make use of TDEIO itself, but rather <tt>TDEIO::NetAccess</tt>, an API meant to simplify network file operations. We will only need one of its methods, <tt>upload(...)</tt>, which takes a local file URL and a remote destination URL as arguments. Yes, you read that right. We need to create a temporary local file, which we will upload to the user's chosen destination, and which we will then remove. Fortunately, TDE provides just the class for the occasion; that is {{TDE class|tdelibs|tdecore|KTempFile}}.

Remember the mast two chunks of code we previously wrote? Time to rewrite them!

<syntaxhighlight lang="c++">
if (saveURL.isLocalFile()) {
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
}
else {
</syntaxhighlight>

We have the local file handler from our previous effort. Let's proceed to write the handler for non-local files then. First, we'll create a new {{TDE class|tdelibs|tdecore|KTempFile}}:
<syntaxhighlight lang="c++">
KTempFile tempFile;
tempFile.setAutoDelete(true);
TQString tempFileName = tempFile.name();
if (tempFileName.isEmpty()) {
kdError() << "could not create a temp file!" << endl;
return;
}
</syntaxhighlight>

Now let's save our image to that file:
<syntaxhighlight lang="c++">
bool ok = img.save(tempFileName, type.latin1());
if (!ok) {
kdError() << "Couldn't write temporary file: " << tempFileName << endl;
return;
}
</syntaxhighlight>

And finally, let's upload that file to the remote location:
<syntaxhighlight lang="c++">
if (!TDEIO::NetAccess::upload(tempFileName, saveURL, this)) {
kdError() << "Could not upload file to " << saveURL << endl;
}
</syntaxhighlight>

We now have a file dialog which can save in every image format that TQt and TDE support writing to, and which supports both local and non-local filesystems.

== TDE Developers' usage ==
=== Adding image format support ===
{{TODO}}

[[Category: Developers]]

Images (for developers)

2023-11-25T21:57:23Z

Blu256: /* TQImage::save(...) */ a nice section pretitle

{{WIP|Blu256}}

Working with images is an important part of a graphical application, whether it's a simple application or a complex graphical suite. In TQt/TDE, this can be as simple as learning to use a few classes. This guide aims to be a good guide for developers who want to work with TQt/TDE.

__TOC__

== Image classes ==
* {{TQt class|TQPixmap}} is one of the two basic image classes provided by TQt.
: It is, essentially, a paint device, so it is optimized for drawing. You'll see this class used a lot (more than TQImage) because of this quality.
* {{TQt class|TQImage}} is the other basic image class.
: According to the API docs, it is "a hardware-independent pixmap representation" and it is optimized for I/O operations and direct pixel access and manipulation.
* {{TQt class|TQIconSet}} is a helper class for icons.
: Compared to the basic image classes, this class does not represent a single image, but a ''set'' of images which correspond to an icon. A folder icon can come in different sizes (a different image file corresponds to each size), but it is still considered to be the same icon.

Usually you won't need more advanced classes.

== Basic usage ==
=== Loading an image ===
The simplest way to load an image is to use the constructor of the {{TQt class|TQPixmap}} class with the path of the file you want to load. If the file is located in one of your application paths (e.g. the <tt>share</tt> folder) use the {{TDE class|tdelibs|tdecore|TDEStandardDirs}} class.

If you want to load an icon, the simplest (and by far the most preferred) way to do so is via the {{TDE class|tdelibs|tdecore|TDEIconLoader}} class. For TDE applications you don't even have to explicitly initialize this object. You can access an instance of this class through the `kapp` pointer of the {{TDE class|tdelibs|tdecore|TDEApplication}} class. The icon loader class makes sure that recommended settings are used for the kind of icon you are loading, so you usually need to provide a `group` parameter of type [http://trinitydesktop.org/docs/trinity/tdelibs/tdecore/html/classTDEIcon.html#a8d521faaf8f00ecbe33314a08d386f91 TDEIcon::Group] which defines the type of icon that you are loading and will decide its size and whether any effects will be applied to it. For example, to load a folder icon with the default settings for a toolbar icon:

<syntaxhighlight lang="c++">
TQPixmap icon = kapp->iconLoader()->loadIcon("folder", TDEIcon::Toolbar);
</syntaxhighlight>

If you want to let the user choose an image, you can make use of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}}. You might want to use '''KImageIO''' in your project to support more image formats.

=== Displaying an image ===
Images can be used in quite a few widgets, including labels, text views and buttons. These widgets offer constructors and/or functions where you can pass an image as an argument (usually as a {{TQt class|TQPixmap}} or a {{TQt class|TQIconSet}}.

The following example creates a push button with a folder icon from the icon theme:

<syntaxhighlight lang="c++">
TQIconSet icon = kapp->iconLoader()->loadIconSet("folder", TDEIcon::Toolbar);
TQPushButton *button = new TQPushButton(icon, i18n("Open folder..."), this);
</syntaxhighlight>

If you want to display an image as standalone, you first need a widget where you will display it. Usually, a {{TQt class|TQLabel}} should be enough.

=== Vector images (SVG) ===
{{TODO}}

=== Applying effects ===
{{TODO}}

== Advanced usage ==
=== Loading KImageIO ===
KImageIO is a library which allows applications that use the TQt library (i.e. TQImageIO, TQImage, TQPixmap and friends) to read and write images in extra formats. It essentially extends TQImageIO with support for more image formats.

To make use of KImageIO you only need to:
# link your application with the <tt>tdeio</tt> library
# Include the <kimageio.h> header
# call KImageIO::registerFormats() once, somewhere in your code, before you load an image.

=== Saving an image ===
Saving an image is a complex process which involves a lot of factors, such as image format, quality, remote vs. local destination etc. Fortunately it's made easy thanks to technologies such as [[TDEIO]] and KImageIO.

Let's start with the basics.

==== The Foundation: <tt>TQImage::save(...)</tt> ====
{{TQt class|TQImage}} provides a convenient <code>save(const TQString &fileName, const char *format, int quality = -1)</code> method which, as you can tell, saves the image in memory to the selected destination (<tt>fileName</tt>).

The <tt>format</tt> argument is a string that represents the image format in which the file will be saved. The allowed values are determined by the file formats for which {{TQt class|TQImageIO}} has write support.

TQt natively supports PNG, BMP, XBM, XPM, PNM, JPEG, MNG and GIF formats (support for the latter three formats is configured at compile-time). For details on these formats refer to the {{TQt class|TQImageIO}} API documentation.

'''KImageIO''' adds support for more file formats, such as JPEG2000, EPS and TGA.

For example, to save an image <code>TQImage img</code> in PNG format, you could use the following call:

<syntaxhighlight lang="c++">
img.save("/home/test/image.png", "PNG");
</syntaxhighlight>

The <tt>quality</tt> parameter is pretty self-explanatory. Its default value is -1, which will make TQt use the default quality when saving.

You can combine the above code with {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} to get a decent save dialog which can save your PNG image locally:

<syntaxhighlight lang="c++">
TQString saveFile = KFileDialog::getSaveFileName(TQString::null, "*.PNG|" + i18n("PNG image (*.png)"), this);
if (!saveFile.isEmpty()) {
img.save(saveFile, "PNG");
}
</syntaxhighlight>

But what if we want more? What if we want to support more file formats? And what about saving on another computer via (S)FTP or another protocol?

==== Better image saving (feat. KImageIO) ====
Let's improve the situation with file formats by making use of some features of KImageIO.

We shall start by querying KImageIO for all the image formats it can write to:

<syntaxhighlight lang="c++">
TQStringList mimeTypes = KImageIO::mimeTypes(KImageIO::Writing);
if (mimeTypes.isEmpty()) {
kdError() << "kimgio: no image formats support writing!" << endl;
}
</syntaxhighlight>

This example shows some basic error handling. You should probably properly inform the user about the failure and abort the save operation at that point.

Then we can construct a file dialog based on the MIME information that we obtained. It's worth noting that the convenient static methods of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} cannot take a <tt>TQStringList mimeTypes</tt> as argument, so we will have to construct the dialog more or less manually:

<syntaxhighlight lang="c++">
KFileDialog *saveDlg = new KFileDialog(TQString::null, TQString::null, this, "mysavedialog", true);
saveDlg->setOperationMode(KFileDialog::Saving);
saveDlg->setMimeFilter(mimeTypes);
</syntaxhighlight>

Then we can execute the dialog:

<syntaxhighlight lang="c++">
if (!saveDlg->exec()) {
// The dialog was canceled
}
</syntaxhighlight>

And finally, after it has been closed, we can obtain the URL where we will save the file. It's a good idea to check the input thoroughly. Once again, you should implement proper error handling for when something goes wrong. I cannot stress enough the importance of sane error handling.

<syntaxhighlight lang="c++">
KURL saveURL = saveDlg->selectedURL();

TQString type = KImageIO::type(saveURL.url());
if (!KImageIO::canWrite(type)) {
kdError() << "kimgio: writing to image format " << type << " is not supported" << endl;
}
</syntaxhighlight>

For simplicity's sake we will only accept local URLs for now.

<syntaxhighlight lang="c++">
if (!saveURL.isLocalFile()) {
kdError() << "Cannot save to remote location (yet!)" << endl;
return;
}
</syntaxhighlight>

So, now that we have the URL, what's next? Easy, we actually save the image:

<syntaxhighlight lang="c++">
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
</syntaxhighlight>

Note how we use <tt>path()</tt> on saveURL instead of <tt>url()</tt>. It is because the function accepts a file path. By design it will not accept even local <tt>file://</tt> URLs.

So how do we save to a remote location?

==== Even better image saving (feat. TDEIO) ====
At some point you might have wondered how TDE applications are able to save to a remote or network location almost as seamlessly as to a directory on your hard drive. The TDEIO component is responsible for all the behind-the-scenes magic. In other word, you don't need to make your application speak FTP in order to be able to save an image to a remote FTP server. TDEIO automatically infers the protocol from the URL and starts a subprogram which handles all the needed communication and hides the protocol specifics behind well-known file operations, such as copy or delete.

Most TDE applications do not make use of TDEIO itself, but rather <tt>TDEIO::NetAccess</tt>, an API meant to simplify network file operations. We will only need one of its methods, <tt>upload(...)</tt>, which takes a local file URL and a remote destination URL as arguments. Yes, you read that right. We need to create a temporary local file, which we will upload to the user's chosen destination, and which we will then remove. Fortunately, TDE provides just the class for the occasion; that is {{TDE class|tdelibs|tdecore|KTempFile}}.

Remember the mast two chunks of code we previously wrote? Time to rewrite them!

<syntaxhighlight lang="c++">
if (saveURL.isLocalFile()) {
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
}
else {
</syntaxhighlight>

We have the local file handler from our previous effort. Let's proceed to write the handler for non-local files then. First, we'll create a new {{TDE class|tdelibs|tdecore|KTempFile}}:
<syntaxhighlight lang="c++">
KTempFile tempFile;
tempFile.setAutoDelete(true);
TQString tempFileName = tempFile.name();
if (tempFileName.isEmpty()) {
kdError() << "could not create a temp file!" << endl;
return;
}
</syntaxhighlight>

Now let's save our image to that file:
<syntaxhighlight lang="c++">
bool ok = img.save(tempFileName, type.latin1());
if (!ok) {
kdError() << "Couldn't write temporary file: " << tempFileName << endl;
return;
}
</syntaxhighlight>

And finally, let's upload that file to the remote location:
<syntaxhighlight lang="c++">
if (!TDEIO::NetAccess::upload(tempFileName, saveURL, this)) {
kdError() << "Could not upload file to " << saveURL << endl;
}
</syntaxhighlight>

We now have a file dialog which can save in every image format that TQt and TDE support writing to, and which supports both local and non-local filesystems.

== TDE Developers' usage ==
=== Adding image format support ===
{{TODO}}

[[Category: Developers]]

Images (for developers)

2023-11-25T21:56:53Z

Blu256: Add section on saving images

{{WIP|Blu256}}

Working with images is an important part of a graphical application, whether it's a simple application or a complex graphical suite. In TQt/TDE, this can be as simple as learning to use a few classes. This guide aims to be a good guide for developers who want to work with TQt/TDE.

__TOC__

== Image classes ==
* {{TQt class|TQPixmap}} is one of the two basic image classes provided by TQt.
: It is, essentially, a paint device, so it is optimized for drawing. You'll see this class used a lot (more than TQImage) because of this quality.
* {{TQt class|TQImage}} is the other basic image class.
: According to the API docs, it is "a hardware-independent pixmap representation" and it is optimized for I/O operations and direct pixel access and manipulation.
* {{TQt class|TQIconSet}} is a helper class for icons.
: Compared to the basic image classes, this class does not represent a single image, but a ''set'' of images which correspond to an icon. A folder icon can come in different sizes (a different image file corresponds to each size), but it is still considered to be the same icon.

Usually you won't need more advanced classes.

== Basic usage ==
=== Loading an image ===
The simplest way to load an image is to use the constructor of the {{TQt class|TQPixmap}} class with the path of the file you want to load. If the file is located in one of your application paths (e.g. the <tt>share</tt> folder) use the {{TDE class|tdelibs|tdecore|TDEStandardDirs}} class.

If you want to load an icon, the simplest (and by far the most preferred) way to do so is via the {{TDE class|tdelibs|tdecore|TDEIconLoader}} class. For TDE applications you don't even have to explicitly initialize this object. You can access an instance of this class through the `kapp` pointer of the {{TDE class|tdelibs|tdecore|TDEApplication}} class. The icon loader class makes sure that recommended settings are used for the kind of icon you are loading, so you usually need to provide a `group` parameter of type [http://trinitydesktop.org/docs/trinity/tdelibs/tdecore/html/classTDEIcon.html#a8d521faaf8f00ecbe33314a08d386f91 TDEIcon::Group] which defines the type of icon that you are loading and will decide its size and whether any effects will be applied to it. For example, to load a folder icon with the default settings for a toolbar icon:

<syntaxhighlight lang="c++">
TQPixmap icon = kapp->iconLoader()->loadIcon("folder", TDEIcon::Toolbar);
</syntaxhighlight>

If you want to let the user choose an image, you can make use of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}}. You might want to use '''KImageIO''' in your project to support more image formats.

=== Displaying an image ===
Images can be used in quite a few widgets, including labels, text views and buttons. These widgets offer constructors and/or functions where you can pass an image as an argument (usually as a {{TQt class|TQPixmap}} or a {{TQt class|TQIconSet}}.

The following example creates a push button with a folder icon from the icon theme:

<syntaxhighlight lang="c++">
TQIconSet icon = kapp->iconLoader()->loadIconSet("folder", TDEIcon::Toolbar);
TQPushButton *button = new TQPushButton(icon, i18n("Open folder..."), this);
</syntaxhighlight>

If you want to display an image as standalone, you first need a widget where you will display it. Usually, a {{TQt class|TQLabel}} should be enough.

=== Vector images (SVG) ===
{{TODO}}

=== Applying effects ===
{{TODO}}

== Advanced usage ==
=== Loading KImageIO ===
KImageIO is a library which allows applications that use the TQt library (i.e. TQImageIO, TQImage, TQPixmap and friends) to read and write images in extra formats. It essentially extends TQImageIO with support for more image formats.

To make use of KImageIO you only need to:
# link your application with the <tt>tdeio</tt> library
# Include the <kimageio.h> header
# call KImageIO::registerFormats() once, somewhere in your code, before you load an image.

=== Saving an image ===
Saving an image is a complex process which involves a lot of factors, such as image format, quality, remote vs. local destination etc. Fortunately it's made easy thanks to technologies such as [[TDEIO]] and KImageIO.

Let's start with the basics.

==== <tt>TQImage::save(...)</tt> ====
{{TQt class|TQImage}} provides a convenient <code>save(const TQString &fileName, const char *format, int quality = -1)</code> method which, as you can tell, saves the image in memory to the selected destination (<tt>fileName</tt>).

The <tt>format</tt> argument is a string that represents the image format in which the file will be saved. The allowed values are determined by the file formats for which {{TQt class|TQImageIO}} has write support.

TQt natively supports PNG, BMP, XBM, XPM, PNM, JPEG, MNG and GIF formats (support for the latter three formats is configured at compile-time). For details on these formats refer to the {{TQt class|TQImageIO}} API documentation.

'''KImageIO''' adds support for more file formats, such as JPEG2000, EPS and TGA.

For example, to save an image <code>TQImage img</code> in PNG format, you could use the following call:

<syntaxhighlight lang="c++">
img.save("/home/test/image.png", "PNG");
</syntaxhighlight>

The <tt>quality</tt> parameter is pretty self-explanatory. Its default value is -1, which will make TQt use the default quality when saving.

You can combine the above code with {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} to get a decent save dialog which can save your PNG image locally:

<syntaxhighlight lang="c++">
TQString saveFile = KFileDialog::getSaveFileName(TQString::null, "*.PNG|" + i18n("PNG image (*.png)"), this);
if (!saveFile.isEmpty()) {
img.save(saveFile, "PNG");
}
</syntaxhighlight>

But what if we want more? What if we want to support more file formats? And what about saving on another computer via (S)FTP or another protocol?

==== Better image saving (feat. KImageIO) ====
Let's improve the situation with file formats by making use of some features of KImageIO.

We shall start by querying KImageIO for all the image formats it can write to:

<syntaxhighlight lang="c++">
TQStringList mimeTypes = KImageIO::mimeTypes(KImageIO::Writing);
if (mimeTypes.isEmpty()) {
kdError() << "kimgio: no image formats support writing!" << endl;
}
</syntaxhighlight>

This example shows some basic error handling. You should probably properly inform the user about the failure and abort the save operation at that point.

Then we can construct a file dialog based on the MIME information that we obtained. It's worth noting that the convenient static methods of {{TDE class|tdelibs|tdeio/tdefile|KFileDialog}} cannot take a <tt>TQStringList mimeTypes</tt> as argument, so we will have to construct the dialog more or less manually:

<syntaxhighlight lang="c++">
KFileDialog *saveDlg = new KFileDialog(TQString::null, TQString::null, this, "mysavedialog", true);
saveDlg->setOperationMode(KFileDialog::Saving);
saveDlg->setMimeFilter(mimeTypes);
</syntaxhighlight>

Then we can execute the dialog:

<syntaxhighlight lang="c++">
if (!saveDlg->exec()) {
// The dialog was canceled
}
</syntaxhighlight>

And finally, after it has been closed, we can obtain the URL where we will save the file. It's a good idea to check the input thoroughly. Once again, you should implement proper error handling for when something goes wrong. I cannot stress enough the importance of sane error handling.

<syntaxhighlight lang="c++">
KURL saveURL = saveDlg->selectedURL();

TQString type = KImageIO::type(saveURL.url());
if (!KImageIO::canWrite(type)) {
kdError() << "kimgio: writing to image format " << type << " is not supported" << endl;
}
</syntaxhighlight>

For simplicity's sake we will only accept local URLs for now.

<syntaxhighlight lang="c++">
if (!saveURL.isLocalFile()) {
kdError() << "Cannot save to remote location (yet!)" << endl;
return;
}
</syntaxhighlight>

So, now that we have the URL, what's next? Easy, we actually save the image:

<syntaxhighlight lang="c++">
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
</syntaxhighlight>

Note how we use <tt>path()</tt> on saveURL instead of <tt>url()</tt>. It is because the function accepts a file path. By design it will not accept even local <tt>file://</tt> URLs.

So how do we save to a remote location?

==== Even better image saving (feat. TDEIO) ====
At some point you might have wondered how TDE applications are able to save to a remote or network location almost as seamlessly as to a directory on your hard drive. The TDEIO component is responsible for all the behind-the-scenes magic. In other word, you don't need to make your application speak FTP in order to be able to save an image to a remote FTP server. TDEIO automatically infers the protocol from the URL and starts a subprogram which handles all the needed communication and hides the protocol specifics behind well-known file operations, such as copy or delete.

Most TDE applications do not make use of TDEIO itself, but rather <tt>TDEIO::NetAccess</tt>, an API meant to simplify network file operations. We will only need one of its methods, <tt>upload(...)</tt>, which takes a local file URL and a remote destination URL as arguments. Yes, you read that right. We need to create a temporary local file, which we will upload to the user's chosen destination, and which we will then remove. Fortunately, TDE provides just the class for the occasion; that is {{TDE class|tdelibs|tdecore|KTempFile}}.

Remember the mast two chunks of code we previously wrote? Time to rewrite them!

<syntaxhighlight lang="c++">
if (saveURL.isLocalFile()) {
bool ok = img.save(saveURL.path(), type.latin1());
if (!ok) {
kdError() << "Couldn't save!" << endl;
}
}
else {
</syntaxhighlight>

We have the local file handler from our previous effort. Let's proceed to write the handler for non-local files then. First, we'll create a new {{TDE class|tdelibs|tdecore|KTempFile}}:
<syntaxhighlight lang="c++">
KTempFile tempFile;
tempFile.setAutoDelete(true);
TQString tempFileName = tempFile.name();
if (tempFileName.isEmpty()) {
kdError() << "could not create a temp file!" << endl;
return;
}
</syntaxhighlight>

Now let's save our image to that file:
<syntaxhighlight lang="c++">
bool ok = img.save(tempFileName, type.latin1());
if (!ok) {
kdError() << "Couldn't write temporary file: " << tempFileName << endl;
return;
}
</syntaxhighlight>

And finally, let's upload that file to the remote location:
<syntaxhighlight lang="c++">
if (!TDEIO::NetAccess::upload(tempFileName, saveURL, this)) {
kdError() << "Could not upload file to " << saveURL << endl;
}
</syntaxhighlight>

We now have a file dialog which can save in every image format that TQt and TDE support writing to, and which supports both local and non-local filesystems.

== TDE Developers' usage ==
=== Adding image format support ===
{{TODO}}

[[Category: Developers]]

Images (for developers)

2023-11-25T20:58:11Z

Blu256: Add layout of page

Images (for developers)

2023-11-25T20:55:17Z

Blu256: Switch to the new TDE class template

Template:TDE class

2023-11-25T20:52:59Z

Blu256: fix class name display

<noinclude>
'''TDE class''' is a template which should be used to denote TDE classes.

== Example ==

<syntaxhighlight lang="html+handlebars">
Use {{TDE class|tdelibs|tdecore|TDEIconLoader}}.
</syntaxhighlight>

Use {{TDE class|tdelibs|tdecore|TDEIconLoader}}.
</noinclude><includeonly><span style="color: midnightblue; font-weight: bold;">{{{3}}} <sup class="plainlinks">[http://trinitydesktop.org/docs/trinity/{{{1}}}/{{{2}}}/html/class{{{3}}}.html API]</sup></span></includeonly>

Template:TDE class

2023-11-25T20:51:28Z

Blu256: Add TDE class template

<noinclude>
'''TDE class''' is a template which should be used to denote TDE classes.

== Example ==

<syntaxhighlight lang="html+handlebars">
Use {{TDE class|tdelibs|tdecore|TDEIconLoader}}.
</syntaxhighlight>

Use {{TDE class|tdelibs|tdecore|TDEIconLoader}}.
</noinclude><includeonly><span style="color: midnightblue; font-weight: bold;">{{{1}}} <sup class="plainlinks">[http://trinitydesktop.org/docs/trinity/{{{1}}}/{{{2}}}/html/class{{{3}}}.html API]</sup></span></includeonly>

Images (for developers)

2023-11-25T20:48:07Z

Blu256: Added basic instructions for loading and displaying images

Images (for developers)

2023-11-25T20:28:28Z

Blu256: Started writing

LiveCDs

2023-10-29T18:11:35Z

Blu256: Mark some links as outdated

[[Category:Documentation]]

Each of these LiveCDs comes with the Trinity Desktop Environment preinstalled, so that you can try it out without having to mess around with installing it in your main environment. Unless otherwise marked, all of them contain the most recent version of Trinity.

===Distributions===
*[https://dragora.org/en/index.html Dragora GNU/Linux-Libre] - <i>independent, [https://www.gnu.org/distros/free-distros.html FSF-approved libre distribution]</i>
*[http://exegnulinux.net/ Exe Gnu/Linux]
*[http://trinity.mypclinuxos.com/ PCLinuxOS (external)]
*[http://www.q4os.org/ Q4OS]
*[https://www.ttoslinux.org/download.html TTOS Linux]

====Outdated====
*[[ALTLinuxInstall|ALT Linux]]
**[http://ftp.altlinux.org/pub/distributions/ALTLinux/p7/images/starterkits/ P7 starterkit] (based on stable branch)
**[http://en.altlinux.org/Regular Regular TDE] (weekly build based on Sisyphus the dev repo)
*[http://mirror.ppa.trinitydesktop.org/trinity/cdimages/pclinuxos/ PCLinuxOS (internal)]
*[[Slax with Trinity]]
*[http://mirror.ppa.trinitydesktop.org/trinity/cdimages/ubuntu/ Ubuntu Releases]

User talk:Mrmazda

2023-10-29T17:52:52Z

Blu256:

= Recent addition to Mageia page =

Hello [[User:Mrmazda|Mrmazda]],

I'm writing in relation to your most recent addition to the Mageia installation page:

To first { } pair in file /etc/urpmi/urpmi.cfg, add line with string curl-options: -L, or add -L to existing curl-options line if not already present.

Could you please clarify on the page why (and in what cases) the addition of the curl "follow redirects" flag is needed? Thank you!

Mavridis Philippe (blu.256) 09:57, 9 May 2022 (UTC)

: https://mail.trinitydesktop.org/mailman3/hyperkitty/list/devels@trinitydesktop.org/message/ZHD3J2K3FNJ7CJOQPLK6OPN4SIJTT56I/ explains the Mageia urpmi package management system prefers curl, which doesn't always play nice with Trinity's mirroring system.

:: Thank you! -- Mavridis Philippe (blu.256) 17:52, 29 October 2023 (UTC)

Arch Trinity Repository Installation Instructions

2023-10-29T17:48:47Z

Blu256: Replace latest release (R14.1.1)

The current latest release ([[Release Notes For R14.1.1|R14.1.1]]) is available for Arch in the form of prebuilt packages for x86_64, aarch64 and armv7h architectures.

= Instructions =

1. Add official Trinity ArchLinux repository to <kbd>/etc/pacman.conf</kbd> on your system:

[trinity]
Server = https://mirror.ppa.trinitydesktop.org/trinity/archlinux/$arch

2. Fetch GPG key and add to pacman keychain on your system:

<syntaxhighlight lang="shell-session">
# pacman-key --recv-key D6D6FAA25E9A3E4ECD9FBDBEC93AF1698685AD8B
# pacman-key --lsign-key D6D6FAA25E9A3E4ECD9FBDBEC93AF1698685AD8B
</syntaxhighlight>

3. Synchronize Pacman databases (optionally update your system):

<syntaxhighlight lang="shell-session">
# pacman -Sy
</syntaxhighlight>

4. Install the necessary packages.
: e.g. for a full Trinity installation:

<syntaxhighlight lang="shell-session">
# pacman -S tde-meta
</syntaxhighlight>

[[Category:Installation]]