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

tcsendbreak.3p (3273B)

    

  1. '\" et
  2. .TH TCSENDBREAK "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. tcsendbreak
  12. \(em send a break for a specific duration
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <termios.h>
  17. .P
  18. int tcsendbreak(int \fIfildes\fP, int \fIduration\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. If the terminal is using asynchronous serial data transmission,
  22. \fItcsendbreak\fR()
  23. shall cause transmission of a continuous stream of zero-valued bits for
  24. a specific duration. If
  25. .IR duration
  26. is 0, it shall cause transmission of zero-valued bits for at least 0.25
  27. seconds, and not more than 0.5 seconds. If
  28. .IR duration
  29. is not 0, it shall send zero-valued bits for an
  30. implementation-defined period of time.
  31. .P
  32. The
  33. .IR fildes
  34. argument is an open file descriptor associated with a terminal.
  35. .P
  36. If the terminal is not using asynchronous serial data transmission, it
  37. is implementation-defined whether
  38. \fItcsendbreak\fR()
  39. sends data to generate a break condition or returns without taking any
  40. action.
  41. .P
  42. Attempts to use
  43. \fItcsendbreak\fR()
  44. from a process which is a member of a background process group on a
  45. .IR fildes
  46. associated with its controlling terminal shall cause the process group
  47. to be sent a SIGTTOU signal.
  48. If the calling thread is blocking SIGTTOU signals or the process is
  49. ignoring SIGTTOU signals, the process shall be allowed to perform the
  50. operation, and no signal is sent.
  51. .SH "RETURN VALUE"
  52. Upon successful completion, 0 shall be returned. Otherwise, \-1 shall
  53. be returned and
  54. .IR errno
  55. set to indicate the error.
  56. .SH ERRORS
  57. The
  58. \fItcsendbreak\fR()
  59. function shall fail if:
  60. .TP
  61. .BR EBADF
  62. The
  63. .IR fildes
  64. argument is not a valid file descriptor.
  65. .TP
  66. .BR EIO
  67. The process group of the writing process is orphaned, the calling thread
  68. is not blocking SIGTTOU, and the process is not ignoring SIGTTOU.
  69. .TP
  70. .BR ENOTTY
  71. The file associated with
  72. .IR fildes
  73. is not a terminal.
  74. .LP
  75. .IR "The following sections are informative."
  76. .SH EXAMPLES
  77. None.
  78. .SH "APPLICATION USAGE"
  79. None.
  80. .SH RATIONALE
  81. None.
  82. .SH "FUTURE DIRECTIONS"
  83. None.
  84. .SH "SEE ALSO"
  85. The Base Definitions volume of POSIX.1\(hy2017,
  86. .IR "Chapter 11" ", " "General Terminal Interface",
  87. .IR "\fB<termios.h>\fP"
  88. .\"
  89. .SH COPYRIGHT
  90. Portions of this text are reprinted and reproduced in electronic form
  91. from IEEE Std 1003.1-2017, Standard for Information Technology
  92. -- Portable Operating System Interface (POSIX), The Open Group Base
  93. Specifications Issue 7, 2018 Edition,
  94. Copyright (C) 2018 by the Institute of
  95. Electrical and Electronics Engineers, Inc and The Open Group.
  96. In the event of any discrepancy between this version and the original IEEE and
  97. The Open Group Standard, the original IEEE and The Open Group Standard
  98. is the referee document. The original Standard can be obtained online at
  99. http://www.opengroup.org/unix/online.html .
  100. .PP
  101. Any typographical or formatting errors that appear
  102. in this page are most likely
  103. to have been introduced during the conversion of the source files to
  104. man page format. To report such errors, see
  105. https://www.kernel.org/doc/man-pages/reporting_bugs.html .