Chapter 3. Distribution Appstream Metadata

3.1. AppStream XML files
3.2. Icon Cache

AppStream provides an own Metadata format which gets shipped by the distributions and is read by the Xapian database generator or software centers directly.

This chapter contains information about it.

3.1. AppStream XML files

3.1.1. Introduction

AppStream XML files are small textfiles describing all available applications in the distribution's package repositories. The XML files might be compressed with GZip.

3.1.2. File naming and location

The XML files must have an unique name, which is usually the distribution's name and version, combined with the name of the repository/origin. For example in Debian 8 (Jessie), the filename for the main repository component would be debian-jessie-main.xml.gz. For Fedora 20 (Heisenbug) updates it would be fedora-20-updates.xml.gz. 3rd-party repositories use a vendor name and repository-name combination, for example Ubuntu PPAs might get ppa-ubuntu12.04-username-foobar.xml.

There are two valid locations to store AppStream XML data. /usr/share/app-info/xmls stores all AppStream data which has been installed via software packages, while /var/cache/app-info/xmls stores application data which was downloaded by the package manager or placed there by other tools (e.g. Listaller). The XML files can either be plain files or be compressed with gzip. It is always a good idea to compress the files, because they tend to become quite large.

3.1.3. General XML structure

The XML starts with an <components> tag as root element. It has all the <component>, <application>, <font> and <inputmethod> elements as children.

Data to fill the different component elements is usually taken from their Desktop files and package data. However, if an upstream project ships metainfo files (see Chapter 2, Upstream Meta Information), values defined there should override data from any other source.

All child elements of the <components> element, no matter of which type they are, must at least have an id, name, summary and pkgname tag. For applications, a icon tag is also required.

The <components> root node has these properties, where the first two are required:

version: This property declares the AppStream spec version this file is based on (currently 0.6). The property is required.
origin: Defines the repository-id this AppStream XML file belongs to. This usually matches the filename without extension (see the explanation on how to pick a good filename above). It is also used to associate the right cached icons with AppStream metadata. This property is required.

3.1.4. Valid tags for all component types

These tags can be applied to every component type (application, component, font, inputmethod) which is described in the AppStream metadata.

Additionally to the type property, every <component/> tag in AppStream distro data may have a priority property, defining the priority of this specific metadata over other metadata from different AppStream XML files (e.g. from a different repository) which have the same component-id. The value of this tag is an integer, if the property is missing, a value of "0" is assumed.

<id/>

The <id/> tag is the same name as the installed .desktop file for the application. Additional identifiers are possible later, but right now desktop is the only supported type.

<pkgname/>

The name of the package which needs to be installed in order to provide this application.

<name/>

The application name defined in the application's desktop file.

<project_license/>

The

<project_license>

tag is indicating the license of your project/application. It should be a string in SPDX format. Licenses may be combined using and and or logic. Possible values include:

GPL-2
LGPL-3+ and GPL-3+
MIT
CC-BY-SA-2
...

A full list of recognized licenses and their identifiers can be found at the SPDX OpenSource License Registry. For SPDX compatibility, versions with trailing dot-zeroes are considered to be equivalent to versions without (e.g., "2.0.0" is considered equal to "2.0" and "2").

Although the license tag is not mandatory, it is recommended to include it.

<summary/>

A short summary of the purpose and function of this application. Usually taken from the Desktop file, if the application does not ship an AppData file.

<description/>

A long description of the application. It is usually taken from the package descriptions or meta-info files, if they were provided. The description might use markup. Right now, only paragraph, ordered list and unordered list are supported. An example description element might look like this:

<description>
  <p>
   Power Statistics is a program used to view historical and current battery
   information and will show programs running on your computer using power.
  </p>
  <p>Example list:</p>
  <ul>
   <li>First item</li>
   <li>Second item</li>
  </ul>
  <p>
  You probably only need to install this application if you are having problems
  with your laptop battery, or are trying to work out what programs are using
  significant amounts of power.
  </p>
 </description>

As opposed to the by-paragraph translation used in meta-info files, this tag is translated "as a whole", meaning that the <description/> tag itself has a language property and contain the translated paragraphs for the given language. This allows faster parsing of the Appstream XML file, and does not increase it's size much, as long as it is compressed.

