isposix

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

commit 80355d538e7066016c6b5a4e8bcd32ff45cbf142
parent 86d5e4565ccf98be966fa3bb1f443c975820b1f2
Auteurice: Arthur Pons <arthur.pons@unistra.fr>
Date:   Mon, 25 Nov 2024 11:53:52 +0100

MAJ du README pour mettre en cohérence la doc

Diffstat:
M
README
 | 
61
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--

1 file changed, 59 insertions(+), 2 deletions(-)
diff --git a/README b/README
@@ -1,2 +1,59 @@
-Script pour vérifier si une commande et/ou une option de cette commande sont
-posix ou pas
+# isposix (et autres outils)
+
+Ce dépôt contient des outils pour aider au diagnostic de la posixitude d'un
+script shell
+
+## isposix
+
+Renvoie vrai si une commande et ses options existent dans la norme posix.
+
+**Attention**, le fait qu'`isposix` renvoie vrai ne veut pas dire que l'usage
+de la commande est correcte ou même qu'elle s'exécutera tout court. Tout ce
+qu'il fait est de vérifier que la commande existe dans la liste des commandes
+posix et que les options associées sont renseignées dans la spec.
+
+### Usage
+
+	isposix [-c]
+
+Mettre dans stdin les commandes que l'on veut analyser sans leurs arguments.
+Affiche dans stderr le résultat.
+
+	$ echo "ls -la" | isposix
+	ls -l -a | is posix
+	$ echo "ls -lha" | isposix
+	ls -l -h -a | not posix
+	$ <<. isposix
+	ls -la
+	ls -lha
+	.
+	ls -l -a | is posix
+	ls -l -h -a | not posix
+	$ echo "ls -lha" | isposix 2>/dev/null && echo "Portable" || echo "Pas portable"
+	Pas portable
+
+## posix
+
+
+Ouvre la page de manuel posix d'une commande spécifiée. Puisque les pages sont
+en html, utilise la variable d'environnement `$BROWSER` pour savoir avec quel
+navigateur l'ouvrir.  Sinon par défaut c'est `w3m`.
+
+### Usage
+
+	posix [-o] command
+
+	$ posix ls
+	$ posix -o xargs
+	-E
+	-I
+	-L
+	-n
+	-p
+	-r
+	-s
+	-t
+	-x
+	-0
+	& posix -o xargs | grep -q -- -n && echo "-n d'xargs est posix" || echo "-n d'xargs n'est pas posix"
+	-n d'xargs est posix