Manpages

NOM

termios, tcgetattr, tcsetattr, tcsendbreak, tcdrain, tcflush, tcflow, cfmakeraw, cfgetospeed, cfgetispeed, cfsetispeed, cfsetospeed, cfsetspeed - Configuration du terminal

SYNOPSIS

#include <termios.h>
#include <unistd.h>

int tcgetattr(int fd, struct termios *termios_p);

int tcsetattr(int fd, int optional_actions,
const struct termios *termios_p);

int tcsendbreak(int fd, int durée);

int tcdrain(int fd);

int tcflush(int fd, int queue_selector);

int tcflow(int fd, int action);

void cfmakeraw(struct termios *termios_p);

speed_t cfgetispeed(const struct termios *termios_p);

speed_t cfgetospeed(const struct termios *termios_p);

int cfsetispeed(struct termios *termios_p, speed_t vitesse);

int cfsetospeed(struct termios *termios_p, speed_t vitesse);

int cfsetspeed(struct termios *termios_p, speed_t vitesse);

Exigences de macros de test de fonctionnalités pour la glibc (consulter feature_test_macros(7)) :

cfsetspeed(), cfmakeraw():
Since glibc 2.19:
_DEFAULT_SOURCE
Glibc 2.19 and earlier:
_BSD_SOURCE

DESCRIPTION

Les fonctions termios établissent une interface générale pour les terminaux, permettant de contrôler les ports de communication asynchrone.

La structure termios
Plusieurs fonctions décrites ici utilisent un argument termios_p qui est un pointeur sur une structure termios. Cette structure contient au moins les membres suivants :

tcflag_t c_iflag;      /* modes d’entrée */
tcflag_t c_oflag;      /* modes de sortie */
tcflag_t c_cflag;      /* modes de contrôle */
tcflag_t c_lflag;      /* modes locaux */
cc_t     c_cc[NCCS];   /* caractères spéciaux */

Les valeurs qui peuvent être mises dans ces membres sont décrites ci-dessous. Dans le cas des quatre premiers membres, les définitions de certains des modes associés qui peuvent être utilisés ne sont exposés que si une macro est définie pour des tests spécifiques (consultez feature_test_macros(7)), comme indiqué entre crochets (« [] »).

Dans les descriptions ci-dessous, « pas dans POSIX » signifie que la valeur n’est pas spécifiée dans POSIX.1-2001, et « XSI » signifie que la valeur est spécifiée dans POSIX.1-2001 comme faisant partie de l’extension XSI.

Constantes pour l’attribut c_iflag :

If neither IGNPAR nor PARMRK is set, read a character with a parity error or framing error as \0.

IMAXBEL

(Pas dans POSIX) Faire sonner le terminal quand le tampon d’entrée est plein. Linux n’implémente pas ce bit, et considère qu’il est toujours actif.

IUTF8 (depuis Linux 2.6.4)

(Pas dans POSIX) L’entrée est en UTF-8 ; ceci permet au caractère d’effacement de fonctionner correctement dans le mode « cooked ».

Constantes pour l’attribut c_oflag :

Constantes pour l’attribut c_cflag :

CBAUDEX

(Pas dans POSIX) Masque étendu des vitesses (1 bit) inclus dans CBAUD. [Nécessite _BSD_SOURCE ou _SVID_SOURCE]

POSIX dit que la vitesse est stockée dans une structure termios sans dire précisément où, et fournit cfgetispeed() et cfsetispeed() pour la lire ou l’écrire. Certains systèmes utilisent les bits de CBAUD dans c_cflag, d’autres systèmes utilisent des champs distincts, par exemple sg_ispeed et sg_ospeed.

CRTSCTS

(Pas dans POSIX) Contrôle de flux RTS/CTS. [Nécessite _BSD_SOURCE ou _SVID_SOURCE]

Constantes pour l’attribut c_lflag :

ECHOCTL

(Pas dans POSIX) Si ECHO est également activé, les caractères spéciaux du terminal autres que TAB, NL, START, et STOP sont représentés par ^X, où X est le caractère dont le code ASCII est supérieur de 0x40 à celui du caractère spécial. Par exemple, 0x08 (BS) est représenté par ^H. [Nécessite _BSD_SOURCE ou _SVID_SOURCE]

ECHOPRT

