Editing Desktop file format
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
- | + | = Maemo 5 - Fremantle = | |
- | + | .desktop files are read from directory: | |
/usr/share/applications/hildon/ | /usr/share/applications/hildon/ | ||
- | + | .desktop files consist of at least one <code>Desktop Entry</code> group, containing at least the fields <code>Type</code> and <code>Name</code>. | |
- | Maemo | + | Maemo .desktop files conform with [http://standards.freedesktop.org/desktop-entry-spec/1.0/ the freedesktop.org desktop entry spec version 1.0]. |
- | + | == Standard keys == | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
Maemo recognises and parses a subset of all of the standard keys defined in the desktop spec. The following keys have a specific meaning in Maemo: | Maemo recognises and parses a subset of all of the standard keys defined in the desktop spec. The following keys have a specific meaning in Maemo: | ||
{| class="wikitable" | {| class="wikitable" | ||
- | |||
|- | |- | ||
! Key | ! Key | ||
Line 26: | Line 19: | ||
! Required? | ! Required? | ||
|- | |- | ||
- | | | + | | Type |
| string | | string | ||
| Possible values are "Application", "Link" or "Directory". Only "Application" and "Directory" are parsed on Maemo. | | Possible values are "Application", "Link" or "Directory". Only "Application" and "Directory" are parsed on Maemo. | ||
| Y | | Y | ||
|- | |- | ||
- | | | + | | Name |
| string | | string | ||
| The name of the Desktop Entry group - should be unique on the system | | The name of the Desktop Entry group - should be unique on the system | ||
| Y | | Y | ||
|- | |- | ||
- | | | + | | Icon |
| string | | string | ||
| Icon to display in file manager, menus, etc. If the name is an absolute path, the given file will be used. If the name is not an absolute path, the algorithm described in the [http://freedesktop.org/wiki/Standards/icon-theme-spec Icon Theme Specification] will be used to locate the icon. | | Icon to display in file manager, menus, etc. If the name is an absolute path, the given file will be used. If the name is not an absolute path, the algorithm described in the [http://freedesktop.org/wiki/Standards/icon-theme-spec Icon Theme Specification] will be used to locate the icon. | ||
| N | | N | ||
|- | |- | ||
- | | | + | | Comment |
| string | | string | ||
| Tooltip for the icon. Unused in touch interface. | | Tooltip for the icon. Unused in touch interface. | ||
| N | | N | ||
|- | |- | ||
- | | | + | | NoDisplay |
| boolean | | boolean | ||
| If this is set to <code>true</code> the icon will not be shown in the menu. This is useful for applications which are associated with a mime type, but are not intended for standalone use. | | If this is set to <code>true</code> the icon will not be shown in the menu. This is useful for applications which are associated with a mime type, but are not intended for standalone use. | ||
| N | | N | ||
|- | |- | ||
- | | | + | | Exec |
| string | | string | ||
| The absolute path to the executable to be run when the desktop entry is selected. | | The absolute path to the executable to be run when the desktop entry is selected. | ||
| N | | N | ||
|- | |- | ||
- | | | + | | Categories |
| string | | string | ||
| This field is not used by hildon-desktop, but is used by 3rd party applications such as Catorise | | This field is not used by hildon-desktop, but is used by 3rd party applications such as Catorise | ||
- | |||
- | |||
- | |||
- | |||
- | |||
| N | | N | ||
|} | |} | ||
- | + | == Maemo extension keys == | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
The following keys have a particular meaning on Maemo. None of these fields are required. | The following keys have a particular meaning on Maemo. None of these fields are required. | ||
{| class="wikitable" | {| class="wikitable" | ||
- | |||
|- | |- | ||
! Key | ! Key | ||
Line 82: | Line 65: | ||
! Meaning | ! Meaning | ||
|- | |- | ||
- | | | + | | X-Text-Domain |
| string | | string | ||
| The L10n domain from which the application name is translated (with dgettext) | | The L10n domain from which the application name is translated (with dgettext) | ||
|- | |- | ||
- | | | + | | X-Osso-Service |
| string | | string | ||
- | | DBus service name - if specified hildon desktop will try to call the | + | | DBus service name - if specified hildon desktop will try to call the top_application method on this service rather than execute what is listed in the Exec field). |
|- | |- | ||
- | | | + | | X-App-Loading-Image |
- | | | + | | |
- | | | + | | |
|- | |- | ||
- | | | + | | X-Maemo-Prestarted |
| boolean | | boolean | ||
- | | If true, the application will be started automatically at boot time | + | | If true, the application will be started automatically at boot time |
- | + | ||
|- | |- | ||
- | | | + | | X-Maemo-Wm-Class |
| | | | ||
| | | | ||
|- | |- | ||
- | | | + | | X-Maemo-Prestarted-Priority |
- | | | + | | nuber |
- | | | + | | Proprity for the application launch - lower means application is launched sooner |
|- | |- | ||
- | | | + | | X-Maemo-Switcher-Icon |
| | | | ||
| | | | ||
|- | |- | ||
- | | | + | | X-Maemo-Ignore-Lowmem |
| boolean | | boolean | ||
- | | Ignore the low memory status when this application is launched. If this is absent, or set to false, an application will not be launched | + | | Ignore the low memory status when this application is launched. If this is absent, or set to false, an application will not be launched is there is insufficient memory available. |
|- | |- | ||
- | | | + | | X-Maemo-Prestarted-Ignore-Load |
| boolean | | boolean | ||
| If true, prestart the app as soon as possible without regards to load or memory limits | | If true, prestart the app as soon as possible without regards to load or memory limits | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
|} | |} | ||
- | Note that while Maemo 5 (Fremantle) does not by default read the " | + | |
+ | Note that while Maemo 5 (Fremantle) does not by default read the "Categories="-entry from the desktop file, enhanced menu applications like [http://maemo.org/downloads/product/Maemo5/catorise/ Catorise] do. It is recommended that you add a Categories line to the .desktop file. | ||
Categories=Office; ''Office or whatever Category is suitable'' | Categories=Office; ''Office or whatever Category is suitable'' | ||
Line 138: | Line 109: | ||
It is silently ignored in the standard application menu, but allows you to pre-define the location of your application in [http://maemo.org/downloads/product/Maemo5/catorise/ Catorise]. A list of valid categories is found [http://standards.freedesktop.org/menu-spec/latest/apa.html here]. | It is silently ignored in the standard application menu, but allows you to pre-define the location of your application in [http://maemo.org/downloads/product/Maemo5/catorise/ Catorise]. A list of valid categories is found [http://standards.freedesktop.org/menu-spec/latest/apa.html here]. | ||
- | The canonical source for the key types supported on Maemo | + | The canonical source for the key types supported on Maemo is the <code>hildon-desktop</code> module, and specifically the files [http://maemo.gitorious.org/fremantle-hildon-desktop/hildon-desktop/blobs/master/src/launcher/hd-launcher-item.c src/launcher/hd-launcher-item.c] and [http://maemo.gitorious.org/fremantle-hildon-desktop/hildon-desktop/blobs/master/src/launcher/hd-launcher-app.c src/launcher/hd-launcher-app.c] |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
== OS 2008 - Chinook == | == OS 2008 - Chinook == | ||
Line 154: | Line 121: | ||
; Name | ; Name | ||
; Categories | ; Categories | ||
- | :not used on | + | :not used on maemo, but used in Ubuntu mobile |
; Comment | ; Comment | ||
:now unused, was used as second line of text in the startup menu in Bora | :now unused, was used as second line of text in the startup menu in Bora | ||
Line 170: | Line 137: | ||
:set the L10n domain from which the application name is translated (with dgettext) | :set the L10n domain from which the application name is translated (with dgettext) | ||
;X-Osso-Service | ;X-Osso-Service | ||
- | :a DBus service name - if specified hildon desktop will try to call the | + | :a DBus service name - if specified hildon desktop will try to call the top_application method on this service rather than execute what is listed in the Exec field). |
(Credits to [https://bugs.maemo.org/show_bug.cgi?id=95#c15 Johan Billen]) | (Credits to [https://bugs.maemo.org/show_bug.cgi?id=95#c15 Johan Billen]) | ||
Line 176: | Line 143: | ||
BTW: If your application needs the browser to do special URL handling, the desktop file needs to be extended [[URL_Handler|accordingly]]. | BTW: If your application needs the browser to do special URL handling, the desktop file needs to be extended [[URL_Handler|accordingly]]. | ||
- | + | = Further reading = | |
* [http://standards.freedesktop.org/desktop-entry-spec/1.0/ Desktop Entry Specification] | * [http://standards.freedesktop.org/desktop-entry-spec/1.0/ Desktop Entry Specification] |
Learn more about Contributing to the wiki.