commentblock.sh

#!/usr/bin/env bash
# shellcheck disable=all
#
# The comment block.
#
# Sources:
#
# https://linuxcommand.org/lc3_adv_standards.php
# https://www.cyberciti.biz/tips/finding-bash-perl-python-portably-using-env.html

# #############################
# (Actual example begins below)
# #############################

#!/usr/bin/env bash
# ---------------------------------------------------------------------------
# [scriptname] - [Short description.]
#
# [Long description, potentially over multiple paragraphs.]
#
# This script requires [dependencies] to be installed:
# [installation instructions or links]

# Copyright [YEARS], Ivan Boothe <git@rootwork.org>

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

# This program 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 Affero General Public License at <http://www.gnu.org/licenses/> for
# more details.

# USAGE
#
# $ ./imagedate.sh [-q|--quiet] [-d|--date] [-t|--time] <FILE>
# $ ./imagedate.sh [-h|--help]

# EXAMPLES
#
# $ ./imagedate.sh .
# $ ./imagedate.sh -q foo
# $ ./imagedate.sh --date="2020:01:01" --time="10:10:10" foo
# $ ./imagedate.sh -q --date="2020:01:01" --time="10:10:10" foo
# $ ./imagedate.sh --help

# RESOURCES
#
# [links or sources of inspiration]

# Revision history:
# 2000-03-04  Added flag options for quiet and help; minor cleanup and bug
#             fixes (1.2)
# 2000-02-01  Minor cleanup (1.1)
# 2000-01-01  Initial release (1.0)
# ---------------------------------------------------------------------------