summaryrefslogtreecommitdiff
path: root/doc/flatpak-update.xml
diff options
context:
space:
mode:
authorMatthew Leeds <matthew.leeds@endlessm.com>2017-11-15 22:25:57 -0800
committerAtomic Bot <atomic-devel@projectatomic.io>2017-11-16 08:00:05 +0000
commita218bdb282cdcc3db4f6065d16eeaa5fe6bb4b05 (patch)
treeb11a62d3196b117d3403eaf2960e623d1acd8b0a /doc/flatpak-update.xml
parent763c27b0080a6343820f6d93e26bb2fcab56ce4f (diff)
downloadflatpak-a218bdb282cdcc3db4f6065d16eeaa5fe6bb4b05.tar.gz
docs: Document "flatpak update --appstream" better
The manpage description for flatpak-update's --appstream option says it updates appstream data for the remote, but it's unclear that the remote should be passed on the command line instead of a ref. This commit updates the manpage to document that form of the command. Closes: #1177 Approved by: alexlarsson
Diffstat (limited to 'doc/flatpak-update.xml')
-rw-r--r--doc/flatpak-update.xml8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/flatpak-update.xml b/doc/flatpak-update.xml
index c90ac1ac..57734272 100644
--- a/doc/flatpak-update.xml
+++ b/doc/flatpak-update.xml
@@ -34,6 +34,12 @@
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="opt" rep="repeat">REF</arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>flatpak update</command>
+ <arg choice="opt" rep="repeat">OPTION</arg>
+ <arg choice="plain">--appstream</arg>
+ <arg choice="opt">REMOTE</arg>
+ </cmdsynopsis>
</refsynopsisdiv>
<refsect1>
@@ -188,7 +194,7 @@
<term><option>--appstream</option></term>
<listitem><para>
- Update appstream for the remote.
+ Update appstream for <arg choice="plain">REMOTE</arg>, or all remotes if no remote is specified.
</para></listitem>
</varlistentry>