marcomaggi / mbfl

         Marco's BASH Functions Library
         ==============================


Topics
------

  1. Introduction
  2. License
  3. Install
  4. Usage
  A. Credits
  B. Bugs
  C. Resources


1. Introduction
---------------

The MBFL is a collection of shell functions for the GNU Bash
shell.  This  package is  an attempt to  make Bash  a viable
solution for medium sized scripts.


2. License
----------

Copyright (c) 2003-2005, 2009 Marco Maggi.

This is free software; you can redistribute it and/or modify
it under the terms of  the GNU Lesser General Public License
as published by the Free Software Foundation; either version
3.0 of the License, or (at your option) any later version.

This  library is  distributed in  the hope  that it  will be
useful, but  WITHOUT ANY WARRANTY; without  even the implied
warranty  of  MERCHANTABILITY or  FITNESS  FOR A  PARTICULAR
PURPOSE.  See the GNU Lesser General Public License for more
details.

You should  have received a  copy of the GNU  Lesser General
Public License along with this library; if not, write to the
Free Software Foundation, Inc.,  59 Temple Place, Suite 330,
Boston, MA 02111-1307 USA.


3. Install
----------

See  the "README.build"  file  for the  requirements of  the
building infrastructure.  Do this:

    $ cd mbfl-1.3b1
    $ mkdir "=build"
    $ cd "=build"

to inspect the available configuration options:

    $ ../configure --help

then do it:

    $ ../configure [options]
    $ make
    $ make tests
    $ make install

  The Makefile supports  the DESTDIR environment variable to
install files in a  temporary location, example: to see what
will happen:

    $ make -n install DESTDIR=/tmp/marco/mbfl

to really do it:

    $ make install DESTDIR=/tmp/marco/mbfl

  The "make  tests" invocation will run all  the tests under
the "$(srcdir)/tests"  directory.  To select a  set of tests
set the  "TESTMATCH" variable to  a string that  matches the
test names (the  names of the functions in  the test files);
for example, the following runs the getopts tests:

    $ make tests TESTMATCH=getopts

and the following runs only the "getopts-2.4" test:

    $ make tests TESTMATCH=getopts-2.4


4. Usage
--------

Read  the documentation  in Texinfo  format.   Briefely: the
best way  to use  the library is  to include at  runtime the
library file "libmbfl.sh" in the script; this is possible by
installing MBFL  on the  system and using  this code  in the
scripts:

  source "${MBFL_LIBRARY:=$(mbfl-config)}"

the output of the  "mbfl-config" script is the full pathname
of the  library file.  The  value can be  overridden setting
the environment variable "MBFL_LIBRARY".


A. Credits
----------

The  stuff was  written  by Marco  Maggi.   If this  package
exists it's because of the  great GNU software tools that he
uses all the time.


B. Bugs
-------

Bug  reports  are  appreciated:   You  should  use  the  bug
reporting interface at the GNA! site.


C. Resources
------------

The GNU Project software can be found here:

       <http://www.gnu.org/>

the MBFL home page is at:

    <http://marcomaggi.github.com/mbfl.html>

the latest version of MBFL should be found here:

      <http://gna.org/projects/mbfl/>

development takes place at:

      <http://github.com/marcomaggi/mbfl/tree/master>

the Freshmeat page is:

      <http://freshmeat.net/projects/mbfl>


### end of file
# Local Variables:
# mode: text
# End: