summaryrefslogtreecommitdiffstats
path: root/man3/termios.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/termios.3')
-rw-r--r--man3/termios.374
1 files changed, 37 insertions, 37 deletions
diff --git a/man3/termios.3 b/man3/termios.3
index 78731d21e..bcd9ef9b1 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -53,7 +53,7 @@ Standard C library
.P
.RS -4
Feature Test Macro Requirements for glibc (see
-.BR feature_test_macros (7)):
+.MR feature_test_macros 7 ):
.RE
.P
.BR cfsetspeed (),
@@ -86,7 +86,7 @@ The values that may be assigned to these fields are described below.
In the case of the first four bit-mask fields,
the definitions of some of the associated flags that may be set are
exposed only if a specific feature test macro (see
-.BR feature_test_macros (7))
+.MR feature_test_macros 7 )
is defined, as noted in brackets ("[]").
.P
In the descriptions below, "not in POSIX" means that the
@@ -340,7 +340,7 @@ or
and
.BR TCSET *
ioctls; see
-.BR ioctl_tty (2))
+.MR ioctl_tty 2 )
.TP
.B CMSPAR
(not in POSIX)
@@ -502,7 +502,7 @@ End-of-file character (EOF).
More precisely: this character causes the pending tty buffer to be sent
to the waiting user program without waiting for end-of-line.
If it is the first character of the line, the
-.BR read (2)
+.MR read 2
in the user program returns 0, which signifies end-of-file.
Recognized when
.B ICANON
@@ -708,20 +708,20 @@ An input line is available when one of the line delimiters
is typed (NL, EOL, EOL2; or EOF at the start of line).
Except in the case of EOF, the line delimiter is included
in the buffer returned by
-.BR read (2).
+.MR read 2 .
.IP \[bu]
Line editing is enabled (ERASE, KILL;
and if the
.B IEXTEN
flag is set: WERASE, REPRINT, LNEXT).
A
-.BR read (2)
+.MR read 2
returns at most one line of input; if the
-.BR read (2)
+.MR read 2
requested fewer bytes than are available in the current line of input,
then only as many bytes as requested are read,
and the remaining characters will be available for a future
-.BR read (2).
+.MR read 2 .
.IP \[bu]
The maximum line length is 4096 chars
(including the terminating newline character);
@@ -747,43 +747,43 @@ The settings of MIN
and TIME
.RI ( c_cc[VTIME] )
determine the circumstances in which a
-.BR read (2)
+.MR read 2
completes; there are four distinct cases:
.TP
MIN == 0, TIME == 0 (polling read)
If data is available,
-.BR read (2)
+.MR read 2
returns immediately, with the lesser of the number of bytes
available, or the number of bytes requested.
If no data is available,
-.BR read (2)
+.MR read 2
returns 0.
.TP
MIN > 0, TIME == 0 (blocking read)
-.BR read (2)
+.MR read 2
blocks until MIN bytes are available,
and returns up to the number of bytes requested.
.TP
MIN == 0, TIME > 0 (read with timeout)
TIME specifies the limit for a timer in tenths of a second.
The timer is started when
-.BR read (2)
+.MR read 2
is called.
-.BR read (2)
+.MR read 2
returns either when at least one byte of data is available,
or when the timer expires.
If the timer expires without any input becoming available,
-.BR read (2)
+.MR read 2
returns 0.
If data is already available at the time of the call to
-.BR read (2),
+.MR read 2 ,
the call behaves as though the data was received immediately after the call.
.TP
MIN > 0, TIME > 0 (read with interbyte timeout)
TIME specifies the limit for a timer in tenths of a second.
Once an initial byte of input becomes available,
the timer is restarted after each further byte is received.
-.BR read (2)
+.MR read 2
returns when any of the following conditions is met:
.RS
.IP \[bu] 3
@@ -792,19 +792,19 @@ MIN bytes have been received.
The interbyte timer expires.
.IP \[bu]
The number of bytes requested by
-.BR read (2)
+.MR read 2
has been received.
(POSIX does not specify this termination condition,
and on some other implementations
.\" e.g., Solaris
-.BR read (2)
+.MR read 2
does not return in this case.)
.RE
.IP
Because the timer is started only after the initial byte
becomes available, at least one byte will be read.
If data is already available at the time of the call to
-.BR read (2),
+.MR read 2 ,
the call behaves as though the data was received immediately after the call.
.P
POSIX
@@ -815,12 +815,12 @@ file status flag takes precedence over the MIN and TIME settings.
If
.B O_NONBLOCK
is set, a
-.BR read (2)
+.MR read 2
in noncanonical mode may return immediately,
regardless of the setting of MIN or TIME.
Furthermore, if no data is available,
POSIX permits a
-.BR read (2)
+.MR read 2
in noncanonical mode to return either 0, or \-1 with
.I errno
set to
@@ -913,7 +913,7 @@ is successfully called.
.P
Setting the speed to \fBB0\fP instructs the modem to "hang up".
The actual bit rate corresponding to \fBB38400\fP may be altered with
-.BR setserial (8).
+.MR setserial 8 .
.P
The input and output baud rates are stored in the \fItermios\fP
structure.
@@ -1031,7 +1031,7 @@ Setting the baud rate to a value other than those defined by
constants is possible via the
.B TCSETS2
ioctl; see
-.BR ioctl_tty (2).
+.MR ioctl_tty 2 .
.P
.BR cfgetispeed ()
returns the input baud rate stored in the
@@ -1088,7 +1088,7 @@ it may be necessary to follow this call with a further call to
to check that all changes have been performed successfully.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
-.BR attributes (7).
+.MR attributes 7 .
.TS
allbox;
lbx lb lb
@@ -1221,15 +1221,15 @@ line discipline code of the terminal driver as a result
.B TABDLY
mask).
.SH SEE ALSO
-.BR reset (1),
-.BR setterm (1),
-.BR stty (1),
-.BR tput (1),
-.BR tset (1),
-.BR tty (1),
-.BR ioctl_console (2),
-.BR ioctl_tty (2),
-.BR cc_t (3type),
-.BR speed_t (3type),
-.BR tcflag_t (3type),
-.BR setserial (8)
+.MR reset 1 ,
+.MR setterm 1 ,
+.MR stty 1 ,
+.MR tput 1 ,
+.MR tset 1 ,
+.MR tty 1 ,
+.MR ioctl_console 2 ,
+.MR ioctl_tty 2 ,
+.MR cc_t 3type ,
+.MR speed_t 3type ,
+.MR tcflag_t 3type ,
+.MR setserial 8