NAME

termio − general terminal interface

DESCRIPTION

All of the asynchronous communications ports use the same general interface, no matter what hardware is involved.  The remainder of this section discusses the common features of this interface. 

When a terminal file is opened, it normally causes the process to wait until a connection is established.  In practice, users’ programs seldom open these files; they are opened by getty and become a user’s standard input, output, and error files.  The very first terminal file opened by the session leader becomes the controlling terminal for that process’s session.  This terminal file must not be associated with any other session.  The controlling terminal plays a special role in handling quit and interrupt signals, as discussed below.  The controlling terminal is inherited by a child process during a fork(2).  A process can break this association by changing its process group using setpgrp(2), creating a new session using setsid(2), or when all file descriptors associated with the controlling terminal have been closed. 

A terminal associated with one of these files ordinarily operates in full-duplex mode.  Characters may be typed at any time, even while output is occurring, and are only lost when the system’s character input buffers become completely full, which is rare, or when the user has accumulated the maximum allowed number of input characters that have not yet been read by some program.  Currently, this limit is 256 characters.  When the input limit is reached, the terminal bell rings for each character entered over the 256 character limit, and all the saved characters will be thrown away without notice.  The input limit can be configured beyond the 256 character limit with the ioctl(2) commands TCGETRAWQ, TCSETRAWQ, and TCGETRAWQMAX described in this man page. 

Normally, terminal input is processed in units of lines.  A line is delimited by a new-line (ASCII LF) character, an end-of-file (ASCII EOT) character, or an end-of-line character.  This means that a program attempting to read will be suspended until an entire line has been typed.  Also, no matter how many characters are requested in the read call, at most one line will be returned.  It is not, however, necessary to read a whole line at once; any number of characters may be requested in a read, even one, without losing information. 

During input, erase and kill processing is normally done.  By default, the character # erases the last character typed, except that it will not erase beyond the beginning of the line.  By default, the character @ kills (deletes) the entire input line, and optionally outputs a new-line character.  Both these characters operate on a key-stroke basis, independently of any backspacing or tabbing that may have been done.  Both the erase and kill characters may be entered literally by preceding them with the escape character (\).  In this case the escape character is not read.  The erase and kill characters may be changed. 

Certain characters have special functions on input.  These functions and their default character values are summarized as follows:

INTR (Rubout or ASCII DEL) generates an interrupt signal which is sent to all processes with the associated control terminal.  Normally, each such process is forced to terminate, but arrangements may be made either to ignore the signal or to receive a trap to an agreed-upon location; see signal(2). 

QUIT (Control-│ or ASCII FS) generates a quit signal.  Its treatment is identical to the interrupt signal except that, unless a receiving process has made other arrangements, it will not only be terminated but a core image file (called core) will be created in the current working directory. 

SWTCH ASCII NUL is used by the job control facility, shl, to change the current layer to the control layer. 

