From 6d0f86d86896877d659e6c8ea6cb441eeaefb6e6 Mon Sep 17 00:00:00 2001
From: Matthew Leeds <mleeds@redhat.com>
Date: Mon, 27 Feb 2017 14:50:16 -0600
Subject: [PATCH] doc: Mention that flatpak-run can be used with runtimes

The ability to use flatpak-run to enter into a shell in a runtime was
added in flatpak 0.6.13 but the docs weren't updated to reflect that.
This commit updates the flatpak-run documentation to explain the
functionality.
---
 doc/flatpak-run.xml | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/doc/flatpak-run.xml b/doc/flatpak-run.xml
index 50b419fa..b21f9a54 100644
--- a/doc/flatpak-run.xml
+++ b/doc/flatpak-run.xml
@@ -25,14 +25,14 @@
 
     <refnamediv>
         <refname>flatpak-run</refname>
-        <refpurpose>Run an application</refpurpose>
+        <refpurpose>Run an application or open a shell in a runtime</refpurpose>
     </refnamediv>
 
     <refsynopsisdiv>
             <cmdsynopsis>
                 <command>flatpak run</command>
                 <arg choice="opt" rep="repeat">OPTION</arg>
-                <arg choice="plain">APP</arg>
+                <arg choice="plain">REF</arg>
                 <arg choice="opt" rep="repeat">ARG</arg>
             </cmdsynopsis>
     </refsynopsisdiv>
@@ -41,9 +41,13 @@
         <title>Description</title>
 
         <para>
-            Runs an application in a sandboxed environment.
-            <arg choice="plain">APP</arg> must name an installed application.
-            Extra arguments are passed on to the application.
+            If <arg choice="plain">REF</arg> names an installed application,
+            flatpak runs the application in a sandboxed environment. Extra
+            arguments are passed on to the application.
+        </para>
+        <para>
+            If <arg choice="plain">REF</arg> names a runtime, a shell is opened in the
+            runtime. This is useful for development and testing.
         </para>
         <para>
             flatpak creates a sandboxed environment for the application to run in
@@ -345,6 +349,9 @@
         <para>
             <command>$ flatpak run --devel --command=bash org.gnome.Builder</command>
         </para>
+        <para>
+            <command>$ flatpak run --command=bash org.gnome.Sdk</command>
+        </para>
 
     </refsect1>