(Pas dans POSIX) Si ICANON et ECHO sont aussi activés, les caractères sont imprimés lorsqu’ils sont effacés. [Nécessite _BSD_SOURCE ou _SVID_SOURCE]

DEFECHO

(Pas dans POSIX) N’effectuer l’affichage que lorsque le caractère est lu. (Non implémenté dans Linux)

Le tableau c_cc définit des caractères spéciaux. Les symboles (valeurs initiales) et significations sont :
VDISCARD

(Pas dans POSIX, non supporté sous Linux ; 017, SI, Ctrl-O) Bascule start/stop pour ignorer les caractères en attente de sortie. Reconnu quand IEXTEN est actif, et pas transmis en entrée.

VREPRINT

(Pas dans POSIX ; 022, DC2, Ctrl-R) Réafficher les caractères pas encore lus (REPRINT). Reconnu quand ICANON et IEXTEN sont actifs, et pas transmis en entrée.

VSTATUS

(Pas dans POSIX, non supporté sous Linux ; 024, DC4, Ctrl-T). Caractère d’état (STATUS). Affiche sur le terminal des informations sur l’état, incluant l’état du processus en premier plan et la quantité de temps CPU qu’il a consommé. Envoie aussi un signal SIGINFO (not supporté par Linux) au groupe du processus de premier plan.

VWERASE

(Pas dans POSIX ; 027, ETB, Ctrl-W) Effacement de mot (WERASE). Reconnu quand ICANON et IEXTEN sont actifs, et pas transmis en entrée.

Un caractère spécial de terminal isolé peut être désactivé en positionnant la valeur de l’élément c_cc correspondant à _POSIX_VDISABLE.

Les valeurs d’indices ci-dessus sont toutes différentes, sauf VTIME et VMIN qui peuvent avoir la même valeur que VEOL et VEOF respectivement. En mode non canonique, la signification d’un caractère spécial est remplacée par sa valeur de temporisation. Pour des explications sur VMIN et VTIME, consultez la description du mode non canonique ci-dessous.

Récupérer et changer les paramètres du terminal
tcgetattr() récupère les paramètres associés à l’objet référencé par fd et les stocke dans la structure termios pointée par termios_p. Cette fonction peut être appelée par un processus en arrière-plan. Néanmoins, les attributs de terminal peuvent être modifiés par la suite par le processus au premier plan.

tcsetattr() définit les paramètres du terminal (à moins que le matériel sous-jacent ne le supporte pas) en lisant la structure termios pointée par termios_p. optional_actions précise quand les changements auront lieu :
TCSANOW

Les modifications sont effectuées immédiatement.

TCSADRAIN

Les modifications sont effectuées lorsque toutes les opérations d’écriture sur fd auront été transmises. Cette option devrait être utilisée pour toute modification de paramètre affectant les sorties.

TCSAFLUSH

Les modifications sont effectuées lorsque toutes les opérations d’écriture sur fd auront été transmises. Les entrées qui n’ont pas été traitées seront éliminées avant de faire les modifications.

Mode canonique et non canonique
The setting of the ICANON canon flag in c_lflag determines whether the terminal is operating in canonical mode (ICANON set) or noncanonical mode (ICANON unset). By default, ICANON is set.

Dans le mode canonique :

In noncanonical mode input is available immediately (without the user having to type a line-delimiter character), no input processing is performed, and line editing is disabled. The read buffer will only accept 4095 chars; this provides the necessary space for a newline char if the input mode is switched to canonical. The settings of MIN (c_cc[VMIN]) and TIME (c_cc[VTIME]) determine the circumstances in which a read(2) completes; there are four distinct cases:
MIN == 0, TIME == 0 (lecture de scrutation (polling))

Si des données sont disponibles, read(2) renvoie immédiatement le nombre d’octets disponibles ou le nombre d’octets demandés (le plus petit des deux). Si aucune donnée n’est disponible, read(2) renvoie 0.

MIN > 0, TIME == 0 (lecture bloquante)

read(2) est bloquant jusqu’à ce que MIN octets soient disponibles, puis renvoie jusqu’au nombre d’octet demandés.

MIN == 0, TIME > 0 (lecture avec délai)

