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
|
<?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">
<refentryinfo>
<title>flatpak</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</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>flatpak</refname>
<refpurpose>Build, install and run applications and runtimes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>flatpak</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="req">COMMAND</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Flatpak is a tool for managing applications and the runtimes
they use. In the Flatpak model, applications can be built and
distributed independently from the host system they are used
on, and they are isolated from the host system ('sandboxed')
to some degree, at runtime.
</para>
<para>
Flatpak can operate in system-wide or per-user mode. The system-wide
data (runtimes, applications and configuration) is located in
<filename>$prefix/var/lib/flatpak/</filename>, and the per-user
data is in <filename>$HOME/.local/share/flatpak/</filename>.
Below these locations, there is a local repository in the
<filename>repo/</filename> subdirectory and installed runtimes
and applications are in the corresponding <filename>runtime/</filename>
and <filename>app/</filename> subdirectories.
</para>
<para>
System-wide remotes can be statically preconfigured by dropping
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
files into <filename>/usr/share/flatpak/remotes.d/</filename> and
<filename>/etc/flatpak/remotes.d/</filename>. If a file with
the same name exists in both, the file under
<filename>/etc</filename> will take precedence.
</para>
<para>
In addition to the system-wide installation in <filename>$prefix/var/lib/flatpak/</filename>,
which is always considered the default one unless overridden, more
system-wide installations can be defined via configuration files in
<filename>/etc/flatpak/installations.d/</filename>, which must define
at least the id of the installation and the absolute path to it.
Other optional parameters like <arg choice="plain">DisplayName</arg>,
<arg choice="plain">Priority</arg> or <arg choice="plain">StorageType</arg>
are also supported.
</para>
<para>
Flatpak uses OSTree to distribute and deploy data. The repositories
it uses are OSTree repositories and can be manipulated with the
<command>ostree</command> utility. Installed runtimes and
applications are OSTree checkouts.
</para>
<para>
Basic commands for building flatpaks such as build-init, build and build-finish
are included in the flatpak utility. For higher-level build support, see
the separate
<citerefentry><refentrytitle>flatpak-builder</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool.
</para>
<para>
Flatpak supports installing from sideload repos. These are partial
copies of a repository (generated by <command>flatpak create-usb</command>) that are used as
an installation source when offline (and online as a performance improvement).
Such repositories are configured by creating symlinks to the sideload sources
in the <filename>sideload-repos</filename> subdirectory of the installation directory (i.e. typically
<filename>/var/lib/flatpak/sideload-repos</filename> or
<filename>~/.local/share/flatpak/sideload-repos</filename>). Additionally
symlinks can be created in <filename>/run/flatpak/sideload-repos</filename>
which is a better location for non-persistent sources (as it is cleared on reboot). These symlinks
can point to either the directory given to <command>flatpak create-usb</command> which by default
writes to the subpath <filename>.ostree/repo</filename>, or directly to an ostree repo.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
The following global options are understood. Individual commands have their
own options.
</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>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Show debug information during command processing. Use -vv for more detail.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostree-verbose</option></term>
<listitem><para>
Show OSTree debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>
Print version information and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--default-arch</option></term>
<listitem><para>
Print the default arch and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--supported-arches</option></term>
<listitem><para>
Print the supported arches in priority order and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gl-drivers</option></term>
<listitem><para>
Print the list of active gl drivers and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--installations</option></term>
<listitem><para>
Print paths of system installations and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-system-only</option></term>
<listitem><para>
When the <command>flatpak --print-updated-env</command>
command is run, only print the environment for system
flatpak installations, not including the user’s home
installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--print-updated-env</option></term>
<listitem><para>
Print the set of environment variables needed to use
flatpaks, amending the current set of environment variables.
This is intended to be used in a systemd environment
generator, and should not need to be run manually.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<para>Commands for managing installed applications and runtimes:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-install</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Install an application or a runtime from a remote or bundle.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-update</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update an installed application or runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-uninstall</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Uninstall an installed application or runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-mask</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Mask out updates and automatic installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-pin</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Pin runtimes to prevent automatic removal.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-list</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List installed applications and/or runtimes.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-info</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show information for an installed application or runtime.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-history</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show history.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Manage flatpak configuration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-repair</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Repair flatpak installation.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-create-usb</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Copy apps and/or runtimes onto removable media.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for finding applications and runtimes:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-search</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Search for applications and runtimes.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for managing running applications:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Run an application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-kill</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Stop a running application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-override</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Override permissions for an application.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-make-current</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Specify the default version to run.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-enter</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Enter the namespace of a running application.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for managing file access:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-document-export</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Grant an application access to a specific file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-document-unexport</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Revoke access to a specific file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-document-info</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show information about a specific file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-documents</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List exported files.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for managing the dynamic permission store:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-permission-remove</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Remove item from permission store.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-permissions</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List permissions.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-permission-show</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show app permissions.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-permission-reset</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Reset app permissions.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-permission-set</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Set app permissions.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for managing remote repositories:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List all configured remote repositories.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote-add</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Add a new remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Modify properties of a configured remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote-delete</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Delete a configured remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote-ls</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
List contents of a configured remote repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote-info</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Show information about a ref in a configured remote repository.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands for building applications:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-init</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Initialize a build directory.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Run a build command in a build directory.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-finish</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Finalizes a build directory for export.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-export</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Export a build directory to a repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-bundle</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Create a bundle file from a ref in a local repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-import-bundle</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Import a file bundle into a local repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-sign</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Sign an application or runtime after its been exported.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-update-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update the summary file in a repository.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-build-commit-from</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Create a new commit based on an existing ref.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Print information about a repo.
</para></listitem>
</varlistentry>
</variablelist>
<para>Commands available inside the sandbox:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-spawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Run a command in another sandbox.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>File formats</title>
<para>File formats that are used by Flatpak commands:</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<listitem><para>
Reference to a remote for an application or runtime
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<listitem><para>
Reference to a remote
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-remote</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<listitem><para>
Configuration for a remote
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-installation</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<listitem><para>
Configuration for an installation location
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-metadata</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<listitem><para>
Information about an application or runtime
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Environment</title>
<para>
Besides standard environment variables such as <envar>XDG_DATA_DIRS</envar> and
<envar>XDG_DATA_HOME</envar>, flatpak consults some of its own.
</para>
<variablelist>
<!-- Please keep these in alphabetical order -->
<!-- FLATPAK intentionally not documented:
it is intended for testing and development only
(it is the flatpak executable used by the
flatpak-portal) -->
<varlistentry>
<term><envar>FLATPAK_BINARY</envar></term>
<listitem><para>
Path to the flatpak executable that will be written
into exported <filename>.desktop</filename> files
and scripts when an app is installed.
The default is <filename>/usr/bin/flatpak</filename>,
unless overridden at build time by
<option>--bindir</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_BWRAP</envar></term>
<listitem><para>
Path to the
<citerefentry><refentrytitle>bwrap</refentrytitle><manvolnum>1</manvolnum></citerefentry>
executable that will be used to create the sandbox.
Depending on how Flatpak was configured at build-time,
the default is either to search the
<envar>PATH</envar>,
or use a vendored copy which is normally installed as
<filename>/usr/libexec/flatpak-bwrap</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_CONFIG_DIR</envar></term>
<listitem><para>
The location of flatpak site configuration. If this is not set,
<filename>/etc/flatpak</filename> is used (unless overridden at build
time by --sysconfdir).
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_DATA_DIR</envar></term>
<listitem><para>
The location of Flatpak's OS-level defaults and
integration hooks.
If this is not set,
<filename>/usr/share/flatpak</filename> is used,
unless overridden at build time by
<option>--datadir</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_DBUSPROXY</envar></term>
<listitem><para>
Path to the
<citerefentry><refentrytitle>xdg-dbus-proxy</refentrytitle><manvolnum>1</manvolnum></citerefentry>
executable that will be used to filter D-Bus
traffic between the sandbox and the host system.
Depending on how Flatpak was configured at build-time,
the default is either to search the
<envar>PATH</envar>,
or use a vendored copy which is normally installed as
<filename>/usr/libexec/flatpak-dbus-proxy</filename>.
</para></listitem>
</varlistentry>
<!-- FLATPAK_DISABLE_REVOKEFS intentionally not documented:
it is intended for testing and development only
(it forces use of the code path we would use if
FUSE didn't work) -->
<varlistentry>
<term><envar>FLATPAK_DOWNLOAD_TMPDIR</envar></term>
<listitem><para>
Path to a directory that will be used temporarily
when downloading OCI layers,
and potentially for other downloads in future.
The standard <envar>TMPDIR</envar> is not used
for this,
because Flatpak apps are frequently too large to
fit on a tmpfs.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_FANCY_OUTPUT</envar></term>
<listitem><para>
May be set to <literal>0</literal> to avoid fancy
formatting when outputting to a terminal.
This feature is also disabled automatically when
standard output is not a terminal,
or when <envar>G_MESSAGES_DEBUG</envar> is set.
</para></listitem>
</varlistentry>
<!-- FLATPAK_FORCE_ALLOW_FUZZY_MATCHING intentionally not documented:
it is intended for testing and development only
(it forces use of the fuzzy matching code path that
we would normally only use when run on a tty) -->
<varlistentry>
<term><envar>FLATPAK_FORCE_TEXT_AUTH</envar></term>
<listitem><para>
May be set to <literal>1</literal> to force use of
a simple built-in
<citerefentry><refentrytitle>polkit</refentrytitle><manvolnum>8</manvolnum></citerefentry>
agent when authentication is required to modify
the system-wide installation.
By default,
the desktop environment's polkit agent is used,
if one is available,
usually resulting in a graphical prompt.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_GL_DRIVERS</envar></term>
<listitem><para>
A colon-separated list of graphics driver extensions
to try to use for OpenGL, Vulkan and similar APIs,
most-preferred first.
The default is to select a graphics driver
automatically.
Values in this list match the last dot-separated
component of the names of extensions with the
<literal>active-gl-driver</literal> condition.
Typical values are
<literal>default</literal>,
<literal>mesa-git</literal> or
<literal>nvidia-550-120</literal>
(replacing the version number by the major and minor
version of the <literal>nvidia</literal> kernel module).
</para></listitem>
</varlistentry>
<!-- FLATPAK_PORTAL_MOCK_FLATPAK intentionally not documented:
it is intended for testing and development only
(flatpak-portal runs it instead of the real flatpak) -->
<!-- FLATPAK_REVOKEFS_FUSE intentionally not documented:
it is intended for testing and development only
(it replaces /usr/libexec/revokefs-fuse) -->
<varlistentry>
<term><envar>FLATPAK_RUN_DIR</envar></term>
<listitem><para>
The location of flatpak runtime global files. If this is not set,
<filename>/run/flatpak</filename> is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_SYSTEM_CACHE_DIR</envar></term>
<listitem><para>
The location where temporary child repositories will be created during pulls
into the system-wide installation. If this is not set, a directory in
<filename>/var/tmp/</filename> is used. This is useful because it is more
likely to be on the same filesystem as the system repository (thus increasing
the chances for e.g. reflink copying), and we can avoid filling the user's
home directory with temporary data.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_SYSTEM_DIR</envar></term>
<listitem><para>
The location of the default system-wide installation. If this is not set,
<filename>/var/lib/flatpak</filename> is used (unless overridden at build
time by <option>--localstatedir</option> or
<option>-Dsystem_install_dir</option>).
</para></listitem>
</varlistentry>
<!-- FLATPAK_SYSTEM_HELPER_ON_SESSION intentionally not documented:
it is intended for testing and development only -->
<!-- FLATPAK_TEST_COVERAGE intentionally not documented:
it is intended for testing and development only -->
<!-- FLATPAK_TRIGGERSDIR intentionally not documented:
it is intended for testing and development only,
and is mostly superseded by FLATPAK_DATA_DIR -->
<varlistentry>
<term><envar>FLATPAK_TTY_PROGRESS</envar></term>
<listitem><para>
May be set to <literal>1</literal> to enable reporting
machine-readable progress to the terminal.
This feature is not currently enabled by default
because it uses the OSC 9;4 sequence,
which some terminal emulators interpret as a
popup notification.
</para></listitem>
</varlistentry>
<varlistentry>
<term><envar>FLATPAK_USER_DIR</envar></term>
<listitem><para>
The location of the per-user installation. If this is not set,
<filename>$XDG_DATA_HOME/flatpak</filename> is used.
</para></listitem>
</varlistentry>
<!-- FLATPAK_VALIDATE_ICON intentionally not documented:
it is intended for testing and development only -->
</variablelist>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remote</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-installation</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<ulink url="https://www.flatpak.org">https://www.flatpak.org</ulink>
</para>
</refsect1>
</refentry>
|
