xbps/bin/xbps-alternatives/xbps-alternatives.1

110 lines
3.0 KiB
Groff

.Dd June 20, 2019
.Dt XBPS-ALTERNATIVES 1
.Sh NAME
.Nm xbps-alternatives
.Nd XBPS utility to handle alternatives
.Sh SYNOPSIS
.Nm xbps-alternatives
.Op OPTIONS
.Ar MODE
.Sh DESCRIPTION
The
.Nm
utility lists or sets the alternatives provided by installed packages.
Alternatives are classified by groups, and a group contains a number
of symbolic links which are applied when the group is set.
.Pp
When a package is installed its alternative groups are registered in the package database (pkgdb).
.Pp
When a package is removed its alternative groups are unregistered from the package database (pkgdb).
If there are no more alternative groups, the package database removes the references. If there were
alternative groups registered previously, the previous package is set as default provider.
.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 -debug
Enables extra debugging shown to stderr.
.It Fl g, Fl -group
Alternative group name to match. To be used with the
.Ar set
mode.
.It Fl h, Fl -help
Show the help message.
.It Fl r, Fl -rootdir Ar dir
Specifies a full path for the target root directory.
.It Fl v, Fl -verbose
Enables verbose messages.
.It Fl V, Fl -version
Show the version information.
.El
.Sh MODE
Only one of the following modes can be used at a time.
.Bl -tag -width -x
.It Fl l, Fl -list Op PKG Op -g Ar group
Lists all current alternative groups or only from
.Ar PKG ,
or just a specific group, if the
.Fl g Fl -group
option is set.
.It Fl s, Fl -set Ar PKG Op -g Ar group
Set alternative groups specified by
.Ar PKG
or just a specific group, if the
.Fl g Fl -group
option is set.
.El
.Sh FILES
.Bl -tag -width /var/db/xbps/.<pkgname>-files.plist
.It Ar /etc/xbps.d
Default configuration directory.
.It Ar /usr/share/xbps.d
Default system configuration directory.
.It Ar /var/db/xbps/.<pkgname>-files.plist
Package files metadata.
.It Ar /var/db/xbps/pkgdb-0.38.plist
Default package database (0.38 format). Keeps track of installed packages and properties.
.It Ar /var/cache/xbps
Default cache directory to store downloaded binary packages.
.El
.Sh ENVIRONMENT
.Bl -tag -width XBPS_TARGET_ARCH
.It Sy XBPS_ARCH
Overrides
.Xr uname 2
machine result with this value.
.It Sy XBPS_TARGET_ARCH
Sets the target architecture to this value.
.It Sy XBPS_SYSLOG
Overrides the
.Xr xbps.d 5
.Sy syslog=true|false
configuration option.
.El
.Sh SEE ALSO
.Xr xbps-checkvers 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-remove 1 ,
.Xr xbps-rindex 1 ,
.Xr xbps-uchroot 1 ,
.Xr xbps-uunshare 1 ,
.Xr xbps.d 5
.Sh AUTHORS
.An Juan Romero Pardines <xtraeme@gmail.com>
.An Duncan Overbruck <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 https://github.com/void-linux/xbps/issues