xbps/bin/xbps-checkvers/xbps-checkvers.1
classabbyamp 06fbbba2e5 manpages: small formatting improvements
- use `.Os` to show "Void Linux" in the footer
- use `Aq Mt` to display email addresses
- use `.Lk` for the bug link
- remove unnecessary use of `.Nm <name>` when already defined
- add xbps-alternatives(1) to SEE ALSO where missing
- bump date
2023-02-10 21:33:51 +01:00

123 lines
3.2 KiB
Groff

.Dd Feb 9, 2023
.Dt XBPS-CHECKVERS 1
.Os
.Sh NAME
.Nm xbps-checkvers
.Nd XBPS utility to check for outdated packages
.Sh SYNOPSIS
.Nm
.Op OPTIONS
.Op FILES...
.Sh DESCRIPTION
The
.Nm
utility checks for outdated packages in a target root directory or in
all registered repositories by comparing the package versions against
the source package versions available in a
.Nm void-packages
tree. By default and unless the
.Fl I, Fl -installed
option is set, it will compare package versions in repositories against
the
.Nm void-packages
tree.
The
.Ar FILES
argument sets extra packages to process with the outdated ones (only processed if missing).
.Sh OPTIONS
.Bl -tag -width -x
.It Fl C, Fl -config Ar dir
Specifies a path to the XBPS configuration directory.
If the first character is not '/' then it's a relative path of
.Ar rootdir .
.It Fl D, Fl -distdir Ar dir
Specifies a full path to the void-packages repository. By default set to
.Nm ~/void-packages .
.It Fl e, Fl -removed
List packages present in repos, but not in distdir.
Srcver is a question mark for them.
.It Fl d, Fl -debug
Enables extra debugging shown to stderr.
.It Fl f, Fl -format Ar format
Format according to the string
.Ar format ,
inspired by
.Xr printf 3 .
.Pp
The following formatting codes may be used:
.Bl -tag -width Ds
.It Cm \en
Newline.
.It Cm \et
Tab.
.It Cm \e0
NULL.
.It Cm \&%%
A plain
.Sq Li \&% .
.It Cm \&%n
The package name.
.It Cm \&%r
The package version from repositories or pkgdb (returns ? if not found).
.It Cm \&%s
The source package version (returns ? if not found).
.It Cm \&%t
The requested template name (this can be a sub package).
.It Cm \&%R
The repository url (returns ? if not found).
.El
.Pp
The default format is
.Dq Cm "%n %r %s %t %R" .
.It Fl h, Fl -help
Show the help message.
.It Fl i, Fl -ignore-conf-repos
Ignore repositories defined in configuration files.
Only repositories specified in the command line via
.Ar --repository
will be used.
.It Fl I, Fl -installed
Check for outdated installed packages rather than in repositories.
.It Fl m, Fl -manual
Only process listed files.
.It Fl R, Fl -repository=uri
Repository to be added to the top of the list. This option can be specified multiple times.
.It Fl r, Fl -rootdir Ar dir
Specifies a full path for the target root directory.
.It Fl s, Fl -show-all
List all packages found in the
.Nm void-packages
tree and prints version available in repository and srcpkgs with the following format:
.Ar pkgname repover srcver .
If any version can't be resolved,
.Em ?
is printed instead.
.It Fl V, Fl -version
Show the version information.
.El
.Sh SEE ALSO
.Xr xbps-alternatives 1 ,
.Xr xbps-create 1 ,
.Xr xbps-dgraph 1 ,
.Xr xbps-digest 1 ,
.Xr xbps-fbulk 1 ,
.Xr xbps-fetch 1 ,
.Xr xbps-install 1 ,
.Xr xbps-pkgdb 1 ,
.Xr xbps-query 1 ,
.Xr xbps-reconfigure 1 ,
.Xr xbps-rindex 1 ,
.Xr xbps-uchroot 1 ,
.Xr xbps-uunshare 1 ,
.Xr xbps.d 5
.Sh AUTHORS
.An Dave Elusive Aq Mt davehome@redthumb.info.tm
.An Juan Romero Pardines Aq Mt xtraeme@gmail.com
.An Duncan Overbruck Aq Mt mail@duncano.de
.Sh BUGS
Probably, but I try to make this not happen. Use it under your own
responsibility and enjoy your life.
.Pp
Report bugs at
.Lk https://github.com/void-linux/xbps/issues