Sujet : Re: règle pour écrire les "usage: ..."
De : om+news (at) *nospam* miakinen.net (Olivier Miakinen)
Groupes : fr.comp.os.unixDate : 11. Jul 2022, 17:59:59
Autres entêtes
Organisation : There's no cabale
Message-ID : <tahkuf$6ob$1@cabale.usenet-fr.net>
References : 1 2 3 4 5
User-Agent : Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0 SeaMonkey/2.49.4
Le 11/07/2022 18:43, Thomas répondait à Alain Ketterlin :
Personnellement je préfère éviter |, ce qui évite aussi les parenthèses
en général. Par exemple, chez moi la page de man de sort indique
sort [OPTION]... [FILE]...
sort [OPTION]... --files0-from=F
bonne idée :-)
je préfère ta proposition que celle d'Olivier
Ça tombe très bien, parce que moi aussi. :-)
Il se trouve simplement que je n'y avais pas pensé, mais cette méthode me
semble aussi éminemment préférable
(note le retour de l'étoile, sous la forme [x]...)
perso j'aurais préféré [x...]
(sachant que les 2 sont parfaitement équivalents)
en fait, pour l'ambiguité, il est permis d'avoir un minuscule doute :
Pas vraiment ici.
est-ce que
x [y] ...
équivaut à
x ([y] ...)
ou à
(x [y]) ...
?
Dans l'exemple donné par Alain il n'est absolument pas question de :
x [y] ...
mais de :
x [y]...
L'absence d'espace entre le crochet et les trois points ne laisse ÀMHA
aucun doute sur l'interprétation de cette écriture.
Si l'ordre des options est sans importance, il vaut peut-être mieux en
donner une liste linéaire, comme le fait en général --help (ou le man).
Un synopsis "mkdir [-m mode] [-p]" aurait l'air d'imposer l'ordre.
ah ben tant mieux :
j'ai horreur de l'analyse de texte, et la lecture des arguments en fait
partie.
ça me parait bcp moins compliqué à faire avec un ordre imposé.
Permets-moi d'être en complet désaccord avec toi sur ce point, parce que
là l'usage est quasiment universel, du moins pour toutes les options avec
tiret.
Je veux dire que si la syntaxe proposée est :
usage: rapid [-v] -ni [-od dir] gui_file...
alors je m'attendrais à ce que toutes ces écritures soient autorisées :
rapid -v -ni -od dir gui_file...
rapid -ni -v -od dir gui_file...
rapid -ni -od dir -v gui_file...
rapid -v -od dir -ni gui_file...
rapid -od dir -v -ni gui_file...
rapid -od dir -ni -v gui_file...
Bien sûr je m'interdirais seulement de mettre 'dir' ailleurs que juste
derrière '-od', ou de mettre 'gui_file...' ailleurs qu'à la fin.
dans l'erreur j'ai précisé :
Unknown or misplaced switch
^^^^^^^^^
Cela me semble une brutalité excessive pour l'utilisateur, avec un risque
qu'il te maudisse jusqu'à la cinquantième génération.
-- Olivier Miakinen