summaryrefslogtreecommitdiff
path: root/doc/flatpak-update.xml
diff options
context:
space:
mode:
authorAlexander Larsson <alexl@redhat.com>2016-10-14 16:33:35 +0200
committerAlexander Larsson <alexl@redhat.com>2016-10-14 16:39:10 +0200
commit70e9b2c737a30eab15a914a3712aa6117ccbe7c1 (patch)
tree9c9905c43f91eb468caaee8d4e1528231e78b790 /doc/flatpak-update.xml
parent7018717ce2abe7503ce6ba3f8b4e219a915b95fb (diff)
downloadflatpak-70e9b2c737a30eab15a914a3712aa6117ccbe7c1.tar.gz
update: Support specifying multiple arguments
Diffstat (limited to 'doc/flatpak-update.xml')
-rw-r--r--doc/flatpak-update.xml23
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/flatpak-update.xml b/doc/flatpak-update.xml
index c1ccd3db..301981dd 100644
--- a/doc/flatpak-update.xml
+++ b/doc/flatpak-update.xml
@@ -32,7 +32,7 @@
<cmdsynopsis>
<command>flatpak update</command>
<arg choice="opt" rep="repeat">OPTION</arg>
- <arg choice="opt">NAME <arg choice="opt">BRANCH</arg></arg>
+ <arg choice="opt" rep="repeat">REF</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -40,17 +40,22 @@
<title>Description</title>
<para>
- Updates an application or runtime. <arg choice="plain">NAME</arg> is the
- name of an installed application or runtime. Optionally,
- <arg choice="plain">BRANCH</arg> can be specified to update a
- specific branch, otherwise all installed branches are updated. If
- no <arg choice="plain">NAME</arg> is given, then everything installed
+ Updates applications and runtimes. <arg choice="plain">REF</arg> is a reference to the
+ application or runtime to install. If no <arg choice="plain">REF</arg> is given, everything
is updated.
</para>
<para>
- By default this looks for both installed applications and
- runtimes, but you can limit this by using the --app or
- --runtime option.
+ Each <arg choice="plain">REF</arg> arguments is a full or partial indentifier in the
+ flatpak ref format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements
+ except ID are optional and can be left out, including the slashes,
+ so most of the time you need only specify ID. Any part left out will be matched
+ against what is installed, and if there are multiple matches an error message
+ will list the alternatives.
+ </para>
+ <para>
+ By default this looks for both apps and runtime with the given <arg choice="plain">REF</arg> in
+ the specified <arg choice="plain">REMOTE</arg>, but you can limit this by using the --app or
+ --runtime option, or by supplying the initial element in the REF.
</para>
<para>
Normally, this command updates the application to the tip