flatpak-builder/doc/xdg-app-install-runtime.xml

124 lines
3.8 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="xdg-app-install-runtime">
<refentryinfo>
<title>dxg-app install-runtime</title>
<productname>xdg-app</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>alexl@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app install-runtime</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-install-runtime</refname>
<refpurpose>Install a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app install-runtime</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">REPOSITORY</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Installs a runtime. <arg choice="plain">REPOSITORY</arg> must
name an existing remote. <arg choice="plain">RUNTIME</arg> is the
name of the runtime to install. Optionally,
<arg choice="opt">BRANCH</arg> can be specified to install a specific
branch. Note that xdg-app allows having multiple branches of a runtime
installed and used at the same time.
</para>
<para>
xdg-app can operate in system-wide or per-user mode. The system-wide
runtimes are located in <filename>$prefix/share/xdg-app/runtime</filename>,
and the per-user runtimes are in <filename>$HOME/.local/share/xdg-app/runtinme</filename>.
</para>
<para>
xdg-app uses OSTree, and installed runtimes are OSTree checkouts.
</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>--user</option></term>
<listitem><para>
Work on the per-user configuration instead of the system-wide
configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to install for.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<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>$ xdg-app --user install-runtime test-repo org.gnome.Platform 3.14</command>
</para>
</refsect1>
</refentry>