diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2018-08-30 17:13:13 -0400 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2018-08-31 06:58:32 +0000 |
| commit | be36b88def44cd0804001eff1382af907a03bcec (patch) | |
| tree | 09fcf0f411891cd7a105cfaadc895587229535ae /doc/flatpak-metadata.xml | |
| parent | 537cab492743437fb035e12f78a8fcbc53fdae12 (diff) | |
| download | flatpak-be36b88def44cd0804001eff1382af907a03bcec.tar.gz | |
Document all known .flatpak-info keys
Some of the keys in the Instance group were missing.
Add them to the man page.
Closes: #2051
Approved by: alexlarsson
Diffstat (limited to 'doc/flatpak-metadata.xml')
| -rw-r--r-- | doc/flatpak-metadata.xml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/flatpak-metadata.xml b/doc/flatpak-metadata.xml index ae62764a..5c1441bf 100644 --- a/doc/flatpak-metadata.xml +++ b/doc/flatpak-metadata.xml @@ -399,6 +399,22 @@ 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> The absolute path on the host system of the app's @@ -407,6 +423,20 @@ </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> The branch of the app, for example @@ -415,6 +445,12 @@ </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> The version number of the Flatpak version that ran @@ -430,6 +466,39 @@ </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> True if this app cannot access the D-Bus session bus |