<url/>

Defines URLs for this application. This tag can be present multiple times.

For a list of possible url types and what they are expected to do, take a look at the tag's description at Section 2.1.3, “XML Specification”.

<project_group/>

The

<project_group>

tag identifies a project with a specific upstream umbrella project. Known values include GNOME, KDE, XFCE, LXDE, Mozilla and MATE, although other umbrella projects like Yorba would make sense too.

Note

Applications should only identify with an umbrella project if you use all their infrastructure and policies, for instance string freezes dates, bugtracker and source control instance.

<icon/>

The

<icon>

tag describes the application's icon. It can be of the type stock, cached, local, or url.

stock icons are loaded from stock. The icon name should never include any file-extension or path.

cached icons are loaded from the AppStream icon cache. The icon tag should contain the icon file name, including it's extension.

local icons are reserved for AppStream data installed by local applications or via 3rd-party application installers, such as Listaller. They should specify a full file path.

remote icons loaded from a remote URL. This is currently not implemented anywhere, but might be used in future.

Examples of the different methods to specify an icon:

<icon type="stock">gimp</icon>
<icon type="cached">firefox.png</icon>
<icon type="local">/usr/share/pixmaps/foobar.png</icon>
<icon type="remote">http://example.com/icons/foobar.png</icon>

Multiple

<icon/>

tags might be combined for one application, e.g. to define a stock icon and a cached icon. Software-Centers should always prefer the stock icon, if it is available, and fall back to the other icon types if they can not find it. The libappstream library makes it easy to do that, if you are not accessing the Xapian database manually.

The AppStream Xapian database generator will prefer cached over local over remote icons when setting the non-stock icon for the application.

<mimetypes/>

This tag can contain one or more

<mimetype>

tags, describing the mime types this application supports. The data can usually be fetched from the Desktop files. Example:

<mimetypes>
    <mimetype>text/html</mimetype>
    <mimetype>image/jpeg</mimetype>
    <mimetype>application/rss+xml</mimetype>
 </mimetypes>

<categories/>

This tag can contain one or more

<category>

tags, describing the categories this application is in. This data is usually taken from Desktop files, a list of categories can be found in the Freedesktop menu spec. Example:

<categories>
    <category>GNOME</category>
    <category>GTK</category>
    <category>Network</category>
    <category>Telephony</category>
</categories>

Deprecated Tags

The tag

<appcategories>

with its

<appcategory>

child elements is deprecated API. AppStream parsers should handle these tags just like the category tags, there is no difference except for the name.

<keywords/>

This tag can contain one or more

<keyword>

tags, describing keywords for the application, to make it easier to find in a software center. The data is taken from Desktop files. Example:

<keywords>
  <keyword>IDE</keyword>
  <keyword>development</keyword>
  <keyword>programming</keyword>
</keywords>

<screenshots/>

This tag can contain one or more

<screenshot>

tags, describing screenshots which are available for the application. A screenshot tag my have the attribute type="default", marking it as the application's default screenshot, which primarily represents it in a software center.

Every

<screenshot>

is defined by several images of different sizes. All images should have their width and hight set as arguments. Also, one of the images shoukd be marked as type="source", indicating that it is the unscaled version of the screenshot. Images of type="thumbnail" define thumbnails of the screenshot.

Optionally, a screenshot can contain a

<caption>

tag, describing the screenshot's caption. This is usually what the user can see on the image shown. The tag is translatable.

Every image should have a full remote url set, usually pointing to a cache of images maintained by the distributor. Example:

<screenshots>
  <screenshot type="default">
    <caption>Foobar showing kitchen-sink functionality</caption>
    <caption xml:lang="si">Foobar shoeewing kischän-sünk funzionality</caption>
    <image type="source" width="800" height="600">http://www.example.org/en_US/main.png</image>
    <image type="thumbnail" width="200" height="150">http://www.example.org/en_US/main-small.png</image>
  </screenshot>
  <screenshot>
     ....
  </screenshot>
</screenshots>

<compulsory_for_desktop/>

The

<compulsory_for_desktop>

tag indicates that the application which the data belongs to is essential for the functionality of the defined desktop environment. Examples for compulsory applications are the GNOME-Shell by the GNOME-Project, or the Plasma-Desktop by KDE, as well as things like iBus or the desktop login manager.

