• 56171

    文章

  • 559

    评论

  • 47

    友链

  • 最近新加了换肤功能,大家多来逛逛吧~~~~
  • 喜欢这个网站的朋友可以加一下QQ群,我们一起交流技术。

桌面条目文件规范

695856371Web网页设计师②群 | 喜欢本站的朋友可以收藏本站,或者加入我们大家一起来交流技术!

欢迎来到梁钟霖个人博客网站。本个人博客网站提供最新的站长新闻,各种互联网资讯。 还提供个人博客模板,最新最全的java教程,java面试题。在此我将尽我最大所能将此个人博客网站做的最好! 谢谢大家,愿大家一起进步!

原文链接

介绍

KDE和GNOME桌面环境都采用了类似的”桌面条目”格式,或描述特定程序如何启动的配置文件,它在菜单中的显示方式等。统一标准对更大的社区有利。 所有各方都同意这样做,即两个环境之间的互操作,以及实现规范的任何其他环境变得更加简单。

文件命名

桌面条目文件应具有.desktop扩展名,但类型目录的文件除外,该文件应具有.directory扩展名。基于扩展确定文件类型使得确定文件类型非常容易和快速。当没有文件扩展名时,桌面系统应通过“魔术检测”来后备识别。

对于应用程序,.desktop扩展名之前的桌面文件名称部分应该是有效的D-Bus知名名称。这意味着它是由点(U+002E FULL STOP)分隔的非空元素序列,其中没有一个以数字开头,并且每个元素仅包含来自集合的字符[A-Za-z0-9- _]:ASCII字母,数字,短划线(U+002D HYPHEN-MINUS)和下划线(U+002D HYPHEN-MINUS)。

桌面条目的名称应遵循“反向DNS”约定:它应以应用程序作者控制的反向DNS域名开头,小写。域名后面应该跟应用程序的名称,通常用合并的单词和首字母大写字母(CamelCase)编写。例如,如果exam​​ple.org的所有者编写“Foo Viewer”,他们可能会选择名称org.example.FooViewer,结果是名为org.example.FooViewer.desktop的文件。

允许使用包含短划线的已知名称,但不建议这样做,因为在反向DNS名称的某些相关用途中不允许使用短划线,例如D-Bus对象路径和接口名称以及Flatpak应用程序ID。如果作者的域名包含短划线,建议将其替换为下划线:这不会导致歧义,因为DNS域名中不允许使用下划线。

如果作者的域名包含以数字开头的元素(在D-Bus知名名称中不允许),建议在桌面条目名称的该元素前加下划线。例如,7-zip.org可能会发布名为org._7_zip.Archiver的应用程序。

桌面文件 ID

表示应用程序的每个桌面条目由其桌面文件ID标识,该文件ID基于其文件名。

要确定桌面文件的ID,请相对于安装桌面文件的$XDG_DATA_DIRS组件创建其完整路径,删除“applications/”前缀,然后将“/”变为“-”。例如/usr/share/applications/foo/bar.desktop具有桌面文件ID foo-bar.desktop。

如果多个文件具有相同的桌面文件ID,则使用$XDG_DATA_DIRS优先顺序中的第一个。例如,如果$ XDG_DATA_DIRS包含默认路径/usr/local/share:/usr/share,那么/usr/local/share/applications/org.foo.bar.desktop/usr/share/applications/org.foo.bar.desktop都具有相同的桌面文件ID org.foo.bar.desktop,但只会使用第一个。如果foo-bar.desktop和foo/bar.desktop都存在,则选择未定义。

如果桌面文件未安装在$XDG_DATA_DIRS组件之一的applications子目录中,则它没有ID。

文件的基本格式

桌面条目文件以UTF-8编码。 文件被解释为由换行符分隔的一系列行。 文件中字母大小写是有意义的。

兼容的实现绝不能从文件中删除任何字段,即使它们不支持它们。 这些字段必须保存在某个列表中,如果文件被“重写”,它们将被包含在内。 这可确保即使其他系统访问和更改文件,也会保留任何特定于桌面的扩展。

注释

以#开头的行被视为注释,将被忽略,但是应该在桌面条目文件的读写期间保留它们。

