Rename everything but the on-disk location to flatpak

1 files changed, 162 insertions, 0 deletions

diff --git a/doc/flatpak-export-file.xml b/doc/flatpak-export-file.xml
new file mode 100644
index 0000000..057e58c
--- /dev/null
+++ b/doc/flatpak-export-file.xml
@@ -0,0 +1,162 @@
+<?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-export-file">
+
+    <refentryinfo>
+        <title>flatpak export-file</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 export-file</refentrytitle>
+        <manvolnum>1</manvolnum>
+    </refmeta>
+
+    <refnamediv>
+        <refname>flatpak-export-file</refname>
+        <refpurpose>Export a file to a sandboxed application</refpurpose>
+    </refnamediv>
+
+    <refsynopsisdiv>
+            <cmdsynopsis>
+                <command>flatpak export-file</command>
+                <arg choice="opt" rep="repeat">OPTION</arg>
+                <arg choice="plain">FILE</arg>
+            </cmdsynopsis>
+    </refsynopsisdiv>
+
+    <refsect1>
+        <title>Description</title>
+
+        <para>
+            Creates a document identifier for a local file that can be
+            exposed to sandboxed applications, allowing them access to
+            files that they would not otherwise see.
+        </para>
+
+        <para>
+            This command also lets you modify the per-application
+            permissions of the documents, granting access to the
+            file on a per-application basis.
+        </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>--unique</option></term>
+
+                <listitem><para> Don't reuse an existing document id
+                for the file.  This makes it safe to later remove the
+                document when you're finished with it.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--transient</option></term>
+
+                <listitem><para>
+                  The document will only exist for the length of
+                  the session. This is useful for temporary grants.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--app=APPID</option></term>
+
+                <listitem><para>
+                  Grant read access to the specified application.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--allow-write</option></term>
+
+                <listitem><para>
+                  Also grant write access to the applications specified with --app.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--allow-delete</option></term>
+
+                <listitem><para>
+                  Also grant the ability to delete a document id to the applications specified with --app.
+                </para></listitem>
+            </varlistentry>
+
+            <varlistentry>
+                <term><option>--allow-grant-permission</option></term>
+
+                <listitem><para>
+                  Also grant the ability further grant permissions to the applications specified with --app.
+                </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 export-file --app=org.gnome.GEdit ~/test.txt</command>
+        </para>
+<programlisting>
+/run/user/1000/doc/e52f9c6a/test.txt
+</programlisting>
+
+    </refsect1>
+
+    <refsect1>
+        <title>See also</title>
+
+        <para>
+            <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+            <citerefentry><refentrytitle>flatpak-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+        </para>
+
+    </refsect1>
+
+</refentry>