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

    <refentryinfo>
        <title>flatpak enter</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 enter</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>flatpak-enter</refname>
        <refpurpose>Enter an application or runtime's sandbox</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>flatpak enter</command>
                <arg choice="opt" rep="repeat">OPTION</arg>
                <arg choice="plain">INSTANCE</arg>
                <arg choice="plain">COMMAND</arg>
                <arg choice="opt" rep="repeat">ARG</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Enter a running sandbox.
        </para>
        <para>
            <arg choice="plain">INSTANCE</arg> must be either the pid of a process running
            in a flatpak sandbox, or the ID of a running application, or the instance ID
            of a running sandbox. You can use <command>flatpak ps</command> to find the
            instance IDs of running flatpaks.
        </para>
        <para>
            <arg choice="plain">COMMAND</arg> is the command to run in the sandbox.
            Extra arguments are passed on to the command.
        </para>
        <para>
            This creates a new process within the running sandbox, with the same environment.
            This is useful when you want to debug a problem with a running application.
        </para>
        <para>
          This command works as a regular user if the system support unprivileged user namespace. If
          that is not available you need to run run it like: <command>sudo -E flatpak enter</command>.
        </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>
        </variablelist>
    </refsect1>

    <refsect1>
        <title>Examples</title>

        <para>
            <command>$ flatpak enter 15345 sh</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>
            <citerefentry><refentrytitle>flatpak-ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        </para>

    </refsect1>

</refentry>