TIME indique une limite de temps en dixième de seconde. Le décompte du temps commence lors de l’appel à read(2). read(2) se termine si au moins un octet est disponible ou si la temporisation expire. Si la temporisation expire sans qu’il n’y ait eu de données disponibles, read(2) renvoie 0. Si des données sont déjà disponibles au moment de l’appel à read(2), l’appel se comporte comme si les données étaient reçues immédiatement après l’appel.

MIN > 0, TIME > 0 (lecture avec délai entre deux octets)

TIME indique une limite de temps en dixième de seconde. Quand un premier caractère est disponible en entrée, la temporisation est démarrée, puis remise à zéro à chaque caractère reçu. read(2) se termine quand une des conditions suivantes est vraie.

Comme la temporisation n’est démarrée que lors de la réception du premier octet, au moins un octet sera lu. Si des données sont déjà disponibles au moment de l’appel à read(2), l’appel se comporte comme si les données étaient reçues immédiatement après l’appel.

POSIX ne spécifie pas si le réglage de l’attribut d’état de fichier O_NONBLOCK est prioritaire sur les réglages de MIN et TIME. Si O_NONBLOCK est défini, un read(2) en mode non canonique pourrait s’arrêter immédiatement, quelque soit le réglage de MIN ou TIME. De plus, si aucune donnée n’est disponible, POSIX permet un read(2) en mode non canonique de renvoyer soit 0, soit -1 avec errno défini à EAGAIN.

Mode brut
cfmakeraw() place le terminal dans un mode proche du mode « raw » de l’ancien pilote de terminal version 7 : l’entrée est disponible caractère par caractère, il n’y a pas d’écho ni de traitement particulier des caractères d’entrée ou sortie. Les attributs du terminal sont définis ainsi :

termios_p->c_iflag &= ~(IGNBRK | BRKINT | PARMRK | ISTRIP
                | INLCR | IGNCR | ICRNL | IXON);
termios_p->c_oflag &= ~OPOST;
termios_p->c_lflag &= ~(ECHO | ECHONL | ICANON | ISIG | IEXTEN);
termios_p->c_cflag &= ~(CSIZE | PARENB);
termios_p->c_cflag |= CS8;

Contrôle de la ligne
tcsendbreak() transmet un flux continu de bits à zéro pendant une durée donnée si le terminal utilise une transmission série asynchrone. Si durée vaut zéro, les bits à zéro sont émis pendant au moins 0,25 seconde, et pas plus de 0,5 seconde. Si durée est non nulle, l’émission se fera pendant un temps dépendant de l’implémentation.

Si le terminal n’est pas connecté avec une liaison série asynchrone, tcsendbreak() n’effectue aucune action.

tcdrain() attend que toutes les écritures sur l’objet référencé par fd aient été transmises.

tcflush() élimine toutes les écritures sur l’objet fd pas encore transmises, ainsi que les données reçues mais pas encore lues, ceci en fonction de la valeur de queue_selector :
TCIFLUSH

efface les données reçues mais non lues.

TCOFLUSH

efface les données écrites mais non transmises.

TCIOFLUSH

efface à la fois les données reçues non lues, et les données écrites non transmises.

tcflow() suspend la transmission ou la réception des données sur l’objet référencé par fd, en fonction de la valeur de action :

Lors de l’ouverture d’un terminal, ni ses sorties ni ses entrées ne sont suspendues.

Vitesse de la ligne
Il est possible d’utiliser les fonctions suivantes pour lire ou écrire la vitesse de communication du terminal, en utilisant la structure termios. Les modifications ne prennent effet que lorsque la fonction tcsetattr() a été invoquée et qu’elle a réussi.

Définir une vitesse B0 demande au modem de raccrocher. La vitesse réelle de communication correspondant à B38400 peut être modifiée avec setserial(8).

Les vitesses en entrée et en sortie sont stockées dans la structure termios.

cfgetospeed() renvoie la vitesse de sortie stockée dans la structure termios pointée par termios_p.

cfsetospeed() définit la vitesse de sortie stockée dans la structure termios pointée par termios_p à la valeur vitesse, qui doit être l’une des constantes suivantes :

B0

La vitesse nulle, B0, est utilisée pour terminer une connexion. Si B0 est indiquée, il n’y a aucune garantie d’état des lignes de contrôle du modem. Normalement, ceci devrait déconnecter la ligne. CBAUDEX est un masque pour les vitesses supérieures à celles définies dans POSIX.1 (supérieures ou égales à 57600). Ainsi, B57600 & CBAUDEX est non nulle.

