README

-*- coding: utf-8-unix -*-

		    Marco's Bash Functions Libraries
		    ================================


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

  This package  relies on the  facilities of  the packages: GNU  m4, GNU
Coreutils, sudo.

  This package makes use of the GNU Autotools.


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

Copyright (c)  2003-2005, 2009-2010,  2012-2014, 2017-2018,  2020, 2023,
2024 Marco Maggi <mrc.mgg@gmail.com>.  All rights reserved.

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",
   which is meant to be the program from the package GNU Coreutils; this
   pathname is hard-coded in the library.  It defaults to: /bin/whoami.

--with-id=/path/to/id
   Allows the selection of the pathname to the executable "id", which is
   meant to be the program from the package GNU Coreutils; this pathname
   is hard-coded in the library.  It defaults to: /bin/id.

  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

  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" selection  the action "one green
gas" and appending 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.

  A  lot of  ideas  were  recycled from  the  "Revised^6  Report on  the
Algorithmic Language Scheme" (R6RS):

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


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

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
# fill-column: 72
# paragraph-start: "*"
# End: