###############################################################################
## Copyright (c) 2006 - Noah at FocusHacks dot com                           ##
## This is freely distributable software. If you like it, send me an e-mail. ##
###############################################################################

OpenBSD pkgscripts

###############################################################################

FEATURES:
* Relies only on bourne shell and lynx, both of which are installed by default
  on modern versions of OpenBSD

* Automatically gets packages based on architecture (i386, sparc64, etc) and
  Kernel version number (3.7, 3.8, etc).  No configuration needed.

* Provides a very easy way to install binary packages without much hassle.

* Automatically downloads the package and dependencies from OpenBSD's website
  (thanks to pkg_add's own functionality)



INSTALLATION:
* Unpack obsd_pkgscripts-<version>.tar.gz

* Adding ~/pkgscripts to your PATH in your .profile or .bash_profile 
  is recommended.  pkg_get uses sudo during the pkg_add phase, so you can 
  (and should) run pkgscripts as a normal user.  Optionally, you may move the
  scripts to another directory in your own path (such as ~/bin or ~/scripts).
  Copying these scripts to a world-wide path (such as /usr/local/bin) is *not*
  recommended!

* run pkg_update.sh.  
  This will make a directory and fetch the appropriate index file from the
  main OpenBSD ftp site.  If you wish to use a different mirror, you must edit
  pkg_update.sh and pkg_get.sh by hand in this first version of obsd_pkgscripts.



USAGE:

pkg_update.sh			No arguments needed.  Run periodically to keep
				your package list fresh.  You may put it in
				your personal crontab.

pkg_scan.sh <partial name>	This simply greps through the index looking
				for a matching package name.  For example,
				"pkg_scan.sh bash" would return a list of
				packages containing the word "bash", which
				would include all the binary bash versions
				that are available for download.  Good for
				checking to see what version number is in the
				package tree for a given package.

pkg_get.sh <full/partial name> 	This checks to make sure only one package
				matches the request string.  If more than one
				package is found, it lists all matches.  If
				only one package is found, it downloads and
				installs the package and any dependencies that
				are needed (if found).  Relies HEAVILY on
				built-in magic of pkg_add(8) which is in it's
				own right quite intelligent.



BUGS:
Please report all bugs to Noah at FocusHacks dot com.



TODO: 
Add a configuration file for mirror selection.



HISTORY:
03/30/2006: Documentation added, and obsd_pkgscripts-0.99 released.
01/30/2006: pkgscripts edited to be architecture and release version independent
03/??/2005: pkg_update added to fetch index.txt file
??/??/2004: Initial pkg_get.sh created.  index.txt fetched by hand.