	OBPkg - an C based package manager for OpenBSD
	----------------------------------------------

	       (c) 2006 Steffen Wendzel
	   cdp (at) doomed-reality (dot) org
	     http://cdp.doomed-reality.org



TOC.
 - ABOUT
 - DOCUMENTATION
 - FAQ

-------------------------------------------------------------------
ABOUT.

OBPkg is an front-end for installing ports and packages on OpenBSD
systems that also supports unofficial package sources. You can (de)in-
stall
	* local Ports of /usr/ports
	* official Packages from FTP (e.g. ftp.openbsd.org)
	* universal (inofficial) Packages from (private) FTP
	* Packages from local directories (e.g. mounted CD-ROM)

-------------------------------------------------------------------
INSTALLATION.

Run these commands (excluding 'make') as root:
(configure needs root access to detect /usr/ports)

$ ./configure
$ make
$ make install
$ make non-port-install

Install the sample configuration file obpkg.conf in /etc

$ cp obpkg.conf /etc/

To start it run /usr/local/sbin/obpkg (as root).

-------------------------------------------------------------------

DOCUMENTATION.

OBPkg is easy to use. You can setup your configuration in the config
file /etc/obpkg.conf. You specify all package sources in this file.

* To use an local directory (e.g. from your OpenBSD CD-ROM or NFS),
  use the pkg_local keyword followed by the path. For Example:

  pkg_local=/mnt/cdrom/packages

* To mount a FTP directory use official_pkg_ftp for official package
  mirrors and universe_pkg_ftp for inofficial package mirrors.
  The syntax is keyword=Host,Path,Username,Password
  NOTE: Username & Password take no effekt. Since pkg_add only
	supports anonymous FTP, OBPkg does not support it too.
  
  For example, if you want to add the OpenBSD-3.9 packages for i386,
  use:

  official_pkg_ftp=ftp.openbsd.org,/pub/OpenBSD/3.9/packages/i386,ftp,nobody

  Here is another example:
  
  universe_pkg_ftp=my.great.server.dyndns.org,/pkg,ftp,ftp

NOTE: If you (de)install a package it will be still marked as
      (de)installed until you select the package category again.

-------------------------------------------------------------------
FAQ.

F: Why do we need this?
A: I don't say, that you need this tool. It just makes your package
   management easier. If you are unskilled in package administration under
   OpenBSD and someone else installs this tool for you, it should be at
   least a good thing.

F: Why do I need an installed ports archive?
A: -

F: What means 'universe'.
A: 'universe' are packages not made by the OpenBSD developers. I
   stole this word from the Ubuntu package system 'Synaptic'.

