summaryrefslogtreecommitdiff
path: root/doc/flatpak-info.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/flatpak-info.xml')
-rw-r--r--doc/flatpak-info.xml177
1 files changed, 177 insertions, 0 deletions
diff --git a/doc/flatpak-info.xml b/doc/flatpak-info.xml
new file mode 100644
index 0000000..bcd454c
--- /dev/null
+++ b/doc/flatpak-info.xml
@@ -0,0 +1,177 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<refentry id="flatpak-info">
+
+ <refentryinfo>
+ <title>flatpak info</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 info</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>flatpak-info</refname>
+ <refpurpose>Show information about installed application and/or runtime</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>flatpak info</command>
+ <arg choice="opt" rep="repeat">OPTION</arg>
+ <arg choice="plain">NAME</arg>
+ <arg choice="opt">BRANCH</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ Show info about and installed application and/or runtime.
+ </para>
+ <para>
+ By default, both per-user and system-wide installations
+ are queried. Use the --user or --system options to change
+ this.
+ </para>
+ <para>
+ By default this queries the installed apps and runtimes, but you can
+ limit this by using the --app or --runtime option.
+ </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>--user</option></term>
+
+ <listitem><para>
+ Query per-user installations.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--system</option></term>
+
+ <listitem><para>
+ Query system-wide installations.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--app</option></term>
+
+ <listitem><para>
+ Query for applications.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--runtime</option></term>
+
+ <listitem><para>
+ Query for runtimes.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-r</option></term>
+ <term><option>--show-ref</option></term>
+
+ <listitem><para>
+ Show the installed ref.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-o</option></term>
+ <term><option>--show-origin</option></term>
+
+ <listitem><para>
+ Show the remote the ref is installed from.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-c</option></term>
+ <term><option>--show-commit</option></term>
+
+ <listitem><para>
+ Show the installed commit id.
+ </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>--version</option></term>
+
+ <listitem><para>
+ Print version information and exit.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Examples</title>
+
+ <para>
+ <command>$ flatpak --user list</command>
+ </para>
+<programlisting>
+org.gnome.Builder
+org.freedesktop.glxgears
+org.gnome.MyApp
+org.gnome.GEdit
+</programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>See also</title>
+
+ <para>
+ <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>flatpak-install-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>flatpak-update-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+
+ </refsect1>
+
+</refentry>