gelinive

git clone git://bebou.netlib.re/gelinive
Log | Files | Refs | README |

commit 297e3c1e99e6d8c36cc1ad7ffe0a65cf3080ec7b
parent 2aadff71ca13f8d9383b44ddcd0686ba4531362e
Auterice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Mon, 11 Mar 2024 11:54:23 +0100

De la documentation

Un -h ou --help qui n'affiche pas du man. Sert juste à rappeler
la syntaxe.

Deux pages de man pour la commande et le format.

Ajustement du makefile pour générer les pages de man et les installer.

Diffstat:
M
.gitignore
 | 
1
+
M
gelinive
 | 
13
+++++++++----
A
gelinive.1.md
 | 
32
++++++++++++++++++++++++++++++++
A
gelinive.5.md
 | 
39
+++++++++++++++++++++++++++++++++++++++
M
makefile
 | 
16
++++++++++++----
D
manpage
 | 
25
-------------------------

6 files changed, 93 insertions(+), 33 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@
 !data
 !tests/*
 !README.md
+!gelinive.?.md
diff --git a/gelinive b/gelinive
@@ -2,10 +2,15 @@
 
 if [ "$1" = "-h" -o "$1" = "--help" ]
 then
-lowdown -M title=gelinive -M section=1 -stman manpage |
-	preconv |
-	groff -Tutf8 -man |
-	less -R
+<<. cat
+Utilisation : gelinive [fichier] ou [< fichier] gelinive
+
+Si fichier est omis alors gelinive lire dans stdin.
+Autrement dit dans la majorité des cas vous pourrez
+entrer les données au clavier.
+
+Pas d'arguments
+.
 exit 0
 fi
 
diff --git a/gelinive.1.md b/gelinive.1.md
@@ -0,0 +1,32 @@
+title: GELINIVE
+section: 1
+
+## NOM
+
+gelinive - calcul la résistance au battage
+
+## SYNOPSIS
+
+**gelinive** FICHIER
+
+## DESCRIPTION
+
+Calcul la résistance au battaque et l'enfoncement total d'une sonde dans la
+neige. Pour le format en entrée et sortie voir gelinive(5).
+
+## UTILISATION
+
+    gelinive data
+
+ou
+
+    < data gelinive
+
+## VOIR AUSSI
+
+gelinive(5)
+
+## AUTEURICE
+
+Arthur Pons <arthur.pons@unistra.fr>
+
diff --git a/gelinive.5.md b/gelinive.5.md
@@ -0,0 +1,39 @@
+title: GELINIVE
+section: 5
+
+## NAME
+
+gelinive - format des sondages par battage
+
+## SYNOPSIS
+
+gelinive
+
+## DESCRIPTION
+
+gelinive(1) prend en entrée et écrit en sortie (stdout) des données sous ce
+format séparées par des tabulations.
+
+## CHAMPS SÉPARÉS PAR DES TABULATIONs
+
+Les deux derniers champs du format sont optionnels. gelinive(1) permet justement
+de les créer.
+
+L'ordre et le contenu des champs sont :
+
+  1. q        le nombre de tubes
+  2. P        le poids mobile (1 kg)
+  3. n        le nombre de coups
+  4. h        la hauteur de chute (cm)
+  5. d        l'enfoncement pour n coups (cm)
+  6. R        la résistance au battage
+  7. e        l'enfoncement total de la sonde (cm)
+
+## VOIR AUSSI
+
+gelinive(1)
+
+## AUTEURICE
+
+Arthur Pons <arthur.pons@unistra.fr>
+
diff --git a/makefile b/makefile
@@ -1,10 +1,18 @@
 PREFIX = /usr/local
 
-test:;tests/test
+all: gelinive.1 gelinive.5
 
-all:
+test:;tests/test
 
 install:
-	mkdir -p ${DESTDIR}${PREFIX}/bin
-	cp gelinive ${DESTDIR}${PREFIX}/bin
+	mkdir -p ${PREFIX}/bin
+	cp gelinive ${PREFIX}/bin
+	chmod +x ${PREFIX}/bin/gelinive
+	cp gelinive.1 ${PREFIX}/man/man1
+	cp gelinive.5 ${PREFIX}/man/man5
+
+gelinive.1: gelinive.1.md
+	lowdown -stman $< > $@
 
+gelinive.5: gelinive.5.md
+	lowdown -stman $< > $@
diff --git a/manpage b/manpage
@@ -1,25 +0,0 @@
-## NOM
-
-gelinive - calcul la résistance au battage
-
-## SYNOPSIS
-
-**gelinive** FICHIER
-
-## DESCRIPTION
-
-Calcul la résistance au battaque et l'enfoncement total d'une sonde dans la
-neige.
-
-**FICHIER** doit être un fichier au format tsv contenant, dans l'ordre
-
-  * q : nombre de tubes
-  * P : poids mobile
-  * n : nombre de coups
-  * h : hauteur de chute
-  * d : enfoncement pour n coups (cm)
-
-En sortie gelinive ajoutera à ce fichier tsv deux colonnes :
-
-  * R : résistance au battage
-  * e : enfoncement total de la sonde (cm)