summaryrefslogtreecommitdiff
path: root/doc/flatpak-export-file.xml
blob: 057e58cf80d21e161fc31a9b76a8d3b76a36a37c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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>