home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Club Amiga de Montreal - CAM
/
CAM_CD_1.iso
/
files
/
592b.lha
/
TermII
/
Fran軋is
/
Documentation
/
COMMANDES.doc.pp
/
COMMANDES.doc
Wrap
Text File
|
1992-01-01
|
23KB
|
547 lines
Le 2 Juillet 1991
Term II
version 1.1
(c) 1990,1991 - Eric GONTIER
COMMANDES.doc
INTRODUCTION :
Term II est utilisable par un système de commandes. Toutes les
fonctions de Term II sont accessibles par des commandes. Tout
est commande. Pour l'instant, Term II reconnait 90 commandes,
mais il devrait en avoir près d'une centaine très bientôt.
Ce mécanisme de commandes est très important, car il a permis
de faire Term II indépendamment de son interface utilisateur.
Plusieurs propriétés en découlent immédiatement :
- Le fichier de configuration est un fichier de commandes.
L'utilisateur peut le modifier très simplement avec un
simple éditeur de texte.
- Les menus ne sont qu'une interface aux commandes. Deux
sortes de menu sont proposés. Le premier est un menu court,
qui ne propose que quelques options donnant accès à des
requesters pour des sélections plus fines. Le deuxième est
plus classique : il se compose de menus et de sous-menus,
donnant ainsi l'accès immédiat à de nombreuses commandes.
- Dernier intéret, et non des moindres, ces fonctions
sont appelables facilement depuis ARexx, ce qui permet de
créer facilement des scripts, pour concevoir des automates
de téléchargement par exemple. Un mécanisme puissant pour
faciliter l'écriture de ces scripts et tirant au mieux
parti des possibilités de ARexx est en cours d'élaboration.
Une description préléminaire se trouve à la fin de ce
document.
La suite de ce document décrit les commandes existantes dans la
version 1.0 avec leur syntaxe. Le lecteur se reportera au
fichier SCRIPTS.doc pour plus d'informations sur l'utilisation
de ces commandes dans l'écriture de scripts à l'aide de ARexx.
LES COMMANDES :
about
Cette commande affiche l'about du programme : copyright,
version, date, nom de l'utilisateur dans le cas d'une
version enregistrée
capture
Cette commande affiche le tableau de bord pour la capture
d'une connection. La capture est toujours ajoutée en fin de
fichier. On ne risque donc pas d'écraser un fichier par
erreur.
capture_buffer taille
Cette commande permet de fixer la taille du buffer de
capture. Dès que le buffer est plein, Term II écrit le
buffer dans le fichier de capture. Il n'est pas conseillé
de prendre un buffer trop gros, car dans ce cas, il peut y
avoir des temps morts gênants pendant l'écriture sur
disque du buffer.
capture_dir "directory"
Cette commande permet de fixer le répertoire de capture par
défaut. Ce directory n'est utilisé que quand on passe par
le tableau de bord de capture. Si on utilise la commande
capture_on, il faut dans ce cas donner un chemin d'accès
complet.
capture_off
Stopper la capture et vide le buffer.
capture_on "nom_de_fichier"
Démarre la capture d'une connection. Le nom_de_fichier doit
être un chemin d'accès complet. En particulier, le
répertoire fixé avec la commande capture_dir n'est pas
utilisée.
capture_on_
Démarre la capture. Un requester s'affiche pour saisir le
nom du fichier dans lequel devra être stocké la capture.
Dans ce cas, le répertoire de capture, fixé avec la
commande capture_dir, est utilisé.
console_autowrap_off
Cette commande met la console en mode sans autowrap. Term
II ne passera pas à la ligne automatiquement si la ligne
est plus grande que l'écran, est une partie du texte peut
ne pas êtrelisible.
console_autowrap_on
Cette commande met la console en mode autowrap. Dans ce
cas, si Term II reçoit une ligne plus grande que l'écran,
Term II passe à la ligne automatiquement, permettant ainsi
de voir tout le texte.
console_clear
Efface la fenêtre
console_close
Ferme la fenêtre. Les caractères passant à travers
l'interface série ne sont plus affichés. Mais Term II
continue à fonctionner. Ce mode de fonctionnement est
intéressant pour les connections en aveugle, par des
scripts. On gagne du temps en ne faisant pas afficher la
connection, mais on ne sait pas exactement ce qui se passe.
Si la console est fermée, le seule moyen pour envoyer du
texte est d'utiliser la commande serial_send.
console_command
Ouvre le requester avec la plupart des commandes liées à la
commande, modifiables par gadgets.
console_echo_off
Arrete l'écho systématique.
console_echo_on
Mise en place de l'écho systématique. Tout caractère tapé
est affiché à l'écran avant d'être envoyé sur l'interface
série.
console_font "nom.font" size
Cette commande permet de changer la fonte utilisée par la
fenêtre. Malheureusement, une limitation du console.device
de l'Amiga empêche l'utilisation de fontes non
proportionnelles.
console_map_key numero "commande"
Cette commande permet d'associer une commande à une touche
de fonction. Les numéros 1 à 10 correspondent aux touches
F1 à F10. Les numéros 11 à 20 correspondent aux touche
<shift>F1 à <shift>F10. Par exemple :
console_map_key 1 "serial_send \"ATDT3600\n\""
associe la commande serial_send "ATDT3600\n" a la touche de
fonction F1. Le caractère \ permet de définir des
caractères spéciaux : \n correspond au RETURN (x0d) et \l
au LINE FEED (x0a). \\ et \" permettent d'insérer les
caractères \ et " respectivement, dans une chaine de
caractères.
Voici quelques exemples d'assignation des touches de
fonction, tel qu'on peut les trouver dans term.config :
#
# Exemples de programmation de touches de fonction
#
# shift-F10 pour quitter Term II
console_map_key 20 "rexx \"quit.rexx\""
# F10 pour lancer la XCMD Laser
console_map_key 10 "rexx \"laser.rexx\""
# F9 pour déconnecter un modem HAYES
console_map_key 9 "serial_send \"+++\""
# F1 pour appeler mon BBS favori
console_map_key 1 "serial_send \"ATDT999999\n\""
console_open
Ouvre une console, avec une fenêtre. Les options choisies
avec les commandes window sont prises en compte pour
choisir le nombre de couleurs, l'écran de travail, les
gadgets de la fenêtre, etc...
console_setfont
Cette commande donne accès à un requester de fontes pour
sélectionner une nouvelle fonte pour la console. Il est
conseillé de n'utiliser que des fontes non
proportionnelles.
menu_long_on
Met en place le menu long. C'est le menu avec le plus de
sélections possibles.
menu_off
Retire le menu de la fenêtre.
menu_short_on
Met en place le menu court.
option_load "nom_de_fichier"
Lit et interprête un fichier de commandes. Au lancement,
Term II exécute un option_load "term.config" pour
s'auto-configurer.
option_save "nom_de_fichier"
Sauve toutes les paramètres de configuration sous forme
d'un fichier de commandes. L'option "Save Config" du menu
correspond à un option_save "term.config"
panel
Cette commande met en route la XCMD Panel qui permet de
disposer d'un panneau de commandes : il suffit de cliquer
sur un bouton pour lancer une exécution. Si le processus
n'est pas déjà présent en mémoire, il est chargé puis créé.
Pour plus d'informations sur cette XCMD, voir le fichier
PANEL.doc
phone_book
Cette commande met en route la XCMD Phone Bool qui met en
route un carnet de téléphone capable de composer
automatiquement des numéros. Si le processus n'est pas déjà
présent en mémoire, il est chargé puis créé. Pour plus
d'informations sur cette XCMD, voir le fichier
PHONE_BOOK.doc.
quit
Termine Term II, libérant du même coup toutes les
ressources acquises par Term au cours de son exécution. Si
les XCMD Panel ou Phone Book ont été exécutées elles seront
errêtées et retirées de la mémoire.
rexx "nom_de_fichier"
Cette commande permet de démarrer un script rexx (si
RexxMaster est déjà en tâche de fond)
rexx_delay delai
Cette commande, utilisable uniquement depuis un script
ARexx permet de mettre en attente le script, tandis que
Term II continue à fonctionner normalement. Si le mécanisme
de memory a été mis en route, la variable memory à
l'intérieur du programme ARexx sera mise à jour (création
si nécessaire). Voir aussi les commandes rexx_memory_on,
rexx_memory_off et rexx_wait, ainsi que le fichier
SCRIPTS.doc, pour plus d'informations. Il y a aussi
plusieurs scripts d'exemple qui accompagnent Term II.
rexx_memory_off
Cette commande n'est utilisable que depuis un script Rexx.
Elle permet d'arrêter le mécanisme de "memory".
rexx_memory_on
Cette commande n'est utilisable qu'à l'intérieur d'un
script ARexx. Elle permet de mettre en route le mécanisme
de "memory". Ce mécanisme permet de se souvenir en
permanence des 80 derniers caractères reçus par Term via
l'interface série. Un programme ARexx pourra récupérer ces
80 caractères dans la variable "memory" qui est créée
automatiquement par Term. Cette variable est mise à jour à
chaque appel aux fonctions rexx_delay ou rexx_wait. Le
fichier SCRIPTS.doc donne des exemples d'utilisation de ces
fonctions.
rexx_wait delai1 delai2
Cette commande n'est utilisable que depuis un script ARexx.
Elle accepte deux valeurs de délai (en secondes) comme
paramètre, donnant ainsi deux possibilités de retour dans
le script. Le premier délai (délai1) permet de fixer un
timeout pour l'arrivée du premier caractère attendu sur
l'interface série. Le deuxième délai (délai2) permet de
fixer un timeout sur le dernier caractère reçu. Si le
mécanisme de "memory" a été mis en place, la variable
"memory" sera mise à jour à l'intérieur du script appelant.
Voir aussi le fichier SCRIPTS.doc et les commandes
rexx_delay, rexx_memory_on, rexx_memory_off.
serial
Affiche le tableau de bord de l'interface série pour
permettre de la paramétrer facilement, à la souris.
serial_baud baud
Fixe la vitesse de transmission sur l'interface série.
serial_buffer taille
Fixe la taille du buffer de l'interface série. Tout ce qui
entre dans l'interface série est bufferisé par l'Amiga.
Term II ne fait que lire dans ce buffer. A grande vitesse
il est possible que Term II ne vide pas le buffer
suffisamment vite. Dans ce cas, il peut être intéressant
d'en augmenter la taille.
serial_close
Ferme le serial.device et libère les ressources associées.
serial_length longueur
Fixe la longueur des mots échangés sur le serial.device.
Les longueurs autorisées sont 7 bits ou 8 bits.
serial_off
Cette commande interdit à Term II de lire le serial.device.
Cette commande peut-être utilisée dans les scripts ou dans
les XCMD pour être sûr que Term II ne lit le serial device
que sur demande. (par exemple avec xcmd_sread). Après un
serial_off, Term ne pourra plus mettre à jour le buffer de
memory utilisé dans les scripts et dans les XCMD.
serial_on
Cette commande à l'effet inverse de serial_off : elle
autorise Term à lire le serial.device.
serial_open "serial.device" unit
Ouvre le serial.device. il faut spécifier le device utilisé
ainsi que l'unit. En pratique, on utilise souvent le
"serial.device" comme device, et 0 comme unit. Mais il est
possible de prendre un autre device (carte modem interne,
style SUPRA par exemple), ou une autre unit (carte
multisérie de Commodore)
serial_parity parite
Fixe la parité sur l'interface série. Trois sorte de
parités sont autorisées : 0 impaire, 1 paire, 2 sans
parité, 3 parité space, 4 parité mark.
serial_send "chaine"
Envoie la chaine de caractères dans l'interface série
serial_stop stop
Fixe le nombre de bit de stops. Les valeurs autorisées sont
1 ou 2.
serial_xdisabled
Empêche la gestion du handshake XON/XOFF par le serial
device
serial_xenabled
Autorise la gestion du handshake XON/XOFF par le serial
device.
window_backdrop_off
Indique que la fenetre ne devra pas être backdrop. Ne prend
effet qu'au prochain console_open.
window_backdrop_on
Indique que la fenetre devra être backdrop. Ne prend effet
qu'au prochain console_open.
window_borderless_off
Indique que la fenêtre devra être avec bords. Ne prend
effet qu'au prochain console_open.
window_borderless_on
Indique que la fenêtre devra être sans bords. Ne prend
effet qu'au prochain console_open.
window_closegadget_off
La fenêtre sera sans close gadget.
window_closegadget_on
La fenêtre aura un close gadget.
window_color nombre
Fixe le nombre de couleurs pour l'écran. Le nombre est 2, 4
ou 8.
window_dragbar_off
La fenêtre n'aura pas de drag bar. On ne pourra donc pas la
déplacer.
window_dragbar_on
La fenêtre aura une drag bar.
window_options
Affiche le tableau de bord des options pour la fenêtre.
window_publicscreen_default
Si on demande un public screen, alors Term II s'installera
sur l'écran public par défaut.
window_publicscreen_name "nom"
Si on demande un écran public, Term II s'installera sur
celui dont le nom est donné.
window_screen_public
Indique la fenetre devra s'ouvrir sur un écran public.
L'écran est désigné par une des options window_publicscreen
window_screen_term
Indique que Term II utilisera son propre écran.
window_screen_workbench
Indique que Term II utilisera le même écran que celui du
Workbench.
window_sizegadget_off
Pas de size gadget pour la fenêtre.
window_sizegadget_on
Il y aura un size gadget à la fenêtre.
window_termscreen_interlace_off
Si Term a son propre écran (window_screen_term), Term
n'utilisera pas un écran entrelacé.
window_termscreen_interlace_on
Si Term a son propre écran (window_screen_term), Term
utilise un écran entrelacé.
window_termscreen_shanghai_off
Si Term a son propre écran, l'écran ne sera pas shanghai
window_termscreen_shanghai_on
Si Term a son propre écran, l'écran sera shanghai
xcmd_delay
Cette commande est l'équivalent de rexx_delay. Elle permet
de faire un délai depuis une XCMD (voir le fichier
XCMD.doc). xcmd_Args[0] est l'adresse d'un long contenant
la valeur du délai en secondes. Cette commande ne peut être
appelée que depuis un processus externe.
xcmd_lock_request
Cette commande demande à Term II de retourner un lock sur
le répertoire de Term II, et un lock sur l'écran de Term
II. Si besoin, l'écran sera ouvert par Term II. Cette
commande est utile s'il pas prévu qu'une commande START
soit transmise au processus externe. Le processus externe
devra libérer ces locks lui-même avec les fonctions UnLock
et UnlockPubScreen. Les valeurs des locks sont retournés en
même temps que la XCMD, dans les champs xcmd_TermScreen et
xcmd_TermDir. Cette commande ne peut-être appelée que
depuis un processus externe.
xcmd_memory_request
Cette commande demande à Term II de retourner les 80
derniers caractères reçus. C'est au processus externe de
fournir un pointeur valide vers une chaine de 81 caractères
(pour contenir le 0 de fin de chaine) dans laquelle Term II
recopiera ces 80 caractères (plus le 0 de fin de chaine).
Ce pointeur doit être placé dans le champ xcmd_Args[0] de
la XCMD avant d'être envoyé à Term II. Cette commande ne
peut être appelée que depuis un processus externe.
xcmd_memory_off
Equivalent de rexx_memory_off. Cette commande arrête le
mécanisme de memory. Voir le fichier SCRIPTS.doc. Cette
commande ne peut être appelée que depuis un processus
externe.
xcmd_memory_on
Equivalent de rexx_memory_on, cette commande met en route
le mécanise de memory. Voir le fichier SCRIPTS.doc. Cette
commande ne peut être appelée que depuis un processus
externe.
xcmd_setserial
Commande spéciale pour les XCMD permettant de modifier les
paramètres de l'interface série.
xcmd_sflush
Commande spéciale pour les XCMD permettant de vider les
buffers de l'interface série.
xcmd_squery
Commande spéciale pour les XCMD permettant d'obtenir le
nombre de caractères recus par l'interface série et en
attente de lecture.
xcmd_sread
Commande spéciale pour les XCMD permettant de lire sur
l'interface série. Voir le fichier SCRIPTS.doc
xcmd_start "port"
Cette commande émet un message XCMD_START vers le port d'un
processus externe. Par exemple la commande
xcmd_start "PANEL_PORT"
permet de faire démarrer la maquette du panel.
xcmd_stop "port"
Envoie un message XCMD_STOP vers le port d'un processus
externe.
xcmd_swrite
Commande spéciale pour les XCMD permettant d'écrire sur
l'interface série. Voir le fichier SCRIPTS.doc.
xcmd_wait
Equivalent de la commande rexx_wait. Voir le fichier
SCRIPTS.doc. xcmd_Args[0] pointe sur un long contenant la
valeur du premier délai en secondes. xmd_Args[1] pointe sur
un long contenant la valeur du second délai, en secondes.
Cette commande ne peut être appelée que depuis un processus
externe.
xpr
Affiche le tableau de bord pour le téléchargement avec les
protocoles XPR.
xpr_close
Ferme la librairie XPR ouverte.
xpr_down_dir "directory"
Fixe le répertoire de download.
xpr_init "init"
Envoie une chaine d'initialisation à un protocole XPR.
Cette chaine dépend du protocole utilisé. Consulter la doc
du protocole XPR utilisé.
xpr_open "LibName"
Ouvre une librairie XPR.
xpr_open_
Cette commande ouvre une librairie XPR. Un requester permet
de saisir le nom de la librairie.
xpr_receive "nom"
Reçoit un fichier (download) par le protocole XPR
sélectionné.
xpr_receive_
Cette commande permet de recevoir un fichier. Un requester
est utilisé pour saisir le nom du fichier.
xpr_send "nom"
Envoie un fichier (upload).
xpr_send_
Envoie un fichier. Utilise un requester pour saisir le nom
du fichier.
xpr_setup
Initialise un protocole XPR.
xpr_up_dir "directory"
Fixe le repertoire d'upload.