summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version.1.asciidoc
diff options
context:
space:
mode:
authorJelle van der Waa <jelle@archlinux.org>2023-11-05 16:11:12 +0100
committerChristian Heusel <christian@heusel.eu>2024-01-10 19:44:15 +0100
commite6f7aa395fabc7eca1ee4d93e454d2551cea505c (patch)
tree57a604c65a7df94072518db91f95f53cd9bbd6b4 /doc/man/pkgctl-version.1.asciidoc
parente413b65df3dcddeb94da2defb53ab17ef2a8558d (diff)
downloaddevtools-e6f7aa395fabc7eca1ee4d93e454d2551cea505c.tar.xz
feat(version): introduce version check subcommand
The version subcommand handles pkgver related commands, the first subcommand being `check`. Check runs nvchecker if a `.nvchecker.toml` file exists and compares the current pkgver with the latest release. Introduces nvchecker as optional dependency which has to be installed in order to use this particular subcommand. BREAKING CHANGE: formerly pkgctl version would output the version of the pkgctl tool, now it is used as a version related subcommand. Fixes #140 Component: pkgctl version Component: pkgctl version check Co-authored-by: Christian Heusel <christian@heusel.eu>
Diffstat (limited to 'doc/man/pkgctl-version.1.asciidoc')
-rw-r--r--doc/man/pkgctl-version.1.asciidoc18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index 9beebf5..53a72f3 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -3,16 +3,17 @@ pkgctl-version(1)
Name
----
-pkgctl-version - Show pkgctl version information
+pkgctl-version - Package version related commands.
+
Synopsis
--------
-pkgctl version [OPTIONS]
+pkgctl version [OPTIONS] [SUBCOMMAND]
Description
-----------
-Shows the current version information of pkgctl.
+Package version related commands such as checking if a package is out of date.
Options
-------
@@ -20,4 +21,15 @@ Options
*-h, --help*::
Show a help text
+Subcommands
+-----------
+
+pkgctl version check::
+ Check if there is an new upstream version available
+
+See Also
+--------
+
+linkman:pkgctl-version-check[1]
+
include::include/footer.asciidoc[]