Remove asciidoc build dependency, use troff manpages directly.

This commit is contained in:
Juan RP
2010-05-03 21:50:34 +02:00
parent 361a7afa29
commit 1b44e18b35
7 changed files with 509 additions and 358 deletions

169
bin/xbps-repo/xbps-repo.8 Normal file
View File

@@ -0,0 +1,169 @@
'\" t
.\" Title: xbps-repo
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 05/03/2010
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "XBPS\-REPO" "8" "05/03/2010" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
xbps-repo \- XBPS command for binary package repositories
.SH "SYNOPSIS"
.sp
\fBxbps\-repo\fR [\fIoptions\fR] \fItarget\fR [\fIarguments\fR]
.SH "DESCRIPTION"
.sp
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, add or remove local and remote repositories, search for packages and show information about a binary package in repository pool\&.
.SH "OPTIONS"
.PP
\fB\-c\fR \fIcachedir\fR
.RS 4
Sets the
\fIcache\fR
directory to store downloaded binary packages from remote repositories\&. By default it\(cqs set to
\fI/var/cache/xbps\fR
and it\(cqs always relative to the
\fIroot\fR
directory\&. So if you use a
\fIrootdir\fR
of
\fI/blah\fR, it will become
\fI/blah/cachedir\fR\&.
.RE
.PP
\fB\-r\fR \fIrootdir\fR
.RS 4
Sets the
\fIroot\fR
directory\&. By default the root directory is set to
\fI/\fR\&. Please note that the database directory is always set to
\fI/var/db/xbps\fR
independently of
\fIrootdir\fR\&. So if you use a
\fIrootdir\fR
of
\fI/blah\fR, metadata stuff will go into
\fI/blah/var/db/xbps\fR\&.
.RE
.PP
\fB\-V\fR
.RS 4
Shows the current XBPS release version (library and code)\&.
.RE
.SH "TARGETS"
.sp
Please note that all targets are \fBcase insensitive\fR\&.
.PP
\fBadd\fR \fIURI\fR
.RS 4
Adds a repository as specified in
\fIURI\fR
to the repository pool\&. Local (by specifying a
\fBdirectory\fR) and remote (by specifiying an
\fBHTTP/HTTPS/FTP URL\fR) repositories can be specified\&.
.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 available in the index\&. If a newer package is available, the for old package file will be removed automatically\&.
.RE
.PP
\fBlist\fR
.RS 4
Lists all currently registered repositories in repository pool\&.
.RE
.PP
\fBremove\fR \fIURI\fR
.RS 4
Removes a repository from repository pool as specified by the
\fIURI\fR
argument\&. You have to use the same
\fIURI\fR
that was used in the
\fBadd\fR
target\&.
.RE
.PP
\fBsearch\fR \fIpattern\fR
.RS 4
Search for packages containing the shell
\fIpattern\fR
(see fnmatch(3)) in its
\fBpkgname\fR
or
\fBdescription\fR
values in repository pool\&.
.RE
.PP
\fBshow \fR\fB\fIpkgname\fR\fR
.RS 4
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\&.
\fBNOTE: if a remote repository is the winner and binary package is not available in cachedir, it will fetch remotely and \fR\fB\fIon\-the\-fly\fR\fR\fB the info\fR\&.
.RE
.PP
\fBshow\-deps \fR\fB\fIpkgname\fR\fR
.RS 4
Shows run time dependencies for binary package
\fIpkgname\fR\&. The first repository in the pool wins\&.
.RE
.PP
\fBshow\-files \fR\fB\fIpkgname\fR\fR
.RS 4
Shows the file list for a binary package
\fIpkgname\fR
by searching it in repository pool\&. The first repository in the pool wins\&.
\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\&.
.RE
.PP
\fBsync\fR
.RS 4
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\&.
.RE
.SH "FILES"
.PP
\fB/var/db/xbps/repositories\&.plist\fR
.RS 4
Registered repository list\&.
.RE
.PP
\fB/var/db/xbps/<remoterepodir>/pkg\-index\&.plist\fR
.RS 4
Remote repository package index file\&.
.RE
.PP
\fB/var/cache/xbps\fR
.RS 4
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), xbps\-src(8)
.sp
The XBPS project: \fIhttp://code\&.google\&.com/p/xbps\fR
.sp
To build binary packages, the xbps\-src(8) shell script is the command designed for this task\&. This must be retrieved from a Mercurial repository, available at \fIhttp://xbps\-src\&.xbps\&.googlecode\&.com/hg/\fR\&.
.SH "AUTHORS"
.sp
The \fBXBPS binary package system\fR has been designed and implemented by Juan Romero Pardines <xtraeme@gmail\&.com>\&.

View File

@@ -1,125 +0,0 @@
XBPS-REPO(8)
===========
NAME
----
xbps-repo - XBPS command for binary package repositories
SYNOPSIS
--------
*xbps-repo* ['options'] 'target' ['arguments']
DESCRIPTION
-----------
The xbps-repo(8) command is used to handle local or remote binary
package repositories in the *XBPS binary package system*.
You can use it to create a package index for a local repository,
add or remove local and remote repositories, search for packages
and show information about a binary package in repository pool.
OPTIONS
-------
*-c* 'cachedir'::
Sets the 'cache' directory to store downloaded binary packages
from remote repositories.
By default it's set to '/var/cache/xbps' and it's always relative
to the 'root' directory. So if you use a 'rootdir' of '/blah',
it will become '/blah/cachedir'.
*-r* 'rootdir'::
Sets the 'root' directory. By default the root directory is
set to '/'. Please note that the database directory is always
set to '/var/db/xbps' independently of 'rootdir'. So if you
use a 'rootdir' of '/blah', metadata stuff will go into
'/blah/var/db/xbps'.
*-V*::
Shows the current XBPS release version (library and code).
TARGETS
-------
Please note that all targets are *case insensitive*.
*add* 'URI'::
Adds a repository as specified in 'URI' to the repository pool.
Local (by specifying a *directory*) and remote (by specifiying an
*HTTP/HTTPS/FTP URL*) repositories can be specified.
*genindex* '/path/to/local/repo'::
Generates a package index for a local repository as specified in
its argument. It will look for archives with *.xbps* 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
for old package file will be removed automatically.
*list*::
Lists all currently registered repositories in repository pool.
*remove* 'URI'::
Removes a repository from repository pool as specified by the
'URI' argument. You have to use the same 'URI' that was used
in the *add* target.
*search* 'pattern'::
Search for packages containing the shell 'pattern' (see fnmatch(3)) in
its *pkgname* or *description* values in repository pool.
*show 'pkgname'*::
Shows information about binary package 'pkgname'. This will print
the size it takes in filesystem, description, maintainer, architecture
and other information. The first repository in the pool wins. *NOTE:
if a remote repository is the winner and binary package is not available
in cachedir, it will fetch remotely and __on-the-fly__ the info*.
*show-deps 'pkgname'*::
Shows run time dependencies for binary package 'pkgname'. The first
repository in the pool wins.
*show-files 'pkgname'*::
Shows the file list for a binary package 'pkgname' by searching it
in repository pool. The first repository in the pool wins. *NOTE:
if a remote repository is the winner and binary package is not
available in `cachedir`, it will fetch remotely and __on-the-fly__
the info*.
*sync*::
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.
FILES
-----
*/var/db/xbps/repositories.plist*:: Registered repository list.
+
*/var/db/xbps/<remoterepodir>/pkg-index.plist*:: Remote repository package index file.
+
*/var/cache/xbps*:: xbps _cache_ directory for downloaded binary packages.
+
BUGS
----
Probably, but I try to make this not happen. Use it under your own
responsability and enjoy your life.
Report bugs in '<http://code.google.com/p/xbps>'.
SEE ALSO
--------
link:xbps-bin.8.html[xbps-bin(8)], link:xbps-src.8.html[xbps-src(8)]
The XBPS project: '<http://code.google.com/p/xbps>'
To build binary packages, the xbps-src(8) shell script is the command
designed for this task. This must be retrieved from a Mercurial repository,
available at '<http://xbps-src.xbps.googlecode.com/hg/>'.
AUTHORS
-------
The *XBPS binary package system* has been designed and implemented by
Juan Romero Pardines <xtraeme@gmail.com>.