summaryrefslogtreecommitdiffstats
path: root/doc/posix_users/device.t
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 21:24:38 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1999-10-11 21:24:38 +0000
commit7479042a5914a6b9223e734b4a14652314661e1a (patch)
treee673fe698aa58bb0e4c6be0bd468ced47207594a /doc/posix_users/device.t
parentAdded descriptions. (diff)
downloadrtems-7479042a5914a6b9223e734b4a14652314661e1a.tar.bz2
Generated concept and function index entries.
Diffstat (limited to 'doc/posix_users/device.t')
-rw-r--r--doc/posix_users/device.t162
1 files changed, 117 insertions, 45 deletions
diff --git a/doc/posix_users/device.t b/doc/posix_users/device.t
index 05ef101fec..542a20e519 100644
--- a/doc/posix_users/device.t
+++ b/doc/posix_users/device.t
@@ -1,9 +1,9 @@
@c
-@c COPYRIGHT (c) 1988-1998.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
+@c COPYRIGHT (c) 1988-1998.
+@c On-Line Applications Research Corporation (OAR).
+@c All rights reserved.
@c
-@c $Id$
+@c $Id$
@c
@chapter Device- and Class- Specific Functions Manager
@@ -41,13 +41,19 @@ There is currently no text in this section.
@section Directives
This section details the device- and class- specific functions manager's
-directives. A subsection is dedicated to each of this manager's directives
+directives. A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.
+@c
+@c
+@c
@page
@subsection cfgetispeed - Reads terminal input baud rate
+@findex cfgetispeed
+@cindex reads terminal input baud rate
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -55,7 +61,7 @@ and status codes.
#include <termios.h>
int cfgetispeed(
- const struct termios *p
+const struct termios *p
);
@end example
@end ifset
@@ -65,12 +71,12 @@ int cfgetispeed(
@subheading STATUS CODES:
-The @code{cfgetispeed()} function returns a code for baud rate.
+The @code{cfgetispeed()} function returns a code for baud rate.
@subheading DESCRIPTION:
-The @code{cfsetispeed()} function stores a code for the terminal speed
-stored in a struct termios. The codes are defined in @code{<termios.h>}
+The @code{cfsetispeed()} function stores a code for the terminal speed
+stored in a struct termios. The codes are defined in @code{<termios.h>}
by the macros BO, B50, B75, B110, B134, B150, B200, B300, B600, B1200,
B1800, B2400, B4800, B9600, B19200, and B38400.
@@ -79,20 +85,26 @@ It merely stores a value for use by @code{tcsetattr()}.
@subheading NOTES:
-Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
+Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
number returned for any given speed may change from system to system.
+@c
+@c
+@c
@page
@subsection cfgetospeed - Reads terminal output baud rate
+@findex cfgetospeed
+@cindex reads terminal output baud rate
+
@subheading CALLING SEQUENCE:
@ifset is-C
@example
#include <termios.h>
-int cfgetospeed(
- const struct termios *p
+int cfgetospeed(
+const struct termios *p
);
@end example
@end ifset
@@ -107,7 +119,7 @@ The @code{cfgetospeed()} function returns the termios code for the baud rate.
@subheading DESCRIPTION:
The @code{cfgetospeed()} function returns a code for the terminal speed
-stored in a @code{struct termios}. The codes are defined in @code{<termios.h>}
+stored in a @code{struct termios}. The codes are defined in @code{<termios.h>}
by the macros BO, B50, B75, B110, B134, B150, B200, B300, B600, B1200, B1800,
B2400, B4800, B9600, B19200, and B38400.
@@ -116,12 +128,18 @@ It merely returns the value stored by a previous call to @code{tcgetattr()}.
@subheading NOTES:
-Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
+Baud rates are defined by symbols, such as B110, B1200, B2400. The actual
number returned for any given speed may change from system to system.
+@c
+@c
+@c
@page
@subsection cfsetispeed - Sets terminal input baud rate
+@findex cfsetispeed
+@cindex sets terminal input baud rate
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -129,8 +147,8 @@ number returned for any given speed may change from system to system.
#include <termios.h>
int cfsetispeed(
- struct termios *p,
- speed_t speed
+struct termios *p,
+speed_t speed
);
@end example
@end ifset
@@ -140,24 +158,30 @@ int cfsetispeed(
@subheading STATUS CODES:
-The @code{cfsetispeed()} function returns a zero when successful and
-returns -1 when an error occurs.
+The @code{cfsetispeed()} function returns a zero when successful and
+returns -1 when an error occurs.
@subheading DESCRIPTION:
The @code{cfsetispeed()} function stores a code for the terminal speed
-stored in a struct termios. The codes are defined in @code{<termios.h>}
-by the macros B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200,
+stored in a struct termios. The codes are defined in @code{<termios.h>}
+by the macros B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200,
B1800, B2400, B4800, B9600, B19200, and B38400.
@subheading NOTES:
-This function merely stores a value in the @code{termios} structure. It
-does not change the terminal speed until a @code{tcsetattr()} is done.
+This function merely stores a value in the @code{termios} structure. It
+does not change the terminal speed until a @code{tcsetattr()} is done.
It does not detect impossible terminal speeds.
+@c
+@c
+@c
@page
-@subsection cfsetospeed - Sets terminal output baud rate
+@subsection cfsetospeed - Sets terminal output baud rate
+
+@findex cfsetospeed
+@cindex sets terminal output baud rate
@subheading CALLING SEQUENCE:
@@ -166,8 +190,8 @@ It does not detect impossible terminal speeds.
#include <termios.h>
int cfsetospeed(
- struct termios *p,
- speed_t speed
+struct termios *p,
+speed_t speed
);
@end example
@end ifset
@@ -177,29 +201,35 @@ int cfsetospeed(
@subheading STATUS CODES:
-The @code{cfsetospeed()} function returns a zero when successful and
-returns -1 when an error occurs.
+The @code{cfsetospeed()} function returns a zero when successful and
+returns -1 when an error occurs.
@subheading DESCRIPTION:
-The @code{cfsetospeed()} function stores a code for the terminal speed stored
-in a struct @code{termios}. The codes are defiined in @code{<termios.h>} by the
+The @code{cfsetospeed()} function stores a code for the terminal speed stored
+in a struct @code{termios}. The codes are defiined in @code{<termios.h>} by the
macros B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200, B1800, B2400,
B4800, B9600, B19200, and B38400.
-The @code{cfsetospeed()} function does not do anything to the hardware. It
+The @code{cfsetospeed()} function does not do anything to the hardware. It
merely stores a value for use by @code{tcsetattr()}.
@subheading NOTES:
-This function merely stores a value in the @code{termios} structure.
+This function merely stores a value in the @code{termios} structure.
It does not change the terminal speed until a @code{tcsetattr()} is done.
It does not detect impossible terminal speeds.
+@c
+@c
+@c
@page
@subsection tcgetattr - Gets terminal attributes
+@findex tcgetattr
+@cindex gets terminal attributes
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -208,8 +238,8 @@ It does not detect impossible terminal speeds.
#include <unistd.h>
int tcgetattr(
- int fildes,
- struct termios *p
+int fildes,
+struct termios *p
);
@end example
@end ifset
@@ -237,9 +267,15 @@ structure pointed to by @code{termios_p}.
NONE
+@c
+@c
+@c
@page
@subsection tcsetattr - Set terminal attributes
+@findex tcsetattr
+@cindex set terminal attributes
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -248,9 +284,9 @@ NONE
#include <unistd.h>
int tcsetattr(
- int fildes,
- int options,
- const struct termios *tp
+int fildes,
+int options,
+const struct termios *tp
);
@end example
@end ifset
@@ -270,8 +306,14 @@ The
@subheading NOTES:
+@c
+@c
+@c
@page
-@subsection tcsendbreak - Sends a break to a terminal
+@subsection tcsendbreak - Sends a break to a terminal
+
+@findex tcsendbreak
+@cindex sends a break to a terminal
@subheading CALLING SEQUENCE:
@@ -297,12 +339,18 @@ The
@subheading NOTES:
-This routine is not currently supported by RTEMS but could be
+This routine is not currently supported by RTEMS but could be
in a future version.
+@c
+@c
+@c
@page
@subsection tcdrain - Waits for all output to be transmitted to the terminal.
+@findex tcdrain
+@cindex waits for all output to be transmitted to the terminal.
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -311,7 +359,7 @@ in a future version.
#include <unistd.h>
int tcdrain(
- int fildes
+int fildes
);
@end example
@end ifset
@@ -335,15 +383,21 @@ Terminal control function attempted for a file that is not a terminal.
@subheading DESCRIPTION:
-The @code{tcdrain()} function waits until all output written to
+The @code{tcdrain()} function waits until all output written to
@code{fildes} has been transmitted.
@subheading NOTES:
NONE
+@c
+@c
+@c
@page
-@subsection tcflush - Discards terminal data
+@subsection tcflush - Discards terminal data
+
+@findex tcflush
+@cindex discards terminal data
@subheading CALLING SEQUENCE:
@@ -369,12 +423,18 @@ The
@subheading NOTES:
-This routine is not currently supported by RTEMS but could be
+This routine is not currently supported by RTEMS but could be
in a future version.
+@c
+@c
+@c
@page
@subsection tcflow - Suspends/restarts terminal output.
+@findex tcflow
+@cindex suspends/restarts terminal output.
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -399,12 +459,18 @@ The
@subheading NOTES:
-This routine is not currently supported by RTEMS but could be
+This routine is not currently supported by RTEMS but could be
in a future version.
+@c
+@c
+@c
@page
@subsection tcgetpgrp - Gets foreground process group ID
+@findex tcgetpgrp
+@cindex gets foreground process group id
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -429,12 +495,18 @@ The
@subheading NOTES:
-This routine is not currently supported by RTEMS but could be
+This routine is not currently supported by RTEMS but could be
in a future version.
+@c
+@c
+@c
@page
@subsection tcsetpgrp - Sets foreground process group ID
+@findex tcsetpgrp
+@cindex sets foreground process group id
+
@subheading CALLING SEQUENCE:
@ifset is-C
@@ -459,7 +531,7 @@ The
@subheading NOTES:
-This routine is not currently supported by RTEMS but could be
+This routine is not currently supported by RTEMS but could be
in a future version.