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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="flatpak-override">
<refentryinfo>
<title>flatpak override</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 override</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-override</refname>
<refpurpose>Override application requirements</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak override</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="opt">APP</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Overrides the application specified runtime requirements. This can be used
to grant a sandboxed application more or less resources than it requested.
</para>
<para>
By default the application gets access to the resources it
requested when it is started. But the user can override it
on a particular instance by specifying extra arguments to
<command>flatpak run</command>, or every time by using
<command>flatpak override</command>.
</para>
<para>
The application overrides are saved in text files residing in $XDG_DATA_HOME/flatpak/overrides in user mode.
</para>
<para>
If the application ID <arg choice="plain">APP</arg> is not specified
then the overrides affect all applications,
but the per-application overrides can override the global overrides.
</para>
<para>
Unless overridden with the <option>--user</option> or <option>--installation</option> options, this command
changes the default 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>-u</option></term>
<term><option>--user</option></term>
<listitem><para>
Update a per-user installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Update the default system-wide installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Updates 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>--share=SUBSYSTEM</option></term>
<listitem><para>
Share a subsystem with the host session. This overrides
the Context section from the application metadata.
<arg choice="plain">SUBSYSTEM</arg> must be one of: network, ipc.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--unshare=SUBSYSTEM</option></term>
<listitem><para>
Don't share a subsystem with the host session. This overrides
the Context section from the application metadata.
<arg choice="plain">SUBSYSTEM</arg> must be one of: network, ipc.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--socket=SOCKET</option></term>
<listitem><para>
Expose a well-known socket to the application. This overrides to
the Context section from the application metadata.
<arg choice="plain">SOCKET</arg> must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus,
ssh-auth, pcsc, cups, gpg-agent, inherit-wayland-socket.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nosocket=SOCKET</option></term>
<listitem><para>
Don't expose a well-known socket to the application. This overrides to
the Context section from the application metadata.
<arg choice="plain">SOCKET</arg> must be one of: x11, wayland, fallback-x11, pulseaudio, system-bus, session-bus,
ssh-auth, pcsc, cups, gpg-agent, inherit-wayland-socket.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--device=DEVICE</option></term>
<listitem><para>
Expose a device to the application. This overrides to
the Context section from the application metadata.
<arg choice="plain">DEVICE</arg> must be one of: dri, input, usb, kvm, shm, all.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nodevice=DEVICE</option></term>
<listitem><para>
Don't expose a device to the application. This overrides to
the Context section from the application metadata.
<arg choice="plain">DEVICE</arg> must be one of: dri, input, usb, kvm, shm, all.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--allow=FEATURE</option></term>
<listitem><para>
Allow access to a specific feature. This updates
the [Context] group in the metadata.
<arg choice="plain">FEATURE</arg> must be one of:
devel, multiarch, bluetooth, canbus,
per-app-dev-shm.
This option can be used multiple times.
</para><para>
See <citerefentry><refentrytitle>flatpak-build-finish</refentrytitle><manvolnum>1</manvolnum></citerefentry>
for the meaning of the various features.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disallow=FEATURE</option></term>
<listitem><para>
Disallow access to a specific feature. This updates
the [Context] group in the metadata.
<arg choice="plain">FEATURE</arg> must be one of:
devel, multiarch, bluetooth, canbus,
per-app-dev-shm.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--filesystem=FILESYSTEM</option></term>
<listitem><para>
Allow the application access to a subset of the filesystem.
This overrides to the Context section from the application metadata.
<arg choice="plain">FILESYSTEM</arg> can be one of: home, host, host-os, host-etc, xdg-desktop, xdg-documents, xdg-download,
xdg-music, xdg-pictures, xdg-public-share, xdg-templates, xdg-videos, xdg-run,
xdg-config, xdg-cache, xdg-data,
an absolute path, or a homedir-relative path like ~/dir or paths
relative to the xdg dirs, like xdg-download/subdir.
The optional :ro suffix indicates that the location will be read-only.
The optional :create suffix indicates that the location will be read-write and created if it doesn't exist.
This option can be used multiple times.
See the "[Context] filesystems" list in
<citerefentry><refentrytitle>flatpak-metadata</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details of the meanings of these filesystems.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nofilesystem=FILESYSTEM</option></term>
<listitem><para>
Undo the effect of a previous
<option>--filesystem=</option><arg choice="plain">FILESYSTEM</arg>
in the app's manifest or a lower-precedence layer of
overrides, and/or remove a previous
<option>--filesystem=</option><arg choice="plain">FILESYSTEM</arg>
from this layer of overrides.
This overrides the Context section of the
application metadata.
<arg choice="plain">FILESYSTEM</arg> can take the same
values as for <option>--filesystem</option>, but the
<arg choice="plain">:ro</arg> and
<arg choice="plain">:create</arg> suffixes are not
used here.
This option can be used multiple times.
</para><para>
This option does not prevent access to a more
narrowly-scoped <option>--filesystem</option>.
For example, if an application has the equivalent of
<option>--filesystem=xdg-config/MyApp</option> in
its manifest or as a system-wide override, and
<literal>flatpak override --user --nofilesystem=home</literal>
as a per-user override, then it will be prevented from
accessing most of the home directory, but it will still
be allowed to access
<filename>$XDG_CONFIG_HOME/MyApp</filename>.
</para><para>
As a special case,
<option>--nofilesystem=host:reset</option>
will ignore all <option>--filesystem</option>
permissions inherited from the app manifest or a
lower-precedence layer of overrides, in addition to
having the behaviour of
<option>--nofilesystem=host</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--add-policy=SUBSYSTEM.KEY=VALUE</option></term>
<listitem><para>
Add generic policy option. For example, "--add-policy=subsystem.key=v1 --add-policy=subsystem.key=v2" would map to this metadata:
<programlisting>
[Policy subsystem]
key=v1;v2;
</programlisting>
</para><para>
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-policy=SUBSYSTEM.KEY=VALUE</option></term>
<listitem><para>
Remove generic policy option. This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--env=VAR=VALUE</option></term>
<listitem><para>
Set an environment variable in the application.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--unset-env=VAR</option></term>
<listitem><para>
Unset an environment variable in the application.
This overrides the unset-environment entry in the [Context]
group of the metadata, and the [Environment] group.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--env-fd=<replaceable>FD</replaceable></option></term>
<listitem><para>
Read environment variables from the file descriptor
<replaceable>FD</replaceable>, and set them as if
via <option>--env</option>. This can be used to avoid
environment variables and their values becoming visible
to other users.
</para><para>
Each environment variable is in the form
<replaceable>VAR</replaceable>=<replaceable>VALUE</replaceable>
followed by a zero byte. This is the same format used by
<literal>env -0</literal> and
<filename>/proc/*/environ</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--own-name=NAME</option></term>
<listitem><para>
Allow the application to own the well-known name <arg choice="plain">NAME</arg> on the session bus.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--talk-name=NAME</option></term>
<listitem><para>
Allow the application to talk to the well-known name <arg choice="plain">NAME</arg> on the session bus.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-talk-name=NAME</option></term>
<listitem><para>
Don't allow the application to talk to the well-known name <arg choice="plain">NAME</arg> on the session bus.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system-own-name=NAME</option></term>
<listitem><para>
Allow the application to own the well known name <arg choice="plain">NAME</arg> on the system bus.
If <arg choice="plain">NAME</arg> ends with .*, it allows the application to own all matching names.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system-talk-name=NAME</option></term>
<listitem><para>
Allow the application to talk to the well known name <arg choice="plain">NAME</arg> on the system bus.
If <arg choice="plain">NAME</arg> ends with .*, it allows the application to talk to all matching names.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system-no-talk-name=NAME</option></term>
<listitem><para>
Don't allow the application to talk to the well known name <arg choice="plain">NAME</arg> on the system bus.
If <arg choice="plain">NAME</arg> ends with .*, it allows the application to talk to all matching names.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--persist=FILENAME</option></term>
<listitem><para>
If the application doesn't have access to the real homedir, make the (homedir-relative) path
<arg choice="plain">FILENAME</arg> a bind mount to the corresponding path in the per-application directory,
allowing that location to be used for persistent data.
This overrides to the Context section from the application metadata.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--reset</option></term>
<listitem><para>
Remove overrides. If an <arg choice="plain">APP</arg> is given, remove the overrides for that
application, otherwise remove the global overrides.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--show</option></term>
<listitem><para>
Shows overrides. If an <arg choice="plain">APP</arg> is given, shows the overrides for that
application, otherwise shows the global overrides.
</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 override --nosocket=wayland org.gnome.gedit</command>
</para>
<para>
<command>$ flatpak override --filesystem=home org.mozilla.Firefox</command>
</para>
</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>
|
