Files
init.sh/modules/template
2021-09-28 13:46:22 +02:00

48 lines
2.1 KiB
Plaintext

# Generic template to use as a model for new modules creation #
# #
# !!! ATTENTION : modules are not supposed to contains any specific code for #
# !!! a distribution or a other. Please use configuration files #
# !!! to introduce any specific code. #
# #
# @template@ must be replaced by the name of your module. It have to be named #
# @template@.sh. You can automaticallly create your new module using the #
# following command : #
# #
# sed -e "s/@template@/mod_name/g" -e "/^# .*/d" -e "s/^##/# /" template > mod_name.sh
# #
# Versioning iis following standard rules. Numbered as x.y.z: #
# * x : increased on deep changes, rewrites or major additions #
# * y : increased on minor functionnality additions #
# * z : increased on fixes (+n fixes => increased by +n) #
# #
##------------------------------------------------------------------------------
##Description of module @template@
##Copyright (c) Year Your Name <your.mail@host.tld>
##------------------------------------------------------------------------------
##<Licence header compatible with BSD-3 licence, you want to use>
##------------------------------------------------------------------------------
##Variable list:
## * <VARNAME>: role explaination
##------------------------------------------------------------------------------
##Module version
export VER_@template@="0.0.1"
##Module's code
@template@()
{
# Code
}
##Preliminary checks code for the module
precheck_@template@()
{
# Code
}
##Public functions might be exported
export -f @template@
export -f precheck_@template@
##EOF