Rename everything but the on-disk location to flatpak

1 files changed, 166 insertions, 0 deletions

diff --git a/doc/flatpak-uninstall.xml b/doc/flatpak-uninstall.xml
new file mode 100644
index 0000000..3152965
--- /dev/null
+++ b/doc/flatpak-uninstall.xml
@@ -0,0 +1,166 @@
+<?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-uninstall">
+
+    <refentryinfo>
+        <title>dxg-app uninstall</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 uninstall</refentrytitle>
+        <manvolnum>1</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+        <refname>flatpak-uninstall</refname>
+        <refpurpose>Uninstall an application or runtime</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+            <cmdsynopsis>
+                <command>flatpak uninstall</command>
+                <arg choice="opt" rep="repeat">OPTION</arg>
+                <arg choice="plain">NAME</arg>
+                <arg choice="opt">BRANCH</arg>
+            </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1>
+        <title>Description</title>
+
+        <para>
+            Uninstalls an application or runtime. The <arg choice="plain">NAME</arg>,
+            <arg choice="plain">ARCH</arg> and <arg choice="plain">BRANCH</arg>
+            arguments must identify an installed application.
+            If <arg choice="plain">BRANCH</arg> is not specified, it defaults
+            to "master".
+        </para>
+        <para>
+            By default this looks for both installed apps and runtime
+            with the given <arg choice="plain">NAME</arg>, but you can
+            limit this by using the --app or --runtime option.
+        </para>
+        <para>
+            Normally, this command removes the ref for this application/runtime from the
+            local OSTree repository and purges and objects that are no longer
+            needed to free up disk space. If the same application is later
+            reinstalled, the objects will be pulled from the remote repository
+            again. The --keep-ref option can be used to prevent this.
+        </para>
+        <para>
+            If all branches of the application/runtime are removed, this command
+            also purges the data directory for the application.
+        </para>
+        <para>
+            Unless overridden with the --user option, this command updates
+            a system-wide installation.
+        </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 application 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>--app</option></term>
+
+                <listitem><para>
+                    Only look for an app with the given name.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--runtime</option></term>
+
+                <listitem><para>
+                    Only look for an runtime with the given name.
+                </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>$ flatpak --user uninstall org.gnome.GEdit</command>
+        </para>
+
+    </refsect1>
+
+</refentry>