1APPSTREAMCLI COMPOSE(1)      appstreamcli compose      APPSTREAMCLI COMPOSE(1)
2
3
4

NAME

6       appstreamcli-compose - Compose AppStream collection metadata from
7       directory trees
8

SYNOPSIS

10       appstreamcli compose [COMMAND]
11

DESCRIPTION

13       This manual page documents briefly the appstreamcli compose command.
14
15       appstreamcli compose is a tool to construct AppStream collection
16       metadata from directory trees. The tool will also perform many related
17       metadata generation actions, like resizing icons and screenshots and
18       merging in data from referenced desktop-entry files as well as
19       translation status information. Therefore, the tool provides a fast way
20       to test how the final processed metadata for an application that is
21       shipped to users may look like. It also provides a way to easily
22       generate AppStream data for projects which do not need a more complex
23       data generator like appstream-generator.
24
25       In order for the appstreamcli compose command to be available, you may
26       need to install the optional compose module for appstreamcli first.
27
28       For more information about the AppStream project and the other
29       components which are part of it, take a look at the AppStream pages at
30       Freedesktop.org[1].
31

OPTIONS

33       SOURCE DIRECTORIES
34           A list of directories to process needs to be provided as positional
35           parameters. Data from all directories will be combined into one
36           output namespace.
37
38       --origin NAME
39           Set the AppStream data origin identifier. This can be a value like
40           "debian-unstable-main" or "flathub".
41
42       --result-root DIR
43           Sets the directory where all generated output that is deployed to a
44           user's machine is exported to. If this parameter is not set and we
45           only have one directory to process, we use that directory as
46           default output path.
47
48           If both --data-dir and --icons-dir are set, --result-root is not
49           necessary and no data will be written to that directory.
50
51       --data-dir DIR
52           Override the directory where the generated AppStream collection
53           metadata will be written to. Data will be written directly to this
54           directory, and no supdirectories will be created (unlike when using
55           --result-root to set an output location).
56
57       --icons-dir DIR
58           Override the directory where the cached icons are exported to.
59
60       --hints-dir DIR
61           Set a directory where hints reported generated during metadata
62           processing are saved to. If this parameter is not set, no HTML/YAML
63           hint reports will be saved.
64
65       --media-dir DIR
66           If set, creates a directory with media content (icons, screenshots,
67           ...) that can be served via a webserver. The metadata will be
68           extended to include information about these remote media.
69
70       --media-baseurl URL
71           The URL under which the contents of a directory set via --media-dir
72           will be served. This value must be set if a media directory is
73           created.
74
75       --prefix DIR
76           Set the default prefix that is used in the processed directories.
77           If none is set explicitly, /usr is assumed.
78
79       --print-report MODE
80           Print the issue hints report (that gets exported as HTML and YAML
81           document when --hints-dir was set) to the console in text form.
82
83           Various print modes are supported: on-error only prints a short
84           report if the run failed (default), short generates an abridged
85           report that is always printed and full results in a detailed report
86           to be printed.
87
88       --components COMPONENT-IDs
89           Set a comma-separated list of AppStream component IDs that should
90           be considered for the generated metadata. All components that exist
91           in the input data but are not mentioned in this list will be
92           ignored for the generated output.
93
94       --no-color
95           Don't print colored output.
96
97       --verbose
98           Display extra debugging information
99
100       --version
101           Display the version number of appstreamcli compose
102

SEE ALSO

104       appstreamcli(1), appstream-generator(1).
105

AUTHOR

107       This manual page was written by Matthias Klumpp
108       <matthias@tenstral.net>.
109

111       Copyright © 2020-2021 Matthias Klumpp
112

NOTES

114        1. Freedesktop.org
115           https://www.freedesktop.org/wiki/Distributions/AppStream/
116
117
118
119AppStream                                              APPSTREAMCLI COMPOSE(1)
Impressum