From 02b542789a6b2887f54bd30dcee7b879601cacf7 Mon Sep 17 00:00:00 2001
From: Alexander Larsson <alexl@redhat.com>
Date: Thu, 26 Sep 2019 11:52:14 +0200
Subject: [PATCH] Add manpage for flatpak mask

---
 doc/Makefile.am      |   1 +
 doc/flatpak-mask.xml | 150 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 151 insertions(+)
 create mode 100644 doc/flatpak-mask.xml

diff --git a/doc/Makefile.am b/doc/Makefile.am
index ee4fcc3f..31d0dae2 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -29,6 +29,7 @@ man1 = \
 	flatpak-config.1		\
 	flatpak-update.1		\
 	flatpak-uninstall.1		\
+	flatpak-mask.1			\
 	flatpak-list.1			\
 	flatpak-info.1			\
 	flatpak-make-current.1		\
diff --git a/doc/flatpak-mask.xml b/doc/flatpak-mask.xml
new file mode 100644
index 00000000..75685972
--- /dev/null
+++ b/doc/flatpak-mask.xml
@@ -0,0 +1,150 @@
+<?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-mask">
+
+    <refentryinfo>
+        <title>flatpak mask</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 mask</refentrytitle>
+        <manvolnum>1</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+        <refname>flatpak-mask</refname>
+        <refpurpose>Mask out updates and automatic installation</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+            <cmdsynopsis>
+                <command>flatpak mask</command>
+                <arg choice="opt" rep="repeat">OPTION</arg>
+                <arg choice="plain" rep="repeat">PATTERN</arg>
+            </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1>
+        <title>Description</title>
+
+        <para>
+          Flatpak maintains a list of patterns that that define which refs are masked.
+          A masked ref will never be updated or automatically installed (for example an
+          masked extension marked auto-download will not be downloaded). You can still
+          manually install such refs, but once they are installed the version will be pinned.
+        </para>
+        <para>
+          The patterns are just a partial ref, with the * character matching anything
+          within that part of the ref. Here are some example patterns:
+<programlisting>
+org.some.App
+org.some.App//unstable
+app/org.domain.*
+org.some.App/arm
+</programlisting>
+        </para>
+        <para>
+          To list the current set of masks, run this command without any patterns.
+        </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>--remove</option></term>
+
+                <listitem><para>
+                  Instead of adding the patterns, remove matching patterns.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--user</option></term>
+
+                <listitem><para>
+                    Mask refs in a per-user installation.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--system</option></term>
+
+                <listitem><para>
+                    Mask refs in the default system-wide installation.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--installation=NAME</option></term>
+
+                <listitem><para>
+                    Mask refs in a system-wide installation
+                    specified by <arg choice="plain">NAME</arg> among those defined in
+                    <filename>/etc/flatpak/installations.d/</filename>. Using
+                    <option>--installation=default</option> is equivalent to using
+                    <option>--system</option>.
+                </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>
+        </variablelist>
+    </refsect1>
+
+    <refsect1>
+        <title>Examples</title>
+
+        <para>
+            <command>$ flatpak mask</command>
+        </para>
+        <para>
+            <command>$ flatpak mask org.broken.App</command>
+        </para>
+        <para>
+            <command>$ flatpak mask --remove org.broken.App</command>
+        </para>
+
+    </refsect1>
+
+    <refsect1>
+        <title>See also</title>
+
+        <para>
+            <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+            <citerefentry><refentrytitle>flatpak-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+        </para>
+
+    </refsect1>
+
+</refentry>