cfgetispeed() renvoie la vitesse d’entrée stockée dans la structure termios.

cfsetispeed() définit la vitesse d’entrée stockée dans la structure termios à la valeur vitesse, qui doit être spécifiée à l’aide d’une des constantes Bnnn listées ci-dessus pour cfsetospeed(). Si la vitesse d’entrée est mise à 0, elle prendra la même valeur que la vitesse de sortie.

cfsetspeed() est une extension BSD 4.4. Elle prend les mêmes arguments que cfsetispeed(), et définit à la fois les vitesses d’entrée et de sortie.

VALEUR RENVOYÉE

cfgetispeed() renvoie la vitesse d’entrée stockée dans la structure termios.

cfgetospeed() renvoie la vitesse de sortie stockée dans la structure termios.

Toutes les autres fonctions renvoient

Notez que tcsetattr() indique une réussite si une des modifications peut être réalisée. Toutefois, pour effectuer plusieurs changements, il peut être nécessaire de faire suivre cet appel d’une invocation de tcgetattr() pour vérifier que les modifications ont bien été réalisées.

ATTRIBUTS

Pour une explication des termes utilisés dans cette section, consulter attributes(7).

CONFORMITÉ

tcgetattr(), tcsetattr(), tcsendbreak(), tcdrain(), tcflush(), tcflow(), cfgetispeed(), cfgetospeed(), cfsetispeed() et cfsetospeed() sont spécifiés dans POSIX.1-2001.

cfmakeraw() et cfsetspeed() ne sont pas standard, mais sont disponibles sur les BSD.

NOTES

UNIX V7 et plusieurs systèmes ultérieurs avaient une liste de vitesse de transmission où l’on rencontrait, après les quatorze valeurs B0...B9600, les constantes EXTA et EXTB (« External A » et « External B »). De nombreux systèmes étendent cette liste avec des vitesses bien plus rapides.

L’effet d’une durée non nulle avec tcsendbreak() est variable. SunOS indique un break pendant duration * N secondes, où N est au moins 0,25, et au plus 0,5. Linux, AIX, DU, Tru64 envoie un break pendant duration millisecondes. FreeBSD, NetBSD, HP-UX et MacOS ignorent la valeur duration. Sous Solaris et UnixWare, tcsendbreak() avec une duration non nulle se comporte comme tcdrain().

BOGUES

On the Alpha architecture before Linux 4.16 (and glibc before 2.28), the XTABS value was different from TAB3 and it was ignored by the N_TTY line discipline code of the terminal driver as a result (because as it wasn’t part of the TABDLY mask).

VOIR AUSSI

reset(1), setterm(1), stty(1), tput(1), tset(1), tty(1), ioctl_console(2), ioctl_tty(2), setserial(8)

COLOPHON

Cette page fait partie de la publication 5.07 du projet man-pages Linux. Une description du projet et des instructions pour signaler des anomalies et la dernière version de cette page, peuvent être trouvées à l’adresse https://www.kernel.org/doc/man-pages/.

TRADUCTION

La traduction française de cette page de manuel a été créée par Christophe Blaess <https://www.blaess.fr/christophe/>;, Stéphan Rafin <stephan.rafin [AT] laposte.net>, Thierry Vignaud <tvignaud [AT] mandriva.com>, François Micaux, Alain Portal <aportal [AT] univ-montp2.fr>, Jean-Philippe Guérard <fevrier [AT] tigreraye.org>, Jean-Luc Coulon (f5ibh) <jean-luc.coulon [AT] wanadoo.fr>, Julien Cristau <jcristau [AT] debian.org>, Thomas Huriaux <thomas.huriaux [AT] gmail.com>, Nicolas François <nicolas.francois [AT] centraliens.net>, Florentin Duneau <fduneau [AT] gmail.com>, Simon Paillard <simon.paillard [AT] resel.fr>, Denis Barbier <barbier [AT] debian.org> et David Prévot <david [AT] tilapin.org>

Cette traduction est une documentation libre ; veuillez vous reporter à la GNU General Public License version 3 concernant les conditions de copie et de distribution. Il n’y a aucune RESPONSABILITÉ LÉGALE.

Si vous découvrez un bogue dans la traduction de cette page de manuel, veuillez envoyer un message à <debian-l10n-french [AT] lists.org>.