xbps/doc
Juan RP db58e48822 Added xbps-bin(8) and xbps-repo(8) manpages in asciidoc format.
That means that asciidoc is required to build/install XBPS.

--HG--
extra : convert_revision : xtraeme%40gmail.com-20091028153222-ljgdfqqe1ea74xs7
2009-10-28 16:32:22 +01:00
..
BINPKG_INFO doc/BINPKG_INFO: mention that binary packages might be compressed in 2009-10-20 14:25:51 +02:00
BINPKG_REPOSITORY Implemented support for working with remote repositories. 2009-10-27 01:46:00 +01:00
README Added xbps-bin(8) and xbps-repo(8) manpages in asciidoc format. 2009-10-28 16:32:22 +01:00
TODO Remove xbps-src and its associated code. This is required for the 2009-10-18 11:15:39 +02:00

-----------------------------------------------------------------------------
 WHAT IS IT?
-----------------------------------------------------------------------------

xbps - xtraeme's binary package ystem.

xbps is a new binary package system, taken ideas from other free available
implementations, such as dpkg/apt, RPM, pacman and others. Metadata handling
as package databases are handled by proplib. Multiple compression formats
are supported in binary packages thanks to libarchive.

xbps has been designed for Linux, and for the moment I'm not interested to
make it work on any other random OS. xbps is the base to create a basic
Linux system.

-----------------------------------------------------------------------------
 REQUIREMENTS
-----------------------------------------------------------------------------

xbps uses proplib, a property container object library and it's almost the
same one available for NetBSD. Be sure to have it installed before using
xbps. You can get it at:

http://code.google.com/p/portableproplib/

I'm also the human maintaining the portable proplib package. I'd suggest you
to install it into /usr/local to avoid issues with your distribution packages.

To build the xbps utils, you'll need:

	* asciidoc (to build the manpages)
	* acl (devel pkg with static lib)
	* zlib (devel pkg with static lib)
	* bzip2 (devel pkg with static lib)
	* xz (devel pkg with static lib)
	* libarchive (devel pkg with static lib, all features built in)
	* proplib (devel pkg with static lib, see above)
	* openssl (devel pkg with static lib)

------------------------------------------------------------------------------
 HOW TO USE IT
------------------------------------------------------------------------------

Before using xbps, some required utilities need to be built and installed
into $(PREFIX); by default they are installed into /usr/local.
You can do this by issuing "make" and "make install" as root in the top
level directory. See the REQUIREMENTS section above for required packages.

To build binary packages, you need xbps-src. It's stored in a public GIT
repository located at:

	http://repo.or.cz/w/xbps.git

For information about binary packages, see the BINPKG_INFO file.

------------------------------------------------------------------------------
	Juan Romero Pardines <xtraeme@gmail.com>