注释行不被解析,可能包含任何字符(LF除外)。 但是,鼓励将UTF-8用于包含非ASCII字符的注释行。

组头部

名称为groupname的组头部是以下格式的行:

[groupname]

组名可以包含除[]和控制字符以外的所有ASCII字符。

多个组可能没有相同的名称。

在组头部之后的所有{key,value}对,直到新的组头部属于该组。

桌面条目文件的基本格式要求有一个名为Desktop Entry的组头部。 文件中可能存在其他组,但这是明确需要支持的最重要的组。 该组还应该用作自动MIME类型检测的“魔术键”。 桌面条目文件中此组之前应该没有任何内容,但可能有一行或多行注释。

条目

文件中的条目是{key,value}对,格式如下:

Key=Value

等号之前和之后的空格应该被忽略; =符号是实际的分隔符。

在键名中只能使用字符A-Za-z0-9-。

由于大小写是有意义的,键 Name 和 NAME 是不同的。

同一组中的多个键可能不具有相同的名称。不同组中的键可能具有相同的名称。

可能的值类型

识别的值类型是string,localestring,boolean和numeric。

  • string类型的值可以包含除控制字符之外的所有ASCII字符。

  • localestring类型的值是可向用户显示的,并以UTF-8编码。

  • boolean类型的值必须是字符串true或false。

  • numeric类型的值必须是有效的浮点数,由C语言环境中scanf的%f说明符识别。

转义序列\s,\n,\t,\r和\支持string和localestring类型的值,分别表示ASCII空格,换行符,制表符,回车符和反斜杠。

某些键可以有多个值。在这种情况下,键的值被指定为复数:例如,多个字符串。多个值应该用分号分隔,键的值可以选择用分号结束。尾随空字符串必须始终以分号结束。这些值中的分号需要使用;进行转义。

键的本地化值

类型为localestring的键可以由[LOCALE]后缀,其中LOCALE是条目的语言环境类型。 LOCALE的格式必须为lang_COUNTRY.ENCODING@MODIFIER,其中可省略_COUNTRY,.ENCODING和@MODIFIER。如果出现加后缀的键,则必须同时存在不加后缀的相同的键。

在桌面条目文件中读取时,通过将LC_MESSAGES类别的当前POSIX语言环境与键的所有LOCALE后缀相匹配来选择键的值。

匹配如下进行。如果LC_MESSAGES的格式为lang_COUNTRY.ENCODING@MODIFIER,则它将匹配lang_COUNTRY@MODIFIER格式的键。如果这样的键不存在,它将尝试匹配lang_COUNTRY,然后是lang@MODIFIER。然后,将尝试与lang本身进行匹配。最后,如果未找到匹配的密钥,则使用未指定区域设置的所需键。匹配时忽略LC_MESSAGES值的编码。

如果LC_MESSAGES没有MODIFIER字段,则不会匹配带修饰符的键。同样,如果LC_MESSAGES没有COUNTRY字段,则不会匹配指定国家/地区的键。如果LC_MESSAGES只有一个lang字段,那么它将与具有相似值的键进行直接匹配。下表按照匹配顺序列出了各种LC_MESSAGES值的可能匹配项。请注意,未显示ENCODING字段。

表1. 区域设置匹配

LC_MESSAGES值 可能的键按匹配顺序排列
lang_COUNTRY@MODIFIER lang_COUNTRY@MODIFIER, lang_COUNTRY, lang@MODIFIER, lang, 默认值
lang_COUNTRY lang_COUNTRY, lang, 默认值
lang@MODIFIER lang@MODIFIER, lang, 默认值
lang lang, 默认值

例如,如果LC_MESSAGES类别的当前值是sr_YU@Latn,并且桌面文件包括:

Name=Foo
Name[sr_YU]=...
Name[sr@Latn]=...
Name[sr]=...

则 Name 的值用[sr_YU]后缀的。

识别的桌面条目键

键是可选的或必需的。 如果键是可选的,则它可能存在也可能不存在于文件中。 但是,如果不是,标准的实现不应该崩溃,它必须提供一些理智的默认值。

