From 313af0413f261cf952966a25365cd38815da7c70 Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Mon, 10 Mar 2025 21:14:01 +0100
Subject: [PATCH 1/7] docs: Update README.md

Add `lib_gnucompat` library to description.
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 9a7b0af..5bcc33c 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,20 @@ ${COLOR_YELLOW}This is yellow text.${COLOR_RESET}
 EOF
 ```
 
+### lib_gnucompat
+
+Utility functions and dynamically defined constants for scripts preferring
+(or requiring) GNU compatible tooling. Meant especially for systems such as
+MacOS, to prefer GNU-Tools like `coreutils` by preferring prefixed tools like
+`gsed`, `gawk`.
+
+**Usage Examples**:
+
+```bash
+echo "Hello, World!" | \
+  "${SED}" --regexp-extended "s/World/GNU/g"
+```
+
 ### lib_init
 
 Apply general recommended strictness settings for Bash scripts. Includes support

From 915338813de65acb4d73ec4acbfb7c9bc5b563c4 Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:00:15 +0100
Subject: [PATCH 2/7] refactor(docs): Move Header Image

Moving Header Image to docs/ folder, so that we can reuse it for the
generated documentation.
---
 README.md                                        |   2 +-
 {img => docs/img}/LibBashGitHubSocialPreview.jpg | Bin
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename {img => docs/img}/LibBashGitHubSocialPreview.jpg (100%)

diff --git a/README.md b/README.md
index 5bcc33c..a2a3564 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # lib-bash – Bash Libraries
 
-![Lib-Bash Decorative Image](img/LibBashGitHubSocialPreview.jpg)
+![Lib-Bash Decorative Image](docs/img/LibBashGitHubSocialPreview.jpg)
 
 A set of libraries to use from within your Bash scripts.
 
diff --git a/img/LibBashGitHubSocialPreview.jpg b/docs/img/LibBashGitHubSocialPreview.jpg
similarity index 100%
rename from img/LibBashGitHubSocialPreview.jpg
rename to docs/img/LibBashGitHubSocialPreview.jpg

From 9be6840015a052a958596e28da86cf687888c81a Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:01:43 +0100
Subject: [PATCH 3/7] ci(github): Create Scripts to Generate Docs

Generate (rather simple) scripts to generate documentation from the
library-files.
---
 bin/doc-single.sh | 51 +++++++++++++++++++++++++++++++++++++++++++++++
 bin/docs.sh       | 42 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 93 insertions(+)
 create mode 100755 bin/doc-single.sh
 create mode 100755 bin/docs.sh

diff --git a/bin/doc-single.sh b/bin/doc-single.sh
new file mode 100755
index 0000000..49c759f
--- /dev/null
+++ b/bin/doc-single.sh
@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+###
+### Script to generate Markdown documentation for a single script.
+###
+### In contrast to more sophisticated approaches, this script just generates
+### the Markdown from lines starting with three hashes (###) and the following
+### line.
+###
+### Usage:
+###
+### ```bash
+### doc-single.sh <script> > <output>
+### ```
+###
+
+set -o errexit  # abort on nonzero exit status
+set -o nounset  # abort on unbound variable
+set -o pipefail # don't hide errors within pipes
+
+function main() {
+  local script="${1?Missing script}"
+  local line
+  # Boolean flag, to signal, if the previous line was an empty documentation
+  # line. This is used to prevent multiple empty lines in the output.
+  local empty=0
+
+  while IFS= read -r line; do
+    if [[ "${line}" =~ ^"###" ]]; then
+      local content="${line:3}"
+      # If first char is a space, remove it. Do nothing, especially if
+      # the line is empty. Do not remove more than once space, as it might
+      # be intentional.
+      content="${content#"${content%%[![:space:]]*}"}"
+
+      if [[ -n "${content}" ]]; then
+        # If the previous line was an empty line, print an empty line to
+        # separate the sections.
+        if ((empty == 1)); then
+          echo
+        fi
+        empty=0
+        echo "${content}"
+      else
+        # If the line is empty, set the empty flag to true.
+        empty=1
+      fi
+    fi
+  done <"${script}"
+}
+
+main "${@}"
diff --git a/bin/docs.sh b/bin/docs.sh
new file mode 100755
index 0000000..57e605f
--- /dev/null
+++ b/bin/docs.sh
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+###
+### Script to generate Markdown documentation for all library files.
+###
+### Invokes `doc-single.sh` for each library file `lib_*.sh`. The output is
+### written to `docs/lib`. Before processing each library file, the target
+### directory is cleared and ensures that it exists.
+###
+### Usage:
+###
+### ```bash
+### doc.sh
+### ```
+###
+
+set -o errexit  # abort on nonzero exit status
+set -o nounset  # abort on unbound variable
+set -o pipefail # don't hide errors within pipes
+
+MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(dirname "${MY_PATH}")"
+readonly MY_PATH
+readonly SCRIPT_DIR
+readonly DOC_SINGLE="${SCRIPT_DIR}/doc-single.sh"
+readonly LIB_BASH_DIR="${SCRIPT_DIR}/.."
+readonly LIB_DOCS_DIR="${SCRIPT_DIR}/../docs/lib"
+
+function main() {
+  rm -rf "${LIB_DOCS_DIR}"
+  mkdir -p "${LIB_DOCS_DIR}"
+
+  local lib
+
+  for lib in "${LIB_BASH_DIR}"/lib_*.sh; do
+    local lib_name
+    lib_name="$(basename "${lib}")"
+    local target="${LIB_DOCS_DIR}/${lib_name%.sh}.md"
+    "${DOC_SINGLE}" "${lib}" >"${target}"
+  done
+}
+
+main "${@}"

