summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-version-check.1.asciidoc
blob: 2543bcb4eb2bf29d5440b3326a80ee5a0419d36b (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
pkgctl-version-check(1)
=======================

Name
----
pkgctl-version-check - Compares local package versions against upstream

Synopsis
--------
pkgctl version check [OPTIONS] [PKGBASE...]

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

Compares the versions of packages in the local packaging repository against
their latest upstream versions.

Upon execution, it generates a grouped list that provides detailed insights
into each package's status. For each package, it displays the current local
version alongside the latest version available upstream.

Outputs a summary of up-to-date packages, out-of-date packages, and any check
failures.

This simplifies the maintenance of PKGBUILD files, reducing the manual effort
required to track version changes from upstream sources.

Configuration
-------------

Uses linkman:nvchecker[1] and a `.nvchecker.toml` file located alongside the
PKGBUILD. Refer to the configuration section in linkman:pkgctl-version[1].

Options
-------

*-v, --verbose*::
	Display results including up-to-date versions

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

Exit Codes
----------

On exit, return one of the following codes:

*0*::
	Normal exit condition, all checked versions are up-to-date

*1*::
	Unknown cause of failure

*2*::
	Normal exit condition, but there are out-of-date versions

*3*::
	Failed to run some version checks

See Also
--------

linkman:pkgctl-version[1]
linkman:nvchecker[1]

include::include/footer.asciidoc[]