lib/libc/termios/tcsendbreak.3

   1 .\"     $NetBSD: tcsendbreak.3,v 1.9 2003/08/07 16:44:13 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)tcsendbreak.3       8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt TCSENDBREAK 3
  34 .Os
  35 .Sh NAME
  36 .Nm tcsendbreak ,
  37 .Nm tcdrain ,
  38 .Nm tcflush ,
  39 .Nm tcflow
  40 .Nd line control functions
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In termios.h
  45 .Ft int
  46 .Fn tcdrain "int fd"
  47 .Ft int
  48 .Fn tcflow "int fd" "int action"
  49 .Ft int
  50 .Fn tcflush "int fd" "int action"
  51 .Ft int
  52 .Fn tcsendbreak "int fd" "int len"
  53 .Sh DESCRIPTION
  54 The
  55 .Nm tcdrain
  56 function waits until all output written to the terminal referenced by
  57 .Fa fd
  58 has been transmitted to the terminal.
  59 .Pp
  60 The
  61 .Nm tcflow
  62 function suspends transmission of data to or the reception of data from
  63 the terminal referenced by
  64 .Fa fd
  65 depending on the value of
  66 .Fa action .
  67 The value of
  68 .Fa action
  69 must be one of the following:
  70 .Bl -tag -width "TCIOFF"
  71 .It Fa TCOOFF
  72 Suspend output.
  73 .It Fa TCOON
  74 Restart suspended output.
  75 .It Fa TCIOFF
  76 Transmit a STOP character, which is intended to cause the terminal to stop
  77 transmitting data to the system.
  78 (See the description of IXOFF in the
  79 .Ql Input Modes
  80 section of
  81 .Xr termios 4 ) .
  82 .It Fa TCION
  83 Transmit a START character, which is intended to cause the terminal to start
  84 transmitting data to the system.
  85 (See the description of IXOFF in the
  86 .Ql Input Modes
  87 section of
  88 .Xr termios 4 ) .
  89 .El
  90 .Pp
  91 The
  92 .Nm tcflush
  93 function discards any data written to the terminal referenced by
  94 .Fa fd
  95 which has not been transmitted to the terminal, or any data received
  96 from the terminal but not yet read, depending on the value of
  97 .Fa action .
  98 The value of
  99 .Fa action
 100 must be one of the following:
 101 .Bl -tag -width "TCIOFLUSH"
 102 .It Fa TCIFLUSH
 103 Flush data received but not read.
 104 .It Fa TCOFLUSH
 105 Flush data written but not transmitted.
 106 .It Fa TCIOFLUSH
 107 Flush both data received but not read and data written but not transmitted.
 108 .El
 109 .Pp
 110 The
 111 .Nm tcsendbreak
 112 function transmits a continuous stream of zero-valued bits for four-tenths
 113 of a second to the terminal referenced by
 114 .Fa fd .
 115 The
 116 .Fa len
 117 parameter is ignored in this implementation.
 118 .Sh RETURN VALUES
 119 Upon successful completion, all of these functions return a value of zero.
 120 .Sh ERRORS
 121 If any error occurs, a value of -1 is returned and the global variable
 122 .Va errno
 123 is set to indicate the error, as follows:
 124 .Bl -tag -width Er
 125 .It Bq Er EBADF
 126 The
 127 .Fa fd
 128 argument is not a valid file descriptor.
 129 .It Bq Er EINVAL
 130 The
 131 .Fa action
 132 argument is not a proper value.
 133 .It Bq Er ENOTTY
 134 The file associated with
 135 .Fa fd
 136 is not a terminal.
 137 .It Bq Er EINTR
 138 A signal interrupted the
 139 .Nm tcdrain
 140 function.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr tcsetattr 3 ,
 144 .Xr termios 4
 145 .Sh STANDARDS
 146 The
 147 .Nm tcsendbreak ,
 148 .Nm tcdrain ,
 149 .Nm tcflush
 150 and
 151 .Nm tcflow
 152 functions are expected to be compliant with the
 153 .St -p1003.1-88
 154 specification.