Print this page
10271 Convert cf{get,set}ispeed.3C and cf{get,set}speed.3C to mandoc
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/cfgetispeed.3c
+++ new/usr/src/man/man3c/cfgetispeed.3c
1 1 .\"
2 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 3 .\" permission to reproduce portions of its copyrighted documentation.
4 4 .\" Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\"
7 7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 8 .\" Group, have given us permission to reprint portions of their
9 9 .\" documentation.
10 10 .\"
11 11 .\" In the following statement, the phrase ``this text'' refers to portions
12 12 .\" of the system documentation.
13 13 .\"
14 14 .\" Portions of this text are reprinted and reproduced in electronic form
15 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 16 .\" Standard for Information Technology -- Portable Operating System
17 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 20 .\" between these versions and the original IEEE and The Open Group
21 21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 22 .\" document. The original Standard can be obtained online at
23 23 .\" http://www.opengroup.org/unix/online.html.
24 24 .\"
25 25 .\" This notice shall appear on any product containing this material.
26 26 .\"
27 27 .\" The contents of this file are subject to the terms of the
28 28 .\" Common Development and Distribution License (the "License").
29 29 .\" You may not use this file except in compliance with the License.
30 30 .\"
31 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 32 .\" or http://www.opensolaris.org/os/licensing.
33 33 .\" See the License for the specific language governing permissions
34 34 .\" and limitations under the License.
|
↓ open down ↓ |
34 lines elided |
↑ open up ↑ |
35 35 .\"
36 36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 38 .\" If applicable, add the following below this CDDL HEADER, with the
39 39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 41 .\"
42 42 .\"
43 43 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
44 44 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
45 +.\" Copyright 2019, Joyent, Inc.
45 46 .\"
46 -.TH CFGETISPEED 3C "Jul 24, 2002"
47 -.SH NAME
48 -cfgetispeed, cfgetospeed \- get input and output baud rate
49 -.SH SYNOPSIS
50 -.LP
51 -.nf
52 -#include <termios.h>
53 -
54 -\fBspeed_t\fR \fBcfgetispeed\fR(\fBconst struct termios *\fR\fItermios_p\fR);
55 -.fi
56 -
57 -.LP
58 -.nf
59 -\fBspeed_t\fR \fBcfgetospeed\fR(\fBconst struct termios *\fR\fItermios_p\fR);
60 -.fi
61 -
62 -.SH DESCRIPTION
63 -.sp
64 -.LP
65 -The \fBcfgetispeed()\fR function extracts the input baud rate from the
66 -\fBtermios\fR structure to which the \fItermios_p\fR argument points.
67 -.sp
68 -.LP
69 -The \fBcfgetospeed()\fR function extracts the output baud rate from the
70 -\fBtermios\fR structure to which the \fItermios_p\fR argument points.
71 -.sp
72 -.LP
73 -These functions returns exactly the value in the \fBtermios\fR data structure,
74 -without interpretation.
75 -.SH RETURN VALUES
76 -.sp
77 -.LP
78 -Upon successful completion, \fBcfgetispeed()\fR returns a value of type
79 -\fBspeed_t\fR representing the input baud rate.
80 -.sp
81 -.LP
82 -Upon successful completion, \fBcfgetospeed()\fR returns a value of type
83 -\fBspeed_t\fR representing the output baud rate.
84 -.SH ERRORS
85 -.sp
86 -.LP
47 +.Dd January 20, 2019
48 +.Dt CFGETISPEED 3C
49 +.Os
50 +.Sh NAME
51 +.Nm cfgetispeed ,
52 +.Nm cfgetospeed
53 +.Nd get input and output baud rate
54 +.Sh SYNOPSIS
55 +.In termios.h
56 +.Ft speed_t
57 +.Fo cfgetispeed
58 +.Fa "const struct termios *termios_p"
59 +.Fc
60 +.Ft speed_t
61 +.Fo cfgetospeed
62 +.Fa "const struct termios *termios_p"
63 +.Fc
64 +.Sh DESCRIPTION
65 +The
66 +.Fn cfgetispeed
67 +function extracts the input baud rate from the
68 +.Vt termios
69 +structure to which the
70 +.Fa termios_p
71 +argument points.
72 +.Pp
73 +The
74 +.Fn cfgetospeed
75 +function extracts the output baud rate from the
76 +.Vt termios
77 +structure to which the
78 +.Fa termios_p
79 +argument points.
80 +.Pp
81 +These functions return exactly the value in the
82 +.Vt termios
83 +data structure, without interpretation.
84 +.Sh RETURN VALUES
85 +Upon successful completion,
86 +.Fn cfgetispeed
87 +returns a value of type
88 +.Vt speed_t
89 +representing the input baud rate.
90 +.Pp
91 +Upon successful completion,
92 +.Fn cfgetospeed
93 +returns a value of type
94 +.Vt speed_t
95 +representing the output baud rate.
96 +.Sh ERRORS
87 97 No errors are defined.
88 -.SH ATTRIBUTES
89 -.sp
90 -.LP
91 -See \fBattributes\fR(5) for descriptions of the following attributes:
92 -.sp
93 -
94 -.sp
95 -.TS
96 -box;
97 -c | c
98 -l | l .
99 -ATTRIBUTE TYPE ATTRIBUTE VALUE
100 -_
101 -Interface Stability Standard
102 -_
103 -MT-Level MT-Safe, and Async-Signal-Safe
104 -.TE
105 -
106 -.SH SEE ALSO
107 -.sp
108 -.LP
109 -\fBcfgetospeed\fR(3C), \fBtcgetattr\fR(3C), \fBattributes\fR(5),
110 -\fBstandards\fR(5), \fBtermio\fR(7I)
98 +.Sh INTERFACE STABILITY
99 +Standard
100 +.Sh MT-LEVEL
101 +MT-Safe
102 +.Pp
103 +Async-Signal-Safe
104 +.Sh SEE ALSO
105 +.Xr cfsetispeed 3C ,
106 +.Xr tcgetattr 3C ,
107 +.Xr attributes 5 ,
108 +.Xr standards 5 ,
109 +.Xr termio 7I
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX