summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2016-04-13 17:36:40 -0400
committerMatthias Clasen <mclasen@redhat.com>2016-04-13 17:36:40 -0400
commit5d27b8742a28ae30f484958cd2daf082058f6229 (patch)
treee40a9eb252ebd1fbf7897a3960398b58fbd7e5a2 /doc
parent19509eb8081da385b81e684bc6096002a25a3dae (diff)
downloadxdg-app-5d27b8742a28ae30f484958cd2daf082058f6229.tar.gz
Document the --bundle option
I was looking for information on how to install bundles, and found nothing, since the --bundle option wasn't documented.
Diffstat (limited to 'doc')
-rw-r--r--doc/xdg-app-install.xml30
1 files changed, 29 insertions, 1 deletions
diff --git a/doc/xdg-app-install.xml b/doc/xdg-app-install.xml
index 0803a9c..bb8c6d6 100644
--- a/doc/xdg-app-install.xml
+++ b/doc/xdg-app-install.xml
@@ -36,6 +36,12 @@
<arg choice="plain">NAME</arg>
<arg choice="opt">BRANCH</arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>xdg-app install</command>
+ <arg choice="opt" rep="repeat">OPTION</arg>
+ <arg choice="plain">--bundle</arg>
+ <arg choice="plain">FILENAME</arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
@@ -62,6 +68,11 @@
Unless overridden with the --user option, this command creates a
system-wide installation.
</para>
+ <para>
+ The alternative form of the command installs an application from a
+ single-file bundle instead of a configured remote. Such bundles can
+ be created with the xdg-app build-bundle command.
+ </para>
</refsect1>
@@ -81,6 +92,22 @@
</varlistentry>
<varlistentry>
+ <term><option>--bundle</option></term>
+
+ <listitem><para>
+ Install from a bundle file instead
+ of a configured remote.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--user</option></term>
+
+ <listitem><para>
+ Create a per-user installation.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--user</option></term>
<listitem><para>
@@ -179,7 +206,8 @@
<para>
<citerefentry><refentrytitle>xdg-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-update-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>xdg-app-list-apps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>xdg-app-list-apps</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>xdg-app-build-bundle</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>