[unix-history] / usr / share / man / cat3 / tcflush.0

TCSENDBREAK(3)              BSD Programmer's Manual             TCSENDBREAK(3)

N\bNA\bAM\bME\bE
     t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk, t\btc\bcd\bdr\bra\bai\bin\bn, t\btc\bcf\bfl\blu\bus\bsh\bh, t\btc\bcf\bfl\blo\bow\bw - line control functions

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     #\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<t\bte\ber\brm\bmi\bio\bos\bs.\b.h\bh>\b>

     _\bi_\bn_\bt
     t\btc\bcd\bdr\bra\bai\bin\bn(_\bi_\bn_\bt _\bf_\bd);

     _\bi_\bn_\bt
     t\btc\bcf\bfl\blo\bow\bw(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\ba_\bc_\bt_\bi_\bo_\bn);

     _\bi_\bn_\bt
     t\btc\bcf\bfl\blu\bus\bsh\bh(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\ba_\bc_\bt_\bi_\bo_\bn);

     _\bi_\bn_\bt
     t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\bl_\be_\bn);

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     The t\btc\bcd\bdr\bra\bai\bin\bn function waits until all output written to the terminal ref-
     erenced by _\bf_\bd has been transmitted to the terminal.

     The t\btc\bcf\bfl\blo\bow\bw function suspends transmission of data to or the reception of
     data from the terminal referenced by _\bf_\bd depending on the value of _\ba_\bc_\bt_\bi_\bo_\bn.
     The value of _\ba_\bc_\bt_\bi_\bo_\bn must be one of the following:

     _\bT_\bC_\bO_\bO_\bF_\bF  Suspend output.

     _\bT_\bC_\bO_\bO_\bN   Restart suspended output.

     _\bT_\bC_\bI_\bO_\bF_\bF  Transmit a STOP character, which is intended to cause the termi-
             nal to stop transmitting data to the system.  (See the descrip-
             tion of IXOFF in the `Input Modes' section of termios(4)).

     _\bT_\bC_\bI_\bO_\bN   Transmit a START character, which is intended to cause the termi-
             nal to start transmitting data to the system.  (See the descrip-
             tion of IXOFF in the `Input Modes' section of termios(4)).

     The t\btc\bcf\bfl\blu\bus\bsh\bh function discards any data written to the terminal referenced
     by _\bf_\bd which has not been transmitted to the terminal, or any data re-
     ceived from the terminal but not yet read, depending on the value of
     _\ba_\bc_\bt_\bi_\bo_\bn. The value of _\ba_\bc_\bt_\bi_\bo_\bn must be one of the following:

     _\bT_\bC_\bI_\bF_\bL_\bU_\bS_\bH   Flush data received but not read.

     _\bT_\bC_\bO_\bF_\bL_\bU_\bS_\bH   Flush data written but not transmitted.

     _\bT_\bC_\bI_\bO_\bF_\bL_\bU_\bS_\bH  Flush both data received but not read and data written but not
                transmitted.

     The t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk function transmits a continuous stream of zero-valued
     bits for four-tenths of a second to the terminal referenced by _\bf_\bd. The
     _\bl_\be_\bn parameter is ignored in this implementation.

R\bRE\bET\bTU\bUR\bRN\bN V\bVA\bAL\bLU\bUE\bES\bS
     Upon successful completion, all of these functions return a value of ze-
     ro.

E\bER\bRR\bRO\bOR\bRS\bS
     If any error occurs, a value of -1 is returned and the global variable
     _\be_\br_\br_\bn_\bo is set to indicate the error, as follows:


     [EBADF]       The _\bf_\bd argument is not a valid file descriptor.

     [EINVAL]      The _\ba_\bc_\bt_\bi_\bo_\bn argument is not a proper value.

     [ENOTTY]      The file associated with _\bf_\bd is not a terminal.

     [EINTR]       A signal interrupted the t\btc\bcd\bdr\bra\bai\bin\bn function.

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     tcsetattr(3),  termios(4)

S\bST\bTA\bAN\bND\bDA\bAR\bRD\bDS\bS
     The t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk, t\btc\bcd\bdr\bra\bai\bin\bn, t\btc\bcf\bfl\blu\bus\bsh\bh and t\btc\bcf\bfl\blo\bow\bw functions are expected to be
     compliant with the IEEE Std1003.1-1988 (``POSIX'') specification.

4.4BSD                           June 4, 1993                                2
Commit	Line	Data
8bb980a3 C	1	TCSENDBREAK(3) BSD Programmer's Manual TCSENDBREAK(3)
	2
	3	N\bNA\bAM\bME\bE
	4	t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk, t\btc\bcd\bdr\bra\bai\bin\bn, t\btc\bcf\bfl\blu\bus\bsh\bh, t\btc\bcf\bfl\blo\bow\bw - line control functions
	5
	6	S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
	7	#\b#i\bin\bnc\bcl\blu\bud\bde\be <\b<t\bte\ber\brm\bmi\bio\bos\bs.\b.h\bh>\b>
	8
	9	_\bi_\bn_\bt
	10	t\btc\bcd\bdr\bra\bai\bin\bn(_\bi_\bn_\bt _\bf_\bd);
	11
	12	_\bi_\bn_\bt
	13	t\btc\bcf\bfl\blo\bow\bw(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\ba_\bc_\bt_\bi_\bo_\bn);
	14
	15	_\bi_\bn_\bt
	16	t\btc\bcf\bfl\blu\bus\bsh\bh(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\ba_\bc_\bt_\bi_\bo_\bn);
	17
	18	_\bi_\bn_\bt
	19	t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk(_\bi_\bn_\bt _\bf_\bd, _\bi_\bn_\bt _\bl_\be_\bn);
	20
	21	D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
	22	The t\btc\bcd\bdr\bra\bai\bin\bn function waits until all output written to the terminal ref-
	23	erenced by _\bf_\bd has been transmitted to the terminal.
	24
	25	The t\btc\bcf\bfl\blo\bow\bw function suspends transmission of data to or the reception of
	26	data from the terminal referenced by _\bf_\bd depending on the value of _\ba_\bc_\bt_\bi_\bo_\bn.
	27	The value of _\ba_\bc_\bt_\bi_\bo_\bn must be one of the following:
	28
	29	_\bT_\bC_\bO_\bO_\bF_\bF Suspend output.
	30
	31	_\bT_\bC_\bO_\bO_\bN Restart suspended output.
	32
	33	_\bT_\bC_\bI_\bO_\bF_\bF Transmit a STOP character, which is intended to cause the termi-
	34	nal to stop transmitting data to the system. (See the descrip-
	35	tion of IXOFF in the `Input Modes' section of termios(4)).
	36
	37	_\bT_\bC_\bI_\bO_\bN Transmit a START character, which is intended to cause the termi-
	38	nal to start transmitting data to the system. (See the descrip-
	39	tion of IXOFF in the `Input Modes' section of termios(4)).
	40
	41	The t\btc\bcf\bfl\blu\bus\bsh\bh function discards any data written to the terminal referenced
	42	by _\bf_\bd which has not been transmitted to the terminal, or any data re-
	43	ceived from the terminal but not yet read, depending on the value of
	44	_\ba_\bc_\bt_\bi_\bo_\bn. The value of _\ba_\bc_\bt_\bi_\bo_\bn must be one of the following:
	45
	46	_\bT_\bC_\bI_\bF_\bL_\bU_\bS_\bH Flush data received but not read.
	47
	48	_\bT_\bC_\bO_\bF_\bL_\bU_\bS_\bH Flush data written but not transmitted.
	49
	50	_\bT_\bC_\bI_\bO_\bF_\bL_\bU_\bS_\bH Flush both data received but not read and data written but not
	51	transmitted.
	52
	53	The t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk function transmits a continuous stream of zero-valued
	54	bits for four-tenths of a second to the terminal referenced by _\bf_\bd. The
	55	_\bl_\be_\bn parameter is ignored in this implementation.
	56
	57	R\bRE\bET\bTU\bUR\bRN\bN V\bVA\bAL\bLU\bUE\bES\bS
	58	Upon successful completion, all of these functions return a value of ze-
	59	ro.
	60
	61	E\bER\bRR\bRO\bOR\bRS\bS
	62	If any error occurs, a value of -1 is returned and the global variable
	63	_\be_\br_\br_\bn_\bo is set to indicate the error, as follows:
	64
65
66	[EBADF] The _\bf_\bd argument is not a valid file descriptor.
67
68	[EINVAL] The _\ba_\bc_\bt_\bi_\bo_\bn argument is not a proper value.
69
70	[ENOTTY] The file associated with _\bf_\bd is not a terminal.
71
72	[EINTR] A signal interrupted the t\btc\bcd\bdr\bra\bai\bin\bn function.
73
74	S\bSE\bEE\bE A\bAL\bLS\bSO\bO
75	tcsetattr(3), termios(4)
76
77	S\bST\bTA\bAN\bND\bDA\bAR\bRD\bDS\bS
78	The t\btc\bcs\bse\ben\bnd\bdb\bbr\bre\bea\bak\bk, t\btc\bcd\bdr\bra\bai\bin\bn, t\btc\bcf\bfl\blu\bus\bsh\bh and t\btc\bcf\bfl\blo\bow\bw functions are expected to be
79	compliant with the IEEE Std1003.1-1988 (``POSIX'') specification.
80
81	4.4BSD June 4, 1993 2