某些键仅在上下文中另一个特定键也存在并设置为特定值才有效。 如果特定键不存在或未设置为特定值,则不应使用这些键。 例如,只有在Type键的值为Application时才能使用Terminal键。

如果必需键仅在另一个设置为特定值的键的上下文中有效,则只有在另一个键设置为特定值时才必须存在。 例如,当且仅当Type键的值为Link时,必须存在URL键。

一些示例键:Name[C]Comment[it]

描述 值类型 必需?
Type 此规范定义了3种类型的桌面条目:Application(应用程序,类型1),Link(链接,类型2)和Directory(目录,类型3)。 为了允许将来添加新类型,实现应忽略具有未知类型的桌面条目。 string
Version 桌面条目符合的桌面条目规范的版本。 使用此版本规范确认的条目应使用1.1。 请注意,不需要存在版本字段。 string
Name 应用程序的特定名称,例如“Mozilla”。 localestring
GenericName 应用程序的通用名称,例如“Web 浏览器”。 localestring
NoDisplay 表示“此应用程序存在,但不在菜单中显示”。 这可用于例如 将此应用程序与MIME类型相关联,以便从文件管理器(或其他应用程序)启动它,而无需为其提供菜单条目(有很多很好的理由,包括例如netscape -remote或kfmclient openURL类型 的东西)。 boolean
Comment 该条目的工具提示,例如“查看Internet上的站点”。 该值不应该和 Name和GenericName的值重复。 localestring
Icon 要在文件管理器,菜单等中显示的图标。如果名称是绝对路径,则将使用给定文件。 如果名称不是绝对路径,则将使用图标主题规范中描述的算法来定位图标。 localestring
Hidden 隐藏应该被称为已删除。 这意味着用户删除了(在他的级别)存在的东西(在较高级别,例如在系统目录中)。 就用户而言,它完全等同于根本不存在的.desktop文件。 这也可用于“卸载”现有文件(例如,由于重命名) - 让make install安装一个Hidden = true的文件。 boolean
OnlyShowIn, NotShowIn 标识应显示/不显示给定桌面条目的桌面环境的字符串列表。<br>默认情况下,应显示桌面文件,除非存在OnlyShowIn键,在这种情况下,默认情况下不显示该文件。<br> 如果设置了$XDG_CURRENT_DESKTOP,则它包含以冒号分隔的字符串列表。 按顺序,考虑每个字符串。 如果在OnlyShowIn中找到匹配的条目,则显示桌面文件。 如果在NotShowIn中找到条目,则不显示桌面文件。 如果没有任何字符串匹配,则采用默认操作(如上所述)。<br> $XDG_CURRENT_DESKTOP应该由登录管理器根据会话文件中找到的DesktopNames的值设置。 会话文件中的条目有多个值时通常以分号“:”分隔。<br> 相同的桌面名称可能不会同时出现在组的OnlyShowIn和NotShowIn中。 string(s)
DBusActivatable 指定此应用程序是否支持D-Bus激活。 如果缺少此键,则默认值为false。 如果值为true,则实现应忽略Exec键并发送D-Bus消息以启动应用程序。 有关其工作原理的详细信息,请参阅D-Bus激活。 应用程序仍应在其桌面文件中包含Exec =行,以便与不理解DBusActivatable键的实现兼容。 boolean
TryExec 磁盘上可执行文件的路径,用于确定程序是否实际安装。 如果路径不是绝对路径,则在$PATH环境变量中查找该文件。 如果文件不存在或者文件不可执行,则可以忽略该条目(例如,不在菜单中使用)。 string
Exec 要执行的程序,可能带有参数。 有关此键如何工作的详细信息,请参阅Exec键。 如果DBusActivatable未设置为true,则需要Exec键。 即使DBusActivatable为true,为了不理解DBusActivatable的实现的兼容性也应指定Exec。
Path 如果条目是Application类型,则是运行该程序的工作目录。 string
Terminal 程序是否在终端窗口中运行。 boolean
Actions 应用程序操作的标识符。 这可以用于告诉应用程序进行特定操作,与默认行为不同。 应用程序操作部分描述了操作的工作方式。 string(s)
MimeType 此应用程序支持的MIME类型。 string(s)
Categories 应在菜单中显示条目的类别(有关可能的值,请参阅桌面菜单规范)。 string(s)
Implements 此应用程序实现的接口列表。 默认情况下,桌面文件不实现任何接口。 有关其工作原理的详细信息,请参阅接口。 string(s)
Keywords 除了描述此条目的其他元数据之外可以使用的字符串列表。 这可能是有用的,例如便于搜索条目。 这些值不用于显示,并且不应该与Name或GenericName的值重复。 localestring(s)
StartupNotify 如果为true,则表示应用程序在使用DESKTOP_STARTUP_ID环境变量集启动时将发送“删除”消息。 如果为false,则表示该应用程序根本不适用于启动通知(未显示任何窗口,即使在使用StartupWMClass时也会破坏等)。 如果不存在,则合理的处理取决于实现(假设为false,使用StartupWMClass等)。 (有关更多详细信息,请参阅“启动通知协议规范”)。 boolean
StartupWMClass 如果指定,则已知应用程序将会映射至少一个具有给定字符串为其WM类或WM名称提示的窗口(有关更多详细信息,请参阅启动通知协议规范)。 string
URL 如果条目是链接类型,则是要访问的URL。 string

