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

138 lines
4.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="xdg-app-uninstall-runtime">
<refentryinfo>
<title>dxg-app uninstall-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 uninstall-runtime</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-uninstall-runtime</refname>
<refpurpose>Uninstall a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app uninstall-runtime</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">RUNTIME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Uninstalls a runtime. The <arg choice="plain">RUNTIME</arg>,
<arg choice="plain">ARCH</arg> and <arg choice="plain">BRANCH</arg>
arguments must specify an installed runtime.
If <arg choice="plain">BRANCH</arg> is not specified, it defaults
to "master".
</para>
<para>
Normally, this command removes the ref for this runtime from the
local OSTree repository and purges and objects that are no longer
needed to free up disk space. If the same runtime is later reinstalled,
the objects will be pulled from the remote repository again. The
--keep-ref option can be used to prevent this.
</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>--keep-ref</option></term>
<listitem><para>
Keep the ref for the runtime and the objects belonging to it
in the local repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--user</option></term>
<listitem><para>
Remove a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Remove a system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to uninstall, instead of the architecture of
the host system.
</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 uninstall-runtime --arch x86_64 org.gnome.Platform 3.14</command>
</para>
</refsect1>
</refentry>