ERASE (#) erases the preceding character.  It will not erase beyond the start of a line, as delimited by a NL, EOF, or EOL character. 

KILL (@) deletes the entire line, as delimited by a NL, EOF, or EOL character. 

EOF (Control-d or ASCII EOT) may be used to generate an end-of-file from a terminal.  When received, all the characters waiting to be read are immediately passed to the program, without waiting for a new-line, and the EOF is discarded.  Thus, if there are no characters waiting, which is to say the EOF occurred at the beginning of a line, zero characters will be passed back, which is the standard end-of-file indication. 

NL (ASCII LF) is the normal line delimiter.  It can not be changed or escaped. 

EOL (ASCII NUL) is an additional line delimiter, like NL.  It is not normally used. 

STOP (Control-s or ASCII DC3) can be used to temporarily suspend output.  It is useful with CRT terminals to prevent output from disappearing before it can be read.  While output is suspended, STOP characters are ignored and not read. 

START (Control-q or ASCII DC1) is used to resume output which has been suspended by a STOP character.  While output is not suspended, START characters are ignored and not read.  The start/stop characters can not be changed or escaped. 

The character values for INTR, QUIT, SWTCH, ERASE, KILL, EOF, and EOL may be changed to suit individual tastes.  The ERASE, KILL, and EOF characters may be escaped by a preceding \ character, in which case no special function is done. 

When the carrier signal from the data-set drops, a hang-up signal is sent to all processes that have this terminal as the control terminal.  Unless other arrangements have been made, this signal causes the processes to terminate.  If the hang-up signal is ignored, any subsequent read returns with an end-of-file indication.  Thus, programs that read a terminal and test for end-of-file can terminate appropriately when hung up on. 

When one or more characters are written, they are transmitted to the terminal as soon as previously-written characters have finished typing.  Input characters are echoed by putting them in the output queue as they arrive.  If a process produces characters more rapidly than they can be typed, it will be suspended when its output queue exceeds some limit.  When the queue has drained down to some threshold, the program is resumed. 

Several ioctl(2) system calls apply to terminal files.  The primary calls use the following structure, defined in <termio.h>:

#defineNCC8
structtermio {
unsignedshortc_iflag; /∗ input modes ∗/
unsignedshortc_oflag; /∗ output modes ∗/
unsignedshortc_cflag; /∗ control modes ∗/
unsignedshortc_lflag; /∗ local modes ∗/
charc_line;/∗ line discipline ∗/
unsignedcharc_cc[NCC]; /∗ control chars ∗/
};

The special control characters are defined by the array c_cc (note that this is c_cc).  The relative positions and initial values for each function are as follows:

0VINTRDEL
1VQUITFS
2VERASE#
3VKILL@
4VEOFEOT
5VEOLNUL
6reserved
7SWTCHNUL

The c_iflag (note that this is c_iflag) field describes the basic terminal input control:

IGNBRK0000001Ignore break condition.
BRKINT0000002Signal interrupt on break.
IGNPAR0000004Ignore characters with parity errors.
PARMRK0000010Mark parity errors.
INPCK0000020Enable input parity check.
ISTRIP0000040Strip character.
INLCR0000100Map NL to CR on input.
IGNCR0000200Ignore CR.
ICRNL0000400Map CR to NL on input.
IUCLC0001000Map upper-case to lower-case on input.
IXON0002000Enable start/stop output control.
IXANY0004000Enable any character to restart output.
IXOFF0010000Enable start/stop input control.

If IGNBRK is set, the break condition (a character framing error with data all zeros) is ignored, that is, not put on the input queue and therefore not read by any process.  Otherwise if BRKINT is set, the break condition will generate an interrupt signal and flush both the input and output queues.  If IGNPAR is set, characters with other framing and parity errors are ignored. 

If PARMRK is set, a character with a framing or parity error which is not ignored is read as the three-character sequence: 0377, 0, X, where X is the data of the character received in error.  To avoid ambiguity in this case, if ISTRIP is not set, a valid character of 0377 is read as 0377, 0377.  If PARMRK is not set, a framing or parity error which is not ignored is read as the character NUL (0). 

If INPCK is set, input parity checking is enabled.  If INPCK is not set, input parity checking is disabled.  This allows output parity generation without input parity errors. 

If ISTRIP is set, valid input characters are first stripped to 7-bits, otherwise all 8-bits are processed. 

If INLCR is set, a received NL character is translated into a CR character.  If IGNCR is set, a received CR character is ignored (not read).  Otherwise if ICRNL is set, a received CR character is translated into a NL character. 

If IUCLC is set, a received upper-case alphabetic character is translated into the corresponding lower-case character. 

If IXON is set, start/stop output control is enabled.  A received STOP character will suspend output and a received START character will restart output.  All start/stop characters are ignored and not read.  If IXANY is set, any input character, will restart output which has been suspended. 

If IXOFF is set, the system will transmit START/STOP characters when the input queue is nearly empty/full. 

The initial input control values are ICRNL, IXON, and ISTRIP. 

The c_oflag field specifies the system treatment of output:

OPOST0000001Postprocess output.
OLCUC0000002Map lower case to upper on output.
ONLCR0000004Map NL to CR-NL on output.
OCRNL0000010Map CR to NL on output.
ONOCR0000020No CR output at column 0.
ONLRET0000040NL performs CR function.
OFILL0000100Use fill characters for delay.
OFDEL0000200Fill is DEL, else NUL.
NLDLY0000400Select new-line delays:
NL00
NL10000400
CRDLY0003000Select carriage-return delays:
CR00
CR10001000
CR20002000
CR30003000
TABDLY0014000Select horizontal-tab delays:
TAB00
TAB10004000
TAB20010000
TAB30014000Expand tabs to spaces.
BSDLY0020000Select backspace delays:
BS00
BS10020000
VTDLY0040000Select vertical-tab delays:
VT00
VT10040000
FFDLY0100000Select form-feed delays:
FF00
FF10100000

If OPOST is set, output characters are post-processed as indicated by the remaining flags, otherwise characters are transmitted without change. 

If OLCUC is set, a lower-case alphabetic character is transmitted as the corresponding upper-case character.  This function is often used in conjunction with IUCLC. 

If ONLCR is set, the NL character is transmitted as the CR-NL character pair.  If OCRNL is set, the CR character is transmitted as the NL character.  If ONOCR is set, no CR character is transmitted when at column 0 (first position).  If ONLRET is set, the NL character is assumed to do the carriage-return function; the column pointer will be set to 0 and the delays specified for CR will be used.  Otherwise the NL character is assumed to do just the line-feed function; the column pointer will remain unchanged.  The column pointer is also set to 0 if the CR character is actually transmitted. 

The delay bits specify how long transmission stops to allow for mechanical or other movement when certain characters are sent to the terminal.  In all cases a value of 0 indicates no delay.  If OFILL is set, fill characters will be transmitted for delay instead of a timed delay.  This is useful for high baud rate terminals which need only a minimal delay.  If OFDEL is set, the fill character is DEL, otherwise NUL. 

If a form-feed or vertical-tab delay is specified, it lasts for about 2 seconds. 

New-line delay lasts about 0.10 seconds.  If ONLRET is set, the carriage-return delays are used instead of the new-line delays.  If OFILL is set, two fill characters will be transmitted. 

Carriage-return delay type 1 is dependent on the current column position, type 2 is about 0.10 seconds, and type 3 is about 0.15 seconds.  If OFILL is set, delay type 1 transmits two fill characters, and type 2, four fill characters. 

Horizontal-tab delay type 1 is dependent on the current column position.  Type 2 is about 0.10 seconds.  Type 3 specifies that tabs are to be expanded into spaces.  If OFILL is set, two fill characters will be transmitted for any delay. 

Backspace delay lasts about 0.05 seconds.  If OFILL is set, one fill character will be transmitted. 

The actual delays depend on line speed and system load. 

The initial output control values are OPOST, and ONCLR. 

The c_cflag field describes the hardware control of the terminal:

CBAUD0000017Baud rate:
B00Hang up
B50000000150 baud
B75000000275 baud
B1100000003110 baud
B1340000004134.5 baud
B1500000005150 baud
B2000000006200 baud
B3000000007300 baud
B6000000010600 baud
B120000000111200 baud
B180000000121800 baud
B240000000132400 baud
B480000000144800 baud
B960000000159600 baud
B19200000001619200 baud
B38400000001738400 baud
CSIZE0000060Character size:
CS505 bits
CS600000206 bits
CS700000407 bits
CS800000608 bits
CSTOPB0000100Send two stop bits, else one.
CREAD0000200Enable receiver.
PARENB0000400Parity enable.
PARODD0001000Odd parity, else even.
HUPCL0002000Hang up on last close.
CLOCAL0004000Local line, else dial-up.
LOBLK0010000Block layer output.

The CBAUD bits specify the baud rate.  The zero baud rate, B0, is used to hang up the connection.  If B0 is specified, the data-terminal-ready signal will not be asserted.  Normally, this will disconnect the line.  For any particular hardware, impossible speed changes are ignored. 

The CSIZE bits specify the character size in bits for both transmission and reception.  This size does not include the parity bit, if any.  If CSTOPB is set, two stop bits are used, otherwise one stop bit.  For example, at 110 baud, two stops bits are required. 

If PARENB is set, parity generation and detection is enabled and a parity bit is added to each character.  If parity is enabled, the PARODD flag specifies odd parity if set, otherwise even parity is used. 

If CREAD is set, the receiver is enabled.  Otherwise no characters will be received. 

If HUPCL is set, the line will be disconnected when the last process with the line open closes it or terminates.  That is, the data-terminal-ready signal will not be asserted. 

If CLOCAL is set, the line is assumed to be a local, direct connection with no modem control.  Otherwise modem control is assumed. 

If LOBLK is set, the output of a job control layer will be blocked when it is not the current layer.  Otherwise the output generated by that layer will be multiplexed onto the current layer. 

The initial hardware control values after open are B9600, CS8, CREAD, and HUPCL. 

The c_lflag field of the argument structure is used by the line discipline to control terminal functions.  The basic line discipline (0) provides the following:

ISIG0000001Enable signals.
ICANON0000002Canonical input (erase and kill processing).
XCASE0000004Canonical upper/lower presentation.
ECHO0000010Enable echo.
ECHOE0000020Echo erase character as BS-SP-BS.
ECHOK0000040Echo NL after kill character.
ECHONL0000100Echo NL.
NOFLSH0000200Disable flush after interrupt or quit.

If ISIG is set, each input character is checked against the special control characters INTR, SWTCH, and QUIT.  If an input character matches one of these control characters, the function associated with that character is performed.  If ISIG is not set, no checking is done.  Thus these special input functions are possible only if ISIG is set.  These functions may be disabled individually by changing the value of the control character to an unlikely or impossible value (e.g., 0377). 

If ICANON is set, canonical processing is enabled.  This enables the erase and kill edit functions, and the assembly of input characters into lines delimited by NL, EOF, and EOL.  If ICANON is not set, read requests are satisfied directly from the input queue.  A read will not be satisfied until at least MIN characters have been received or the timeout value TIME has expired between characters.  This allows fast bursts of input to be read efficiently while still allowing single character input.  The MIN and TIME values are stored in the position for the EOF and EOL characters, respectively.  The time value represents tenths of seconds. 

Case A:  MIN > 0, TIME > 0
TIME serves as an inter-byte timer.  It is activated after the first byte is received and will be reset upon reception of each byte thereafter.  If MIN bytes are received before the timer expires (TIME has been reached), a read is satisfied.  If TIME is reached before MIN bytes have been received, the bytes read up to that point are returned to the user.  Note that at least one byte will be returned since the timer would not have been enabled unless a byte had been received.  When using this interaction of MIN and TIME, a read will block until the these mechanisms have been activated by either the reception of a byte or a signal.

Case B:  MIN > 0, TIME = 0
TIME (timer) plays no role.  A read will block until MIN bytes have been received or until the reception of a signal.  Programs using a read of record-based terminal I/O may block indefinitely.

Case C:  MIN = 0, TIME > 0
TIME serves as a read timer.  A read() is satisfied as soon as either a single byte is received or the timer expires (i.e., TIME has been reached).  In the latter case, the read will return zero bytes.  If TIME does not expire, the read can only be satisfied by reception of a byte. 

Case D:  MIN = 0, TIME= 0
The minimum of either the number of bytes requested or the number of bytes currently available shall be returned without waiting for more bytes to be input.  If no characters are available, the read() shall return zero. 

Note that Cases A and B exist to handle burst mode activity where a program would like to process at least MIN characters at a time.  Cases C and D exist to handle single character timed transfers.  Also note that the value MIN is just a minimum.  It does not denote a record length (e.g., a program does a read of 10 bytes, MIN is 5, and 20 bytes are present on the queue, 10 bytes will be returned to the user). 

If XCASE is set, and if ICANON is set, an upper-case letter is accepted on input by preceding it with a \ character, and is output preceded by a \ character.  In this mode, the following escape sequences are generated on output and accepted on input:

for: use:

` \´

│ \!

~ \^

{ \(

} \)

\ \\

For example, A is input as \a, \n as \\n, and \N as \\\n. 

If ECHO is set, characters are echoed as received. 

When ICANON is set, the following echo functions are possible.  If ECHO and ECHOE are set, the erase character is echoed as ASCII BS SP BS, which will clear the last character from a CRT screen.  If ECHOE is set and ECHO is not set, the erase character is echoed as ASCII SP BS.  If ECHOK is set, the NL character will be echoed after the kill character to emphasize that the line will be deleted.  Note that an escape character preceding the erase or kill character removes any special function.  If ECHONL is set, the NL character will be echoed even if ECHO is not set.  This is useful for terminals set to local echo (so-called half duplex).  Unless escaped, the EOF character is not echoed.  Because EOT is the default EOF character, this prevents terminals that respond to EOT from hanging up. 

If NOFLSH is set, the normal flush of the input and output queues associated with the quit, switch, and interrupt characters will not be done. 

The initial line-discipline control values are ISIG, ICANON, ECHO, and ECHOK. 

The primary ioctl(2) system calls have the form:

ioctl (fildes, command, arg)
struct termio ∗arg;

The commands using this form are:

TCGETA Get the parameters associated with the terminal and store in the termio structure referenced by arg. 

TCSETA Set the parameters associated with the terminal from the structure referenced by arg.  The change is immediate. 

TCSETAW Wait for the output to drain before setting the new parameters.  This form should be used when changing parameters that will affect output. 

TCSETAF Wait for the output to drain, then flush the input queue and set the new parameters. 

Additional ioctl(2) calls have the form:

ioctl (fildes, command, arg)
int arg;

The commands using this form are:

TCSBRK Wait for the output to drain.  If arg is 0, then send a break (zero bits for 0.25 seconds). 

TCXONC Start/stop control.  If arg is 0, suspend output; if 1, restart suspended output; if 2, transmit a STOP character, to cause the terminal to stop transmitting data to the system; or if 3, transmit a START character, to cause the terminal to start transmitting data to the system. 

TCFLSH If arg is 0, flush the input queue; if 1, flush the output queue; if 2, flush both the input and output queues. 

TCGETRAWQ
CX specific command to get the raw queue character limit for the tty associated with the specified file descriptor.  The raw queue character limit is returned in arg.

TCSETRAWQ CX specific command to set the raw (input) queue character limit for the tty specified by the given file descriptor.  The application defined limit is set in arg. By default, all tty devices are opened with a raw queue character limit of 256.  This is the normal CX limit and any overflow of this limit results in the outputting of an ASCII BEL.  At this point, all data on the input queue is lost.  Specialized applications such as those which do not do any type of input flow control may wish to access TCSETRAWQ.  With this command, the raw (input) queue character limit may be expanded to an application defined limit via the arg parameter.  Any limits greater than 256 will not be subject to the warning bell, but will flush the entire input queue resulting in the loss of all data on it whenever the application defined character limit is exceeded.  In order to preserve system integrity by controlling the allocation of tty cblock queues, application defined raw queue character limits are themselves limited by a system configurable upper bound or ceiling.  By default, this upper bound is set to 256 and under normal CX operation, this upper limit should remain at 256.  If needed, the system administrator can change this limit by adjusting or adding the value associated with the configuration file variable "MAXRAWQ".  MAXRAWQ does not indicate that all tty ports will have raw queue input limits relating to its value on open.  Rather it is a system "ceiling" for all ports’ input queue limits.  All ports are opened by default to the normal CX limit of 256.  Using the TCSETRAWQ command permits the application program to adjust the raw queue limit for a particular port to any value in the range 256 <= user defined limit <= MAXRAWQ.  By default, MAXRAWQ is set to 256.  Valid values for MAXRAWQ are in the range 256 <= MAXRAWQ <= 32767.  If MAXRAWQ < 256, the default value of 256 will be assumed.  When using TCSETRAWQ, the value of arg cannot be greater than MAXRAWQ or less than 256.  Otherwise, the function call will return -1 and set errno to [EINVAL].  Applications using this command must ensure that a sufficient number of clists have been configured into the system. 

TCGETMAXRAWQ
CX specific command to obtain the system configureable upper bound (MAXRAWQ) on tty raw (input) queue character limits. The value of the system configuration variable "MAXRAWQ" is returned in arg.

NOTE

The ioctl(2) requests described above are interpreted and translated within the libc library ioctl function call into the appropriate <termios.h> ioctl calls.  The termio arguments are also translated into the corresponding termios arguments.  Users are encouraged to use the new POSIX/OCS/BCS ioctl requests, termios structure, and terminal attributes as described in termios(7). 

FILES

/dev/tty∗

SEE ALSO

stty(1), fork(2), ioctl(2), setpgrp(2), signal(2), termios(7). 

CX/UX Administrator’s Reference