logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

tcflow.3p (3771B)

    

  1. '\" et
  2. .TH TCFLOW "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. tcflow
  12. \(em suspend or restart the transmission or reception of data
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <termios.h>
  17. .P
  18. int tcflow(int \fIfildes\fP, int \fIaction\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fItcflow\fR()
  23. function shall suspend or restart transmission or reception of data on
  24. the object referred to by
  25. .IR fildes ,
  26. depending on the value of
  27. .IR action .
  28. The
  29. .IR fildes
  30. argument is an open file descriptor associated with a terminal.
  31. .IP " *" 4
  32. If
  33. .IR action
  34. is TCOOFF, output shall be suspended.
  35. .IP " *" 4
  36. If
  37. .IR action
  38. is TCOON, suspended output shall be restarted.
  39. .IP " *" 4
  40. If
  41. .IR action
  42. is TCIOFF and
  43. .IR fildes
  44. refers to a terminal device, the system shall transmit a STOP character,
  45. which is intended to cause the terminal device to stop transmitting data
  46. to the system. If
  47. .IR fildes
  48. is associated with a pseudo-terminal, the STOP character need not be
  49. transmitted.
  50. .IP " *" 4
  51. If
  52. .IR action
  53. is TCION and
  54. .IR fildes
  55. refers to a terminal device, the system shall transmit a START character,
  56. which is intended to cause the terminal device to start transmitting
  57. data to the system. If
  58. .IR fildes
  59. is associated with a pseudo-terminal, the START character need not be
  60. transmitted.
  61. .P
  62. The default on the opening of a terminal file is that neither its input
  63. nor its output are suspended.
  64. .P
  65. Attempts to use
  66. \fItcflow\fR()
  67. from a process which is a member of a background process group on a
  68. .IR fildes
  69. associated with its controlling terminal, shall cause the process group
  70. to be sent a SIGTTOU signal.
  71. If the calling thread is blocking SIGTTOU signals or the process is
  72. ignoring SIGTTOU signals, the process shall be allowed to perform the
  73. operation, and no signal is sent.
  74. .SH "RETURN VALUE"
  75. Upon successful completion, 0 shall be returned. Otherwise, \-1
  76. shall be returned and
  77. .IR errno
  78. set to indicate the error.
  79. .SH ERRORS
  80. The
  81. \fItcflow\fR()
  82. function shall fail if:
  83. .TP
  84. .BR EBADF
  85. The
  86. .IR fildes
  87. argument is not a valid file descriptor.
  88. .TP
  89. .BR EINVAL
  90. The
  91. .IR action
  92. argument is not a supported value.
  93. .TP
  94. .BR EIO
  95. The process group of the writing process is orphaned, the calling thread
  96. is not blocking SIGTTOU, and the process is not ignoring SIGTTOU.
  97. .TP
  98. .BR ENOTTY
  99. The file associated with
  100. .IR fildes
  101. is not a terminal.
  102. .LP
  103. .IR "The following sections are informative."
  104. .SH EXAMPLES
  105. None.
  106. .SH "APPLICATION USAGE"
  107. None.
  108. .SH RATIONALE
  109. None.
  110. .SH "FUTURE DIRECTIONS"
  111. None.
  112. .SH "SEE ALSO"
  113. .IR "\fItcsendbreak\fR\^(\|)"
  114. .P
  115. The Base Definitions volume of POSIX.1\(hy2017,
  116. .IR "Chapter 11" ", " "General Terminal Interface",
  117. .IR "\fB<termios.h>\fP"
  118. .\"
  119. .SH COPYRIGHT
  120. Portions of this text are reprinted and reproduced in electronic form
  121. from IEEE Std 1003.1-2017, Standard for Information Technology
  122. -- Portable Operating System Interface (POSIX), The Open Group Base
  123. Specifications Issue 7, 2018 Edition,
  124. Copyright (C) 2018 by the Institute of
  125. Electrical and Electronics Engineers, Inc and The Open Group.
  126. In the event of any discrepancy between this version and the original IEEE and
  127. The Open Group Standard, the original IEEE and The Open Group Standard
  128. is the referee document. The original Standard can be obtained online at
  129. http://www.opengroup.org/unix/online.html .
  130. .PP
  131. Any typographical or formatting errors that appear
  132. in this page are most likely
  133. to have been introduced during the conversion of the source files to
  134. man page format. To report such errors, see
  135. https://www.kernel.org/doc/man-pages/reporting_bugs.html .