Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xbps-checkvers.1: improve options and general description #414

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 35 additions & 6 deletions bin/xbps-checkvers/xbps-checkvers.1
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@ 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
tree.
By default it will use the tree located in
.Nm ~/void-packages ,
but this location can be changed with the
.Fl D, Fl -distdir
option.
By default and unless the
.Fl I, Fl -installed
option is set, it will compare package versions in repositories against
option is set, it will use package versions from repositories to compare against
the
.Nm void-packages
tree.
Expand All @@ -27,14 +33,15 @@ argument sets extra packages to process with the outdated ones (only processed i
.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
If the first character is not '/', then it's a path relative to
.Ar rootdir .
.It Fl D, Fl -distdir Ar dir
Specifies a full path to the void-packages repository. By default set to
Specifies the path to the void-packages tree (usually a git 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.
The source package version will be question mark for them, see documentation for
.Fl f, Fl -format .
.It Fl d, Fl -debug
Enables extra debugging shown to stderr.
.It Fl f, Fl -format Ar format
Expand Down Expand Up @@ -78,7 +85,7 @@ 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.
Only process listed packages.
.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
Expand All @@ -94,6 +101,28 @@ is printed instead.
.It Fl V, Fl -version
Show the version information.
.El
.Sh EXAMPLES
Show all packages in
.Pa ~/void-packages ,
listing the repository version and the
.Pa srcpkgs
version:
.Pp
.Dl $ xbps-checkvers -s
.Pp
Show packages in
.Pa ~/src/void-packages
which have a newer version than the installed version:
.Pp
.Dl $ xbps-checkvers -D ~/src/void-packages -I
.Pp
Check whether installed package
.Sq foo
has a newer version in the
.Nm void-packages
tree:
.Pp
.Dl $ xbps-checkvers -I -m foo
.Sh SEE ALSO
.Xr xbps-create 1 ,
.Xr xbps-dgraph 1 ,
Expand Down