Software centers are expected to detect the running desktop environment and disable uninstallation for compulsory components of that desktop, so users will not be able to damage their currently running, primary desktop environment.

Multiple occurrences of the

<compulsory_for_desktop>

tag are allowed, so a project can be essential for many desktops. The distributor decides which applications should be made compulsory, however it is generally a good idea to follow upstream's recommendations on that matter.

A list of all allowed values for this tag is defined in the XDG Menu Specification. Software center applications will only recognize these values.

<provides/>

This tag is described in detail at Section 2.1, “Generic Component”.

For generic component types, this tag has to be present. Distributors must ensure that all things described in this tag are present in the package referenced in the associated pkgname tag.

<release/>

The

<release>

tag describes some metainformation about the current release of the described component. It may be present multiple times (for older releases), but a tag for the current version must always be present. A release tag can have the properties version and timestamp which contain the version number and a release timestamp in form of YYYYMMDD.

Examples for a valid release tags:

<release version="1.2" timestamp="20140412" />
<release version="1.0" timestamp="20120826" />

In case a <release/> tag has a <description/> tag as parameter, describing the new release briefly, distributors are encouraged to provide 2-4 <release/> release tags for every component. If no description is provided, one tag is enough.

<architectures/>

If the architectures tag is present, the component is not available on all architectures the distribution supports. Supported architectures for this component are specified as children using the arch tag.

For example, this marks a component to only be available on i686:

<architectures>
  <arch>i686</arch>
</architectures>

3.1.5. Example file

This is an example AppStream metadata file:

<?xml version="1.0"?>
<components version="0.6">
  <component type="application">
    <id>firefox.desktop</id>
    <pkgname>firefox-bin</pkgname>
    <name>Firefox</name>
    <name lang="en_GB">Firefoux</name>
    <summary>Web browser</summary>
    <summary lang="fr_FR">Navigateur web</summary>
    <project_license>MPL-2</project_license>
    <keywords>
      <keyword>internet</keyword>
      <keyword>web</keyword>
      <keyword>browser</keyword>
      <keyword lang="fr_FR">navigateur</keyword>
    </keywords>
    <icon type="stock">web-browser</icon>
    <icon type="cached">firefox.png</icon>
    <categories>
      <category>network</category>
      <category>web</category>
    </categories>
    <mimetypes>
      <mimetype>text/html</mimetype>
      <mimetype>text/xml</mimetype>
      <mimetype>application/xhtml+xml</mimetype>
      <mimetype>application/vnd.mozilla.xul+xml</mimetype>
      <mimetype>text/mml</mimetype>
      <mimetype>application/x-xpinstall</mimetype>
      <mimetype>x-scheme-handler/http</mimetype>
      <mimetype>x-scheme-handler/https</mimetype>
    </mimetypes>
    <url type="homepage">http://www.mozilla.com</url>
    <screenshots>
      <screenshot type="default">
        <image type="source" width="800" height="600">http://www.awesomedistro.example.org/en_US/firefox.desktop/main.png</image>
        <image type="thumbnail" width="200" height="150">http://www.awesomedistro.example.org/en_US/firefox.desktop/main-small.png</image>
      </screenshot>
    </screenshots>
    <provides>
      <binary>firefox</binary>
    </provides>
  </component>
  <component>
    <id>pulseaudio</id>
    <name>PulseAudio</name>
    <summary>The PulseAudio sound server</summary>
    <url type="homepage">http://www.freedesktop.org/wiki/Software/PulseAudio/</url>
    <project_license>GPLv2</project_license>
    <provides>
      <library>libpulse-simple.so.0</library>
      <library>libpulse.so.0</library>
      <binary>start-pulseaudio-kde</binary>
      <binary>start-pulseaudio-x11</binary>
    </provides>
    <release version="2.0"/>
  </component>
  <component type="font">
    <id>LinLibertine_M.otf</id>
    <name>Libertine</name>
    <summary>Linux Libertine Open fonts</summary>
    <font_classifier>Mono</font_classifier>
    <font_parent>Libertine</font_parent>
  </component>
  <!-- more components here! -->
</components>