summaryrefslogtreecommitdiff
path: root/doc/vercmp.8.txt
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-01-22 10:03:51 -0600
committerDan McGee <dan@archlinux.org>2011-01-22 10:03:51 -0600
commit51175f31c4aac9df6ceeffc7855a0f842c580fdb (patch)
tree4fe5405a24aa967572f407dafbbee9231a25b0dc /doc/vercmp.8.txt
parente277e838d798c1463ae5df98dcf637df70e048ec (diff)
parent859bdb5b1d1b9ccb781c95026836283a005a96ce (diff)
Merge branch 'epoch-work'
Diffstat (limited to 'doc/vercmp.8.txt')
-rw-r--r--doc/vercmp.8.txt71
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/vercmp.8.txt b/doc/vercmp.8.txt
new file mode 100644
index 00000000..f2fc5305
--- /dev/null
+++ b/doc/vercmp.8.txt
@@ -0,0 +1,71 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet:
+/////
+vercmp(8)
+=========
+
+Name
+----
+vercmp - version comparsion utility
+
+
+Synopsis
+--------
+'vercmp' <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 comparsion operates as follows:
+
+ Alphanumeric:
+ 1.0a < 1.0alpha < 1.0b < 1.0beta < 1.0p < 1.0pre < 1.0rc < 1.0
+ 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`.
+
+
+Options
+-------
+*-h, \--help*::
+ Display syntax for the given operation. If no operation was supplied
+ then the general syntax is shown.
+
+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
+
+Configuration
+-------------
+There is none.
+
+See Also
+--------
+linkman:pacman[8], linkman:makepkg[8], linkman:libalpm[3]
+
+include::footer.txt[]