os/ossrv/genericopenlibs/openenvcore/include/sys/ttycom.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 /** @file  ../include/sys/ttycom.h
     2 @internalComponent
     3 */
     4 
     5 /** @struct winsize
     6 
     7 Window or terminal size structure.  This information is stored by the kernel in order to provide a consistent interface, but is not used by the kernel.
     8 
     9 @publishedAll
    10 @externallyDefinedApi
    11 */
    12 
    13 /** @var winsize::ws_row
    14 rows, in characters
    15 */
    16 
    17 /** @var winsize::ws_col
    18 columns, in characters  
    19 */
    20 
    21 /** @var winsize::ws_xpixel
    22 horizontal size, pixels
    23 */
    24 
    25 /** @var winsize::ws_ypixel
    26 vertical size, pixels
    27 */
    28 
    29 /** @def TIOCGETD	
    30 
    31 get line discipline
    32 
    33 @publishedAll
    34 @externallyDefinedApi
    35 */
    36 
    37 /** @def TIOCSETD	
    38 
    39 set line discipline 
    40 
    41 @publishedAll
    42 @externallyDefinedApi
    43 */
    44 
    45 
    46 /** @def TIOCCBRK	
    47 
    48 clear break bit
    49  
    50 @publishedAll
    51 @externallyDefinedApi
    52 */
    53 
    54 
    55 /** @def TIOCSBRK	
    56 
    57 set break bit
    58  
    59 @publishedAll
    60 @externallyDefinedApi
    61 */
    62 
    63 
    64 /** @def TIOCSDTR	 
    65 
    66 set data terminal ready 
    67 
    68 @publishedAll
    69 @externallyDefinedApi
    70 */
    71 
    72 
    73 /** @def TIOCCDTR
    74 
    75 clear data terminal ready 
    76 	 
    77 @publishedAll
    78 @externallyDefinedApi
    79 */
    80 
    81 
    82 /** @def TIOCGPGRP	
    83 
    84 get pgrp of tty
    85 
    86 @publishedAll
    87 @externallyDefinedApi
    88 */
    89 
    90 /** @def TIOCSPGRP
    91 
    92 set pgrp of tty 
    93 	
    94 @publishedAll
    95 @externallyDefinedApi
    96 */
    97 
    98 
    99 /** @def TIOCGETA	
   100 
   101 get termios struct
   102 
   103 @publishedAll
   104 @externallyDefinedApi
   105 */
   106 
   107 
   108 /** @def TIOCSETA	
   109 
   110 set termios struct 
   111 
   112 @publishedAll
   113 @externallyDefinedApi
   114 */
   115 
   116 
   117 /** @def TIOCSETAW	
   118 
   119 drain output, set
   120 
   121 @publishedAll
   122 @externallyDefinedApi
   123 */
   124 
   125 
   126 /** @def TIOCSETAF	
   127 
   128 drn out, fls in, set 
   129 
   130 @publishedAll
   131 @externallyDefinedApi
   132 */
   133 
   134 
   135 /** @def TIOCOUTQ	
   136 
   137 output queue size
   138 
   139 @publishedAll
   140 @externallyDefinedApi
   141 */
   142 
   143 
   144 /** @def TIOCSTI		
   145 
   146 simulate terminal input
   147 
   148 @publishedAll
   149 @externallyDefinedApi
   150 */
   151 
   152 
   153 /** @def TIOCNOTTY	
   154 
   155 void tty association
   156  
   157 @publishedAll
   158 @externallyDefinedApi
   159 */
   160 
   161 
   162 /** @def TIOCSTOP	
   163 
   164 stop output.
   165  
   166 @publishedAll
   167 @externallyDefinedApi
   168 */
   169 
   170 /** @def TIOCSTART	
   171 
   172 Start output. 
   173 
   174 @publishedAll
   175 @externallyDefinedApi
   176 */
   177 
   178 
   179 /** @def TIOCSCTTY	
   180 
   181 become controlling tty
   182  
   183 @publishedAll
   184 @externallyDefinedApi
   185 */
   186 
   187 /** @def TIOCDRAIN	 
   188 
   189 wait till output drained
   190 
   191 @publishedAll
   192 @externallyDefinedApi
   193 */
   194 
   195 
   196 /** @def TIOCEXCL	
   197 
   198  set exclusive use of tty 
   199  
   200 @publishedAll
   201 @externallyDefinedApi
   202 */
   203 
   204 /** @def TIOCNXCL	 
   205 
   206 reset exclusive use of tty
   207 
   208 @publishedAll
   209 @externallyDefinedApi
   210 */
   211 
   212 
   213 /** @def TIOCFLUSH	
   214 
   215 flush buffers
   216 
   217 @publishedAll
   218 @externallyDefinedApi
   219 */
   220 
   221 /** @def TIOCGWINSZ	
   222 
   223 get window size
   224 
   225 @publishedAll
   226 @externallyDefinedApi
   227 */
   228 
   229 /** @def TIOCSWINSZ	
   230 
   231 set window size
   232 
   233 @publishedAll
   234 @externallyDefinedApi
   235 */
   236 
   237 
   238 /** @def TIOCCONS	
   239 
   240 become virtual console
   241 
   242 @publishedAll
   243 @externallyDefinedApi
   244 */
   245 
   246 
   247 /** @def TIOCMSET	
   248 
   249 set all modem bits
   250 
   251 @publishedAll
   252 @externallyDefinedApi
   253 */
   254 
   255 /** @def TIOCMBIS	
   256 
   257 bis modem bits
   258 
   259 @publishedAll
   260 @externallyDefinedApi
   261 */
   262 
   263 /** @def TIOCMBIC	
   264 
   265 bic modem bits
   266 
   267 @publishedAll
   268 @externallyDefinedApi
   269 */
   270 
   271 
   272 /** @def TIOCMGET	
   273 
   274 get all modem bits
   275 
   276 @publishedAll
   277 @externallyDefinedApi
   278 */
   279 
   280 
   281 /** @def TIOCM_LE	
   282 
   283 line enable
   284 
   285 @publishedAll
   286 @externallyDefinedApi
   287 */
   288 
   289 
   290 /** @def TIOCM_DTR	
   291 
   292 data terminal ready
   293 
   294 @publishedAll
   295 @externallyDefinedApi
   296 */
   297 
   298 
   299 /** @def TIOCM_RTS	
   300 
   301 request to send
   302 
   303 @publishedAll
   304 @externallyDefinedApi
   305 */
   306 
   307 
   308 /** @def TIOCM_ST	
   309 
   310 secondary transmit
   311 
   312 @publishedAll
   313 @externallyDefinedApi
   314 */
   315 
   316 
   317 /** @def TIOCM_SR
   318 
   319 secondary receive
   320 	
   321 @publishedAll
   322 @externallyDefinedApi
   323 */
   324 
   325 
   326 /** @def TIOCM_CTS
   327 
   328 clear to send
   329 	
   330 @publishedAll
   331 @externallyDefinedApi
   332 */
   333 
   334 
   335 /** @def TIOCM_DCD	
   336 
   337 data carrier detect
   338 	
   339 @publishedAll
   340 @externallyDefinedApi
   341 */
   342 
   343 /** @def TIOCM_RI 		
   344 
   345 ring indicate
   346 
   347 @publishedAll
   348 @externallyDefinedApi
   349 */
   350 
   351 
   352 /** @def TIOCM_DSR	
   353 
   354 data set ready
   355 
   356 @publishedAll
   357 @externallyDefinedApi
   358 */
   359 
   360 /** @def TIOCM_CD	
   361 
   362 data carrier detect
   363 	
   364 @publishedAll
   365 @externallyDefinedApi
   366 */
   367 
   368 
   369 /** @def TIOCM_CAR	
   370 
   371 data carrier detect
   372 
   373 @publishedAll
   374 @externallyDefinedApi
   375 */
   376 
   377 /** @def TIOCM_RNG	
   378 
   379 ring indicate
   380 
   381 @publishedAll
   382 @externallyDefinedApi
   383 */
   384 
   385 /** @def TIOCPKT_DATA	
   386 
   387 data packet
   388 	
   389 @publishedAll
   390 @released
   391 */
   392 
   393 /** @def TIOCPKT_FLUSHREAD	
   394 
   395 flush packet
   396 
   397 @publishedAll
   398 @released
   399 */
   400 
   401 
   402 /** @def TIOCPKT_FLUSHWRITE	
   403 
   404 flush packet 
   405 
   406 @publishedAll
   407 @released
   408 */
   409 
   410 /** @def TIOCPKT_STOP		
   411 
   412 stop output
   413 
   414 @publishedAll
   415 @released
   416 */
   417 
   418 
   419 /** @def TIOCPKT_START		
   420 
   421 start output
   422 
   423 @publishedAll
   424 @released
   425 */
   426 
   427 
   428 /** @def TIOCPKT_NOSTOP	
   429 
   430 no more stop output, start output
   431 	
   432 @publishedAll
   433 @released
   434 */
   435 
   436 /** @def TIOCPKT_DOSTOP		
   437 
   438 now do stop output, start output
   439 
   440 @publishedAll
   441 @released
   442 */
   443 
   444 /** @def TIOCPKT_IOCTL		
   445 
   446 state change of pty driver
   447 
   448 @publishedAll
   449 @released
   450 */
   451 
   452 
   453 /** @def TIOCEXT	
   454 
   455 pty: external processing
   456 	
   457 @publishedAll
   458 @released
   459 */
   460 
   461 
   462 /** @def TIOCSIG	
   463 
   464 pty: generate signal
   465 	 
   466 @publishedAll
   467 @released
   468 */
   469 
   470 
   471 /** @def TIOCMSDTRWAIT
   472 
   473 modem: set wait on close
   474 	
   475 @publishedAll
   476 @released
   477 */
   478 
   479 
   480 /** @def TIOCTIMESTAMP	
   481 
   482 enable or get timestamp of last input event
   483 
   484 @publishedAll
   485 @released
   486 */
   487 
   488 
   489 /** @def TIOCSDRAINWAIT	
   490 
   491 set ttywait timeout
   492 
   493 @publishedAll
   494 @released
   495 */
   496 
   497 
   498 
   499 /** @def TTYDISC	
   500 
   501 termios tty line discipline 
   502 	
   503 @publishedAll
   504 @released
   505 */
   506 
   507 
   508 /** @def PPPDISC	
   509 
   510 PPP discipline 
   511 	
   512 @publishedAll
   513 @released
   514 */
   515 
   516 
   517 /** @def NETGRAPHDISC	
   518 
   519 Netgraph tty node discipline 
   520 
   521 @publishedAll
   522 @released
   523 */
   524 
   525 
   526 /** @def H4DISC	
   527 
   528 Netgraph Bluetooth H4 discipline
   529 	
   530 @publishedAll
   531 @externallyDefinedApi
   532 */						
   533 
   534 
   535 						
   536 
   537 						 
   538 						
   539 
   540 
   541 
   542