1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Addons | AppStream | AppStream 1.0</title><meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /><link rel="stylesheet" type="text/css" href="static/css/style.css" /><link rel="stylesheet" type="text/css" href="static/css/highlight.css" /><meta name="generator" content="DAPS 3.3.2" /><meta name="product-name" content="AppStream" /><meta name="product-number" content="1.0" /><meta name="book-title" content="AppStream" /><meta name="chapter-title" content="2.7. Addons" /><meta name="description" content="2.7.1 Introduction # Some components are not standalone, but rather extend existing software installed on the system and can only be used together with it. The addon component type exists to reflect that. Software which provides addons can ship one or more files in /usr/share/metainfo/%{id}.metainfo…" /><link rel="home" href="index.html" title="AppStream" /><link rel="up" href="chap-Metadata.html" title="Chapter 2. Upstream Metadata" /><link rel="prev" href="sect-Metadata-Service.html" title="2.6. Services" /><link rel="next" href="sect-Metadata-Fonts.html" title="2.8. Fonts" />
<script src="static/js/highlight.min.js" type="text/javascript"></script><script>
document.addEventListener('DOMContentLoaded', (event) => {
document.querySelectorAll('.verbatim-wrap.highlight').forEach((block) => {
hljs.highlightBlock(block);
});
});
hljs.configure({
useBR: false
});
</script></head><body class="offline js-off"><div class="bypass-block"><a href="#_content">Jump to content</a><a href="#_bottom-navigation">Jump to page navigation: previous page [access key p]/next page [access key n]</a></div><div id="_outer-wrap"><div id="_white-bg"><div id="_header"><div id="_logo"><a href="https://www.freedesktop.org/software/appstream/docs/"><img src="static/images/logo.png" alt="Logo" /><span>AppStream</span></a></div><div class="crumbs"><a class="book-link" href="index.html" title="AppStream"><span class="book-icon">AppStream</span></a><span> › </span><a class="crumb" href="chap-Metadata.html">Upstream Metadata</a><span> › </span><a class="crumb" href="sect-Metadata-Addon.html" accesskey="c"><span class="single-contents-icon"></span>Addons</a></div><div class="clearme"></div></div></div><div id="_toolbar-wrap"><div id="_toolbar"><div id="_toc-area" class="inactive"><a id="_toc-area-button" class="tool" title="Contents" accesskey="c" href="index.html"><span class="tool-spacer"><span class="toc-icon">Contents</span><span class="clearme"></span></span><span class="tool-label">Contents</span></a><div class="active-contents bubble-corner"></div><div class="active-contents bubble"><div class="bubble-container"><h6>AppStream</h6><div id="_bubble-toc"><ol><li class="inactive"><a href="chap-AppStream-About.html"><span class="number">1 </span><span class="name">About AppStream</span></a></li><li class="inactive"><a href="chap-Metadata.html"><span class="number">2 </span><span class="name">Upstream Metadata</span></a></li><li class="inactive"><a href="chap-CatalogData.html"><span class="number">3 </span><span class="name">Catalog Metadata</span></a></li><li class="inactive"><a href="chap-AppStream-Misc.html"><span class="number">4 </span><span class="name">Miscellaneous</span></a></li><li class="inactive"><a href="chap-Quickstart.html"><span class="number">5 </span><span class="name">Metadata Quickstart</span></a></li><li class="inactive"><a href="chap-Validation.html"><span class="number">6 </span><span class="name">Data Validation</span></a></li><li class="inactive"><a href="chap-AppStream-ManualPages.html"><span class="number">7 </span><span class="name">Manual pages</span></a><ol>
<a href="re01.html#id-1.8.3.1">appstreamcli</a>
2012-2024Matthias Klumpp
AppStream
26 July,2012
appstreamcli1appstreamcliHandle AppStream metadata formats and query AppStream dataappstreamcliCOMMAND<a href="re01.html#id-1.8.3.5">Description</a>
This manual page documents briefly the appstreamcli command.
appstreamcli is a small helper tool to work with AppStream metadata and
access the AppStream component index from the command-line. The AppStream component
index contains a list of all available software components for your distribution, matched to their
package names.
It is generated using AppStream XML or Debian DEP-11 data, which is provided by your distributor.
For more information about the AppStream project and the other components which are part of it, take a look at
the AppStream pages at Freedesktop.org.
<a href="re01.html#id-1.8.3.6">Options</a>get IDGet a component from the metadata pool by its identifier.ssearch TERMSearch the AppStream component pool for a given search term.what-provides TYPE TERM
Return components which provide a given item. An item type can be specified using the
TYPE parameter, a value to search for has to be
supplied using the TERM parameter.
Examples:
Get components which handle the "text/xml" mediatype.
appstreamcli what-provides mediatype "text/xml"
Get component which provides the "libfoo.so.2" library.
appstreamcli what-provides lib libfoo.so.2
refreshrefresh-cache
Trigger a database refresh, if necessary.
In case you want to force the database to be rebuilt, supply the --force flag.
This command must be executed with root permission.status
Display various information about the installed metadata and
the metadata cache.
os-info
Show information about the current operating system from the metadata
index.
This requires the operating system to provide a operating-system
component for itself.
dump ID
Dump the complete XML descriptions of components with the given ID that were found in the
metadata pool.
validate FILES
Validate AppStream XML metadata for compliance with the specification.
Both XML metadata types, upstream and distro XML, are handled.
The format type which should be validated is determined automatically.
The --pedantic flag triggers a more pedantic
validation of the file, including minor and style issues in the report.
validate-tree DIRECTORY
Validate AppStream XML metadata found in a file-tree.
This performs a standard validation of all found metadata, but also checks for additional
errors, like the presence of .desktop files and validity of other additional metadata.
check-license LICENSE
Test a license string or license expression for validity and display details about it.
This will check whether the license string is considered to be valid for AppStream, and return
a non-zero exit code if it is not. The command will also display useful information like the
canonical ID of a license, whether it is suitable as license for AppStream metadata,
and whether the license is considered to be for Free and Open Source software or proprietary software.
AppStream will consider any license as Free and Open Source that is marked as suitable by either the
Free Software Foundation (FSF), Open Source Initiative (OSI) or explicit license list
of the Debian Free Software Guidelines (DFSG).
install ID
Install a software component by its ID using the package manager or Flatpak.
This resolves the AppStream component ID to an installation candidate and then
calls either the native package manager or Flatpak (if available) to install
the component.
remove ID
Uninstall a software component by its ID using the package manager or Flatpak.
This will uninstall software matching the selected ID using either the native
package manager or Flatpak (if available).
put FILE
Install a metadata file into the right directory on the current machine.
compare-versionsvercmp VER1 [CMP] VER2
Compare two version numbers. If two version numbers are given as parameters, the versions will be compared and the
comparison result will be printed to stdout.
If a version number, a comparison operator and another version number are passed in as parameter, the result of the comparison
operation will be printed to stdout, and appstreamcli will exit with a non-zero exit status in case the comparison
failed.
The comparison operator can be one of the following:
eq - Equal tone - Not equal tolt - Less thangt - Greater thanle - Less than or equal toge - Greater than or equal tonew-template TYPE FILE
Create a metainfo file template to be used by software projects. The --from-desktop option can be used
to use a .desktop file as template for generating the example file.
The generated files contain example entries which need to be filed in with the actual desired values by the project author.
The first TYPE parameter is the name of an AppStream component type. For a complete list check out
the documentation or the help output
of appstreamcli for this subcommand.
make-desktop-file MI_FILE DESKTOP_FILE
Create a XDG desktop-entry file from a metainfo file.
If the desktop-entry file specified in DESKTOP_FILE already exists, it will get extended with
the new information extracted from the metainfo file. Otherwise a new file will be created.
This command will use the first binary mentioned in a provides tag of the component
for the Exec= field of the new desktop-entry file.
If this is not the desired behavior, the --exec flag can be used
to explicitly define a binary to launch. Other methods of launching the application are currently not supported.
In order to generate a proper desktop-entry, this command assumes that not only the minimally required tags for an
AppStream component are set, but also that it has an <icon/> tag of type "stock" to describe
the stock icon that should be used as well as a <categories/> tag containing the categories the application should
be placed in.
news-to-metainfo NEWS_FILE MI_FILE [OUT_FILE]
This command converts a NEWS file as used by many open source projects into the XML used by AppStream. Since NEWS files are free text,
a lot of heuristics will be applied to get reasonable results. The converter can also read a YAML version of the AppStream release
description and convert it to XML as well.
If the metainfo file MI_FILE already exists, it will be augmented with the new release entries, otherwise the release entries
will be written without any wrapping component.
If [OUT_FILE] is specified, instead of acting on MI_FILE the changed data will
be written to the particular file. If any of the output filenames is set to "-", the output will instead be written to stdout.
The --format option can be used to enforce reading the input file in a specific format ("text" or "yaml") in case the format autodetection fails.
The --limit option is used to limit the amount of release entries written (the newest entries will always be first).
metainfo-to-news MI_FILE NEWS_FILE
This command reverses the news-to-metainfo command and writes a NEWS file as text or YAML using the XML
contained in a metainfo file. If NEWS_FILE is set to "-", the resulting data
will be written to stdout instead of to a file.
The --format option can be used to explicitly specify the output format ("yaml" or "text"). If it is not set,
appstreamcli will guess which format is most suitable.
convert FILE1 FILE1
Converts AppStream XML metadata into its YAML representation and vice versa.
compose
Composes an AppStream metadata catalog from a directory tree with metainfo files.
This command is only available if the org.freedesktop.appstream.compose
component is installed.
See appstreamcli-compose1
for more information.
--detailsPrint out more information about a found component.--no-colorDon't print colored output.--no-netDo not access the network when validating metadata.
The same effect can be achieved by setting the AS_VALIDATE_NONET environment variable
before running appstreamcli.
--versionDisplay the version number of appstreamcli<a href="re01.html#id-1.8.3.7">See Also</a>pkcon1.<a href="re01.html#id-1.8.3.8">AUTHOR</a>
This manual page was written by Matthias Klumpp matthias@tenstral.net.
<a href="re02.html#id-1.8.4.1">appstreamcli compose</a>
2020-2024Matthias Klumpp
AppStream
28 Aug,2020
appstreamcli compose1appstreamcli-composeCompose AppStream metadata catalog from directory treesappstreamcli composeCOMMAND<a href="re02.html#id-1.8.4.5">Description</a>
This manual page documents briefly the appstreamcli compose command.
The appstreamcli compose tool is used to construct AppStream metadata catalogs from directory trees.
The tool will also perform many related metadata generation actions, like resizing icons and
screenshots and merging in data from referenced desktop-entry files as well as translation status
information.
Therefore, the tool provides a fast way to test how the final processed metadata for an application
that is shipped to users may look like.
It also provides a way to easily generate AppStream data for projects which do not need a more complex data
generator like appstream-generator.
In order for the appstreamcli compose command to be available, you may need to install the
optional compose module for appstreamcli first.
For more information about the AppStream project and the other components which are part of it, take a look at
the AppStream pages at Freedesktop.org.
<a href="re02.html#id-1.8.4.6">Options</a>SOURCE-DIRECTORIES
A list of directories to process needs to be provided as positional parameters.
Data from all directories will be combined into one output namespace.
--origin NAME
Set the AppStream data origin identifier. This can be a value like
"debian-unstable-main" or "flathub".
--result-root DIR
Sets the directory where all generated output that is deployed to a user's
machine is exported to. If this parameter is not set and we only have one
directory to process, we use that directory as default output path.
If both --data-dir and --icons-dir are
set, --result-root is not necessary and no data will be
written to that directory.
--data-dir DIR
Override the directory where the generated AppStream metadata catalog
will be written to. Data will be written directly to this directory, and
no supdirectories will be created (unlike when using --result-root
to set an output location).
--icons-dir DIR
Override the directory where the cached icons are exported to.
--hints-dir DIR
Set a directory where hints reported generated during metadata processing
are saved to. If this parameter is not set, no HTML/YAML hint reports
will be saved.
--media-dir DIR
If set, creates a directory with media content (icons, screenshots, ...) that
can be served via a webserver. The metadata will be extended to include information
about these remote media.
--media-baseurl URL
The URL under which the contents of a directory set via --media-dir
will be served. This value must be set if a media directory is created.
--prefix DIR
Set the default prefix that is used in the processed directories. If
none is set explicitly, /usr is assumed.
--print-report MODE
Print the issue hints report (that gets exported as HTML and YAML
document when --hints-dir was set) to the console
in text form.
Various print modes are supported: on-error only prints a
short report if the run failed (default), short generates
an abridged report that is always printed and full results
in a detailed report to be printed.
--no-partial-urls
If set, all URLs in the generated data will be absolute and media_baseurl will not be used.
This makes changing the media mirror harder without regenerating all data and is generally not recommended,
to increase flexibility.
--icon-policy POLICY-STRING
Override the existing icon policy with a custom one. The icon policy sets how icons of
different sizes should be dealt with. They can be in the icon cache only, be a remote icon in
the media location or be both cached and available in the remote location.
The icon-policy string is comprised of comma-separated %{size}x%{size}@%{scale}=%{state} statements.
The size and scale are that of the respective icon, with the scale being allowed to be
omitted if it is 1. The state can be one of remote, cached or
cached-remote.
By default, a policy of 48x48=cached,48x48@2=cached,64x64=cached,64x64@2=cached,128x128=cached-remote,128x128@2=cached-remote
is selected.
--allow-custom CUSTOM-KEY-NAMES
By default, all custom entries set in MetaInfo input data are removed.
This flag allows one to whitelist custom keys to be propagated to the final catalog output data.
The custom-key names should be provided as a comma-separated list.
--components COMPONENT-IDs
Set a comma-separated list of AppStream component IDs that should be
considered for the generated metadata. All components that exist in
the input data but are not mentioned in this list will be ignored
for the generated output.
--no-colorDon't print colored output.--verboseDisplay extra debugging information--versionDisplay the version number of appstreamcli compose<a href="re02.html#id-1.8.4.7">See Also</a>
appstreamcli1,
appstream-generator1.
<a href="re02.html#id-1.8.4.8">AUTHOR</a>
This manual page was written by Matthias Klumpp matthias@tenstral.net.
</ol></li><li class="inactive"><a href="chap-AppStream-API.html"><span class="number">8 </span><span class="name">AppStream API Reference</span></a></li><li class="inactive"><a href="ix01.html"><span class="number"> </span><span class="name">Index</span></a></li></ol></div><div class="clearme"></div></div></div></div><div id="_nav-area" class="inactive"><div class="tool"><span class="nav-inner"><span class="tool-label">Navigation</span><a accesskey="p" class="tool-spacer" title="2.6. Services" href="sect-Metadata-Service.html"><span class="prev-icon">←</span></a><a accesskey="n" class="tool-spacer" title="2.8. Fonts" href="sect-Metadata-Fonts.html"><span class="next-icon">→</span></a></span></div></div></div></div><div id="_fixed-header-wrap" class="inactive"><div id="_fixed-header"><div class="crumbs"><a class="book-link" href="index.html" title="AppStream"><span class="book-icon">AppStream</span></a><span> › </span><a class="crumb" href="chap-Metadata.html">Upstream Metadata</a><span> › </span><a class="crumb" href="sect-Metadata-Addon.html" accesskey="c"><span class="single-contents-icon"></span>Addons</a></div><div class="buttons"><a class="top-button button" href="#">Top</a><div class="button"><a accesskey="p" class="tool-spacer" title="2.6. Services" href="sect-Metadata-Service.html"><span class="prev-icon">←</span></a><a accesskey="n" class="tool-spacer" title="2.8. Fonts" href="sect-Metadata-Fonts.html"><span class="next-icon">→</span></a></div><div class="clearme"></div></div><div class="clearme"></div></div></div><div id="_content" class=""><div class="documentation"><div class="sect1" id="sect-Metadata-Addon"><div class="titlepage"><div><div><h2 class="title" id="sect-Metadata-Addon"><span class="number">2.7 </span><span xmlns:dm="urn:x-suse:ns:docmanager" class="name">Addons</span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html">#</a></h2></div></div></div><div class="sect2" id="spec-addondata-introduction"><div class="titlepage"><div><div><h3 class="title" id="spec-addondata-introduction"><span class="number">2.7.1 </span><span xmlns:dm="urn:x-suse:ns:docmanager" class="name">Introduction</span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html#spec-addondata-introduction">#</a></h3></div></div></div><p>
Some components are not standalone, but rather extend existing software installed on the system and can only be used
together with it.
The <code class="literal">addon</code> component type exists to reflect that.
</p><p>
Software which provides addons can ship one or more files in <code class="filename">/usr/share/metainfo/%{id}.metainfo.xml</code>.
</p></div><div class="sect2" id="spec-addondata-example"><div class="titlepage"><div><div><h3 class="title" id="spec-addondata-example"><span class="number">2.7.2 </span><span xmlns:dm="urn:x-suse:ns:docmanager" class="name">Example file</span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html#spec-addondata-example">#</a></h3></div></div></div><p>
A addon metainfo file should look like this:
</p><div class="verbatim-wrap highlight XML"><pre class="programlisting">
<?xml version="1.0" encoding="UTF-8"?>
<component type="addon">
<id>org.gnome.gedit_code_assistance</id>
<extends>org.gnome.gedit</extends>
<name>Code Assistance</name>
<summary>Code assistance for C, C++ and Objective-C</summary>
<url type="homepage">http://projects.gnome.org/gedit</url>
<metadata_license>FSFAP</metadata_license>
<project_license>GPL-3.0+</project_license>
</component></pre></div></div><div class="sect2" id="spec-addondata-filespec"><div class="titlepage"><div><div><h3 class="title" id="spec-addondata-filespec"><span class="number">2.7.3 </span><span xmlns:dm="urn:x-suse:ns:docmanager" class="name">File specification</span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html#spec-addondata-filespec">#</a></h3></div></div></div><p>
Note that the XML root must have the <code class="literal">type</code> property set to <code class="code">addon</code>.
This clearly identifies this metainfo document as describing an addon to existing software.
</p><div class="variablelist"><dl class="variablelist"><dt id="tag-id-addon"><span class="term"><id/></span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html#tag-id-addon">#</a></dt><dd><p>
For addons, the component-ID must follow the generic naming conventions (see <a class="xref" href="chap-Metadata.html#tag-id-generic"><id/></a>).
</p></dd><dt id="tag-extends"><span class="term"><extends/></span> <a title="Permalink" class="permalink" href="sect-Metadata-Addon.html#tag-extends">#</a></dt><dd><p>
This tag refers to the ID of the component this addon is extending.
</p><p>
For example, if there is a plugin "kipi" which extends the application "Gwenview", it needs to be referred to as:
</p><div class="verbatim-wrap highlight XML"><pre class="programlisting"><extends>org.kde.Gwenview</extends></pre></div><p>
The <code class="code"><extends/></code> tag may be specified multiple times.
</p></dd></dl></div><p>
For a component of type <code class="literal">addon</code>, the following tags are required and must be present: <a class="xref" href="sect-Metadata-Addon.html#tag-id-addon"><id/></a>, <a class="xref" href="chap-Metadata.html#tag-name"><name/></a>, <a class="xref" href="chap-Metadata.html#tag-summary"><summary/></a>,
<a class="xref" href="chap-Metadata.html#tag-metadata_license"><metadata_license/></a>, <a class="xref" href="sect-Metadata-Addon.html#tag-extends"><extends/></a>.
</p></div></div></div><div class="page-bottom"><div id="_bottom-navigation"><a class="nav-link" href="sect-Metadata-Fonts.html"><span class="next-icon">→</span><span class="nav-label">Fonts</span></a><a class="nav-link" href="sect-Metadata-Service.html"><span class="prev-icon">←</span><span class="nav-label">Services</span></a></div></div></div><div id="_inward"></div></div><div id="_footer-wrap"><div id="_footer"><p>©
2025
Freedesktop.org, the AppStream Project</p></div></div></body></html>
|
