From 5b2320b421970b847490e0ec19965c2e7e4d2fec Mon Sep 17 00:00:00 2001
From: tTh <tth@redlady.dinorama.fr>
Date: Wed, 31 Jul 2024 22:21:54 +0200
Subject: [PATCH] more doc

---
 Tools/README.md | 71 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 63 insertions(+), 8 deletions(-)

diff --git a/Tools/README.md b/Tools/README.md
index a7c69bd..8f1ccd1 100644
--- a/Tools/README.md
+++ b/Tools/README.md
@@ -14,7 +14,7 @@ Usage:
         tga_filtres <src.tga> FILTR <dst.tga> [p1] ... [pn]
 -+- This is the `tthimage' library v0.4.50 (dwtfywl 2022) tTh
   commande  | type arg |  explication
-------------+----------+------------------------------------
+------------+----------+------------------------------
  liss2x2    |          |  lissage 2x2
  hipass     |          |
  lopass     |          |
@@ -31,7 +31,7 @@ La colonne du milieu indique le type des paramètres :
 ## tga_alpha
 
 Manipulation du canal alpha (la transparence), lequel canal
-est globalement mal géré par l'ensemble de libtthimage.
+est globalement mal géré par l'ensemble de la libtthimage.
 
 ## tga_applymap
 
@@ -40,6 +40,12 @@ logiciel de fractales sous ms-dos :
 [Fractint](https://fractint.org/). Quelques exemples de
 ces fichiers sont dans le répertoire `Datas/` du projet.
 
+Vous rencontrerez parfois des messages d'erreur comme
+« *color map is to big* » ou « *only 97 entries in foo.map* ».
+Pas d'inquiétude, tout va bien se passer.
+Dans le premier cas, les lignes en excédent sont ignorées,
+et dans le second, les valeurs manquantes sont mises au noir.
+
 La gestion de la ligne de commande est désastreuse. **À REFAIRE**
 
 ## tga_cadre
@@ -54,7 +60,6 @@ Paramètres mal documentés.
 Usage:
         tga_combine s1.tga s2.tga MODE d.tga [PARAMS]
 ```
-
 Il existe plein de façon de combiner deux images, la commande
 `testtga list` vous les fera découvrir, la cinquième va vous étonner.
 
@@ -76,9 +81,15 @@ Attendu avec impatience, il aura le support complet des PNG. Un jour...
 
 ## tga_makehf15
 
+Pour les POViste acharnés.
+
 ## tga_to_text
 
-Mis au point pour les imports dans d'autres langages.
+Mis au point pour les imports dans d'autres langages,
+comme Awk, Fortran ou R. Chaque ligne du fichier généré
+contient cinq champs : x, y, r, g, b.
+
+Attention, il peut vite générer d'énormes fichiers.
 
 ## tga_mires
 
@@ -96,14 +107,58 @@ vraiment trop nulle...
 ## tga_tools
 
 Celui ci est très utile pour la recherche de problèmes ou l'automatisation
-de certaines tâches. Exemple :
+de certaines tâches. Un exemple rapide :
 
 ```
-tth@konrad:~/Devel/libtthimage$ tga_tools getdimweb mire.tga 
-width=512 height=512
-tth@konrad:~/Devel/libtthimage$ 
+tth@redlady:~/Devel/libtthimage$ tga_tools getdimweb foo.tga 
+width=640 height=480
+tth@redlady:~/Devel/libtthimage$ tga_tools getdimpov foo.tga 
+ -w640 -h480
+tth@redlady:~/Devel/libtthimage$ 
 ```
 
+###  version
+###  surface
+###  getdims, getdimx, getdimpov, getdimweb
+renvoie une chaine de caractère donnant les dimensions de l'image
+en différents formats.
+###  width, height
+renvoie chacune des deux dimensions.
+###  grminmax
+###  message 
+Flags: un entier. Si non nul, change l'encre et le papier pour
+d'autres valeurs. La chaine de caractère doit être (sjmsb) encodée
+en CP-850, voire même comme celles du Locomotive du CPC.
+
+###  structs
+
+Affichage d'information (boutisme, taille des structures) qui ne
+seront utiles qu'aux codeurs.
+```
+tth@redlady:~/Devel/libtthimage/Tools$ ./tga_tools structs
+petit  =       1234  ->   34 12
+grand  =   12345678  ->   78 56 34 12 00 00 00 00
+basic types    : short=2 int=4 long=8 ptr=8
+Image_Desc     :   1296
+Image_Rect     :     24
+RGBA           :     16
+A_BitPlane     :    128
+RGB_map        :   1624
+Image_Point    :      8
+```
+
+###  header
+###  timestamp
+###  prhisto
+
+Calcul et affichage en mode texte de l'histogramme d'une image.
+Un exemple d'utilisation avec gnuplot serait le bienvenu.
+
+###  tag7
+###  environ
+###  mk_rgb
+###  mk_hgrad
+
 ## genplot2
 
 Outil de tracé pseudo-générique et farci de bugs. *WIP ME HARDLY !*