Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version.1.asciidoc
blob: a72173b188de1b9b793d8c40fcff2497696cdbe1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
pkgctl-version(1)
=================

Name
----
pkgctl-version - Check and manage package versions against upstream


Synopsis
--------
pkgctl version [OPTIONS] [SUBCOMMAND]

Description
-----------

Commands related to package versions, including checks for outdated packages.

Uses 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.

Use pkgctl-version-setup(1) to automatically detect and setup a basic nvchecker
config based on the source array of the package PKGBUILD.

For detailed information on the various configuration options available for the
`.nvchecker.toml` file, refer to the configuration files section in
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
-------

*-h, --help*::
	Show a help text

Subcommands
-----------

pkgctl version check::
	Compares local package versions against upstream

pkgctl version setup::
	Automatically detect and setup a basic nvchecker config

pkgctl version upgrade::
	Adjust the PKGBUILD to match the latest upstream version

See Also
--------

pkgctl-version-check(1)
pkgctl-version-setup(1)
pkgctl-version-upgrade(1)

include::include/footer.asciidoc[]