share/man/man4/tty.4

   1 .\" Copyright (c) 1991, 1992, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)tty.4       8.3 (Berkeley) 4/19/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 11, 2017
  32 .Dt TTY 4
  33 .Os
  34 .Sh NAME
  35 .Nm tty
  36 .Nd general terminal interface
  37 .Sh SYNOPSIS
  38 .In sys/ioctl.h
  39 .Sh DESCRIPTION
  40 This section describes the interface to the terminal drivers
  41 in the system.
  42 .Ss Terminal Special Files
  43 Each hardware terminal port on the system usually has a terminal special device
  44 file associated with it in the directory ``/dev/'' (for
  45 example, ``/dev/tty03'').
  46 When a user logs into
  47 the system on one of these hardware terminal ports, the system has already
  48 opened the associated device and prepared the line for normal interactive
  49 use (see
  50 .Xr getty 8 . )
  51 There is also a special case of a terminal file that connects not to
  52 a hardware terminal port, but to another program on the other side.
  53 These special terminal devices are called
  54 .Em ptys
  55 and provide the mechanism necessary to give users the same interface to the
  56 system when logging in over a network (using
  57 .Xr rlogin 1 ,
  58 or
  59 .Xr telnet 1
  60 for example).
  61 Even in these cases the details of how the terminal
  62 file was opened and set up is already handled by special software
  63 in the system.
  64 Thus, users do not normally need to worry about the details of
  65 how these lines are opened or used.
  66 Also, these lines are often used
  67 for dialing out of a system (through an out-calling modem), but again
  68 the system provides programs that hide the details of accessing
  69 these terminal special files (see
  70 .Xr tip 1 ) .
  71 .Pp
  72 When an interactive user logs in, the system prepares the line to
  73 behave in a certain way (called a
  74 .Em "line discipline" ) ,
  75 the particular details of which is described in
  76 .Xr stty 1
  77 at the command level, and in
  78 .Xr termios 4
  79 at the programming level.
  80 A user may be concerned with changing
  81 settings associated with his particular login terminal and should refer
  82 to the preceding man pages for the common cases.
  83 The remainder of this man page is concerned
  84 with describing details of using and controlling terminal devices
  85 at a low level, such as that possibly required by a program wishing
  86 to provide features similar to those provided by the system.
  87 .Ss Terminal File Operations
  88 All of the following operations are invoked using the
  89 .Xr ioctl 2
  90 system call.
  91 Refer to that man page for a description of the
  92 .Em request
  93 and
  94 .Em argp
  95 parameters.
  96 In addition to the ioctl
  97 .Em requests
  98 defined here, the specific line discipline
  99 in effect will define other
 100 .Em requests
 101 specific to it (actually
 102 .Xr termios 4
 103 defines them as function calls, not ioctl
 104 .Em requests . )
 105 The following section lists the available ioctl requests.
 106 The name of the request, a description of its purpose, and the typed
 107 .Em argp
 108 parameter (if any)
 109 are listed.
 110 For example, the first entry says
 111 .Pp
 112 .D1 Em "TIOCSPGRP int *tpgrp"
 113 .Pp
 114 and would be called on the terminal associated with
 115 file descriptor zero by the following code fragment:
 116 .Bd -literal
 117         int pgrp;
 118
 119         pgrp = getpgrp();
 120         ioctl(0, TIOCSPGRP, &pgrp);
 121 .Ed
 122 .Ss Terminal File Request Descriptions
 123 .Bl -tag -width TIOCGWINSZ
 124 .It Dv TIOCSETD Fa int *ldisc
 125 This call is obsolete but left for compatibility.
 126 Before
 127 .Fx 8.0 ,
 128 it would change to the new line discipline pointed to by
 129 .Fa ldisc .
 130 .It Dv TIOCGETD Fa int *ldisc
 131 Return the current line discipline in the integer pointed to by
 132 .Fa ldisc .
 133 .It Dv TIOCSBRK Fa void
 134 Set the terminal hardware into BREAK condition.
 135 .It Dv TIOCCBRK Fa void
 136 Clear the terminal hardware BREAK condition.
 137 .It Dv TIOCSDTR Fa void
 138 Assert data terminal ready (DTR).
 139 .It Dv TIOCCDTR Fa void
 140 Clear data terminal ready (DTR).
 141 .It Dv TIOCGPGRP Fa int *tpgrp
 142 Return the current process group with which the terminal is associated
 143 in the integer pointed to by
 144 .Fa tpgrp .
 145 This is the underlying call that implements the
 146 .Xr termios 4
 147 .Fn tcgetattr
 148 call.
 149 .It Dv TIOCSPGRP Fa int *tpgrp
 150 Associate the terminal with the process group (as an integer) pointed to by
 151 .Fa tpgrp .
 152 This is the underlying call that implements the
 153 .Xr termios 4
 154 .Fn tcsetattr
 155 call.
 156 .It Dv TIOCGETA Fa struct termios *term
 157 Place the current value of the termios state associated with the
 158 device in the termios structure pointed to by
 159 .Fa term .
 160 This is the underlying call that implements the
 161 .Xr termios 4
 162 .Fn tcgetattr
 163 call.
 164 .It Dv TIOCSETA Fa struct termios *term
 165 Set the termios state associated with the device immediately.
 166 This is the underlying call that implements the
 167 .Xr termios 4
 168 .Fn tcsetattr
 169 call with the
 170 .Dv TCSANOW
 171 option.
 172 .It Dv TIOCSETAW Fa struct termios *term
 173 First wait for any output to complete, then set the termios state
 174 associated with the device.
 175 This is the underlying call that implements the
 176 .Xr termios 4
 177 .Fn tcsetattr
 178 call with the
 179 .Dv TCSADRAIN
 180 option.
 181 .It Dv TIOCSETAF Fa struct termios *term
 182 First wait for any output to complete, clear any pending input,
 183 then set the termios state associated with the device.
 184 This is the underlying call that implements the
 185 .Xr termios 4
 186 .Fn tcsetattr
 187 call with the
 188 .Dv TCSAFLUSH
 189 option.
 190 .It Dv TIOCOUTQ Fa int *num
 191 Place the current number of characters in the output queue in the
 192 integer pointed to by
 193 .Fa num .
 194 .It Dv TIOCSTI Fa char *cp
 195 Simulate typed input.
 196 Pretend as if the terminal received the character pointed to by
 197 .Fa cp .
 198 .It Dv TIOCNOTTY Fa void
 199 This call is obsolete but left for compatibility.
 200 In the past, when a process that did not have a controlling terminal (see
 201 .Em The Controlling Terminal
 202 in
 203 .Xr termios 4 )
 204 first opened a terminal device, it acquired that terminal as its
 205 controlling terminal.
 206 For some programs this was a hazard as they
 207 did not want a controlling terminal in the first place, and this
 208 provided a mechanism to disassociate the controlling terminal from
 209 the calling process.
 210 It
 211 .Em must
 212 be called by opening the file
 213 .Pa /dev/tty
 214 and calling
 215 .Dv TIOCNOTTY
 216 on that file descriptor.
 217 .Pp
 218 The current system does not allocate a controlling terminal to
 219 a process on an
 220 .Fn open
 221 call: there is a specific ioctl called
 222 .Dv TIOCSCTTY
 223 to make a terminal the controlling
 224 terminal.
 225 In addition, a program can
 226 .Fn fork
 227 and call the
 228 .Fn setsid
 229 system call which will place the process into its own session - which
 230 has the effect of disassociating it from the controlling terminal.
 231 This is the new and preferred method for programs to lose their controlling
 232 terminal.
 233 .It Dv TIOCSTOP Fa void
 234 Stop output on the terminal (like typing ^S at the keyboard).
 235 .It Dv TIOCSTART Fa void
 236 Start output on the terminal (like typing ^Q at the keyboard).
 237 .It Dv TIOCSCTTY Fa void
 238 Make the terminal the controlling terminal for the process (the process
 239 must not currently have a controlling terminal).
 240 .It Dv TIOCDRAIN Fa void
 241 Wait until all output is drained, or until the drain wait timeout expires.
 242 .It Dv TIOCGDRAINWAIT Fa int *timeout
 243 Return the current drain wait timeout in seconds.
 244 .It Dv TIOCSDRAINWAIT Fa int *timeout
 245 Set the drain wait timeout in seconds.
 246 A value of zero disables timeouts.
 247 The default drain wait timeout is controlled by the tunable
 248 .Xr sysctl 8
 249 OID
 250 .Va kern.tty_drainwait .
 251 .It Dv TIOCEXCL Fa void
 252 Set exclusive use on the terminal.
 253 No further opens are permitted except by root.
 254 Of course, this means that programs that are run by
 255 root (or setuid) will not obey the exclusive setting - which limits
 256 the usefulness of this feature.
 257 .It Dv TIOCNXCL Fa void
 258 Clear exclusive use of the terminal.
 259 Further opens are permitted.
 260 .It Dv TIOCFLUSH Fa int *what
 261 If the value of the int pointed to by
 262 .Fa what
 263 contains the
 264 .Dv FREAD
 265 bit as defined in
 266 .In sys/file.h ,
 267 then all characters in the input queue are cleared.
 268 If it contains the
 269 .Dv FWRITE
 270 bit, then all characters in the output queue are cleared.
 271 If the value of the integer is zero, then it behaves as if both the
 272 .Dv FREAD
 273 and
 274 .Dv FWRITE
 275 bits were set (i.e., clears both queues).
 276 .It Dv TIOCGWINSZ Fa struct winsize *ws
 277 Put the window size information associated with the terminal in the
 278 .Va winsize
 279 structure pointed to by
 280 .Fa ws .
 281 The window size structure contains the number of rows and columns (and pixels
 282 if appropriate) of the devices attached to the terminal.
 283 It is set by user software
 284 and is the means by which most full\&-screen oriented programs determine the
 285 screen size.
 286 The
 287 .Va winsize
 288 structure is defined in
 289 .In sys/ioctl.h .
 290 .It Dv TIOCSWINSZ Fa struct winsize *ws
 291 Set the window size associated with the terminal to be the value in
 292 the
 293 .Va winsize
 294 structure pointed to by
 295 .Fa ws
 296 (see above).
 297 .It Dv TIOCCONS Fa int *on
 298 If
 299 .Fa on
 300 points to a non-zero integer, redirect kernel console output (kernel printf's)
 301 to this terminal.
 302 If
 303 .Fa on
 304 points to a zero integer, redirect kernel console output back to the normal
 305 console.
 306 This is usually used on workstations to redirect kernel messages
 307 to a particular window.
 308 .It Dv TIOCMSET Fa int *state
 309 The integer pointed to by
 310 .Fa state
 311 contains bits that correspond to modem state.
 312 Following is a list of defined variables and the modem state they represent:
 313 .Pp
 314 .Bl -tag -width TIOCMXCTS -compact
 315 .It TIOCM_LE
 316 Line Enable.
 317 .It TIOCM_DTR
 318 Data Terminal Ready.
 319 .It TIOCM_RTS
 320 Request To Send.
 321 .It TIOCM_ST
 322 Secondary Transmit.
 323 .It TIOCM_SR
 324 Secondary Receive.
 325 .It TIOCM_CTS
 326 Clear To Send.
 327 .It TIOCM_CAR
 328 Carrier Detect.
 329 .It TIOCM_CD
 330 Carrier Detect (synonym).
 331 .It TIOCM_RNG
 332 Ring Indication.
 333 .It TIOCM_RI
 334 Ring Indication (synonym).
 335 .It TIOCM_DSR
 336 Data Set Ready.
 337 .El
 338 .Pp
 339 This call sets the terminal modem state to that represented by
 340 .Fa state .
 341 Not all terminals may support this.
 342 .It Dv TIOCMGET Fa int *state
 343 Return the current state of the terminal modem lines as represented
 344 above in the integer pointed to by
 345 .Fa state .
 346 .It Dv TIOCMBIS Fa int *state
 347 The bits in the integer pointed to by
 348 .Fa state
 349 represent modem state as described above, however the state is OR-ed
 350 in with the current state.
 351 .It Dv TIOCMBIC Fa int *state
 352 The bits in the integer pointed to by
 353 .Fa state
 354 represent modem state as described above, however each bit which is on
 355 in
 356 .Fa state
 357 is cleared in the terminal.
 358 .El
 359 .Sh IMPLEMENTATION NOTES
 360 The total number of input and output bytes
 361 through all terminal devices
 362 are available via the
 363 .Va kern.tty_nin
 364 and
 365 .Va kern.tty_nout
 366 read-only
 367 .Xr sysctl 8
 368 variables.
 369 .Sh SEE ALSO
 370 .Xr stty 1 ,
 371 .Xr ioctl 2 ,
 372 .Xr ng_tty 4 ,
 373 .Xr pty 4 ,
 374 .Xr termios 4 ,
 375 .Xr getty 8