mirror/flatpak
1
0
Fork 0
mirror of https://github.com/flatpak/flatpak.git synced 2026-01-26 00:28:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document all known .flatpak-info keys

Browse Source 
Some of the keys in the Instance group were missing.
Add them to the man page.

Closes: #2051
Approved by: alexlarsson
This commit is contained in:
Matthias Clasen
2018-08-30 17:13:13 -04:00
committed by Atomic Bot
parent 537cab4927
commit be36b88def
1 changed files with 69 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
doc/flatpak-metadata.xml
View File

@@ -398,6 +398,22 @@
in [Application], but for simplicity that isn't documented
here. -->
<variablelist>
<varlistentry>
<term><option>instance-id</option> (string)</term>
<listitem><para>
The ID of the running instance. This number is
used as the name of the directory in
<filename><envar>XDG_RUNTIME_DIR</envar>/.flatpak</filename>
where Flatpak stores information about this instance.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>instance-path</option> (string)</term>
<listitem><para>
The absolute path on the host system of the app's
persistent storage area in <filename>$HOME/.var</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>app-path</option> (string)</term>
<listitem><para>
@@ -406,6 +422,20 @@
inside the container. Available since 0.6.10.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>app-commit</option> (string)</term>
<listitem><para>
The commit ID or the application that is running.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>app-extensions</option> (list of strings)</term>
<listitem><para>
A list of app extensions that are mounted into
the running instance. The format for each list item is
<option>EXTENSION_ID=COMMIT</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>branch</option> (string)</term>
<listitem><para>
@@ -414,6 +444,12 @@
0.6.10.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>arch</option> (string)</term>
<listitem><para>
The architecture of the running instance.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>flatpak-version</option> (string)</term>
<listitem><para>
@@ -429,6 +465,39 @@
inside the container. Available since 0.6.10.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>runtime-commit</option> (string)</term>
<listitem><para>
The commit ID or the runtime that is used.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>runtime-extensions</option> (list of strings)</term>
<listitem><para>
A list of runtime extensions that are mounted into
the running instance. The format for each list item is
<option>EXTENSION_ID=COMMIT</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>extra-args</option> (string)</term>
<listitem><para>
Extra arguments that were passed to flatpak run.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>sandbox</option> (boolean)</term>
<listitem><para>
Whether the <option>--sandbox</option> option was passed
to flatpak run.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>build</option> (boolean)</term>
<listitem><para>
Whether this instance was created by flatpak build.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>session-bus-proxy</option> (boolean)</term>
<listitem><para>