Exec 键

Exec键必须包含命令行。 命令行由可执行程序组成,可选地后跟一个或多个参数。 可执行程序可以使用其完整路径指定,也可以仅使用可执行文件的名称指定。 如果未提供完整路径,则在桌面环境使用的$PATH环境变量中查找可执行文件。 可执行程序的名称或路径可能不包含等号(“=”)。 参数由空格分隔。

参数可以全部引起来(后称为引用)。 如果参数包含保留字符,则必须引用该参数。 引用参数的规则也适用于提供的可执行程序的可执行文件名或路径。

引用必须通过在双引号之间包含参数并转义双引号字符(“"”),反引号字符(“`”),美元符号(“$”)和反斜杠字符(“\”),并在其前面添加一个反斜杠字符来完成。 实现必须在扩展字段代码之前和将参数传递给可执行程序之前解开引用。 保留字符为空格(“ ”),制表符,换行符,双引号(“"”),单引号(“'”),反斜杠字符(“\”),大于号(“>”),小于号(“<” ),波浪号(“~”),竖条(“|”),and符号(“&”),分号(“;”),美元符号(“$”),星号(“*”),问号(“?“),哈希标记(”#“),括号(”(“)和(”)“)和反引号字符(”`“)。

请注意,string类型值的常规转义规则表明反斜杠字符也可以转义为(“\”),并且在引用规则之前应用此转义规则。 因此,要明确表示桌面条目文件中带引号的参数中的文字反斜杠字符,需要使用四个连续的反斜杠字符(“\\”)。 同样,桌面条目文件中带引号的参数中的文字美元符号用(“\$”)明确表示。

已经定义了许多特殊的字段代码,当在命令行中遇到时,它们将由文件管理器或程序启动器扩展。 字段代码由百分比字符(“%”)后跟字母字符组成。 必须将文字百分比字符转义为%%。 应从命令行中删除不推荐使用的字段代码并将其忽略。 字段代码仅扩展一次,不应检查用于替换字段代码的字符串的字段代码本身。

包含未在此规范中列出的字段代码的命令行无效且不得处理,特别是实现可能不会引入对本规范中未列出的字段代码的支持。 如果有的话,应该通过新键引入扩展。

除非本规范明确指示,否则实现必须注意不要将字段代码扩展为多个参数。 这意味着可以包含空格的名称字段,文件名和其他替换项必须在扩展后作为单个参数传递给可执行程序。

尽管Exec键被定义为具有string类型的值(仅限于ASCII字符),但字段代码扩展可能会在参数中引入非ASCII字符。 实现必须注意传递给可执行程序的参数中的所有字符都根据适用的语言环境设置进行了正确编码。

识别的字段代码如下:

代码 描述
%f 单个文件名(包括路径),即使选择了多个文件也是如此。 读取桌面条目的系统应该识别出有问题的程序无法处理多个文件参数,如果程序无法处理其他文件参数,它应该应该为每个选定文件生成并执行程序的多个副本。 如果文件不在本地文件系统上(即在HTTP或FTP位置),则文件将被复制到本地文件系统,%f将扩展为指向临时文件。 用于不了解URL语法的程序。
%F 文件列表。 用于可以一次打开多个本地文件的应用程序。 每个文件作为单独的参数传递给可执行程序。
%u 一个URL。 本地文件可以作为 file:// URL或文件路径传递。
%U URL列表。 每个URL作为单独的参数传递给可执行程序。 本地文件可以作为file:// URL或文件路径传递。
%d 废弃
%D 废弃
%n 废弃
%N 废弃
%i 桌面条目的Icon键扩展为两个参数,首先是--icon,然后是Icon键的值。 如果Icon键为空或缺失,则不应扩展为任何参数。
%c 桌面条目中相应Name键中列出的应用程序的已翻译名称。
%k 桌面文件的位置为URI(例如,如果从vfolder系统获取)或本地文件名,如果没有不知到位置则为空。
%v 废弃
%m 废弃

命令行最多可包含一个%f,%u,%F或%U字段代码。 如果应用程序不应打开任何文件,则必须从命令行中删除%f,%u,%F和%U字段代码并将其忽略。

不能在带引号的参数内使用字段代码,引用参数内的字段代码扩展的结果是未定义的。 %F和%U字段代码只能单独用作参数。

D-Bus 激活

支持由D-Bus启动的应用程序必须实现以下接口(以D-Bus内省XML格式给出):

<interface name='org.freedesktop.Application'>
    <method name='Activate'>
      <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='Open'>
      <arg type='as' name='uris' direction='in'/>
      <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='ActivateAction'>
      <arg type='s' name='action_name' direction='in'/>
      <arg type='av' name='parameter' direction='in'/>
      <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
  </interface>

应用程序必须根据介绍部分中的命名建议命名其桌面文件(例如,文件名必须类似于org.example.FooViewer.desktop)。 应用程序必须具有可以使用已知名称激活的D-Bus服务,该名称与删除了.desktop部分的桌面文件名相同(对于我们的示例,org.example.FooViewer)。 上述接口必须在如下确定的对象路径上实现:从应用程序的众所周知的D-Bus名称开始,将所有点更改为斜杠并添加前缀斜杠。 如果找到破折号('-'),将其转换为下划线('_')。 对于我们的示例,是/org/example/FooViewer。

当启动应用程序时不打开任何文件将调用Activate方法。

当启动应用程序时带有文件,将调用Open方法。字符串数组是一个URI数组,采用UTF-8编码。

激活桌面操作时会调用ActivateAction方法。 action-name参数是操作的名称。

所有方法都接收platform-data参数,该参数的使用方式与环境变量的使用方式类似。 目前,规范只定义了一个字段:desktop-startup-id。 这应该是与存储在DESKTOP_STARTUP_ID环境变量中的值相同的字符串,如启动通知协议规范所指定的。

接口

Implements键可用于声明桌面文件实现的一个或多个接口。

每个接口名称必须遵循用于D-Bus接口名称的规则,但除此之外,它们没有特别的含义。 例如,在此列出接口并不一定意味着该应用程序实现了D-Bus接口,甚至不存在这样的D-Bus接口。 完全由定义特定接口的实体来定义实现它的意义。

虽然完全取决于接口的设计者来决定给定的接口名称的含义,但这里有一些推荐的“最佳实践”:

  • 接口应该要求应用程序是可以DBusActivatable的,包括使用D-Bus“反向DNS”约定命名应用程序的桌面文件的要求
  • 接口名称应对应于应用程序在导出org.freedesktop.Application接口时在同一对象路径上导出的D-Bus接口
  • 如果接口希望允许有关实现的详细信息,则应通过指定实现者在其桌面文件中添加与接口同名的组来实现(例如:[org.freedesktop.ImageAcquire]

尽管建议,接口可以指定几乎任何可以想象的要求,包括这样(荒谬)的事情,“当通过Exec行启动时,应用程序应该呈现一个设置了_FOO_IDENTIFIER属性的窗口,此时将发送一个X客户端消息到那个窗口“。 另一个例子是“此接口的所有实现都应该标记为NoDisplay,并且在启动时,不会显示任何窗口,并且将在不确认的情况下删除所有用户的文件”。

接口定义者在设计接口时应注意保持向后和向前兼容性问题。

注册MIME类型

MimeType键用于指示应用程序知道如何处理的MIME类型。 对于某些应用程序,预计此列表可能会变长。 期望应用程序能够使用Exec键中列出的命令合理地打开这些类型的文件。

此字段中的MIME类型或桌面文件中的任何形式的优先级都不应该具有优先级。 应用程序的优先级在.desktop文件之外处理。

附加应用程序操作

Application类型的桌面条目可以包括一个或多个操作。 操作表示调用应用程序的其他方法。 应用程序启动器应该在应用程序的上下文中将它们公开给用户(例如,作为子菜单)。 这用于构建所谓的“快速列表”或“跳转列表”。

操作标识符

每个操作都由一个字符串标识,其格式与键名相同(请参阅“条目”一节)。 每个标识符都与必须存在于.desktop文件中的操作组相关联。操作组是名为Desktop Action %s的组,其中%s是操作标识符。

Actions键中未提及的操作标识符的操作组无效。实现者必须忽略这样的操作组。

操作的键

每个操作组中都支持以下键。 如果操作组中不存在必需键,则实现者应忽略此操作。

表3.特定于操作的键

描述 值类型 必需?
Name 将显示给用户的标签。 由于操作始终显示在特定应用程序的上下文中(即,作为启动程序的子菜单),因此这只需要在应用程序中明确,并且不应包含应用程序名称。 localestring
Icon 与操作一起显示的图标。 如果值是绝对路径,则将使用给定文件。 如果值不是绝对路径,则将使用图标主题规范中描述的算法来定位图标。 实现可能会选择忽略它。 localestring
Exec 执行此操作的程序,可能带参数。有关此键如何工作的详细信息,请参阅Exec键。 如果主桌面条目组中的DBusActivatable未设置为true,则需要Exec键。 即使DBusActivatable为true,为了不理解DBusActivatable的实现的兼容性也应该指定Exec。 string

实施说明

应用程序操作应该由实现者支持。 但是,如果不支持它们,实现者可以简单地忽略Actions键和关联的Desktop Action操作组,并继续使用Desktop Entry组:描述和调用应用程序的主要方法是通过Desktop Entry组的NameIconExec键。

预计显示应用程序列表的其他桌面组件(例如软件安装程序)不会为这些操作提供任何用户界面。 因此,应用程序必须仅包含作为通用发·射器有意义的操作。

扩展格式

如果要使用适用于所有支持方的新{key,value}对修改标准,则将进行小组讨论。 这是引入更改的首选方法。 如果一个特定的一方希望添加一个供个人使用的字段,他们应该在密钥前面添加字符串X-PRODUCT,例如: X-NewDesktop-Foo,遵循其他IETF和RFC标准设定的先例。

或者,可以将字段放在它们自己的组中,然后它们可以具有任意键名。 如果是这种情况,该组应遵循上述方案,即[X-PRODUCT GROUPNAME]或类似的东西。 这些步骤将避免不同但相似的环境之间的命名空间冲突。

示例桌面条目文件

[Desktop Entry]
Version=1.0
Type=Application
Name=Foo Viewer
Comment=The best viewer for Foo objects available!
TryExec=fooview
Exec=fooview %F
Icon=fooview
MimeType=image/x-foo;
Actions=Gallery;Create;

[Desktop Action Gallery]
Exec=fooview --gallery
Name=Browse Gallery

[Desktop Action Create]
Exec=fooview --create-new
Name=Create a new Foo!
Icon=fooview-new

 转载至链接:https://my.oschina.net/u/1248114/blog/3065631。


转载原创文章请注明出处,转载至: 梁钟霖个人博客www.liangzl.com

0条评论

Loading...


发表评论

电子邮件地址不会被公开。 必填项已用*标注

自定义皮肤
注册梁钟霖个人博客