From ca1f62e1edec1b67c613d7ab07014205c5280f11 Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:02:41 +0100
Subject: [PATCH 4/7] docs(lib): Align and Extend Documentation

Align to a common documentation pattern and add documentation where
missing.
---
 lib_console.sh    | 229 ++++++++++++++++++++++++++++++----------------
 lib_gnucompat.sh  |  79 +++++++++++-----
 lib_init.sh       |  35 +++++--
 lib_scriptinfo.sh |  37 ++++++--
 4 files changed, 260 insertions(+), 120 deletions(-)

diff --git a/lib_console.sh b/lib_console.sh
index fb3dba3..2d09870 100644
--- a/lib_console.sh
+++ b/lib_console.sh
@@ -1,13 +1,22 @@
 #!/usr/bin/env bash
+# ==============================================================================
+###
+### # lib_console.sh
 ###
 ### Include for console support.
 ###
-### Usage:
+### **Usage**:
 ###
-###   SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-###   readonly SCRIPT_DIR
-###   source "${SCRIPT_DIR}/lib-bash/lib_console.sh"
+### ```bash
+### MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+### SCRIPT_DIR="$(dirname "${MY_PATH}")"
+### readonly MY_PATH
+### readonly SCRIPT_DIR
+### readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+### source "${LIB_BASH_DIR}/lib_console.sh"
+### ```
 ###
+# ==============================================================================
 
 # Guard variable to prevent multiple imports
 if [[ -n "${LIB_CONSOLE_SH_INCLUDED:-}" ]]; then
@@ -26,36 +35,69 @@ readonly LIB_CONSOLE_DIR
 source "${LIB_CONSOLE_DIR}/lib_init.sh"
 
 # ------------------------------------------------------------------------------
-# Constants
+###
+### ## Color Constants
+###
 # ------------------------------------------------------------------------------
 
-# Foreground Colors
+###
+### ### Foreground Colors
+###
+
+### * `COLOR_RESET`: Reset the color.
 readonly COLOR_RESET="\033[0m"
+### * `COLOR_BLACK`: Black color.
 readonly COLOR_BLACK="\033[0;30m"
+### * `COLOR_RED`: Red color.
 readonly COLOR_RED="\033[0;31m"
+### * `COLOR_GREEN`: Green color.
 readonly COLOR_GREEN="\033[0;32m"
+### * `COLOR_YELLOW`: Yellow color.
 readonly COLOR_YELLOW="\033[0;33m"
+### * `COLOR_BLUE`: Blue color.
 readonly COLOR_BLUE="\033[0;34m"
+### * `COLOR_MAGENTA`: Magenta color.
 readonly COLOR_MAGENTA="\033[0;35m"
+### * `COLOR_CYAN`: Cyan color.
 readonly COLOR_CYAN="\033[0;36m"
+### * `COLOR_WHITE`: White color.
 readonly COLOR_WHITE="\033[0;37m"
+### * `COLOR_GRAY`: Gray color.
 readonly COLOR_GRAY="\033[1;30m"
+### * `COLOR_LIGHT_RED`: Light red color.
 readonly COLOR_LIGHT_RED="\033[1;31m"
+### * `COLOR_LIGHT_GREEN`: Light green color.
 readonly COLOR_LIGHT_GREEN="\033[1;32m"
