summaryrefslogtreecommitdiffstats
path: root/doc/vercmp.8.asciidoc
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2018-05-03 06:10:21 +0200
committerAllan McRae <allan@archlinux.org>2018-05-14 01:59:17 +0200
commit076b6184de2b20e9b26225d93f6f3a7030504109 (patch)
treeca0e375b9fd89d6b6ce40026b732985c4b335841 /doc/vercmp.8.asciidoc
parent860e4c4943ad062bd0eff99f28e7d64804b3c08e (diff)
downloadpacman-076b6184de2b20e9b26225d93f6f3a7030504109.tar.gz
pacman-076b6184de2b20e9b26225d93f6f3a7030504109.tar.xz
Ensure better text editor automatic filetype detection
Since we no longer use vim-specific modelines, use the .asciidoc file extension which is, well, reserved for asciidoc formatted files. This should presumably work everywhere without needing editor-specific workarounds and configuration. Also add a shebang to makepkg.conf to indicate it contains bash content. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Allan McRae <allan@archlinux.org>
Diffstat (limited to 'doc/vercmp.8.asciidoc')
-rw-r--r--doc/vercmp.8.asciidoc72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/vercmp.8.asciidoc b/doc/vercmp.8.asciidoc
new file mode 100644
index 00000000..88021674
--- /dev/null
+++ b/doc/vercmp.8.asciidoc
@@ -0,0 +1,72 @@
+vercmp(8)
+=========
+
+Name
+----
+vercmp - version comparison utility
+
+
+Synopsis
+--------
+'vercmp' [-h] [--help] <version1> <version2>
+
+
+Description
+-----------
+'vercmp' is used to determine the relationship between two given version
+numbers. It outputs values as follows:
+
+* < 0 : if ver1 < ver2
+* = 0 : if ver1 == ver2
+* > 0 : if ver1 > ver2
+
+Version comparison operates as follows:
+
+ Alphanumeric:
+ 1.0a < 1.0b < 1.0beta < 1.0p < 1.0pre < 1.0rc < 1.0 < 1.0.a < 1.0.1
+ Numeric:
+ 1 < 1.0 < 1.1 < 1.1.1 < 1.2 < 2.0 < 3.0.0
+
+Additionally, version strings can have an 'epoch' value defined that will
+overrule any version comparison, unless the epoch values are equal. This is
+specified in an `epoch:version-rel` format. For example, `2:1.0-1` is always
+greater than `1:3.6-1`.
+
+Keep in mind that the 'pkgrel' is only compared if it is available on both
+versions given to this tool. For example, comparing `1.5-1` and `1.5` will
+yield 0; comparing `1.5-1` and `1.5-2` will yield < 0 as expected. This is
+mainly for supporting versioned dependencies that do not include the 'pkgrel'.
+
+
+Options
+-------
+*-h, \--help*::
+
+ Display summary of the available return codes. Must be the first option
+ specified.
+
+
+Examples
+--------
+
+ $ vercmp 1 2
+ -1
+
+ $ vercmp 2 1
+ 1
+
+ $ vercmp 2.0-1 1.7-6
+ 1
+
+ $ vercmp 2.0 2.0-13
+ 0
+
+ $ vercmp 4.34 1:001
+ -1
+
+
+See Also
+--------
+linkman:pacman[8], linkman:makepkg[8], linkman:libalpm[3]
+
+include::footer.asciidoc[]