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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
|
<?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-run">
<refentryinfo>
<title>flatpak run</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 run</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak-run</refname>
<refpurpose>Run an application or open a shell in a runtime</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak run</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">REF</arg>
<arg choice="opt" rep="repeat">ARG</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
If <arg choice="plain">REF</arg> names an installed application,
Flatpak runs the application in a sandboxed environment. Extra
arguments are passed on to the application. The current branch and arch of
the application is used unless otherwise specified with <option>--branch</option>
or <option>--arch</option>. See
<citerefentry><refentrytitle>flatpak-make-current</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
</para>
<para>
If <arg choice="plain">REF</arg> names a runtime, a shell is opened in the
runtime. This is useful for development and testing. If there is ambiguity about
which branch to use, you will be prompted to choose. Use <option>--branch</option>
to avoid this. The primary arch is used unless otherwise specified with
<option>--arch</option>.
</para>
<para>
By default, Flatpak will look for the application or runtime in the per-user
installation first, then in all system installations. This can be overridden
with the <option>--user</option>, <option>--system</option> and
<option>--installation</option> options.
</para>
<para>
Flatpak creates a sandboxed environment for the application to run in
by mounting the right runtime at <filename>/usr</filename> and a writable
directory at <filename>/var</filename>, whose content is preserved between
application runs. The application itself is mounted at <filename>/app</filename>.
</para>
<para>
The details of the sandboxed environment are controlled by the application
metadata and various options like <option>--share</option> and <option>--socket</option>
that are passed to the run command: Access is allowed if it was requested either
in the application metadata file or with an option and the user hasn't overridden it.
</para>
<para>
The remaining arguments are passed to the command that gets run in the sandboxed
environment. See the <option>--file-forwarding</option> option for handling of file
arguments.
</para>
<para>
Environment variables are generally passed on to the sandboxed application, with
certain exceptions. The application metadata can override environment variables,
as well as the <option>--env</option> option. Apart from that, Flatpak always
unsets or overrides the following variables, since their session values
are likely to interfere with the functioning of the sandbox:
</para>
<simplelist>
<member>PATH</member>
<member>LD_LIBRARY_PATH</member>
<member>LD_PRELOAD</member>
<member>LD_AUDIT</member>
<member>XDG_CONFIG_DIRS</member>
<member>XDG_DATA_DIRS</member>
<member>SHELL</member>
<member>TEMP</member>
<member>TEMPDIR</member>
<member>TMP</member>
<member>TMPDIR</member>
<member>XDG_RUNTIME_DIR</member>
<member>container</member>
<member>TZDIR</member>
<member>PYTHONPATH</member>
<member>PYTHONPYCACHEPREFIX</member>
<member>PERLLIB</member>
<member>PERL5LIB</member>
<member>XCURSOR_PATH</member>
<member>GST_PLUGIN_PATH_1_0</member>
<member>GST_REGISTRY</member>
<member>GST_REGISTRY_1_0</member>
<member>GST_PLUGIN_PATH</member>
<member>GST_PLUGIN_SYSTEM_PATH</member>
<member>GST_PLUGIN_SCANNER</member>
<member>GST_PLUGIN_SCANNER_1_0</member>
<member>GST_PLUGIN_SYSTEM_PATH_1_0</member>
<member>GST_PRESET_PATH</member>
<member>GST_PTP_HELPER</member>
<member>GST_PTP_HELPER_1_0</member>
<member>GST_INSTALL_PLUGINS_HELPER</member>
<member>KRB5CCNAME</member>
<member>XKB_CONFIG_ROOT</member>
<member>GIO_EXTRA_MODULES</member>
<member>GDK_BACKEND</member>
<member>VK_ADD_DRIVER_FILES</member>
<member>VK_ADD_LAYER_PATH</member>
<member>VK_DRIVER_FILES</member>
<member>VK_ICD_FILENAMES</member>
<member>VK_LAYER_PATH</member>
<member>__EGL_EXTERNAL_PLATFORM_CONFIG_DIRS</member>
<member>__EGL_EXTERNAL_PLATFORM_CONFIG_FILENAMES</member>
<member>__EGL_VENDOR_LIBRARY_DIRS</member>
<member>__EGL_VENDOR_LIBRARY_FILENAMES</member>
</simplelist>
<para>
Also several environment variables with the prefix "GST_" that are used by gstreamer
are unset (since Flatpak 1.12.5).
</para>
<para>
Flatpak also overrides the XDG environment variables to point sandboxed applications
at their writable filesystem locations below <filename>~/.var/app/$APPID/</filename>:
</para>
<simplelist>
<member>XDG_DATA_HOME</member>
<member>XDG_CONFIG_HOME</member>
<member>XDG_CACHE_HOME</member>
<member>XDG_STATE_HOME (since Flatpak 1.13)</member>
</simplelist>
<para>
Apps can use the <option>--persist=.local/state</option> and
<option>--unset-env=XDG_STATE_HOME</option> options to get a
Flatpak 1.13-compatible <filename>~/.local/state</filename>
on older versions of Flatpak.
</para>
<para>
The host values of these variables are made available inside the sandbox via these
HOST_-prefixed variables:
</para>
<simplelist>
<member>HOST_XDG_DATA_HOME</member>
<member>HOST_XDG_CONFIG_HOME</member>
<member>HOST_XDG_CACHE_HOME</member>
<member>HOST_XDG_STATE_HOME (since Flatpak 1.13)</member>
</simplelist>
<para>
Flatpak sets the environment variable <envar>FLATPAK_ID</envar> to the application
ID of the running app.
</para>
<para>
Flatpak also bind-mounts as read-only the host's <filename>/etc/os-release</filename>
(if available, or <filename>/usr/lib/os-release</filename> as a fallback) to
<filename>/run/host/os-release</filename> in accordance with the
<ulink url="https://www.freedesktop.org/software/systemd/man/os-release.html">
os-release specification</ulink>.
</para>
<para>
If parental controls support is enabled, flatpak will check the
current user’s parental controls settings, and will refuse to
run an app if it is blocklisted for the current user.
</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>
Look for the application and runtime in per-user installations.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>
Look for the application and runtime in the default system-wide installations.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installation=NAME</option></term>
<listitem><para>
Look for the application and runtime in the 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>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Print OSTree debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--arch=ARCH</option></term>
<listitem><para>
The architecture to run. See <command>flatpak --supported-arches</command>
for architectures supported by the host.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--command=COMMAND</option></term>
<listitem><para>
The command to run instead of the one listed in the application metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--cwd=DIR</option></term>
<listitem><para>
The directory to run the command in. Note that this must be a directory
inside the sandbox.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--branch=BRANCH</option></term>
<listitem><para>
The branch to use.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<term><option>--devel</option></term>
<listitem><para>
Use the devel runtime that is specified in the application metadata instead of the regular runtime, and use a seccomp profile that is less likely to break development tools.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime=RUNTIME</option></term>
<listitem><para>
Use this runtime instead of the one that is specified in the application metadata.
This is a full tuple, like for example <arg choice="plain">org.freedesktop.Sdk/x86_64/1.2</arg>, but
partial tuples are allowed. Any empty or missing parts are filled in with the corresponding
values specified by the app.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime-version=VERSION</option></term>
<listitem><para>
Use this version of the runtime instead of the one that is specified in the application metadata.
This overrides any version specified with the --runtime 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, usb, input, 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, usb, input, 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 overrides to
the Context section from the application metadata.
<arg choice="plain">FEATURE</arg> must be one of: devel, multiarch, bluetooth.
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 overrides to
the Context section from the application metadata.
<arg choice="plain">FEATURE</arg> must be one of: devel, multiarch, bluetooth.
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 and/or the overrides set up with
<citerefentry><refentrytitle>flatpak-override</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
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
<citerefentry><refentrytitle>flatpak-override</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
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>--usb=TYPE[:DATA]</option></term>
<listitem><para>
Adds a USB device query to the application metadata. This
allows device enumeration and usage by the USB portal.
<arg choice="plain">TYPE</arg> must be one of: all, cls, dev, vnd.
</para><variablelist>
<varlistentry>
<term><option>all</option></term>
<listitem><para>
Match all devices.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>cls</option></term>
<listitem><para>
A device class and subclass query. <arg choice="plain">DATA</arg>
must be in the form of <arg choice="plain">CLASS:SUBCLASS</arg> where
both <arg choice="plain">CLASS</arg> and <arg choice="plain">SUBCLASS</arg>
must be a valid 2-digit hexadecimal class id number. Alternatively,
<arg choice="plain">SUBCLASS</arg> may be <literal>*</literal> to match
all subclasses.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>dev</option></term>
<listitem><para>
A device product id query. <arg choice="plain">DATA</arg>
must be a valid 4-digit hexadecimal product id number,
for example <option>0a1b</option>. It requires a
<option>vnd</option> filter in the query.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>vnd</option></term>
<listitem><para>
A device vendor id query. <arg choice="plain">DATA</arg>
must be a valid 4-digit hexadecimal vendor id number
greater than zero, for example <option>0fab</option>.
</para></listitem>
</varlistentry>
</variablelist><para>
It is possible to compose multiple device queries together
with the <literal>+</literal> sign, for example
<option>--usb=vnd:0123+dev:4567</option>. The <arg choice="plain">dev</arg>
filter requires a <arg choice="plain">vnd</arg>.
Available since 1.15.11.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nousb=VENDOR_ID:PRODUCT_ID</option></term>
<listitem><para>
Adds a blocking USB device query to the application metadata. Blocked
devices take precedence over allowed devices. The syntax is exactly
equal to <option>--usb</option>.
Available since 1.15.11.
</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.
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>--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.
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>--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.
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-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>--a11y-own-name=NAME</option></term>
<listitem><para>
Allow the application to own the well known name <arg choice="plain">NAME</arg> on the a11y 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>--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>--no-session-bus</option></term>
<listitem><para>
Run this instance without the filtered access to the session dbus connection. Note, this is the default when run with --sandbox.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--session-bus</option></term>
<listitem><para>
Allow filtered access to the session dbus connection. This is the default, except when run with --sandbox.
</para><para>
In sandbox mode, even if you allow access to the session bus the sandbox cannot talk to or own
the application ids (org.the.App.*) on the bus (unless explicitly added), only names in the
.Sandboxed subset (org.the.App.Sandboxed.* and org.mpris.MediaPlayer2.org.the.App.Sandboxed.*).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-a11y-bus</option></term>
<listitem><para>
Run this instance without the access to the accessibility bus. Note, this is the default when run with --sandbox.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--a11y-bus</option></term>
<listitem><para>
Allow access to the accessibility bus. This is the default, except when run with --sandbox.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sandbox</option></term>
<listitem><para>
Run the application in sandboxed mode, which means dropping all the extra permissions it would otherwise have, as
well as access to the session/system/a11y busses and document portal.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--log-session-bus</option></term>
<listitem><para>
Log session bus traffic. This can be useful to see what access you need to allow in
your D-Bus policy.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--log-system-bus</option></term>
<listitem><para>
Log system bus traffic. This can be useful to see what access you need to allow in
your D-Bus policy.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--die-with-parent</option></term>
<listitem><para>
Kill the entire sandbox when the launching process dies.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--parent-pid=PID</option></term>
<listitem><para>
Specifies the pid of the "parent" flatpak, used by
--parent-expose-pids and --parent-share-pids.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--parent-expose-pids</option></term>
<listitem><para>
Make the processes of the new sandbox visible in the sandbox of the parent flatpak, as defined
by --parent-pid.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--parent-share-pids</option></term>
<listitem><para>
Use the same process ID namespace for the processes of
the new sandbox and the sandbox of the parent flatpak, as
defined by --parent-pid. Implies --parent-expose-pids.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--instance-id-fd</option></term>
<listitem><para>
Write the instance ID string to the given file descriptor.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--file-forwarding</option></term>
<listitem><para>
If this option is specified, the remaining arguments are scanned, and all arguments
that are enclosed between a pair of '@@' arguments are interpreted as file paths,
exported in the document store, and passed to the command in the form of the
resulting document path. Arguments between "@@u" and "@@" are considered URIs,
and any "file:" URIs are exported. The exports are non-persistent and with read and write
permissions for the application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app-path=<replaceable>PATH</replaceable></option></term>
<listitem><para>
Instead of mounting the app's content on
<filename>/app</filename> in the sandbox, mount
<replaceable>PATH</replaceable> on <filename>/app</filename>,
and the app's content on
<filename>/run/parent/app</filename>.
If the app has extensions, they will also be redirected
into <filename>/run/parent/app</filename>, and will not
be included in the <envar>LD_LIBRARY_PATH</envar> inside
the sandbox.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--app-path=</option></term>
<listitem><para>
As a special case, <option>--app-path=</option>
(with an empty <replaceable>PATH</replaceable>)
results in an empty directory being mounted on
<filename>/app</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--usr-path=<replaceable>PATH</replaceable></option></term>
<listitem><para>
Instead of mounting the runtime's files on
<filename>/usr</filename> in the sandbox, mount
<replaceable>PATH</replaceable> on
<filename>/usr</filename>,
and the runtime's normal files on
<filename>/run/parent/usr</filename>.
If the runtime has extensions, they will also be redirected
into <filename>/run/parent/usr</filename>, and will not
be included in the <envar>LD_LIBRARY_PATH</envar> inside
the sandbox.
</para><para>
This option will usually only be useful if it is
combined with <option>--app-path=</option> and
<option>--env=LD_LIBRARY_PATH=<replaceable>...</replaceable></option>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
<command>$ flatpak run org.gnome.gedit</command>
</para>
<para>
<command>$ flatpak run --devel --command=bash org.gnome.Builder</command>
</para>
<para>
<command>$ flatpak run --command=bash org.gnome.Sdk</command>
</para>
<para>
<command>$ flatpak run org.gnome.Boxes --nousb=0fd9:*</command>
</para>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-override</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-enter</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>
|
