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:
authorLevente Polyak <anthraxx@archlinux.org>2024-01-19 01:57:18 +0100
committerLevente Polyak <anthraxx@archlinux.org>2024-01-22 19:45:16 +0100
commit4d72f4560c3a64b38dcdb705ec633c3c2ba1f20c (patch)
tree51836e173b48d29b4a8030be4d3c647816ad2bfb /doc/man/pkgctl-version.1.asciidoc
parente3edf25554c78e28679b100e24c55c87ee65a22d (diff)
doc(version): extensively revamp documentation for version subcommands
Enhanced and overhauled the documentation for the 'version' subcommand. The improvements include comprehensive details on the subcommand's behavior, usage, and a variety of scenarios it handles. Added a central section within the pkgctl-version manpage that documents the nvchecker configuration and rules. Component: pkgctl version Singled-off-by: Levente Polyak <anthraxx@archlinux.org>
Diffstat (limited to 'doc/man/pkgctl-version.1.asciidoc')
-rw-r--r--doc/man/pkgctl-version.1.asciidoc29
1 files changed, 25 insertions, 4 deletions
diff --git a/doc/man/pkgctl-version.1.asciidoc b/doc/man/pkgctl-version.1.asciidoc
index e71becd..fa83314 100644
--- a/doc/man/pkgctl-version.1.asciidoc
+++ b/doc/man/pkgctl-version.1.asciidoc
@@ -3,7 +3,7 @@ pkgctl-version(1)
Name
----
-pkgctl-version - Package version related commands.
+pkgctl-version - Check and manage package versions against upstream
Synopsis
@@ -13,7 +13,28 @@ pkgctl version [OPTIONS] [SUBCOMMAND]
Description
-----------
-Package version related commands such as checking if a package is out of date.
+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
-------
@@ -25,10 +46,10 @@ Subcommands
-----------
pkgctl version check::
- Check if there is an new upstream version available
+ Compares local package versions against upstream
pkgctl version upgrade::
- Upgrade the PKGBUILD according to the latest available upstream version
+ Adjust the PKGBUILD to match the latest upstream version
See Also
--------