|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH CFSETISPEED "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
cfsetispeed
|
|
Packit |
7cfc04 |
\(em set input baud rate
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <termios.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
int cfsetispeed(struct termios *\fItermios_p\fP, speed_t \fIspeed\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIcfsetispeed\fR()
|
|
Packit |
7cfc04 |
function shall set the input baud rate stored in the structure pointed
|
|
Packit |
7cfc04 |
to by
|
|
Packit |
7cfc04 |
.IR termios_p
|
|
Packit |
7cfc04 |
to
|
|
Packit |
7cfc04 |
.IR speed.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
There shall be no effect on the baud rates set in the hardware until a
|
|
Packit |
7cfc04 |
subsequent successful call to
|
|
Packit |
7cfc04 |
\fItcsetattr\fR()
|
|
Packit |
7cfc04 |
with the same
|
|
Packit |
7cfc04 |
.BR termios
|
|
Packit |
7cfc04 |
structure. Similarly, errors resulting from attempts to set baud rates
|
|
Packit |
7cfc04 |
not supported by the terminal device need not be detected until the
|
|
Packit |
7cfc04 |
\fItcsetattr\fR()
|
|
Packit |
7cfc04 |
function is called.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fIcfsetispeed\fR()
|
|
Packit |
7cfc04 |
shall return 0; otherwise, \(mi1 shall be returned, and
|
|
Packit |
7cfc04 |
.IR errno
|
|
Packit |
7cfc04 |
may be set to indicate the error.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIcfsetispeed\fR()
|
|
Packit |
7cfc04 |
function may fail if:
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EINVAL
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
.IR speed
|
|
Packit |
7cfc04 |
value is not a valid baud rate.
|
|
Packit |
7cfc04 |
.TP
|
|
Packit |
7cfc04 |
.BR EINVAL
|
|
Packit |
7cfc04 |
The value of
|
|
Packit |
7cfc04 |
.IR speed
|
|
Packit |
7cfc04 |
is outside the range of possible speed values as specified in
|
|
Packit |
7cfc04 |
.IR <termios.h> .
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
Refer to
|
|
Packit |
7cfc04 |
.IR "\fIcfgetispeed\fR\^(\|)".
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIcfgetispeed\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIcfgetospeed\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIcfsetospeed\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fItcsetattr\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "Chapter 11" ", " "General Terminal Interface",
|
|
Packit |
7cfc04 |
.IR "\fB<termios.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|