appstream-generator(1)

1APPSTREAM-GENERATOR(1)        appstream-generator       APPSTREAM-GENERATOR(1)
2
3
4

NAME

6       appstream-generator - Generate AppStream metadata from distribution
7       repositories
8

SYNOPSIS

10       appstream-generator [COMMAND]
11

DESCRIPTION

13       This manual page documents briefly the appstream-generator command.
14
15       appstream-generator generates AppStream metadata from the repositories
16       of a software distribution. It currently supports the following
17       repository formats / distributions: Debian, Ubuntu, Arch Linux, RPM-MD
18       (Fedora, Mageia).
19
20       The generator will produce AppStream collection metadata files in the
21       AppStream YAML or XML format to be shipped to users, as well as
22       detailed HTML reports about found components and HTML and JSON reports
23       on issues found while compiling the metadata. It reads .desktop files
24       as well as metainfo files, renders fonts, scales images, caches
25       screenshots etc. to produce high-quality metadata for AppStream based
26       software centers and other tools to consume. Usually,
27       appstream-generator is integrated with the existing software build &
28       delivery workflow of a distribution.
29
30       The appstream-generator tool is based on the libappstream library for
31       metadata conversion and analysis. If you just want to embed AppStream
32       metadata processing into another tool, using libappstream directly is
33       likely a better choice. The generator tool does some heavy lifting like
34       rendering fonts and scaling images, which might not be necessary for
35       simple cases.
36
37       To use appstream-generator, a asgen-config.json file is required. Its
38       format is described in detail in the asgen-config.json
39       documentation[1].
40
41       The generator supports a wide range of features that can individually
42       configured to fit the needs of different projects and adjust the
43       generated metadata to specific use cases. Refer to the configuration
44       file documentation for information on what options are available.
45
46       For more information about the AppStream project and the other
47       components which are part of it, take a look at the AppStream pages at
48       Freedesktop.org[2].
49

OPTIONS

51       run SUITE [SECTION]
52           Process new metadata for the given distribution suite and publish
53           it.
54
55       cleanup
56           Cleanup old/expired metadata and media files from the cache and
57           directories. It is recommended to run this command every week, or
58           at least every month, depending on how many changes happen in the
59           software repository.
60
61       publish SUITE [SECTION]
62           Export all metadata and publish reports in the export directories.
63
64           You usually do not want to run this task explicitly, because it is
65           already automatically performed by the run command.
66
67       remove-found SUITE
68           Drop all valid processed metadata and hints from the selected
69           suite.
70
71       forget PKID
72           Drop all information we have about this (partial) package-id.
73
74           A package-id consists of a name/version/arch triplet. For this
75           command, the version and architecture can be omitted to forget all
76           packages that match a particular name or name-version combination.
77
78       info PKID
79           Show information associated with this (full) package-id.
80
81           A package-id consists of a name/version/arch triplet.
82
83       -w|--workspace DIR
84           Define the workspace location.
85
86           If this flag is omitted, and no workspace directory is given in the
87           generator configuration file, the current directory is assumed as
88           the workspace location.
89
90           This parameter, if given, overrides any workspace location defined
91           elsewhere.
92
93       -c|--config FILE
94           Define a configuration file.
95
96           Explicitly set a generator configuration JSON file. If this flag is
97           omitted, the asgen-config.json file in the current workspace
98           directory is used.
99
100           If no workspace directory is defined in the configuration file
101           itself, the directory it is located in is used as workspace. This
102           can be overridden by defining a workspace explicitly with -w.
103
104       --force
105           Enforce the command.
106
107       --verbose
108           Show extra debugging information.
109
110       --version
111           Display the version number of appstream-generator.
112

AUTHOR

117       This manual page was written by Matthias Klumpp
118       <matthias@tenstral.net>.
119

COPYRIGHT

121       Copyright © 2016-2018 Matthias Klumpp
122

NOTES

124        1. the asgen-config.json documentation
125           https://github.com/ximion/appstream-generator/blob/master/docs/asgen-config.md
126
127        2. Freedesktop.org
128           http://www.freedesktop.org/wiki/Distributions/AppStream/
129
130
131
132AppStream Generator                                     APPSTREAM-GENERATOR(1)