commit 9a3b65f738ee49ed2c7490e2d64d5933fb659fc4
parent 56e05d111e27b3a730d7f392eea056563327d8b0
Auteur: Loïc Daignault-Pichette <ldp@asteride.xyz>
Date: Sat, 20 Sep 2025 17:38:39 -0400
[doc] Ajouter un LISEZ-MOI
Diffstat:
| A | LISEZ-MOI.txt | | | 115 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 fichier modifié, 115 insertions(+), 0 suppressions(-)
diff --git a/LISEZ-MOI.txt b/LISEZ-MOI.txt
@@ -0,0 +1,115 @@
+EXECROM(8)
+==========
+
+Ce ne sont pas tous les formats de fichier qui contiennent des programmes qui
+sont compatibles avec la syntaxe « #! », qui permet d’interpréter des programmes
+de la même manière que les programmes compilés dans le format d’exécutable natif
+du système d’exploitation. De nombreuses ROMs destinées à certains émulateurs ou
+machines virtuelles souffrent notamment de cette incompatibilité.
+
+Soit ~/uxn/drifblim et ~/uxn/leftA deux ROMs exécutables par une machine
+Varvara. La première contient un assembleur uxntal interprétable par la machine
+virtuelle en mode texte uxncli(1). La commande suivante assemble prog.tal dans
+prog.rom.
+
+ $ uxncli ~/uxn/drifblim prog.tal prog.rom
+
+La seconde ROM est un éditeur de texte en mode graphique. Elle doit donc être
+interprétée par uxnemu(1). La commande suivante ouvre le fichier doc.txt avec
+l’éditeur de texte.
+
+ $ uxnemu ~/uxn/left doc.txt
+
+Grâce à execrom(8), et à quelques manipulations montrées plus bas, ces deux
+programmes peuvent être exécutés comme suit:
+
+ $ drifblim prog.tal prog
+ $ left doc.txt
+
+Dépendance d’exécution
+-----------------------
+
+- POSIX
+
+Dépendances de compilation
+--------------------------
+
+- Compilateur C89 ou plus récent
+- POSIX
+- make (supportant les assignations avec « != »)
+
+Installer
+---------
+
+execrom(8) a été testé sur :
+* OpenBSD 7.7
+* Alpine Linux 3.22
+
+Cloner le dépôt git :
+
+ $ git clone git://git.asteride.xyz/~ldp/execrom.git
+ $ cd execrom
+
+Compiler le programme :
+
+ $ make
+
+Installer le programme et ses pages du manuel :
+
+ # make install
+
+Ils s’installeront sous LIBEXEC_DOS et MAN_DOS, respectivement. Ces variables
+ont chacune une valeur prédéfinie dans le Makefile et dépendent de PREFIX ; il
+peut être utile de les modifier. Puisque les pages du manuel ne sont pour
+l’instant disponibles qu’en français et en catalan et que l’installateur les
+place dans ${MAN_DOS}/fr/ et ${MAN_DOS}/ca/, respectivement, il y a des chances
+qu’elles soient inaccessibles et qu’il faille modifier la variable
+d’environnement MANPATH ou le fichier /etc/man.conf.
+
+Configurer
+----------
+
+Reprenons les ROMs ~/uxn/drifblim et ~/uxn/left. execrom(8) permet d’exécuter
+ces deux programmes sans avoir à spécifier chaque fois l’interpréteur approprié
+et le chemin vers la ROM. Pour ce faire, il faut régler la variable
+d’environnment EXECROM_CHEM pour qu’elle contienne le chemin vers le dossier où
+se trouvent les ROMs, ici, ~/uxn.
+
+ $ export EXECROM_CHEM="$HOME/uxn:$EXECROM_CHEM"
+
+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.
+
+ $ ls ~/uxn
+ drifblim.uxncli
+ left.uxnemu
+
+Enfin, un lien symbolique accessible par PATH et pointant vers
+l’exécutable d’execrom doit être créé pour chaque ROM.
+
+ $ ln -s /usr/local/libexec/execrom ~/.local/bin/driftblim
+ $ ln -s /usr/local/libexec/execrom ~/.local/bin/left
+
+Les ROMs peuvent alors être exécutées directement.
+
+ $ drifblim prog.tal prog
+ $ left doc.txt
+
+Contribuer
+----------
+
+Pour tout commentaire, rapport de bogue ou diff, on peut m’envoyer un courriel à
+ldp@asteride.xyz.
+
+Licence
+-------
+
+execrom(8) est distribué sous licence GPLv3.
+
+Auteur
+------
+
+execrom(8) a été créé et est maintenu par Loïc Daignault-Pichette
+<ldp@asteride.xyz>.
