summaryrefslogtreecommitdiff
path: root/man3/termios.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/termios.3')
-rw-r--r--man3/termios.340
1 files changed, 20 insertions, 20 deletions
diff --git a/man3/termios.3 b/man3/termios.3
index 7ef0a4e2..d01182a2 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -204,9 +204,9 @@ Form feed delay mask. Values are \fBFF0\fP or \fBFF1\fP.
.LP
(POSIX says that the baud speed is stored in the termios structure
without specifying where precisely, and provides
-.B cfgetispeed()
+.BR cfgetispeed ()
and
-.B cfsetispeed()
+.BR cfsetispeed ()
for getting at it. Some systems use bits selected by CBAUD in
.IR c_cflag ,
other systems use separate fields, e.g.
@@ -349,7 +349,7 @@ Recognized when ICANON is set, and then not passed as input.
End-of-file character.
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 \fIread()\fP in the
+If it is the first character of the line, the \fIread\fP() in the
user program returns 0, which signifies end-of-file.
Recognized when ICANON is set, and then not passed as input.
.TP
@@ -434,14 +434,14 @@ return as soon as either at least one character has been received,
or the timer times out. If neither is set, the read will return
immediately, only giving the currently already available characters.)
.PP
-.B tcgetattr()
+.BR tcgetattr ()
gets the parameters associated with the object referred by \fIfd\fP and
stores them in the \fBtermios\fP structure referenced by
\fItermios_p\fP. This function may be invoked from a background process;
however, the terminal attributes may be subsequently changed by a
foreground process.
.LP
-.B tcsetattr()
+.BR tcsetattr ()
sets the parameters associated with the terminal (unless support is
required from the underlying hardware that is not available) from the
\fBtermios\fP structure referred to by \fItermios_p\fP.
@@ -459,7 +459,7 @@ the change occurs after all output written to the object referred by
has been transmitted, and all input that has been received but not read
will be discarded before the change is made.
.LP
-.B tcsendbreak()
+.BR tcsendbreak ()
transmits a continuous stream of zero-valued bits for a specific
duration, if the terminal is using asynchronous serial data
transmission. If \fIduration\fP is zero, it transmits zero-valued bits
@@ -468,14 +468,14 @@ for at least 0.25 seconds, and not more that 0.5 seconds. If
implementation-defined length of time.
.LP
If the terminal is not using asynchronous serial data transmission,
-\fBtcsendbreak()\fP returns without taking any action.
+\fBtcsendbreak\fP() returns without taking any action.
.LP
-.B tcdrain()
+.BR tcdrain ()
waits until all output written to the object referred to by
.I fd
has been transmitted.
.LP
-.B tcflush()
+.BR tcflush ()
discards data written to the object referred to by
.I fd
but not transmitted, or data received but not read, depending on the
@@ -489,7 +489,7 @@ flushes data written but not transmitted.
flushes both data received but not read, and data written but not
transmitted.
.LP
-.B tcflow()
+.BR tcflow ()
suspends transmission or reception of data on the object referred to by
.IR fd ,
depending on the value of
@@ -511,7 +511,7 @@ output is suspended.
The baud rate functions are provided for getting and setting the values
of the input and output baud rates in the \fBtermios\fP structure. The
new values do not take effect
-until \fBtcsetattr()\fP is successfully called.
+until \fBtcsetattr\fP() is successfully called.
Setting the speed to \fBB0\fP instructs the modem to "hang up".
The actual bit rate corresponding to \fBB38400\fP may be altered with
@@ -530,12 +530,12 @@ structure.
termios_p->c_cflag |= CS8;
.fi
.LP
-.B cfgetospeed()
+.BR cfgetospeed ()
returns the output baud rate stored in the \fBtermios\fP structure
pointed to by
.IR termios_p .
.LP
-.B cfsetospeed()
+.BR cfsetospeed ()
sets the output baud rate stored in the \fBtermios\fP structure pointed
to by \fItermios_p\fP to \fIspeed\fP, which must be one of these constants:
.nf
@@ -568,25 +568,25 @@ Normally, this will disconnect the line. \fBCBAUDEX\fP is a mask
for the speeds beyond those defined in POSIX.1 (57600 and above).
Thus, \fBB57600\fP & \fBCBAUDEX\fP is non-zero.
.LP
-.B cfgetispeed()
+.BR cfgetispeed ()
returns the input baud rate stored in the \fBtermios\fP structure.
.LP
-.B cfsetispeed()
+.BR cfsetispeed ()
sets the input baud rate stored in the \fBtermios\fP structure to
.IR speed .
If the input baud rate is set to zero, the input baud rate will be
equal to the output baud rate.
.LP
-.B cfsetspeed()
+.BR cfsetspeed ()
is a 4.4 BSD extension. It will set both input and output speed.
.SH "RETURN VALUE"
.LP
-.B cfgetispeed()
+.BR cfgetispeed ()
returns the input baud rate stored in the
\fBtermios\fP
structure.
.LP
-.B cfgetospeed()
+.BR cfgetospeed ()
returns the output baud rate stored in the \fBtermios\fP structure.
.LP
All other functions return:
@@ -598,11 +598,11 @@ on failure and set
to indicate the error.
.LP
Note that
-.BI tcsetattr()
+.BI tcsetattr ()
returns success if \fIany\fP of the requested changes could be
successfully carried out. Therefore, when making multiple changes
it may be necessary to follow this call with a further call to
-.BI tcgetattr()
+.BI tcgetattr ()
to check that all changes have been performed successfully.
.SH NOTES