flatpak/doc/flatpak-ps.xml

<?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-ps">

    <refentryinfo>
        <title>flatpak ps</title>
        <productname>flatpak</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Matthias</firstname>
                <surname>Clasen</surname>
                <email>mclasen@redhat.com</email>
            </author>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>flatpak ps</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>flatpak-ps</refname>
        <refpurpose>Enumerate running instances</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak ps</command>
                <arg choice="opt" rep="repeat">OPTION</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
          Lists useful information about running Flatpak instances.
        </para>
        <para>
          To see full details of a running instance, you can open the file
          <filename>/run/user/$UID/.flatpak/$INSTANCE/info</filename>, where <replaceable>$INSTANCE</replaceable> is the instance
          ID reported by flatpak ps.
        </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>-v</option></term>
                <term><option>--verbose</option></term>

                <listitem><para>
                    Print debug information during command processing.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--ostree-verbose</option></term>

                <listitem><para>
                    Print OSTree debug information during command processing.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--columns=FIELD,…</option></term>

                <listitem><para>
                    Specify what information to show about each instance. You can
                    list multiple fields, or use this option multiple times.
                </para><para>
                    Append :s[tart], :m[iddle], :e[nd] or :f[ull] to column
                    names to change ellipsization.
                </para></listitem>
            </varlistentry>

        </variablelist>
    </refsect1>

    <refsect1>
        <title>Fields</title>

        <para>The following fields are understood by the <option>--columns</option> option:</para>

        <variablelist>
            <varlistentry>
                <term>instance</term>

                <listitem><para>
                    Show the instance ID
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>application</term>

                <listitem><para>
                    Show the application ID
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>arch</term>

                <listitem><para>
                    Show the architecture
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>branch</term>

                <listitem><para>
                    Show the application branch
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>commit</term>

                <listitem><para>
                    Show the application commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>runtime</term>

                <listitem><para>
                    Show the runtime ID
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>runtime-branch</term>

                <listitem><para>
                    Show the runtime branch
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>runtime-commit</term>

                <listitem><para>
                    Show the runtime commit
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>pid</term>

                <listitem><para>
                    Show the PID of the wrapper process
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>child-pid</term>

                <listitem><para>
                    Show the PID of the sandbox process
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>active</term>

                <listitem><para>
                    Show whether the app is active (i.e. has an active window)
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>background</term>

                <listitem><para>
                    Show whether the app is in the background (with no open windows)
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>all</term>

                <listitem><para>
                    Show all columns
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term>help</term>

                <listitem><para>
                    Show the list of available columns
                </para></listitem>
            </varlistentry>
        </variablelist>

        <para>
          Note that field names can be abbreviated to a unique prefix.
        </para>

    </refsect1>

    <refsect1>
        <title>Examples</title>

        <para>
            <command>$ flatpak ps --columns=application,pid,runtime,runtime-branch</command>
        </para>

    </refsect1>

    <refsect1>
        <title>See also</title>

        <para>
            <citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
            <citerefentry><refentrytitle>flatpak-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        </para>

    </refsect1>

</refentry>