summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile1
-rw-r--r--doc/apk-version.8.scd53
2 files changed, 54 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 7cdf399..77f1766 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -21,6 +21,7 @@ docs: $(obj)/apk.8 \
$(obj)/apk-update.8 \
$(obj)/apk-upgrade.8 \
$(obj)/apk-verify.8 \
+ $(obj)/apk-version.8 \
$(obj)/apk-repositories.5 \
$(obj)/apk-world.5
targets += docs
diff --git a/doc/apk-version.8.scd b/doc/apk-version.8.scd
new file mode 100644
index 0000000..654a033
--- /dev/null
+++ b/doc/apk-version.8.scd
@@ -0,0 +1,53 @@
+apk-version(8)
+
+# NAME
+
+apk version - compare package versions
+
+# SYNOPSIS
+
+*apk version* [<_options_>...] [_packages_...]
+
+*apk version* -c _versions_...
+
+*apk version* -t _left_ _right_
+
+*apk version* -I
+
+# DESCRIPTION
+
+*apk version* compares the versions of installed packages against package
+versions available from repositories (see *apk-repositories*(5)). If no
+packages are specified, all installed packages are considered. Otherwise,
+the comparison is limited to the explicitly listed packages. A summary is
+printed on stdout, with the difference between package versions being
+represented as *>*, *=*, or *<*.
+
+*apk version -c* tests the specified version string(s) for validity and prints
+a list of _invalid_ version strings. If all version strings are valid, nothing
+is printed and *apk version* exits with status code zero. If one or more
+version strings are invalid, the exit code is nonzero.
+
+*apk version -t* accepts two arbitrary version strings and compares them
+without consulting the database, then prints the result as *>*, *=*, or *<*.
+
+*apk version -I* prints the versions and descriptions of each repository's
+index. See *apk-repositories*(5) for more information.
+
+# OPTIONS
+
+These options only apply when checking installed package versions against
+packages available from the repositories (when neither *-c*, *-t*, nor *-I* are
+specified).
+
+*-a*
+ Consider packages from all repository tags.
+
+*-l* _operand_
+ Limit output to packages whose comparison is among the given operands,
+ specified as any combination of *>*, *=*, and *<*.
+
+# AUTHORS
+
+Natanael Copa <ncopa@alpinelinux.org>++
+Timo Teräs <_timo.teras@iki.fi_>