commit 40a834c741b8719450247c60539f8e4b97863d57
parent efab32fc2864e7d3cfbabdd6266ec210c6736c83
Auteur: Loïc Daignault-Pichette <ldp@asteride.xyz>
Date: Sat, 6 Sep 2025 12:37:40 -0400
[doc] Documenter dans une page du manuel
Diffstat:
| A | man/fr/execrom.1 | | | 139 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 fichier modifié, 139 insertions(+), 0 suppressions(-)
diff --git a/man/fr/execrom.1 b/man/fr/execrom.1
@@ -0,0 +1,139 @@
+.Dd 6 septembre 2025
+.Dt EXECROM 1
+.Os
+.Sh NOM
+.Nm execrom
+.Nd Exécuter des ROMs
+.Sh SYNOPSIS
+.Ar ROM
+.Op Ar argument ...
+.Sh DESCRIPTION
+À son lancement,
+l’utilitaire
+.Nm execrom
+inspecte son argument 0,
+censé contenir
+.Ar ROM ,
+le nom avec lequel il a été invoqué.
+Il parcourt ensuite les dossiers répertoriés dans
+.Dv EXECROM_CHEM
+à la recherche d’un fichier
+dont le préfixe corresponde à
+.Ar ROM
+suivi d’un point (« . »).
+Il met fin à sa recherche
+dès le premier fichier conforme trouvé
+et exécute le programme dont le nom correspond
+au suffixe de ce fichier,
+en lui donnant
+.Ar ROM
+et
+.Op Ar argument ...
+en argument.
+.Pp
+Ainsi, les fichiers accessibles par
+.Ev EXECROM_CHEM
+sont des programmes
+dont les noms ont la forme
+.Em nom.interpréteur .
+.Em nom
+est le nom du programme à interpréter.
+Il doit correspondre à
+.Ar ROM
+pour être retenu.
+.Em interpréteur
+est le nom de l’exécutable
+destiné à interpréter le programme.
+Cet exécutable doit être accessible par
+.Dv PATH .
+.Pp
+.Nm
+n’est pas conçu pour être exécuté directement,
+mais plutôt par l’intermédiaire d’un lien symbolique pointant vers lui.
+.Sh ENVIRONNEMENT
+La variable d’environnement suivante influence l’exécution d’\c
+.Nm .
+.Bl -tag -width "EXECROM_CHEM"
+.It Ev EXECROM_CHEM
+Liste de chemins, séparés par des deux-points (« : »),
+vers les dossiers contenant les programmes à interpréter.
+Elle a la même structure que
+.Ev PATH .
+.El
+.Sh EXEMPLES
+.Pa ~/uxn/drifblim
+et
+.Pa ~/uxn/left
+sont deux ROMs exécutables
+par une machine Varava.
+La première contient un assembleur uxntal
+interprétable par la machine virtuelle en mode texte
+.Xr uxncli 1 .
+La commande suivante assemble
+.Pa prog.tal
+dans
+.Pa prog.rom .
+.Bd -literal -offset indent
+$ uxncli ~/uxn/drifblim prog.tal prog.rom
+.Ed
+.Pp
+La seconde ROM est un éditeur de texte en mode graphique.
+Elle doit donc être interprété par
+.Xr uxnemu 1 .
+La commande suivante lance l’éditeur
+avec le fichier
+.Pa doc.txt
+ouvert.
+.Bd -literal -offset indent
+$ uxnemu ~/uxn/left doc.txt
+.Ed
+.Pp
+Grâce à
+.Nm ,
+il est possible d’exécuter ces deux programmes
+sans avoir à spécifier l’interpréteur approprié.
+Pour ce faire,
+il faut régler la variable d’environnment
+.Dv EXECROM_CHEM
+pour qu’elle contienne
+le chemin vers le dossier
+où se trouvent les ROMs,
+ici,
+.Pa ~/uxn.
+.Bd -literal -offset indent
+$ export EXECROM_CHEM="$HOME/uxn:$EXECROM_CHEM"
+.Ed
+.Pp
+Il faut aussi modifier le nom de chaque ROM
+pour que son préfixe et son suffixe correspondent
+à son nom d’invocation et
+au nom du programme destiné à l’interpréter,
+respectivement.
+Le résultat devrait être le suivant.
+.Bd -literal -offset indent
+$ ls ~/uxn
+drifblim.uxncli
+left.uxnemu
+.Ed
+.Pp
+Enfin, un lien symbolique accessible par
+.Dv PATH
+et pointant vers l’exécutable d’\c
+.Nm
+doit être créé pour chaque ROM.
+.Bd -literal -offset indent
+$ ln -s /usr/local/libexec/execrom ~/.local/bin/driftblim
+$ ln -s /usr/local/libexec/execrom ~/.local/bin/left
+.Ed
+.Pp
+Les ROMs peuvent alors être exécutées directement.
+.Bd -literal -offset indent
+$ drifblim prog.tal prog
+$ left doc.txt
+.Ed
+.Sh ÉTATS DE SORTIE
+L’utilitaire
+.Nm execrom
+quitte avec 0 si tout s’est bien passé et avec >0 si une erreur est survenue.
+.Sh AUTEURS
+.An Loïc Daignault-Pichette <ldp@asteride.xyz>
