added module documentation, improved main documentation

modules/conf_disks.sh

@@ -1,4 +1,13 @@
 # Secondary drive configuration
+# ------------------------------------------------------------------------------
+# Variable :
+#  * CALCTYPE: filesystem to use (zfs, ext4, xfs)
+#  * CALCMOUNTPOINT: mount point of the target file system (FQPN)
+#  * CALCLEVEL: ZFS only, RAID level (mirror, raidz1, raidz2, raidz3),
+#               empty for striped volume. Any other level than stripe requires
+#               more than one disk.
+# * CALCDRV: Target drives, preferably through ID.
+# ------------------------------------------------------------------------------
 
 export VER_conf_disks="0.0.7"
 

modules/conf_locale.sh

@@ -1,4 +1,18 @@
+# ------------------------------------------------------------------------------
 # Locale
+# ------------------------------------------------------------------------------
+# Variable:
+#  * LOCALESET: List of locale that will be supported by system
+#  * SYSLOCALE: Default system wide locale
+#
+# Both case will be formated in that way (with exemple for French:
+#                           fr_FR.UTF-8
+#                           ^   ^   ^
+#                           |   |   |
+#     ISO-631-1 language code   |   |
+#  ISO 3166-2 country subdivision   |
+#                                   Character table (ISO or UTF)
+# ------------------------------------------------------------------------------
 
 export VER_conf_locale="0.0.3"
 

modules/conf_mail.sh

@@ -1,4 +1,10 @@
+# ------------------------------------------------------------------------------
 # Mail systême
+# ------------------------------------------------------------------------------
+# Variable:
+#  * HOSTNAME: Name of the host
+#  * MAINDOM: Default main domain name
+# ------------------------------------------------------------------------------
 
 export VER_conf_mail="0.0.2"
 

modules/conf_ntp.sh

@@ -1,4 +1,9 @@
+# ------------------------------------------------------------------------------
 # NTP
+# ------------------------------------------------------------------------------
+# Variable:
+#  * NTPSERVERS: list of NTP servers
+# ------------------------------------------------------------------------------
 
 export VER_conf_ntp="0.0.5"
 

modules/conf_ssh.sh

@@ -1,4 +1,9 @@
-# Configuration des client et serveur SSH
+# ------------------------------------------------------------------------------
+# Configure SSH client and server
+# ------------------------------------------------------------------------------
+# Variable:
+#   none
+# ------------------------------------------------------------------------------
 
 export VER_conf_ssh="0.0.1"
 

modules/install_chromium.sh

@@ -1,6 +1,11 @@
+# ------------------------------------------------------------------------------
 # Since Ubuntu install snapd version of Chromium and we don't want that
 # we need a special procedure to install Debian Buster version.
 # Consequently that module is *Ubuntu centric.
+# ------------------------------------------------------------------------------
+# Variable:
+#   none
+# ------------------------------------------------------------------------------
 
 export VER_install_chromium="0.0.1"
 

modules/install_desktop.sh

@@ -1,5 +1,13 @@
+# ------------------------------------------------------------------------------
 # Install desktop environment -- Ubuntu only
 # Debian version might ask for task-$FLAVOR
+# ------------------------------------------------------------------------------
+# Variable:
+#  * UBUNTU_FLAVOR: Kind of Ubuntu desktop installation (ubuntu for Gnome3,
+#    xubuntu for XFCE, kubuntu for KDE/Plasma, ubuntu-mate for Mate, leave
+#    empty for no desktop or manual)
+#  * X11_DRV: Used to install proprietary driver for X.org (eg: nvidia-drivers)
+# ------------------------------------------------------------------------------
 
 export VER_install_desktop="0.0.2"
 

modules/install_pkg.sh

@@ -1,4 +1,11 @@
-# Installation des paquets
+# ------------------------------------------------------------------------------
+# Install or remove packages
+# ------------------------------------------------------------------------------
+# Variable:
+#  * PKGS_RMLIST: packages to remove
+#  * PKGS_BLACKLIST: package to mark as forbidden (will be removed if not)
+#  * PKGSEL: List of package to install
+# ------------------------------------------------------------------------------
 
 export VER_install_pkg="0.1.1"