+### * `COLOR_LIGHT_YELLOW`: Light yellow color.
 readonly COLOR_LIGHT_YELLOW="\033[1;33m"
+### * `COLOR_LIGHT_BLUE`: Light blue color.
 readonly COLOR_LIGHT_BLUE="\033[1;34m"
+### * `COLOR_LIGHT_MAGENTA`: Light magenta color.
 readonly COLOR_LIGHT_MAGENTA="\033[1;35m"
+### * `COLOR_LIGHT_CYAN`: Light cyan color.
 readonly COLOR_LIGHT_CYAN="\033[1;36m"
+### * `COLOR_LIGHT_WHITE`: Light white color.
 readonly COLOR_LIGHT_WHITE="\033[1;37m"
 
-# Background Colors
+###
+### ### Background Colors
+###
+
+### * `COLOR_BG_BLACK`: Black background color.
 readonly COLOR_BG_BLACK="\033[40m"
+### * `COLOR_BG_RED`: Red background color.
 readonly COLOR_BG_RED="\033[41m"
+### * `COLOR_BG_GREEN`: Green background color.
 readonly COLOR_BG_GREEN="\033[42m"
+### * `COLOR_BG_YELLOW`: Yellow background color.
 readonly COLOR_BG_YELLOW="\033[43m"
+### * `COLOR_BG_BLUE`: Blue background color.
 readonly COLOR_BG_BLUE="\033[44m"
+### * `COLOR_BG_MAGENTA`: Magenta background color.
 readonly COLOR_BG_MAGENTA="\033[45m"
+### * `COLOR_BG_CYAN`: Cyan background color.
 readonly COLOR_BG_CYAN="\033[46m"
+### * `COLOR_BG_WHITE`: White background color.
 readonly COLOR_BG_WHITE="\033[47m"
 
 # Export Color and Color Background Constants
@@ -88,12 +130,14 @@ export COLOR_BG_CYAN
 export COLOR_BG_WHITE
 
 # ------------------------------------------------------------------------------
-# Logging
-#
-# All logging functions to output information to STDERR. STDERR is preferred,
-# as it is not affected by the output redirection of the script, thus, the
-# desired standard output can be redirected to a file or another command.
-#
+###
+### ## Logging
+###
+### All logging functions to output information to STDERR. STDERR is preferred,
+### as it is not affected by the output redirection of the script, thus, the
+### desired standard output can be redirected to a file or another command.
+###
+# ------------------------------------------------------------------------------
 # References:
 #   - https://gkarthiks.github.io/quick-commands-cheat-sheet/bash_command.html
 #   - https://gist.github.com/JBlond/2fea43a3049b38287e5e9cefc87b2124
@@ -130,20 +174,24 @@ function _log() {
 }
 
 # ------------------------------------------------------------------------------
