diff options
| author | Simon McVittie <smcv@collabora.com> | 2017-07-07 16:03:40 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@collabora.com> | 2017-07-07 16:08:35 +0100 |
| commit | b5023ffe87081998a4477ec69e2364361a7b628e (patch) | |
| tree | 243179f175562c4941bc9c8c799a3cca66be7fe0 /doc/flatpak-metadata.xml | |
| parent | 6856ca18bc7fb219d04b1f5f62a499e1e214343c (diff) | |
| download | flatpak-b5023ffe87081998a4477ec69e2364361a7b628e.tar.gz | |
flatpak-metadata(5): Document the Instance group
Signed-off-by: Simon McVittie <smcv@collabora.com>
Diffstat (limited to 'doc/flatpak-metadata.xml')
| -rw-r--r-- | doc/flatpak-metadata.xml | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/flatpak-metadata.xml b/doc/flatpak-metadata.xml index 49ed9251..1be44633 100644 --- a/doc/flatpak-metadata.xml +++ b/doc/flatpak-metadata.xml @@ -187,6 +187,66 @@ </variablelist> </refsect2> <refsect2> + <title>[Instance]</title> + <para> + This group only appears in <filename>/.flatpak-info</filename> + for a running app, and not in the metadata files written by + application authors. It is filled in by Flatpak itself. + </para> + <variablelist> + <varlistentry> + <term><option>app-path</option> (string)</term> + <listitem><para> + The absolute path on the host system of the app's + app files, as mounted at <filename>/app</filename> + inside the container + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>branch</option> (string)</term> + <listitem><para> + The branch of the app, for example + <literal>stable</literal> + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>flatpak-version</option> (string)</term> + <listitem><para> + The version number of the Flatpak version that ran + this app + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>runtime-path</option> (string)</term> + <listitem><para> + The absolute path on the host system of the app's + runtime files, as mounted at <filename>/usr</filename> + inside the container + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>session-bus-proxy</option> (boolean)</term> + <listitem><para> + True if this app cannot access the D-Bus session bus + directly (either it goes via a proxy, or it cannot + access the session bus at all) + <!-- TODO: Those semantics are weird, are they + intended? --> + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>system-bus-proxy</option> (boolean)</term> + <listitem><para> + True if this app cannot access the D-Bus system bus + directly (either it goes via a proxy, or it cannot + access the system bus at all) + <!-- TODO: Those semantics are weird, are they + intended? --> + </para></listitem> + </varlistentry> + </variablelist> + </refsect2> + <refsect2> <title>[Session Bus Policy]</title> <para> If the <option>sockets</option> key is not allowing full access |