mirror of
https://github.com/flatpak/flatpak.git
synced 2026-01-20 21:58:11 -05:00
90bd06304a
Some of the options do not explicitly say they can be used multiple times even though it's clear from the code that they can. This commit fixes that by saying so in the manpages.
185 lines
6.2 KiB
XML
185 lines
6.2 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/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>alexl@redhat.com</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 directory for building an application.
|
|
<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.
|
|
</para>
|
|
<para>
|
|
The result of this command is that a <filename>metadata</filename>
|
|
file is created 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.
|
|
</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 --writable-sdk, in addition to the sdk, also install the specified extension.
|
|
This option can be used multiple times.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--sdk-dir</option></term>
|
|
|
|
<listitem><para>
|
|
Specify a custom subdirectory to use instead of <filename>usr</filename> for --writable-sdk.
|
|
</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>--verbose</option></term>
|
|
|
|
<listitem><para>
|
|
Print debug information during command processing.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>--version</option></term>
|
|
|
|
<listitem><para>
|
|
Print version information and exit.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Examples</title>
|
|
|
|
<para>
|
|
<command>$ flatpak build-init /build/my-app org.gnome.Sdk org.gnome.Platform 3.16</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>
|