-# Output debug message.
-#
-# The debug function is used to output debug information. It is only printed if
-# the DEBUG variable is set to a value greater than 0.
-#
-# If the standard output supports color, the debug information is printed in
-# gray color. Otherwise, the debug information is printed without color.
-#
-# Arguments:
-#   The message to print.
-# Returns:
-#   None
-# Output:
-#   The message is printed to STDERR.
+###
+### ### log_debug
+###
+### Output debug message.
+###
+### The function is used to output debug information. It is only printed
+### if the `DEBUG` variable is set to a value greater than 0 (zero).
+###
+### If the standard output supports color, the debug information is printed in
+### gray color. Otherwise, the debug information is printed without color.
+###
+### **Usage**:
+###
+### ```bash
+### log_debug "Only show if DEBUG=1 (or more)"
+### grep "pattern" file.txt | log_debug
+### ```
+###
 # ------------------------------------------------------------------------------
 function log_debug() {
   if ((DEBUG > 0)); then
@@ -162,34 +210,42 @@ function log_debug() {
 }
 
 # ------------------------------------------------------------------------------
-# Output information message.
-#
-# The info function is used to output information messages. No extra color is
-# used for the information message.
-#
-# Arguments:
-#   The message to print.
-# Returns:
-#   None
-# Output:
-#   The message is printed to STDERR.
+###
+### ### log_info
+###
+### Output information message.
+###
+### The function is used to output information messages. No extra color is
+### used for the information message.
+###
+### **Usage**:
+###
+### ```bash
+### log_info "An informational message."
+### grep "pattern" file.txt | log_info
+### ```
+###
 # ------------------------------------------------------------------------------
 function log_info() {
   _log "[INFO] " "" "$@"
 }
 
 # ------------------------------------------------------------------------------
-# Output warning message.
-#
-# The warning function is used to output warning messages. The warning message
-# is printed in yellow color.
-#
-# Arguments:
-#   The message to print.
-# Returns:
-#   None
-# Output:
-#   The message is printed to STDERR.
+###
+### ### log_warn
+###
+### Output warning message.
+###
+### The function is used to output warning messages. The warning message
+### is printed in yellow color.
+###
+### **Usage**:
+###
+### ```bash
+### log_warn "A warning notice."
+### grep "pattern" file.txt | log_warn
+### ```
+###
 # ------------------------------------------------------------------------------
 function log_warn() {
   if [[ -t 2 ]]; then
@@ -200,17 +256,21 @@ function log_warn() {
 }
 
 # ------------------------------------------------------------------------------
-# Output error message.
-#
-# The error function is used to output error messages. The error message is
-# printed in red color.
-#
-# Arguments:
-#   The message to print.
-# Returns:
-#   None
-# Output:
-#   The message is printed to STDERR.
+###
+### ### log_error
+###
+### Output error message.
+###
+### The function is used to output error messages. The error message is
+### printed in red color.
+###
+### **Usage**:
+###
+### ```bash
+### log_error "An error."
+### grep "pattern" file.txt | log_error
+### ```
+###
 # ------------------------------------------------------------------------------
 function log_error() {
   if [[ -t 2 ]]; then
@@ -221,17 +281,21 @@ function log_error() {
 }
 
 # ------------------------------------------------------------------------------
-# Output error message.
-#
-# The error function is used to output error messages. The error message is
-# printed with dark red background and bright yellow color.
-#
-# Arguments:
-#   The message to print.
-# Returns:
-#   None
-# Output:
-#   The message is printed to STDERR.
+###
+### ### log_fatal
+###
+### Output a fatal error message.
+###
+### The function is used to output error messages. The error message is
+### printed with dark red background and bright yellow color.
+###
+### **Usage**:
+###
+### ```bash
+### log_fatal "A fatal error."
+### grep "pattern" file.txt | log_fatal
+### ```
+###
 # ------------------------------------------------------------------------------
 function log_fatal() {
   if [[ -t 2 ]]; then
@@ -242,14 +306,21 @@ function log_fatal() {
 }
 
 # ------------------------------------------------------------------------------
-# Alternative to `cat` that also processes colored input.
-#
-# Arguments:
-#   None
-# Returns:
-#   None
-# Output:
-#   The colored input is printed to STDOUT.
+###
+### ### ccat
+###
+### Alternative to `cat` that also processes colored input.
+###
+### **Usage**:
+###
+### ```bash
+### ccat <<EOF
+### ${COLOR_RED}This is red text.${COLOR_RESET}
+### ${COLOR_YELLOW}This is yellow text.${COLOR_RESET}
+### EOF
+### ```
+###
+# ------------------------------------------------------------------------------
 function ccat() {
   local content="${1:-$(</dev/stdin)}"
   echo -e "${content}"
diff --git a/lib_gnucompat.sh b/lib_gnucompat.sh
index 5c36813..54edad1 100644
--- a/lib_gnucompat.sh
+++ b/lib_gnucompat.sh
@@ -1,16 +1,23 @@
 #!/usr/bin/env bash
+# ==============================================================================
 ###
-### GNUTools Compatibility Layer
+### # GNU-Tools Compatibility Layer
 ###
 ### This script provides compatibility functions for GNU tools on non-GNU
 ### systems, such as macOS.
 ###
-### Usage:
+### **Usage**:
 ###
-###   SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-###   readonly SCRIPT_DIR
-###   source "${SCRIPT_DIR}/lib-bash/lib_gnucompat.sh"
+### ```bash
+### MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+### SCRIPT_DIR="$(dirname "${MY_PATH}")"
+### readonly MY_PATH
+### readonly SCRIPT_DIR
+### readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+### source "${LIB_BASH_DIR}/lib_gnucompat.sh"
+### ```
 ###
+# ==============================================================================
 
 # Guard variable to prevent multiple imports
 if [[ -n "${LIB_GNUCOMPAT_SH_INCLUDED:-}" ]]; then
@@ -26,13 +33,15 @@ readonly LIB_GNUCOMPAT_DIR
 source "${LIB_GNUCOMPAT_DIR}/lib_init.sh"
 
 # ------------------------------------------------------------------------------
-# Compatibility Functions
-#
-# These functions will return the corresponding GNU tool on non-GNU systems.
-# Such as `gsed` on macOS, which is the GNU version of `sed`.
+###
+### ## Tools Aliases
+###
+### These functions will return the corresponding GNU-tool on non-GNU systems,
+### if available. Such as `gsed` on macOS, which is the GNU version of `sed`.
+###
 # ------------------------------------------------------------------------------
 
-# GNU `sed` command
+### * `SED`: GNU `sed` command
 if command -v gsed &>/dev/null; then
   readonly SED="gsed"
 else
@@ -40,7 +49,7 @@ else
 fi
 export SED
 
-# GNU `awk` command
+### * `AWK`: GNU `awk` command
 if command -v gawk &>/dev/null; then
   readonly AWK="gawk"
 else
@@ -48,7 +57,7 @@ else
 fi
 export AWK
 
-# GNU `grep` command
+### * `GREP`: GNU `grep` command
 if command -v ggrep &>/dev/null; then
   readonly GREP="ggrep"
 else
@@ -56,7 +65,7 @@ else
 fi
 export GREP
 
-# GNU `find` command
+### * `FIND`: GNU `find` command
 if command -v gfind &>/dev/null; then
   readonly FIND="gfind"
 else
@@ -64,7 +73,7 @@ else
 fi
 export FIND
 
-# GNU `sort` command
+### * `SORT`: GNU `sort` command
 if command -v gsort &>/dev/null; then
   readonly SORT="gsort"
 else
@@ -72,7 +81,7 @@ else
 fi
 export SORT
 
-# GNU `tar` command
+### * `TAR`: GNU `tar` command
 if command -v gtar &>/dev/null; then
   readonly TAR="gtar"
 else
@@ -80,7 +89,7 @@ else
 fi
 export TAR
 
-# GNU `date` command
+### * `DATE`: GNU `date` command
 if command -v gdate &>/dev/null; then
   readonly DATE="gdate"
 else
@@ -88,7 +97,7 @@ else
 fi
 export DATE
 
-# GNU `xargs` command
+### * `XARGS`: GNU `xargs` command
 if command -v gxargs &>/dev/null; then
   readonly XARGS="gxargs"
 else
@@ -96,7 +105,7 @@ else
 fi
 export XARGS
 
-# GNU `cut` command
+### * `CUT`: GNU `cut` command
 if command -v gcut &>/dev/null; then
   readonly CUT="gcut"
 else
@@ -104,7 +113,7 @@ else
 fi
 export CUT
 
-# GNU `head` command
+### * `HEAD`: GNU `head` command
 if command -v ghead &>/dev/null; then
   readonly HEAD="ghead"
 else
@@ -112,7 +121,7 @@ else
 fi
 export HEAD
 
-# GNU `tail` command
+### * `TAIL`: GNU `tail` command
 if command -v gtail &>/dev/null; then
   readonly TAIL="gtail"
 else
@@ -120,7 +129,7 @@ else
 fi
 export TAIL
 
-# GNU `tr` command
+### * `TR`: GNU `tr` command
 if command -v gtr &>/dev/null; then
   readonly TR="gtr"
 else
@@ -128,7 +137,7 @@ else
 fi
 export TR
 
-# GNU `uniq` command
+### * `UNIQ`: GNU `uniq` command
 if command -v guniq &>/dev/null; then
   readonly UNIQ="guniq"
 else
@@ -136,7 +145,7 @@ else
 fi
 export UNIQ
 
-# GNU `wc` command
+### * `WC`: GNU `wc` command
 if command -v gwc &>/dev/null; then
   readonly WC="gwc"
 else
@@ -144,7 +153,7 @@ else
 fi
 export WC
 
-# GNU `diff` command
+### * `DIFF`: GNU `diff` command
 if command -v gdiff &>/dev/null; then
   readonly DIFF="gdiff"
 else
@@ -152,7 +161,27 @@ else
 fi
 export DIFF
 
-# Signal, if the given tool is a GNU tool
+# ------------------------------------------------------------------------------
+###
+### ## Functions
+###
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+###
+### ### is_gnu
+###
+### Signal, if the given tool is a GNU tool.
+###
+### **Usage**:
+###
+### ```bash
+### if ! is_gnu "sed"; then
+###   echo "Not a GNU tool."
+### fi
+### ```
+###
+# ------------------------------------------------------------------------------
 function is_gnu() {
   local cmd="${1:?Error: No command provided to is_gnu function}"
 
diff --git a/lib_init.sh b/lib_init.sh
index 35a1952..9369d4e 100644
--- a/lib_init.sh
+++ b/lib_init.sh
@@ -1,13 +1,29 @@
 #!/usr/bin/env bash
+# ==============================================================================
 ###
-### A file for some initial Bash Scripting best practices.
+### # lib_init.sh
 ###
-### Usage:
+### A file for some initial Bash Scripting best practices. It applies the
+### following settings:
 ###
-###   SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-###   readonly SCRIPT_DIR
-###   source "${SCRIPT_DIR}/lib-bash/lib_init.sh"
+### * `errexit`: Abort on nonzero exit status
+### * `nounset`: Abort on unbound variable
+### * `pipefail`: Don't hide errors within pipes
+### * `xtrace`: Show expanded commands if `DEBUG` is set to 2. Set to 1 for
+###   more verbose output.
 ###
+### **Usage**:
+###
+### ```bash
+### MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+### SCRIPT_DIR="$(dirname "${MY_PATH}")"
+### readonly MY_PATH
+### readonly SCRIPT_DIR
+### readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+### source "${LIB_BASH_DIR}/lib_init.sh"
+### ```
+###
+# ==============================================================================
 
 # Guard variable to prevent multiple imports
 if [[ -n "${LIB_INIT_SH_INCLUDED:-}" ]]; then
@@ -15,7 +31,14 @@ if [[ -n "${LIB_INIT_SH_INCLUDED:-}" ]]; then
 fi
 LIB_INIT_SH_INCLUDED=1
 
-# Provide option to trigger debug output with different verbosity levels.
+# ------------------------------------------------------------------------------
+###
+### ## Constants
+###
+# ------------------------------------------------------------------------------
+
+### * `DEBUG`: Provide option to trigger debug output with different verbosity
+###   levels.
 declare -ri DEBUG=${DEBUG:-0}
 export DEBUG
 
diff --git a/lib_scriptinfo.sh b/lib_scriptinfo.sh
index ea4a3d0..4e6b4ee 100644
--- a/lib_scriptinfo.sh
+++ b/lib_scriptinfo.sh
@@ -1,13 +1,22 @@
 #!/usr/bin/env bash
+# ==============================================================================
+###
+### # lib_scriptinfo.sh
 ###
 ### Include for script information functions.
 ###
-### Usage:
+### **Usage**:
 ###
-###   SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
-###   readonly SCRIPT_DIR
-###   source "${SCRIPT_DIR}/lib-bash/lib_scriptinfo.sh"
+### ```bash
+### MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+### SCRIPT_DIR="$(dirname "${MY_PATH}")"
+### readonly MY_PATH
+### readonly SCRIPT_DIR
+### readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+### source "${LIB_BASH_DIR}/lib_scriptinfo.sh"
+### ```
 ###
+# ==============================================================================
 
 # Guard variable to prevent multiple imports
 if [[ -n "${LIB_SCRIPTINFO_SH_INCLUDED:-}" ]]; then
@@ -23,12 +32,20 @@ readonly LIB_SCRIPTINFO_DIR
 source "${LIB_SCRIPTINFO_DIR}/lib_init.sh"
 
 # ------------------------------------------------------------------------------
-# Get script name (without path, with extension).
-#
-# Arguments:
-#   None
-# Returns:
-#   The script name.
+###
+### ## Functions
+###
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+###
+### ### get_script_name
+###
+### Get script name (without path, with extension).
+###
+### * **Arguments**: _None_
+### * **Returns**: The script name.
+###
 # ------------------------------------------------------------------------------
 function get_script_name() {
   echo "${0##*/}"

From 2e03d20a4816b85ee77597f763a306502d2c2be4 Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:03:11 +0100
Subject: [PATCH 5/7] docs: Add Main Readme for Documentation

---
 docs/README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..bed7757
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,5 @@
+# lib-bash – Bash Libraries
+
+![Lib-Bash Decorative Image](img/LibBashGitHubSocialPreview.jpg)
+
+A set of libraries to use from within your Bash scripts.

From 112e28f11657d10377f375bfb6b382a353f37aa2 Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:03:39 +0100
Subject: [PATCH 6/7] docs(lib): Add Generated Documentation

---
 docs/lib/lib_console.md    | 140 +++++++++++++++++++++++++++++++++++++
 docs/lib/lib_gnucompat.md  |  51 ++++++++++++++
 docs/lib/lib_init.md       |  28 ++++++++
 docs/lib/lib_scriptinfo.md |  24 +++++++
 4 files changed, 243 insertions(+)
 create mode 100644 docs/lib/lib_console.md
 create mode 100644 docs/lib/lib_gnucompat.md
 create mode 100644 docs/lib/lib_init.md
 create mode 100644 docs/lib/lib_scriptinfo.md

diff --git a/docs/lib/lib_console.md b/docs/lib/lib_console.md
new file mode 100644
index 0000000..f9ec25e
--- /dev/null
+++ b/docs/lib/lib_console.md
@@ -0,0 +1,140 @@
+
+# lib_console.sh
+
+Include for console support.
+
+**Usage**:
+
+```bash
+MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(dirname "${MY_PATH}")"
+readonly MY_PATH
+readonly SCRIPT_DIR
+readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+source "${LIB_BASH_DIR}/lib_console.sh"
+```
+
+## Color Constants
+
+### Foreground Colors
+
+* `COLOR_RESET`: Reset the color.
+* `COLOR_BLACK`: Black color.
+* `COLOR_RED`: Red color.
+* `COLOR_GREEN`: Green color.
+* `COLOR_YELLOW`: Yellow color.
+* `COLOR_BLUE`: Blue color.
+* `COLOR_MAGENTA`: Magenta color.
+* `COLOR_CYAN`: Cyan color.
+* `COLOR_WHITE`: White color.
+* `COLOR_GRAY`: Gray color.
+* `COLOR_LIGHT_RED`: Light red color.
+* `COLOR_LIGHT_GREEN`: Light green color.
+* `COLOR_LIGHT_YELLOW`: Light yellow color.
+* `COLOR_LIGHT_BLUE`: Light blue color.
+* `COLOR_LIGHT_MAGENTA`: Light magenta color.
+* `COLOR_LIGHT_CYAN`: Light cyan color.
+* `COLOR_LIGHT_WHITE`: Light white color.
+
+### Background Colors
+
+* `COLOR_BG_BLACK`: Black background color.
+* `COLOR_BG_RED`: Red background color.
+* `COLOR_BG_GREEN`: Green background color.
+* `COLOR_BG_YELLOW`: Yellow background color.
+* `COLOR_BG_BLUE`: Blue background color.
+* `COLOR_BG_MAGENTA`: Magenta background color.
+* `COLOR_BG_CYAN`: Cyan background color.
+* `COLOR_BG_WHITE`: White background color.
+
+## Logging
+
+All logging functions to output information to STDERR. STDERR is preferred,
+as it is not affected by the output redirection of the script, thus, the
+desired standard output can be redirected to a file or another command.
+
+### log_debug
+
+Output debug message.
+
+The function is used to output debug information. It is only printed
+if the `DEBUG` variable is set to a value greater than 0 (zero).
+
+If the standard output supports color, the debug information is printed in
+gray color. Otherwise, the debug information is printed without color.
+
+**Usage**:
+
+```bash
+log_debug "Only show if DEBUG=1 (or more)"
+grep "pattern" file.txt | log_debug
+```
+
+### log_info
+
+Output information message.
+
+The function is used to output information messages. No extra color is
+used for the information message.
+
+**Usage**:
+
+```bash
+log_info "An informational message."
+grep "pattern" file.txt | log_info
+```
+
+### log_warn
+
+Output warning message.
+
+The function is used to output warning messages. The warning message
+is printed in yellow color.
+
+**Usage**:
+
+```bash
+log_warn "A warning notice."
+grep "pattern" file.txt | log_warn
+```
+
+### log_error
+
+Output error message.
+
+The function is used to output error messages. The error message is
+printed in red color.
+
+**Usage**:
+
+```bash
+log_error "An error."
+grep "pattern" file.txt | log_error
+```
+
+### log_fatal
+
+Output a fatal error message.
+
+The function is used to output error messages. The error message is
+printed with dark red background and bright yellow color.
+
+**Usage**:
+
+```bash
+log_fatal "A fatal error."
+grep "pattern" file.txt | log_fatal
+```
+
+### ccat
+
+Alternative to `cat` that also processes colored input.
+
+**Usage**:
+
+```bash
+ccat <<EOF
+${COLOR_RED}This is red text.${COLOR_RESET}
+${COLOR_YELLOW}This is yellow text.${COLOR_RESET}
+EOF
+```
diff --git a/docs/lib/lib_gnucompat.md b/docs/lib/lib_gnucompat.md
new file mode 100644
index 0000000..64bc5aa
--- /dev/null
+++ b/docs/lib/lib_gnucompat.md
@@ -0,0 +1,51 @@
+
+# GNU-Tools Compatibility Layer
+
+This script provides compatibility functions for GNU tools on non-GNU
+systems, such as macOS.
+
+**Usage**:
+
+```bash
+MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(dirname "${MY_PATH}")"
+readonly MY_PATH
+readonly SCRIPT_DIR
+readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+source "${LIB_BASH_DIR}/lib_gnucompat.sh"
+```
+
+## Tools Aliases
+
+These functions will return the corresponding GNU-tool on non-GNU systems,
+if available. Such as `gsed` on macOS, which is the GNU version of `sed`.
+
+* `SED`: GNU `sed` command
+* `AWK`: GNU `awk` command
+* `GREP`: GNU `grep` command
+* `FIND`: GNU `find` command
+* `SORT`: GNU `sort` command
+* `TAR`: GNU `tar` command
+* `DATE`: GNU `date` command
+* `XARGS`: GNU `xargs` command
+* `CUT`: GNU `cut` command
+* `HEAD`: GNU `head` command
+* `TAIL`: GNU `tail` command
+* `TR`: GNU `tr` command
+* `UNIQ`: GNU `uniq` command
+* `WC`: GNU `wc` command
+* `DIFF`: GNU `diff` command
+
+## Functions
+
+### is_gnu
+
+Signal, if the given tool is a GNU tool.
+
+**Usage**:
+
+```bash
+if ! is_gnu "sed"; then
+echo "Not a GNU tool."
+fi
+```
diff --git a/docs/lib/lib_init.md b/docs/lib/lib_init.md
new file mode 100644
index 0000000..fad6e86
--- /dev/null
+++ b/docs/lib/lib_init.md
@@ -0,0 +1,28 @@
+
+# lib_init.sh
+
+A file for some initial Bash Scripting best practices. It applies the
+following settings:
+
+* `errexit`: Abort on nonzero exit status
+* `nounset`: Abort on unbound variable
+* `pipefail`: Don't hide errors within pipes
+* `xtrace`: Show expanded commands if `DEBUG` is set to 2. Set to 1 for
+more verbose output.
+
+**Usage**:
+
+```bash
+MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(dirname "${MY_PATH}")"
+readonly MY_PATH
+readonly SCRIPT_DIR
+readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+source "${LIB_BASH_DIR}/lib_init.sh"
+```
+
+## Constants
+
+* `DEBUG`: Provide option to trigger debug output with different verbosity
+levels.
+Call with `DEBUG=2 <command>.sh <file>` to enable verbose debug output
diff --git a/docs/lib/lib_scriptinfo.md b/docs/lib/lib_scriptinfo.md
new file mode 100644
index 0000000..5a627e5
--- /dev/null
+++ b/docs/lib/lib_scriptinfo.md
@@ -0,0 +1,24 @@
+
+# lib_scriptinfo.sh
+
+Include for script information functions.
+
+**Usage**:
+
+```bash
+MY_PATH="$(realpath "${BASH_SOURCE[0]}")"
+SCRIPT_DIR="$(dirname "${MY_PATH}")"
+readonly MY_PATH
+readonly SCRIPT_DIR
+readonly LIB_BASH_DIR="${SCRIPT_DIR}/lib_bash"
+source "${LIB_BASH_DIR}/lib_scriptinfo.sh"
+```
+
+## Functions
+
+### get_script_name
+
+Get script name (without path, with extension).
+
+* **Arguments**: _None_
+* **Returns**: The script name.

From 99ce8193582b9281cb226cc157029e8fa3e651aa Mon Sep 17 00:00:00 2001
From: Mark Michaelis <thragor@mailbox.org>
Date: Wed, 12 Mar 2025 19:21:49 +0100
Subject: [PATCH 7/7] ci(docs): Update Documentation On Release

---
 .github/workflows/release-prepare.yml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.github/workflows/release-prepare.yml b/.github/workflows/release-prepare.yml
index ac87be8..0a94ecb 100644
--- a/.github/workflows/release-prepare.yml
+++ b/.github/workflows/release-prepare.yml
@@ -38,6 +38,11 @@ jobs:
           echo "prev_version=$(cat .version)" >> $GITHUB_OUTPUT
           bin/version.sh ${{ github.event.inputs.release_type }}
           echo "next_version=$(cat .version)" >> $GITHUB_OUTPUT
+      - name: Update Documentation
+        id: update-docs
+        run: |
+          echo "Update documentation for version ${{ steps.version.outputs.next_version }}"
+          bin/docs.sh
       - name: Create pull request
         id: create-pull-request
         # https://github.com/peter-evans/create-pull-request