emo/xbps
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

xbps-repo(8): rewriten manpage to mdoc(7) macro format.

Browse Source
This commit is contained in:
Juan RP 2011-12-17 18:30:13 +01:00
parent 99f0b02e03
commit a1f39a0a82
1 changed files with 122 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

288
bin/xbps-repo/xbps-repo.8
View File

@ -1,175 +1,131 @@
.TH "XBPS\-REPO" "8" "15/12/2011" "\ \&" "\ \&" .Dd December 15, 2011
.\" ----------------------------------------------------------------- .Os Void GNU/Linux
.\" * set default formatting .Dt xbps-repo 8
.\" ----------------------------------------------------------------- .Sh NAME
.\" disable hyphenation .Nm xbps-repo
.nh .Nd XBPS command for binary package repositories
.\" disable justification (adjust text to left margin only) .Sh SYNOPSYS
.ad l .Nm xbps-repo
.\" ----------------------------------------------------------------- .Op options
.\" * MAIN CONTENT STARTS HERE * .Ar target
.\" ----------------------------------------------------------------- .Op arguments
.SH "NAME" .Sh DESCRIPTION
xbps-repo \- XBPS command for binary package repositories The
.SH "SYNOPSIS" .Nm
.sp command is able to interact with binary packages stored in local or
\fBxbps\-repo\fR [\fIoptions\fR] \fItarget\fR [\fIarguments\fR] remote repositories. It is able to create a package index for local
.SH "DESCRIPTION" repositories, list repositories, search for packages and show information
.sp of a binary package in repository pool, among other things.
The xbps\-repo(8) command is used to handle local or remote binary package repositories in the \fBXBPS binary package system\fR\&. You can use it to create a package index for a local repository, list repositories, search for packages and show information about a binary package in repository pool\&. .Sh OPTIONS
.SH "OPTIONS" .Bl -tag -width Fl
.PP .It Fl C Ar conffile
\fB\-C\fR \fIconffile\fR Full path to the XBPS configuration file. By default set to
.RS 4 .Pa /etc/xbps/xbps.conf .
Full path to the XBPS configuration file\&. .It Fl c Ar cachedir
By default it\(cqs set to \fIETCDIR/xbps/xbps.conf\fR\&.
.RE
.PP
\fB\-c\fR \fIcachedir\fR
.RS 4
Sets the Sets the
\fIcache\fR .Em cache
directory to store downloaded binary packages from remote repositories\&. By default it\(cqs set to directory to store downloaded binary packages from remote
\fI/var/cache/xbps\fR\&. repositories. By default set to
.RE .Pa /var/cache/xbps .
.PP .It Fl d
\fB\-d\fR
.RS 4
Enables extra debugging output to be shown to stderr. Enables extra debugging output to be shown to stderr.
.RE .It Fl o Ar key Op key2,...
.PP
\fB-o\fR \fIkey[,key2...]\fR
.RS 4
Used currently in the Used currently in the
\fIshow\fR .Em show
target\&. Prints the value of specified key(s) from package's properties dictionary. target. Prints the value of specified key(s) from
Multiple keys can be specified delimited by the comma character. package's properties dictionary. Multiple keys can be specified delimited by
.RE the comma character.
.PP .It Fl r Ar rootdir
\fB\-r\fR \fIrootdir\fR
.RS 4
Sets the Sets the
\fIroot\fR .Em root
directory\&. By default the root directory is set to directory. By default the root directory is set to
\fI/\fR\&. Please note that the database directory is always set to .Em / .
\fI/var/db/xbps\fR Please note that the database directory is always set to
independently of .Pa /var/db/xbps
\fIrootdir\fR\&. So if you use a independently of rootdir setting. So if you use a rootdir of
\fIrootdir\fR .Pa /blah ,
of metadata stuff will go into
\fI/blah\fR, metadata stuff will go into .Pa /blah/var/db/xbps .
\fI/blah/var/db/xbps\fR\&. .It Fl v
.RE Shows verbose messages. Useful while installing and removing packages.
.PP .It Fl V
\fB\-V\fR Shows the current XBPS release version (version, API, index).
.RS 4 .Sh TARGETS
Shows the current XBPS, API and INDEX versions\&. Please note that all targets are case insensitive.
.RE .Pp
.SH "TARGETS" .Bl -tag -width ident
.sp .It Sy find-files Ar pattern
Please note that all targets are \fBcase insensitive\fR\&. Prints the name of
.PP .Em package(s)
\fBfind\-files\fR \fIpattern\fR matching the pattern on its file list by looking in all repositories index files.
.RS 4 .It Sy genindex Pa /path/to/local/repo
Prints the name for any package registered in the repository pool, that owns Generates a package index for a local repository as specified in its argument.
the file matched by \fIpattern\fR\&. Exact matches and wildcards can be It will look for archives with the
specified\&. Please note that this will look in all packages registered .Sy .xbps
from all repositories currently registered, so if packages are not in \fIcachedir\fR
it will have to connect remotely to the repository to fetch the information
\fIon the fly\fR.
.RE
.PP
\fBgenindex\fR \fI/path/to/local/repo\fR
.RS 4
Generates a package index for a local repository as specified in its argument\&.
It will look for archives with
\fB\&.xbps\fR
extension and will only add it into the index if version is newer than the one extension and will only add it into the index if version is newer than the one
available in the index\&. If a newer package is available, the old package file available in the index. If a newer package is available, the old package file
will be removed automatically\&. will be removed automatically.
.RE .It Sy list
.PP Lists all working repositories in repository pool.
\fBlist\fR .It Sy pkg-list Op index
.RS 4 Lists all currently registered packages in repository index as specified
Lists all working repositories in repository pool\&. in the
.RE .Ar index
.PP argument. If argument is not specified, any package contained in all repositories
\fBpkg\-list [\fR\fB\fIindex\fR\fR\fB]\fR will be shown. The argument expects a decimal number starting from 0,
.RS 4 matching the output of the
Lists all currently registered packages in repository index as specified in the \fIindex\fR argument. .Ar list
If argument is not specified, all repositories will be used to list packages\&. The argument target.
expects a decimal number starting from 0, matching the output of the \fIlist\fR target. .It Sy search Ar pattern
.RE
.PP
\fBsearch\fR \fIpattern\fR
.RS 4
Search for packages containing the shell Search for packages containing the shell
\fIpattern\fR .Em pattern
(see fnmatch(3)) in its (see
\fBpkgname\fR .Xr fnmatch 3 )
in its
.Em pkgname
or or
\fBdescription\fR .Em description
values in repository pool\&. Please note that patterns are matched in case values in repository pool. Please note that patterns are matched in case
insensitive mode. insensitive mode.
.RE .It Sy show Ar pkgname
.PP
\fBshow \fR\fB\fIpkgname\fR\fR
.RS 4
Shows information about binary package Shows information about binary package
\fIpkgname\fR\&. This will print the size it takes in filesystem, description, maintainer, architecture and other information\&. The first repository in the pool wins\&. .Em pkgname .
.RE This will print the size it takes in filesystem, description, maintainer,
.PP architecture and other information. The first repository in the pool wins.
\fBshow\-deps \fR\fB\fIpkgname\fR\fR .It Sy show-deps Ar pkgname
.RS 4 Shows run time dependencies for the binary package
Shows run time dependencies for binary package .Ar pkgname .
\fIpkgname\fR\&. The first repository in the pool wins\&. The first repository in the pool wins.
.RE .It Sy show-files Ar pkgname
.PP Shows the file list for the binary package
\fBshow\-files \fR\fB\fIpkgname\fR\fR .Ar pkgname .
.RS 4 The first repository containing the matching
Shows the file list for a binary package .Ar pkgname
\fIpkgname\fR in the pool wins.
by searching it in repository pool\&. The first repository in the pool wins\&. .Em NOTE :
\fBNOTE: if a remote repository is the winner and binary package is not available in \fR\fBcachedir\fR\fB, it will fetch remotely and \fR\fB\fIon\-the\-fly\fR\fR\fB the info\fR\& from target repository. if a remote repository is the winner and binary package is not available in
.RE .Em cachedir ,
.PP it will fetch remotely and
\fBsync\fR .Em on the fly
.RS 4 the info from target repository.
Syncs the package index file for all registered remote repositories\&. The new file will be fetched if local and remote size/mtime do not match\&. .It Sy sync
.RE Syncs the package index file for all registered remote repositories.
.SH "FILES" The index file will be fetched if local and remote size/mtime do not match.
.PP .Sh FILES
\fB/etc/xbps/conf.plist\fR .Bl -tag -width /var/db/xbps/<remoterepodir>/index.plist -compact
.RS 4 .It Pa /etc/xbps/xbps.conf
Default XBPS configuration file\&. Default XBPS configuration file.
.RE .It Pa /var/db/xbps/<remoterepodir>/index.plist
.PP Remote repository package index file.
\fB/etc/xbps/repositories.plist\fR .It Pa /var/cache/xbps
.RS 4 XBPS cache directory for downloaded binary packages.
Default XBPS repositories configuration file\&. .Sh SEE ALSO
.RE .Xr xbps-bin 8 ,
.PP .Xr http://code.google.com/p/xbps
\fB/var/db/xbps/<remoterepodir>/index\&.plist\fR .Sh AUTHORS
.RS 4 .An Juan Romero Pardines <xtraeme@gmail.com>
Remote repository package index file\&. .Sh BUGS
.RE Probably, but I try to make this not happen. Use it under your own
.PP responsability and enjoy your life.
\fB/var/cache/xbps\fR .Pp
.RS 4 Report bugs in http://code.google.com/p/xbps.
xbps
\fIcache\fR
directory for downloaded binary packages\&.
.RE
.SH "BUGS"
.sp
Probably, but I try to make this not happen\&. Use it under your own responsability and enjoy your life\&.
.sp
Report bugs in \fIhttp://code\&.google\&.com/p/xbps\fR\&.
.SH "SEE ALSO"
.sp
xbps\-bin(8)
.sp
The XBPS project: \fIhttp://code\&.google\&.com/p/xbps\fR
.SH "AUTHORS"
.sp
\fBXBPS\fR has been designed and implemented by Juan Romero Pardines <xtraeme@gmail\&.com>\&.