Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-01-07 20:59:51 -0600
committerDan McGee <dan@archlinux.org>2011-01-22 10:02:15 -0600
commit01403f423a9bace8b43d45a0dfcea5d4f1002cc8 (patch)
treec608878e84c995bda130cd365a45d1e0bd9b55cb
parentb8ab96a270caa5d589c44c62d5664db156d94af7 (diff)
doc: add a vercmp manpage
This includes info on version comparison that is very similar to the stuff in the pacman manpage, but also a few vercmp examples, the return values, and other fun stuff. Also update the version comparison stuff in the pacman manpage. Signed-off-by: Dan McGee <dan@archlinux.org>
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/Makefile.am4
-rw-r--r--doc/index.txt1
-rw-r--r--doc/pacman.8.txt6
-rw-r--r--doc/vercmp.8.txt71
5 files changed, 81 insertions, 2 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
index f047aaa9..a6f4df7f 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -6,6 +6,7 @@ pacman.8
pacman.conf.5
repo-add.8
repo-remove.8
+vercmp.8
*.css
*.html
*.xml
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 6405cf01..b708d3f2 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -7,6 +7,7 @@ ASCIIDOC_MANS = \
pacman.8 \
makepkg.8 \
repo-add.8 \
+ vercmp.8 \
PKGBUILD.5 \
makepkg.conf.5 \
pacman.conf.5 \
@@ -18,6 +19,7 @@ HTML_MANPAGES = \
pacman.8.html \
makepkg.8.html \
repo-add.8.html \
+ vercmp.8.html \
PKGBUILD.5.html \
makepkg.conf.5.html \
pacman.conf.5.html \
@@ -38,6 +40,7 @@ EXTRA_DIST = \
pacman.8.txt \
makepkg.8.txt \
repo-add.8.txt \
+ vercmp.8.txt \
PKGBUILD.5.txt \
PKGBUILD-example.txt \
makepkg.conf.5.txt \
@@ -129,6 +132,7 @@ $(HTML_OTHER): asciidoc.conf
pacman.8 pacman.8.html: pacman.8.txt
makepkg.8 makepkg.8.html: makepkg.8.txt
repo-add.8 repo-add.8.html: repo-add.8.txt
+vercmp.8 vercmp.8.html: vercmp.8.txt
PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt
makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt
pacman.conf.5 pacman.conf.5.html: pacman.conf.5.txt
diff --git a/doc/index.txt b/doc/index.txt
index ef328415..afb2719d 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -43,6 +43,7 @@ configuration files dealing with pacman.
* linkman:pacman[8]
* linkman:pacman.conf[5]
* linkman:repo-add[8]
+* linkman:vercmp[8]
Changelog
~~~~~~~~~
diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt
index 2b47a88c..8f91e408 100644
--- a/doc/pacman.8.txt
+++ b/doc/pacman.8.txt
@@ -80,8 +80,10 @@ to determine which packages need upgrading. This behavior operates as follows:
Numeric:
1 < 1.0 < 1.1 < 1.1.1 < 1.2 < 2.0 < 3.0.0
+
-Additionally, packages can have an 'epoch' value defined that will override any
-version comparison and force an upgrade.
+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`.
*-T, \--deptest*::
Check dependencies; this is useful in scripts such as makepkg to check
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[]