/
flatpak-build-init.xml
240 lines (192 loc) · 8.53 KB
/
flatpak-build-init.xml
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
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-build-init">
<refentryinfo>
<title>flatpak build-init</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>[email protected]</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak build-init</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-build-init</refname>
<refpurpose>Initialize a build directory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak build-init</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">DIRECTORY</arg>
<arg choice="plain">APPNAME</arg>
<arg choice="plain">SDK</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Initializes a separate build directory.
<arg choice="plain">DIRECTORY</arg> is the name of the directory.
<arg choice="plain">APPNAME</arg> is the application id of the app
that will be built.
<arg choice="plain">SDK</arg> and <arg choice="plain">RUNTIME</arg>
specify the sdk and runtime that the application should be built
against and run in.
<arg choice="plain">BRANCH</arg> specify the version of sdk and runtime
</para>
<para>
Initializes a directory as build directory which can be used as
target directory of <command>flatpak build</command>. It
creates a <filename>metadata</filename> inside the given directory.
Additionally, empty <filename>files</filename> and <filename>var</filename>
subdirectories are created.
</para>
<para>
It is an error to run build-init on a directory that has already
been initialized as a build directory.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to use. See <command>flatpak --supported-arches</command>
for architectures supported by the host.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--var=RUNTIME</option></term>
<listitem><para>
Initialize var from the named runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<term><option>--writable-sdk</option></term>
<listitem><para>
Initialize /usr with a copy of the sdk, which is writable during flatpak build. This can be used
if you need to install build tools in /usr during the build. This is stored in the
<filename>usr</filename> subdirectory of the app dir, but will not be part of the final
app.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tag=TAG</option></term>
<listitem><para>
Add a tag to the metadata file.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sdk-extension=EXTENSION</option></term>
<listitem><para>
When using <option>--writable-sdk</option>, in addition to the sdk, also install the specified extension.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--extension=NAME=VARIABLE[=VALUE]</option></term>
<listitem><para>
Add extension point info.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sdk-dir</option></term>
<listitem><para>
Specify a custom subdirectory to use instead of <filename>usr</filename> for <option>--writable-sdk</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--update</option></term>
<listitem><para>
Re-initialize the sdk and var, don't fail if already initialized.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--base=APP</option></term>
<listitem><para>
Initialize the application with files from another specified application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--base-version=VERSION</option></term>
<listitem><para>
Specify the version to use for <option>--base</option>. If not specified, will default to
"master".
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--base-extension=EXTENSION</option></term>
<listitem><para>
When using <option>--base</option>, also install the specified extension from the app.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--type=TYPE</option></term>
<listitem><para>
This can be used to build different types of things. The default
is "app" which is a regular app, but "runtime" creates a runtime
based on an existing runtime, and "extension" creates an extension
for an app or runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--extension-tag=EXTENSION_TAG</option></term>
<listitem><para>
If building an extension, the tag to use when searching for
the mount point of the extension.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak build-init /build/my-app org.example.myapp org.gnome.Sdk org.gnome.Platform 3.36</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-finish</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-export</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>