Development/Tutorials/Desktop File

Desktop File

Tutorial Series	Basics
Previous
What's Next
Further Reading	the .desktop Free Desktop Spec;

Warning

This page needs a review and probably holds information that needs to be fixed.

Parts to be reviewed:

Port to KF5

Desktop File

In order for your application to show up in menus and/or to be automatically associated with mime types in file browsers, you need to provide a .desktop file like follows:

[Desktop Entry]
Type=Application
Exec=your-app %u
MimeType=application/x-your-mime-type;
Icon=some-icon
X-DocPath=yourapp/index.html
Terminal=false
Name=Your App
GenericName=Some Generic Name
Comment=Short Description Of Your App
Categories=Qt;KDE;

Take a look at the .desktop Free Desktop Spec to find our more about the key/value pairs above. It's important to pick a good set of Categories, see the spec for a list of valid values.

Your project

You want your project to show up in the K Menu like this:

In this example, the application is called quickpen and it shows up in the category "Graphics". To accomplish that in your project you need to take care the .desktop file is distributed to the appropriate place.

qmake based projects

In case you are working on a qmake based project, add the following to your .pro file:

target.path = /usr/local/bin
desktop.path = /usr/share/applications
desktop.files += your-app.desktop

INSTALLS += target desktop

Note that the bold strings above should be in your project anyway.

An example .pro file can be found here. The related .desktop file can be found here.

cmake based projects

In case you are working on a cmake based project, add an install directive to your CMakeLists.txt file like this:

install( PROGRAMS your-app.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} )

An example CMakeLists.txt file can be found here. The corresponding .desktop file is here.

Menus

You can also use a .desktop file to describe KDE's context menus. Context menus are the menus that appear when you right-click onto your desktop or onto a file or folder. Let's write a context menu for konqueror that counts the lines in a file.

To do this, change directory to your Service Menu directory:

$ kde4-config --path services
/home/knoppix/.kde/share/kde4/services/:/usr/share/kde4/services/
$ cd /usr/share/kde4/services/ServiceMenus/

Create a desktop file with any name, e.g. count.desktop with the following content:

[Desktop Entry]
Type=Service
ServiceTypes=KonqPopupMenu/Plugin
MimeType=all/all;
Actions=countlines;
X-KDE-Submenu=Count
X-KDE-StartupNotify=false
X-KDE-Priority=TopLevel

[Desktop Action countlines]
Name=Count lines
Exec=kdialog --msgbox "$(wc -l %F)"

It will look like this:

Some remarks:

• it is possible to translate the strings the user sees. For a German translation you could add below X-KDE-Submenu=Count:

X-KDE-Submenu[de]=Zaehlen

• this context menu entry will not only appear in Konqueror, but also e.g. in Dolphin.
• if you want this to work as a menu item, not as a submenu, just delete the line

X-KDE-Submenu=Count

See also

• FreeDeskTop's specification about Desktop entries