A collection of functions for GNU Bash
Shell M4 Makefile
Switch branches/tags
v2.0.0 mbfl--alpha--1.3--base-0 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--versionfix-4 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--versionfix-3 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--versionfix-2 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--versionfix-1 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--version-0 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--patch-1 marco@rapitore.luna--devel-2004,mbfl--stable--1.2--base-0 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-20 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-19 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-18 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-17 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-16 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-15 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-14 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-13 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-12 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-11 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-10 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-9 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-8 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-7 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-6 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-5 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-4 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-3 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-2 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--patch-1 marco@rapitore.luna--devel-2004,mbfl--stable--1.1--base-0 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-13 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-12 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-11 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-10 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-9 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-8 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-7 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-6 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-5 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-4 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-3 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-2 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--patch-1 marco@rapitore.luna--devel-2004,mbfl--stable--1.0--base-0 marco@rapitore.luna--devel-2004,mbfl--main--0.6--patch-4 marco@rapitore.luna--devel-2004,mbfl--main--0.6--patch-3 marco@rapitore.luna--devel-2004,mbfl--main--0.6--patch-2 marco@rapitore.luna--devel-2004,mbfl--main--0.6--patch-1 marco@rapitore.luna--devel-2004,mbfl--main--0.6--base-0 marco@rapitore.luna--devel-2004,mbfl--main--0.5--patch-1 marco@rapitore.luna--devel-2004,mbfl--main--0.5--base-0 marco@rapitore.luna--devel-2004,mbfl--beta--1.2--base-0 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-11 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-10 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-9 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-8 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-7 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-6 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-5 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-4 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-3 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-2 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--patch-1 marco@rapitore.luna--devel-2004,mbfl--beta--0.7--base-0 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-41 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-40 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-39 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-38 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-37 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-36 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-35 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-34 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-33 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-32 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-31 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-30 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-29 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-28 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-27 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-26 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-25 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-24 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-23 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-22 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-21 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-20 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-19 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-18 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-17 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-16 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-15 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-14 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-13 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-12 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-11 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-10 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-9 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-8 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-7 marco@rapitore.luna--devel-2004,mbfl--alpha--1.2--patch-6
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
examples
meta
src
tests
.gitignore
ANNOUNCE
BUGS
COPYING
INSTALL
Makefile.am
README
TODO.org
autogen.sh
configure.ac
configure.sh
prepare.sh

README

		     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; it needs at least Bash version 4.

   This package makes use of the GNU Autotools.


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

Copyright (c) 2003-2005, 2009-2010, 2012-2014, 2017 Marco Maggi.
<marco.maggi-ipsu@poste.it>

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
----------

To install from  a proper release tarball, after  unpacking the archive,
do this:

    $ cd mbfl-2.2.0
    $ mkdir build
    $ cd build

to inspect the available configuration options:

    $ ../configure --help

then do it:

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

  We want to check the following configuration options:

--with-sudo=/path/to/sudo
   Allows the selection  of the pathname to the  executable "sudo"; this
   pathname   is   hard-coded  in   the   library.    It  defaults   to:
   /usr/bin/sudo.

--with-whoami=/path/to/whoami
   Allows the selection of the pathname to the executable "whoami"; this
   pathname   is   hard-coded  in   the   library.    It  defaults   to:
   /usr/bin/whoami.

  From  a repository  checkout or  snapshot  (the ones  from the  Github
site): we must  install the GNU Autotools (GNU  Automake, GNU Autoconf),
then  we must  first run  the script  "autogen.sh" from  the top  source
directory, to generate the needed files:

    $ cd mbfl
    $ sh autogen.sh

we  should   now  see   the  executable   "configure"  script   and  the
"Makefile.in" file.  From now on everything  is the same as for building
from a proper release tarball, but we have to run the "configure" script
enabling the maintainer mode:

    $ mkdir build
    $ cd build
    $ ../configure --enable-maintainer-mode [options]
    $ make
    $ 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/mbfl

to really do it:

    $ make install DESTDIR=/tmp/mbfl

  Notice that,  when running "make check",  we can select which  test to
run by redefining the "TESTS" variable; for example:

    $ make check TESTS=tests/program.test

will  run  only   the  "program.test"  file  located   in  the  "tests/"
subdirectory of the source tree.

  After building the package, and before  installing it, we can test the
example scripts as follows:

    $ make test-template MFLAGS='--help'

will run "examples/template.sh" with the flags "--help";

    $ make test-template-actions MFLAGS='one green gas --help'

will run "examples/template-actions.sh" with the flags "--help".


4. Usage
--------

Read the documentation in Texinfo format.


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 issue tracker  at the
Github site.


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

The GNU Project software can be found here:

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

the MBFL home page is at:

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

development takes place at:

		 <https://github.com/marcomaggi/mbfl/>

and as backup at:

		<https://bitbucket.org/marcomaggi/mbfl>

proper release tarballs for this package are in the download area
at:

	   <https://bitbucket.org/marcomaggi/mbfl/downloads/>


### end of file
# Local Variables:
# mode: text
# coding: utf-8-unix
# fill-column: 72
# paragraph-start: "*"
# End: