maj de la doc

doc/tools/apacheconfig.md

@@ -12,6 +12,19 @@ OPTIONS
         Créer un nouveau répertoire de configuration pour un hôte
     -d, --destdir DESTDIR[=apacheconfig]
         Nom du répertoire local de configuration.
+    -f,--full
+    --partial
+        Indiquer respectivement que la configuration est complète ou partielle.
+        Avec la configuration complète, le serveur peut être complètement
+        configuré avec tous les fichiers présents. Avec la configuration
+        partielle, uniquement les informations spécifiques à un service en
+        particulier sont disponibles.
+        Cette option est utilisée avec --create. Par défaut, la configuration
+        est partielle.
+        Pour le moment, la seule différence est que --full crée un fichier de
+        configuration nommé .apacheconfig alors que --partial crée un fichier
+        nommé apacheconfig.conf qui est visible et donc découvrable et éditable
+        plus facilement
 
     -t, --template [OPT]
         Gérer les fichiers du répertoire local avec templatectl. La valeur de
@@ -42,9 +55,12 @@ OPTIONS
         Lors du déploiement de la configuration, les valeurs des variables
         dynamiques sont remplacées dans les fichiers destination.
         Les arguments qui restent sont passés tels quels à apache_autoconf
+    -N, --network-config
+        Mettre aussi à jour la configuration réseau.
     -r, --certsdir CERTSDIR
         Spécifier le cas échéant le répertoire contenant les certificats à
-        déployer. Cet argument est requis si le répertoire certsconf/ existe.
+        déployer. Cet argument est requis si le répertoire certsconf/ existe,
+        sauf si les certificats sont déjà déployés.
 
     --localhosts
         Créer dans le fichier /etc/hosts tous les noms d'hôte ayant un suffixe
@@ -60,6 +76,20 @@ OPTIONS
         Ne déployer que le fichier de site spécifié. Cette option est utilisée
         avec --deploy ou --localhosts et est utile pour le développement et les
         tests.
+
+    -k, --new-site HOST.TLD
+        Créer une définition pour un nouveau site à partir des fichiers du
+        répertoires templates/
+    -K, --new-site-templatedir TEMPLATEDIR
+        Spécifier le répertoire source pour les templates de site utilisés par
+        l'option --new-site. Par défaut, utiliser le répertoire templates/ situé
+        dans le répertoire de configuration.
+        Si TEMPLATEDIR est un nom simple sans séparateur de chemin '/' et qu'un
+        répertoire templates/TEMPLATEDIR existe, alors prendre ce répertoire-là
+        comme source.
+    --new-site-force
+        Avec --new-site, utiliser le nom d'hôte fourni même s'il n'est pas
+        pleinement qualifié
 ~~~
 
 -*- coding: utf-8 mode: markdown -*- vim:sw=4:sts=4:et:ai:si:sta:fenc=utf-8:noeol:binary

doc/tools/runs.md

@@ -40,7 +40,7 @@ Gestion des scripts
         {$RUNSHOSTSPATH}/$hostname.$domain (par défaut) et
         {$RUNSHOSTSPATH}/$domain/$hostname (le cas échéant)
         L'option --host est équivalente, sauf que son argument est facultatif et
-        que sa valeur par défaut est l'hôte courant, soit natrix
+        que sa valeur par défaut est l'hôte courant, soit hydra
     --list
         Afficher la liste des scripts qui sont disponibles. Avec l'option -h,
         inclure aussi les scripts spécifiques à cet hôte.

doc/ulib/apache.tools.md

@@ -5,6 +5,8 @@
 Calculer l'emplacement des certificats correspondant aux arguments $1 et
 $2 (qui correspondent aux options --conf et --dir de apache_addcert()),
 puis initialiser les variables $3(=cert), $4(=key) et $5(=ca)
+Si ces valeurs sont déjà calculées, on peut fournir $6=certsdir et
+$7=keysdir
 ~~~
 ## `apache_addcert`
 ## `apache_autoconf`
@@ -13,6 +15,16 @@ puis initialiser les variables $3(=cert), $4(=key) et $5(=ca)
 ## `apacheconfig_loadconf`
 ## `apacheconfig_sysinfos`
 ## `apacheconfig_deploy`
+## `apacheconfig_qs`
+~~~
+fonction pour simplifier l'utilisation de apacheconfig_deploy pour un
+répertoire spécifique
+$1=destdir $2=certsdir $3=netconf
+~~~
 ## `apacheconfig_localhosts`
+## `legacy_mkRewriteRules`
+~~~
+$1=infile, $2=thishost, $3=outfile, $4=htmlfile, $5=proxy_enabled?
+~~~
 
 -*- coding: utf-8 mode: markdown -*- vim:sw=4:sts=4:et:ai:si:sta:fenc=utf-8:noeol:binary

doc/ulib/debian.md

@@ -140,7 +140,9 @@ $3(=confips)
 ## `network_fix_hosts`
 ## `network_config`
 ~~~
-(Re)configurer le réseau sur l'hôte courant.
+(Re)configurer le réseau sur l'hôte courant. Des efforts sont faits pour
+ne mettre à jour les fichiers que si c'est nécessaire. Si un des arguments
+$1..$6 n'est pas spécifié, il est ignoré.
 $1 (host) est le nom d'hôte.
 $2 (confips) est le nom d'un tableau contenant la configuration des
 adresses ips pour les interfaces.
@@ -151,9 +153,12 @@ l'interface qui est sélectionnée si une adresse ip n'est pas préfixée de
 son interface. En principe, l'interface principale est le premier bridge
 défini ou la première interface définie.
 $5 (reset_interfaces) spécifie de ne pas chercher à mettre à jour le
-fichier /etc/network/interfaces, mais de le recréer depuis zéro.
+fichier /etc/network/interfaces, mais de le recréer depuis zéro. la valeur
+'force' spécifie de recréer le fichier même si ce n'est pas nécessaire à
+priori.
 $6 (oldhost) est le nom d'hôte actuel, avant la modification
-Si un des arguments n'est pas spécifié, il est ignoré.
+$7(=/etc/network/interfaces) est le fichier à mettre à jour
+
 Le tableau confips doit contenir des définitions d'une des formes
 suivantes:
 [[iface][//gateway]:]address[/suffix],...
@@ -164,6 +169,7 @@ existe, auquel cas il s'agit du premier bridge défini. Pour chaque
 interface, seule la première spécification d'adresse IP tient compte de
 l'argument gateway. Les autres spécifications définissent des adresses IP
 supplémentaires pour l'interface.
+
 Le tableau brs doit contenir des définitions de la forme suivante:
 br:ifaces,...
 br est le nom du bridge, e.g. br0. ifaces est une liste d'interfaces
@@ -171,5 +177,18 @@ séparées par une virgule. e.g. br0:eth0,eth1
 Bien que ce soit techniquement possible, ce script interdit que l'on
 définisse une adresse IP pour une interface faisant partie d'un bridge.
 ~~~
+## `network_config_partial`
+~~~
+une version allégée de network_config() qui ne permet que de rajouter des
+adresses IPs en plus de celles qui sont déjà configurées.
+$1(=confips) est le nom d'un tableau contenant la configuration des
+adresses ips pour les interfaces.
+$2(=/etc/network/interfaces) est le fichier à mettre à jour
+~~~
+## `network_update_etc_networks`
+~~~
+écraser le contenu du fichier /etc/networks avec la chaine $1
+si $1 est vide, initialiser le fichier avec un contenu par défaut.
+~~~
 
 -*- coding: utf-8 mode: markdown -*- vim:sw=4:sts=4:et:ai:si:sta:fenc=utf-8:noeol:binary

doc/ulib/ipcalc.md

@@ -26,6 +26,15 @@ afficher le suffixe (0, 8, 16, 24, 32) associé. Sinon retourner 1
 afficher le masque de sous-réseau. si le suffixe ou le masque ne sont pas
 reconnus, retourner 1
 ~~~
+## `ipcalc_network`
+~~~
+Calculer l'adresse de réseau correspondant à l'adresse ip $1. Le masque
+de sous-réseau peut-être indiqué dans l'adresse ip avec le suffixe /n ou
+/x.x.x.x ou donné dans l'argument $2. Seuls les suffixes 0, 8, 16, 24, 32
+sont supportés.
+Retourner 1 si un erreur s'est produite, par exemple si l'adresse ou le
+suffixe sont invalides ou non supportés.
+~~~
 ## `ipcalc_broadcast`
 ~~~
 Calculer l'adresse de broadcast correspondant à l'adresse ip $1. Le masque

doc/ulib/template.md

@@ -43,11 +43,22 @@ les fichiers des répertoires sources $2..@
 Obtenir le chemin vers le répertoire source de templates $1, situé dans
 ULIBDIR/templates
 ~~~
+## `template_build_vars`
+~~~
+Initialiser les tableaux $1 et $2 avec la description des variables $3..@
+les descriptions sont de la forme var[:depvars,...]=desc
+$1 reçoit les noms (depvars... var) parce que les variables dépendantes
+doivent toujours être placées AVANT la variable maitre
+$2 reçoit les noms (depvars...)
+pour chaque description, une variable __TEMPLATE_DESC_var est créée avec
+la valeur desc
+~~~
 ## `templatectl_config`
 ~~~
-Obtenir le chemin vers le fichier de configuration pour le répertoire $1
+Obtenir le chemin vers le fichier de configuration pour le répertoire $1 Si
-Si $2==nohideconfig, utiliser le nom CONFIG.conf, sinon utiliser par défaut
+l'un des fichiers CONFIG.conf ou .CONFIG existent déjà, prendre ceux-là.
-.CONFIG sauf si le fichier CONFIG.conf existe
+Sinon, si $2==nohideconfig, utiliser le nom CONFIG.conf, sinon utiliser
+.CONFIG
 ~~~
 ## `templatectl_loadvars`
 ~~~
@@ -68,6 +79,8 @@ déploiement des fichiers.
 devraient pas être écrits dans le fichier des variables, sauf si elles
 reçoivent une valeur explicite de la part de l'utilisateur. Ce tableau est
 mis à jour lors de l'analyse du tableau TEMPLATECTL_VARS
+- TEMPLATE_USER_VARS contient une liste de noms de tableaux qui sont définis
+en plus et qui peuvent être utilisés par des scripts annexes
 ~~~
 ## `templatectl_writevars`
 ~~~