diff options
Diffstat (limited to 'upstream/archlinux/man1/pkgctl-version.1')
| -rw-r--r-- | upstream/archlinux/man1/pkgctl-version.1 | 83 |
1 files changed, 52 insertions, 31 deletions
diff --git a/upstream/archlinux/man1/pkgctl-version.1 b/upstream/archlinux/man1/pkgctl-version.1 index 4f8eddfb..493bc91e 100644 --- a/upstream/archlinux/man1/pkgctl-version.1 +++ b/upstream/archlinux/man1/pkgctl-version.1 @@ -1,32 +1,32 @@ '\" t .\" Title: pkgctl-version -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 02/14/2024 +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.21 +.\" Date: 2024-05-01 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "PKGCTL\-VERSION" "1" "02/14/2024" "\ \&" "\ \&" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.TH "PKGCTL\-VERSION" "1" "2024-05-01" "\ \&" "\ \&" .ie \n(.g .ds Aq \(aq .el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation +.ss \n[.ss] 0 .nh -.\" disable justification (adjust text to left margin only) .ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} .SH "NAME" pkgctl-version \- Check and manage package versions against upstream .SH "SYNOPSIS" @@ -34,38 +34,59 @@ pkgctl-version \- Check and manage package versions against upstream pkgctl version [OPTIONS] [SUBCOMMAND] .SH "DESCRIPTION" .sp -Commands related to package versions, including checks for outdated packages\&. +Commands related to package versions, including checks for outdated packages. .sp -Uses \fBnvchecker\fR(1) and a \&.nvchecker\&.toml file located alongside the PKGBUILD\&. +Uses nvchecker(1) and a \f(CR.nvchecker.toml\fP file located alongside the +PKGBUILD. .SH "CONFIGURATION" .sp -The \&.nvchecker\&.toml file must contain a section that matches the package\(cqs pkgbase\&. The pkgbase section within the \&.nvchecker\&.toml file specifies the source and method for checking the latest version of the corresponding package\&. +The \f(CR.nvchecker.toml\fP file must contain a section that matches the +package\(cqs pkgbase. The pkgbase section within the \f(CR.nvchecker.toml\fP file +specifies the source and method for checking the latest version of the +corresponding package. .sp -For detailed information on the various configuration options available for the \&.nvchecker\&.toml file, refer to the configuration files section in \fBnvchecker\fR(1)\&. This documentation provides insights into the possible options that can be utilized to customize the version checking process\&. +Use pkgctl\-version\-setup(1) to automatically detect and setup a basic nvchecker +config based on the source array of the package PKGBUILD. .sp -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\&. +For detailed information on the various configuration options available for the +\f(CR.nvchecker.toml\fP 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. +.sp +To supply GitHub or GitLab tokens to nvchecker, a \f(CRkeyfile.toml\fP should be +placed in the \f(CR$XDG_CONFIG_HOME\fP/nvchecker` directory. This keyfile is +used for providing the necessary authentication tokens required for +accessing the GitHub or GitLab API. .SH "OPTIONS" -.PP -\fB\-h, \-\-help\fR +.sp +\fB\-h, \-\-help\fP .RS 4 Show a help text .RE .SH "SUBCOMMANDS" -.PP +.sp pkgctl version check .RS 4 Compares local package versions against upstream .RE -.PP +.sp +pkgctl version setup +.RS 4 +Automatically detect and setup a basic nvchecker config +.RE +.sp pkgctl version upgrade .RS 4 Adjust the PKGBUILD to match the latest upstream version .RE .SH "SEE ALSO" .sp -\fBpkgctl-version-check\fR(1) \fBpkgctl-version-upgrade\fR(1) +pkgctl\-version\-check(1) +pkgctl\-version\-setup(1) +pkgctl\-version\-upgrade(1) .SH "HOMEPAGE" .sp -\fIhttps://gitlab\&.archlinux\&.org/archlinux/devtools\fR +\fI\c +.URL "https://gitlab.archlinux.org/archlinux/devtools" "" "\fP" .sp -Please report bugs and feature requests in the issue tracker\&. Please do your best to provide a reproducible test case for bugs\&. +Please report bugs and feature requests in the issue tracker. Please do your best to provide a reproducible test case for bugs.
\ No newline at end of file |