Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version.1.asciidoc
diff options
context:
space:
mode:
authorAndreas Baumann <mail@andreasbaumann.cc>2024-03-08 09:03:18 +0100
committerAndreas Baumann <mail@andreasbaumann.cc>2024-03-08 09:03:18 +0100
commit8f46b191dd9ef417976fe07229aa36f0f37a1f15 (patch)
treee981a6b2a88a56a9c2503d65416a38a843348bc6 /doc/man/pkgctl-version.1.asciidoc
parent8c41277a2e62c7ed2b07ac5d09af57b31c9cd890 (diff)
parent509dd24bdcd6c45bd86937fcd1de6fd1fa510441 (diff)
merged with upstream changes
Diffstat (limited to 'doc/man/pkgctl-version.1.asciidoc')
-rw-r--r--doc/man/pkgctl-version.1.asciidoc43
1 files changed, 40 insertions, 3 deletions
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index 9beebf5..fa83314 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -3,16 +3,38 @@ pkgctl-version(1)
Name
----
-pkgctl-version - Show pkgctl version information
+pkgctl-version - Check and manage package versions against upstream
+
Synopsis
--------
-pkgctl version [OPTIONS]
+pkgctl version [OPTIONS] [SUBCOMMAND]
Description
-----------
-Shows the current version information of pkgctl.
+Commands related to package versions, including checks for outdated packages.
+
+Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
+PKGBUILD.
+
+Configuration
+-------------
+
+The `.nvchecker.toml` file must contain a section that matches the
+package's pkgbase. The pkgbase section within the `.nvchecker.toml` file
+specifies the source and method for checking the latest version of the
+corresponding package.
+
+For detailed information on the various configuration options available for the
+`.nvchecker.toml` file, refer to the configuration files section in
+linkman:nvchecker[1]. This documentation provides insights into the possible
+options that can be utilized to customize the version checking process.
+
+To supply GitHub or GitLab tokens to nvchecker, a `keyfile.toml` should be
+placed in the `$XDG_CONFIG_HOME`/nvchecker` directory. This keyfile is
+used for providing the necessary authentication tokens required for
+accessing the GitHub or GitLab API.
Options
-------
@@ -20,4 +42,19 @@ Options
*-h, --help*::
Show a help text
+Subcommands
+-----------
+
+pkgctl version check::
+ Compares local package versions against upstream
+
+pkgctl version upgrade::
+ Adjust the PKGBUILD to match the latest upstream version
+
+See Also
+--------
+
+linkman:pkgctl-version-check[1]
+linkman:pkgctl-version-upgrade[1]
+
include::include/footer.asciidoc[]