Home

Welcome to the wiki of the piwi-bash-library.

For a quick access, you can read the documentation, license and the manpage of last version of the library at:

• DOCUMENTATION.md
• MANPAGE.md
• LICENSE.

For more information about library installation and first usage, please see the following documentations:

• Library installation explains how to install the library
• Library usage explains how to use the library
• Global documentation is the complete documentation of library's variables and methods.

For more information about how to use the library in your scripts, please see the following documentations:

• Scripts usage explains how to use the Common options handled by the library ; the "common options" are defined according to the best practices and usages in *NIX commands
• Help & Manpages explains how to create information strings and manuals for your scripts ; a special Versioning & Licensing documentation explains the usage of "in-script"'s variables to correctly name and versioned your scripts
• Scripts installation describes the library's installation wizard you can use for your scripts
• finally, the Development page explains the rules to follow to write well-coded and well-documented scripts.

Some test scripts (not required to use the library) are defined in the samples/ directory.

For a full example, you can begin running the samples/test.sh script:

cd path/to/library/
./samples/test.sh
# or, to get help:
./samples/test.sh --help

To build your own scripts using the library, use a copy of samples/dev.sh model:

cp path/to/library/samples/dev.sh path/to/your/script.sh

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the documentation are to be interpreted as described in RFC 2119.

Developers can refer to the following references websites:

• Bash Reference Manual: http://www.gnu.org/software/bash/manual/bashref.html
• Bash Guide for Beginners: http://www.tldp.org/LDP/Bash-Beginners-Guide/html/Bash-Beginners-Guide.html
• Advanced Bash-Scripting Guide: http://www.tldp.org/LDP/abs/html/abs-guide.html
• GNU coding standards: http://www.gnu.org/prep/standards/standards.html