xbps/bin/xbps-repo/xbps-repo.8
2012-10-02 03:02:52 -06:00

160 lines
5.1 KiB
Groff

.Dd September 24, 2012
.Os Void GNU/Linux
.Dt xbps-repo 8
.Sh NAME
.Nm xbps-repo
.Nd XBPS command for binary package repositories
.Sh SYNOPSYS
.Nm xbps-repo
.Op options
.Ar target
.Op arguments
.Sh DESCRIPTION
The
.Nm
command is able to interact with binary packages stored in local or
remote repositories. It is able to create a package index for local
repositories, list repositories, search for packages and show information
of a binary package in repository pool, among other things.
.Sh OPTIONS
.Bl -tag -width Fl
.It Fl B Ar repository
If a configuration file cannot be found, this repository will be used as
as the primary source to install packages.
.It Fl C Ar conffile
Full path to the XBPS configuration file. By default set to
.Pa /etc/xbps/xbps.conf .
.It Fl c Ar cachedir
Sets the
.Em cache
directory to store downloaded binary packages from remote
repositories. By default set to
.Pa /var/cache/xbps .
.It Fl d
Enables extra debugging output to be shown to stderr.
.It Fl o Ar key Op key2,...
Used currently in the
.Em show
target. Prints the value of specified key(s) from
package's properties dictionary. Multiple keys can be specified delimited by
the comma character.
.It Fl r Ar rootdir
Sets the
.Em root
directory. By default the root directory is set to
.Em / .
Please note that the database directory is always set to
.Pa /var/db/xbps
independently of rootdir setting. So if you use a rootdir of
.Pa /blah ,
metadata stuff will go into
.Pa /blah/var/db/xbps .
.It Fl v
Shows verbose messages. Useful while installing and removing packages.
.It Fl V
Shows the current XBPS release version (version, API, index).
.Sh TARGETS
Please note that all targets are case insensitive.
.Pp
.Bl -tag -width ident
.It Sy clean
Cleans the
.Em cachedir
and removes obsolete binary packages, either because they are not available
anymore in the repository pool or because its sha256 hash doesn't match.
.It Sy find-files Ar pattern Ar [patterns ...]
Prints the name of
.Em package(s)
matching the pattern on its file list by looking in all repositories index files.
Multiple patterns can be specified as arguments.
.It Sy index-add Ar /path/to/local/repository/foo-1.0.arch.xbps
This will register the binary package into the local repository's index files, and remove
old entry and binary package if any old version exists.
Multiple binary packages can be specified.
.It Sy index-clean Ar /path/to/local/repository
This will remove any obsolete entry found in the local repository's index files.
.It Sy list
Lists all working repositories in repository pool.
.It Sy pkg-list Op repository
Lists all currently registered packages from all repositories, or just from
.Ar repository .
If argument is not specified, any package contained in all repositories
will be shown. The argument expects the repository URI.
matching the output of the
.Ar list
target.
.It Sy search Ar pattern Ar [patterns ...]
Search for packages containing the shell
.Em pattern
(see
.Xr fnmatch 3 )
in its
.Em pkgname
or
.Em description
values in repository pool. Please note that patterns are matched in case
insensitive mode. Multiple patterns can be specified as arguments. Packages that
have the
.Sy *
character as prefix are currently installed.
.It Sy remove-obsoletes Ar /path/to/local/repository
Removes obsolete packages from
.Ar repository .
Packages that are not currently registered in repository's index will
be removed.
.It Sy show Ar pkgname | pkgpattern
Shows information for binary package
.Ar pkgname
or a package matching
.Ar pkgpattern .
This will print the size it takes in filesystem, description, maintainer,
architecture and other information. If specifying a pkgname, the newest
version available in repositories will be shown, otherwise the first
repository matching the pkgpattern will be used.
.It Sy show-deps Ar pkgname | pkgpattern
Shows run time dependencies for binary package
.Ar pkgname
or a package matching
.Ar pkgpattern .
The same rules than in the
.Em show
target also apply here.
.It Sy show-files Ar pkgname | pkgpattern
Shows the file list for the binary package
.Ar pkgname
or a package matching
.Ar pkgpattern .
The same rules than in the
.Em show
target also apply here.
.Em NOTE :
if a remote repository is the winner and binary package is not available in
.Em cachedir ,
it will fetch remotely and
.Em on the fly
the info from target repository.
.It Sy sync Op repository
Syncs the package index file for all remote repositories or just for
.Ar repository .
The index file will be fetched if local and remote size/mtime do not match.
.Sh FILES
.Bl -tag -width /var/db/xbps/<repodir>/index-files.plist -compact
.It Pa /etc/xbps/xbps.conf
Default XBPS configuration file.
.It Pa /var/db/xbps/<repodir>/index.plist
Repository package index file.
.It Pa /var/db/xbps/<repodir>/index-files.plist
Repository package files index ile.
.It Pa /var/cache/xbps
XBPS cache directory for downloaded binary packages.
.Sh SEE ALSO
.Xr xbps-bin 8 ,
.Xr http://code.google.com/p/xbps
.Sh AUTHORS
.An Juan Romero Pardines <xtraeme@gmail.com>
.Sh BUGS
Probably, but I try to make this not happen. Use it under your own
responsability and enjoy your life.
.Pp
Report bugs in http://code.google.com/p/xbps.