-
-
Notifications
You must be signed in to change notification settings - Fork 389
/
flatpak-document-export.xml
226 lines (176 loc) · 7.66 KB
/
flatpak-document-export.xml
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-document-export">
<refentryinfo>
<title>flatpak document-export</title>
<productname>flatpak</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>[email protected]</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>flatpak document-export</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-document-export</refname>
<refpurpose>Export a file to a sandboxed application</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak document-export</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">FILE</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Creates a document id for a local file that can be exposed to
sandboxed applications, allowing them access to files that they
would not otherwise see. The exported files are exposed in a
fuse filesystem at <filename>/run/user/$UID/doc/</filename>.
</para>
<para>
This command also lets you modify the per-application
permissions of the documents, granting or revoking 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>-u</option></term>
<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>-t</option></term>
<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>-n</option></term>
<term><option>--noexist</option></term>
<listitem><para>
Don't require the file to exist already.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option></term>
<term><option>--app=APPID</option></term>
<listitem><para>
Grant read access to the specified application. The
<option>--allow</option> and <option>--forbid</option> options
can be used to grant or remove additional privileges.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option></term>
<term><option>--allow-read</option></term>
<listitem><para>
Grant read access to the applications specified with <option>--app</option>.
This defaults to TRUE.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--forbid-read</option></term>
<listitem><para>
Revoke read access for the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<term><option>--allow-write</option></term>
<listitem><para>
Grant write access to the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--forbid-write</option></term>
<listitem><para>
Revoke write access for the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--allow-delete</option></term>
<listitem><para>
Grant the ability to remove the document from the document portal to the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--forbid-delete</option></term>
<listitem><para>
Revoke the ability to remove the document from the document portal from the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option></term>
<term><option>--allow-grant-permission</option></term>
<listitem><para>
Grant the ability to grant further permissions to the applications specified with <option>--app</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--forbid-grant-permission</option></term>
<listitem><para>
Revoke the ability to grant further permissions for the applications specified with <option>--app</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>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak document-export --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-document-unexport</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-document-info</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-documents</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>