Print this page
10271 Convert cf{get,set}ispeed.3C and cf{get,set}speed.3C to mandoc


  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved

  45 .\"
  46 .TH CFSETISPEED 3C "Jul 24, 2002"
  47 .SH NAME
  48 cfsetispeed, cfsetospeed \- set input and output baud rate
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <termios.h>
  53 
  54 \fBint\fR \fBcfsetispeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
  55 .fi
  56 
  57 .LP
  58 .nf
  59 \fBint\fR \fBcfsetospeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
  60 .fi
  61 
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 The \fBcfsetispeed()\fR function sets the input baud rate stored in the
  66 structure pointed to by \fItermios_p\fR to \fIspeed.\fR
  67 .sp
  68 .LP
  69 The \fBcfsetospeed()\fR function sets the output baud rate stored in the
  70 structure pointed to by \fItermios_p\fR to \fIspeed.\fR
  71 .sp
  72 .LP









  73 There is no effect on the baud rates set in the hardware until a subsequent
  74 successful call to \fBtcsetattr\fR(3C) on the same \fBtermios\fR structure.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Upon successful completion, \fBcfsetispeed()\fR and \fBcfsetospeed()\fR return
  79 \fB0\fR. Otherwise \fB\(mi1\fR is returned, and \fBerrno\fR may be set to
  80 indicate the error.
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The \fBcfsetispeed()\fR and \fBcfsetospeed()\fR functions may fail if:
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBEINVAL\fR\fR
  89 .ad
  90 .RS 10n
  91 The \fIspeed\fR value is not a valid baud rate.
  92 .RE
  93 
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBEINVAL\fR\fR
  98 .ad
  99 .RS 10n
 100 The value of \fIspeed\fR is outside the range of possible speed values as
 101 specified in \fB<termios.h>\fR\&.
 102 .RE
 103 
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109 
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Standard
 118 _
 119 MT-Level        MT-Safe, and Async-Signal-Safe
 120 .TE
 121 
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBcfgetispeed\fR(3C), \fBtcsetattr\fR(3C), \fBattributes\fR(5),
 126 \fBstandards\fR(5), \fBtermio\fR(7I)


  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
  45 .\" Copyright 2019, Joyent, Inc.
  46 .\"
  47 .Dd January 20, 2019
  48 .Dt CFSETISPEED 3C
  49 .Os
  50 .Sh NAME
  51 .Nm cfsetispeed ,
  52 .Nm cfsetospeed
  53 .Nd set input and output baud rate
  54 .Sh SYNOPSIS
  55 .In termios.h
  56 .Ft int
  57 .Fo cfsetispeed
  58 .Fa "struct termios *termios_p"
  59 .Fa "speed_t speed"
  60 .Fc
  61 .Ft int
  62 .Fo cfsetospeed
  63 .Fa "struct termios *termios_p"
  64 .Fa "speed_t speed"
  65 .Fc
  66 .Sh DESCRIPTION
  67 The
  68 .Fn cfsetispeed
  69 function sets the input baud rate stored in the
  70 structure pointed to by
  71 .Fa termios_p
  72 to
  73 .Fa speed .
  74 .Pp
  75 The
  76 .Fn cfsetospeed
  77 function sets the output baud rate stored in the
  78 structure pointed to by
  79 .Fa termios_p
  80 to
  81 .Fa speed .
  82 .Pp
  83 There is no effect on the baud rates set in the hardware until a subsequent
  84 successful call to
  85 .Xr tcsetattr 3C
  86 on the same
  87 .Vt termios
  88 structure.
  89 .Sh RETURN VALUES
  90 Upon successful completion,
  91 .Fn cfsetispeed
  92 and
  93 .Fn cfsetospeed
  94 return
  95 .Sy 0 .
  96 Otherwise
  97 .Sy \(mi1
  98 is returned, and
  99 .Va errno
 100 may be set to indicate the error.
 101 .Sh ERRORS
 102 The
 103 .Fn cfsetispeed
 104 and
 105 .Fn cfsetospeed
 106 functions may fail if:
 107 .Bl -tag -width EINVAL
 108 .It Er EINVAL
 109 The
 110 .Fa speed
 111 value is not a valid baud rate.
 112 .It Er EINVAL
 113 The value of
 114 .Fa speed
 115 is outside the range of possible speed values as specified in
 116 .In termios.h .
 117 .El
 118 .Sh INTERFACE STABILITY
 119 Standard
 120 .Sh MT-LEVEL
 121 MT-Safe
 122 .Pp
 123 Async-Signal-Safe
 124 .Sh SEE ALSO
 125 .Xr cfgetispeed 3C ,
 126 .Xr tcsetattr 3C ,
 127 .Xr attributes 5 ,
 128 .Xr standards 5 ,
 129 .Xr termio 7I