manual/LDP_man-pages/original/man4/console_ioctl.4

   1 .\" Copyright (c) 1995 Jim Van Zandt <jrv@vanzandt.mv.com> and aeb
   2 .\" Sun Feb 26 11:46:23 MET 1995
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, see
  22 .\" <http://www.gnu.org/licenses/>.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified, Sun Feb 26 15:04:20 1995, faith@cs.unc.edu
  26 .\" Modified, Thu Apr 20 22:08:17 1995, jrv@vanzandt.mv.com
  27 .\" Modified, Mon Sep 18 22:32:47 1995, hpa@storm.net (H. Peter Anvin)
  28 .\" FIXME The following are not documented:
  29 .\"     KDFONTOP (since 2.1.111)
  30 .\"     KDGKBDIACRUC (since 2.6.24)
  31 .\"     KDSKBDIACR
  32 .\"     KDSKBDIACRUC (since 2.6.24)
  33 .\"     KDKBDREP (since 2.1.113)
  34 .\"     KDMAPDISP (not implemented as at 2.6.27)
  35 .\"     KDUNMAPDISP (not implemented as at 2.6.27)
  36 .\"     VT_LOCKSWITCH (since 1.3.47, needs CAP_SYS_TTY_CONFIG)
  37 .\"     VT_UNLOCKSWITCH (since 1.3.47, needs CAP_SYS_TTY_CONFIG)
  38 .\"     VT_GETHIFONTMASK (since 2.6.18)
  39 .\"
  40 .TH CONSOLE_IOCTL 4 2009-02-28 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 console_ioctl \- ioctls for console terminal and virtual consoles
  43 .SH DESCRIPTION
  44 The following Linux-specific
  45 .BR ioctl (2)
  46 requests are supported.
  47 Each requires a third argument, assumed here to be
  48 .IR argp .
  49 .TP
  50 .B KDGETLED
  51 Get state of LEDs.
  52 .I argp
  53 points to a
  54 .IR char .
  55 The lower three bits
  56 of
  57 .I *argp
  58 are set to the state of the LEDs, as follows:
  59 .TS
  60 l l l.
  61 LED_CAP         0x04    caps lock led
  62 LEC_NUM         0x02    num lock led
  63 LED_SCR         0x01    scroll lock led
  64 .TE
  65 .TP
  66 .B KDSETLED
  67 Set the LEDs.
  68 The LEDs are set to correspond to the lower three bits of
  69 .IR argp .
  70 However, if a higher order bit is set,
  71 the LEDs revert to normal: displaying the state of the
  72 keyboard functions of caps lock, num lock, and scroll lock.
  73 .LP
  74 Before 1.1.54, the LEDs just reflected the state of the corresponding
  75 keyboard flags, and KDGETLED/KDSETLED would also change the keyboard
  76 flags.
  77 Since 1.1.54 the LEDs can be made to display arbitrary
  78 information, but by default they display the keyboard flags.
  79 The following two ioctls are used to access the keyboard flags.
  80 .TP
  81 .B KDGKBLED
  82 Get keyboard flags CapsLock, NumLock, ScrollLock (not lights).
  83 .I argp
  84 points to a char which is set to the flag state.
  85 The low order three bits (mask 0x7) get the current flag state,
  86 and the low order bits of the next nibble (mask 0x70) get
  87 the default flag state.
  88 (Since 1.1.54.)
  89 .TP
  90 .B KDSKBLED
  91 Set keyboard flags CapsLock, NumLock, ScrollLock (not lights).
  92 .I argp
  93 has the desired flag state.
  94 The low order three bits (mask 0x7) have the flag state,
  95 and the low order bits of the next nibble (mask 0x70) have
  96 the default flag state.
  97 (Since 1.1.54.)
  98 .TP
  99 .B KDGKBTYPE
 100 Get keyboard type.
 101 This returns the value KB_101, defined as 0x02.
 102 .TP
 103 .B KDADDIO
 104 Add I/O port as valid.
 105 Equivalent to
 106 .IR ioperm(arg,1,1) .
 107 .TP
 108 .B KDDELIO
 109 Delete I/O port as valid.
 110 Equivalent to
 111 .IR ioperm(arg,1,0) .
 112 .TP
 113 .B KDENABIO
 114 Enable I/O to video board.
 115 Equivalent to
 116 .IR "ioperm(0x3b4, 0x3df-0x3b4+1, 1)" .
 117 .TP
 118 .B KDDISABIO
 119 Disable I/O to video board.
 120 Equivalent to
 121 .IR "ioperm(0x3b4, 0x3df-0x3b4+1, 0)" .
 122 .TP
 123 .B KDSETMODE
 124 Set text/graphics mode.
 125 .I argp
 126 is one of these:
 127
 128 .TS
 129 l l.
 130 KD_TEXT 0x00
 131 KD_GRAPHICS     0x01
 132 .TE
 133 .TP
 134 .B KDGETMODE
 135 Get text/graphics mode.
 136 .I argp
 137 points to a
 138 .I long
 139 which is set to one
 140 of the above values.
 141 .TP
 142 .B KDMKTONE
 143 Generate tone of specified length.
 144 The lower 16 bits of
 145 .I argp
 146 specify the period in clock cycles,
 147 and the upper 16 bits give the duration in msec.
 148 If the duration is zero, the sound is turned off.
 149 Control returns immediately.
 150 For example,
 151 .I argp
 152 = (125<<16) + 0x637 would specify
 153 the beep normally associated with a ctrl-G.
 154 (Thus since 0.99pl1; broken in 2.1.49-50.)
 155 .TP
 156 .B KIOCSOUND
 157 Start or stop sound generation.
 158 The lower 16 bits of
 159 .I argp
 160 specify the period in clock cycles
 161 (that is,
 162 .I argp
 163 = 1193180/frequency).
 164 .I argp
 165 = 0 turns sound off.
 166 In either case, control returns immediately.
 167 .TP
 168 .B GIO_CMAP
 169 Get the current default color map from kernel.
 170 .I argp
 171 points to
 172 a 48-byte array.
 173 (Since 1.3.3.)
 174 .TP
 175 .B PIO_CMAP
 176 Change the default text-mode color map.
 177 .I argp
 178 points to a
 179 48-byte array which contains, in order, the Red, Green, and Blue
 180 values for the 16 available screen colors: 0 is off, and 255 is full
 181 intensity.
 182 The default colors are, in order: black, dark red, dark
 183 green, brown, dark blue, dark purple, dark cyan, light grey, dark
 184 grey, bright red, bright green, yellow, bright blue, bright purple,
 185 bright cyan and white.
 186 (Since 1.3.3.)
 187 .TP
 188 .B GIO_FONT
 189 Gets 256-character screen font in expanded form.
 190 .I argp
 191 points to an 8192 byte array.
 192 Fails with error code
 193 .B EINVAL
 194 if the
 195 currently loaded font is a 512-character font, or if the console is
 196 not in text mode.
 197 .TP
 198 .B GIO_FONTX
 199 Gets screen font and associated information.
 200 .I argp
 201 points to a
 202 .I "struct consolefontdesc"
 203 (see
 204 .BR PIO_FONTX ).
 205 On call, the
 206 .I charcount
 207 field should be set to the maximum number of
 208 characters that would fit in the buffer pointed to by
 209 .IR chardata .
 210 On return, the
 211 .I charcount
 212 and
 213 .I charheight
 214 are filled with
 215 the respective data for the currently loaded font, and the
 216 .I chardata
 217 array contains the font data if the initial value of
 218 .I charcount
 219 indicated enough space was available; otherwise the
 220 buffer is untouched and
 221 .I errno
 222 is set to
 223 .BR ENOMEM .
 224 (Since 1.3.1.)
 225 .TP
 226 .B PIO_FONT
 227 Sets 256-character screen font.
 228 Load font into the EGA/VGA character
 229 generator.
 230 .I argp
 231 points to a 8192 byte map, with 32 bytes per
 232 character.
 233 Only the first
 234 .I N
 235 of them are used for an 8x\fIN\fP font
 236 (0 <
 237 .I N
 238 <= 32).
 239 This call also invalidates the Unicode mapping.
 240 .TP
 241 .B PIO_FONTX
 242 Sets screen font and associated rendering information.
 243 .I argp
 244
 245 points to a
 246
 247 .in +4n
 248 .nf
 249 struct consolefontdesc {
 250     unsigned short charcount;  /* characters in font
 251                                   (256 or 512) */
 252     unsigned short charheight; /* scan lines per
 253                                   character (1-32) */
 254     char          *chardata;   /* font data in
 255                                   expanded form */
 256 };
 257 .fi
 258 .in
 259
 260 If necessary, the screen will be appropriately resized, and
 261 .B SIGWINCH
 262 sent to the appropriate processes.
 263 This call also invalidates the Unicode mapping.
 264 (Since 1.3.1.)
 265 .TP
 266 .B PIO_FONTRESET
 267 Resets the screen font, size and Unicode mapping to the bootup
 268 defaults.
 269 .I argp
 270 is unused, but should be set to NULL to
 271 ensure compatibility with future versions of Linux.
 272 (Since 1.3.28.)
 273 .TP
 274 .B GIO_SCRNMAP
 275 Get screen mapping from kernel.
 276 .I argp
 277 points to an area of size
 278 E_TABSZ, which is loaded with the font positions used to display each
 279 character.
 280 This call is likely to return useless information if the
 281 currently loaded font is more than 256 characters.
 282 .TP
 283 .B GIO_UNISCRNMAP
 284 Get full Unicode screen mapping from kernel.
 285 .I argp
 286 points to an
 287 area of size
 288 .IR "E_TABSZ*sizeof(unsigned short)" ,
 289 which is loaded with the
 290 Unicodes each character represent.
 291 A special set of Unicodes,
 292 starting at U+F000, are used to represent "direct to font" mappings.
 293 (Since 1.3.1.)
 294 .TP
 295 .B PIO_SCRNMAP
 296 Loads the "user definable" (fourth) table in the kernel which maps
 297 bytes into console screen symbols.
 298 .I argp
 299 points to an area of
 300 size E_TABSZ.
 301 .TP
 302 .B PIO_UNISCRNMAP
 303 Loads the "user definable" (fourth) table in the kernel which maps
 304 bytes into Unicodes, which are then translated into screen symbols
 305 according to the currently loaded Unicode-to-font map.
 306 Special Unicodes starting at U+F000 can be used to map directly to the font
 307 symbols.
 308 (Since 1.3.1.)
 309 .TP
 310 .B GIO_UNIMAP
 311 Get Unicode-to-font mapping from kernel.
 312 .I argp
 313 points to a
 314
 315 .in +4n
 316 .nf
 317 struct unimapdesc {
 318     unsigned short  entry_ct;
 319     struct unipair *entries;
 320 };
 321 .fi
 322 .in
 323
 324 where
 325 .I entries
 326 points to an array of
 327
 328 .in +4n
 329 .nf
 330 struct unipair {
 331     unsigned short unicode;
 332     unsigned short fontpos;
 333 };
 334 .fi
 335 .in
 336
 337 (Since 1.1.92.)
 338 .TP
 339 .B PIO_UNIMAP
 340 Put unicode-to-font mapping in kernel.
 341 .I argp
 342 points to a
 343 .IR "struct unimapdesc" .
 344 (Since 1.1.92)
 345 .TP
 346 .B PIO_UNIMAPCLR
 347 Clear table, possibly advise hash algorithm.
 348 .I argp
 349 points to a
 350
 351 .in +4n
 352 .nf
 353 struct unimapinit {
 354     unsigned short advised_hashsize;  /* 0 if no opinion */
 355     unsigned short advised_hashstep;  /* 0 if no opinion */
 356     unsigned short advised_hashlevel; /* 0 if no opinion */
 357 };
 358 .fi
 359 .in
 360
 361 (Since 1.1.92.)
 362 .TP
 363 .B KDGKBMODE
 364 Gets current keyboard mode.
 365 .I argp
 366 points to a
 367 .I long
 368 which is set to one
 369 of these:
 370
 371 .TS
 372 l l.
 373 K_RAW   0x00
 374 K_XLATE 0x01
 375 K_MEDIUMRAW     0x02
 376 K_UNICODE       0x03
 377 .TE
 378 .TP
 379 .B KDSKBMODE
 380 Sets current keyboard mode.
 381 .I argp
 382 is a
 383 .I long
 384 equal to one of the above values.
 385 .TP
 386 .B KDGKBMETA
 387 Gets meta key handling mode.
 388 .I argp
 389 points to a
 390 .I long
 391 which is
 392 set to one of these:
 393
 394 .TS
 395 l l l.
 396 K_METABIT       0x03    set high order bit
 397 K_ESCPREFIX     0x04    escape prefix
 398 .TE
 399 .TP
 400 .B KDSKBMETA
 401 Sets meta key handling mode.
 402 .I argp
 403 is a
 404 .I long
 405 equal to one of the above values.
 406 .TP
 407 .B KDGKBENT
 408 Gets one entry in key translation table (keycode to action code).
 409 .I argp
 410 points to a
 411
 412 .in +4n
 413 .nf
 414 struct kbentry {
 415     unsigned char  kb_table;
 416     unsigned char  kb_index;
 417     unsigned short kb_value;
 418 };
 419 .fi
 420 .in
 421
 422 with the first two members filled in:
 423 .I kb_table
 424 selects the key table (0 <=
 425 .I kb_table
 426 < MAX_NR_KEYMAPS),
 427 and
 428 .IR kb_index
 429 is the keycode (0 <=
 430 .I kb_index
 431 < NR_KEYS).
 432 .I kb_value
 433 is set to the corresponding action code,
 434 or K_HOLE if there is no such key,
 435 or K_NOSUCHMAP if
 436 .I kb_table
 437 is invalid.
 438 .TP
 439 .B KDSKBENT
 440 Sets one entry in translation table.
 441 .I argp
 442 points to a
 443 .IR "struct kbentry" .
 444 .TP
 445 .B KDGKBSENT
 446 Gets one function key string.
 447 .I argp
 448 points to a
 449
 450 .in +4n
 451 .nf
 452 struct kbsentry {
 453     unsigned char kb_func;
 454     unsigned char kb_string[512];
 455 };
 456 .fi
 457 .in
 458
 459 .I kb_string
 460 is set to the (null-terminated) string corresponding to
 461 the
 462 .IR kb_func th
 463 function key action code.
 464 .TP
 465 .B KDSKBSENT
 466 Sets one function key string entry.
 467 .I argp
 468 points to a
 469 .IR "struct kbsentry" .
 470 .TP
 471 .B KDGKBDIACR
 472 Read kernel accent table.
 473 .I argp
 474 points to a
 475
 476 .in +4n
 477 .nf
 478 struct kbdiacrs {
 479     unsigned int   kb_cnt;
 480     struct kbdiacr kbdiacr[256];
 481 };
 482 .fi
 483 .in
 484
 485 where
 486 .I kb_cnt
 487 is the number of entries in the array, each of which
 488 is a
 489
 490 .in +4n
 491 .nf
 492 struct kbdiacr {
 493     unsigned char diacr;
 494     unsigned char base;
 495     unsigned char result;
 496 };
 497 .fi
 498 .in
 499 .TP
 500 .B KDGETKEYCODE
 501 Read kernel keycode table entry (scan code to keycode).
 502 .I argp
 503 points to a
 504
 505 .in +4n
 506 .nf
 507 struct kbkeycode {
 508     unsigned int scancode;
 509     unsigned int keycode;
 510 };
 511 .fi
 512 .in
 513
 514 .I keycode
 515 is set to correspond to the given
 516 .IR scancode .
 517 (89 <=
 518 .I scancode
 519 <= 255 only.
 520 For 1 <=
 521 .I scancode
 522 <= 88,
 523 .IR keycode == scancode .)
 524 (Since 1.1.63.)
 525 .TP
 526 .B KDSETKEYCODE
 527 Write kernel keycode table entry.
 528 .I argp
 529 points to a
 530 .IR "struct kbkeycode" .
 531 (Since 1.1.63.)
 532 .TP
 533 .B KDSIGACCEPT
 534 The calling process indicates its willingness to accept the signal
 535 .I argp
 536 when it is generated by pressing an appropriate key combination.
 537 (1 <=
 538 .I argp
 539 <= NSIG).
 540 (See
 541 .IR spawn_console ()
 542 in
 543 .IR linux/drivers/char/keyboard.c .)
 544 .TP
 545 .B VT_OPENQRY
 546 Returns the first available (non-opened) console.
 547 .I argp
 548 points to an
 549 .I int
 550 which is set to the
 551 number of the vt (1 <=
 552 .I *argp
 553 <= MAX_NR_CONSOLES).
 554 .TP
 555 .B VT_GETMODE
 556 Get mode of active vt.
 557 .I argp
 558 points to a
 559
 560 .in +4n
 561 .nf
 562 struct vt_mode {
 563     char  mode;    /* vt mode */
 564     char  waitv;   /* if set, hang on writes if not active */
 565     short relsig;  /* signal to raise on release req */
 566     short acqsig;  /* signal to raise on acquisition */
 567     short frsig;   /* unused (set to 0) */
 568 };
 569 .fi
 570 .in
 571
 572 which is set to the mode of the active vt.
 573 .I mode
 574 is set to one of these values:
 575
 576 .TS
 577 l l.
 578 VT_AUTO auto vt switching
 579 VT_PROCESS      process controls switching
 580 VT_ACKACQ       acknowledge switch
 581 .TE
 582 .TP
 583 .B VT_SETMODE
 584 Set mode of active vt.
 585 .I argp
 586 points to a
 587 .IR "struct vt_mode" .
 588 .TP
 589 .B VT_GETSTATE
 590 Get global vt state info.
 591 .I argp
 592 points to a
 593
 594 .in +4n
 595 .nf
 596 struct vt_stat {
 597     unsigned short v_active;  /* active vt */
 598     unsigned short v_signal;  /* signal to send */
 599     unsigned short v_state;   /* vt bit mask */
 600 };
 601 .fi
 602 .in
 603
 604 For each vt in use, the corresponding bit in the
 605 .I v_state
 606 member is set.
 607 (Kernels 1.0 through 1.1.92.)
 608 .TP
 609 .B VT_RELDISP
 610 Release a display.
 611 .TP
 612 .B VT_ACTIVATE
 613 Switch to vt
 614 .IR argp
 615 (1 <=
 616 .I argp
 617 <= MAX_NR_CONSOLES).
 618 .TP
 619 .B VT_WAITACTIVE
 620 Wait until vt
 621 .I argp
 622 has been activated.
 623 .TP
 624 .B VT_DISALLOCATE
 625 Deallocate the memory associated with vt
 626 .IR argp .
 627 (Since 1.1.54.)
 628 .TP
 629 .B VT_RESIZE
 630 Set the kernel's idea of screensize.
 631 .I argp
 632 points to a
 633
 634 .in +4n
 635 .nf
 636 struct vt_sizes {
 637     unsigned short v_rows;       /* # rows */
 638     unsigned short v_cols;       /* # columns */
 639     unsigned short v_scrollsize; /* no longer used */
 640 };
 641 .fi
 642 .in
 643
 644 Note that this does not change the videomode.
 645 See
 646 .BR resizecons (8).
 647 (Since 1.1.54.)
 648 .TP
 649 .B VT_RESIZEX
 650 Set the kernel's idea of various screen parameters.
 651 .I argp
 652 points to a
 653
 654 .in +4n
 655 .nf
 656 struct vt_consize {
 657     unsigned short v_rows;  /* number of rows */
 658     unsigned short v_cols;  /* number of columns */
 659     unsigned short v_vlin;  /* number of pixel rows
 660                                on screen */
 661     unsigned short v_clin;  /* number of pixel rows
 662                                per character */
 663     unsigned short v_vcol;  /* number of pixel columns
 664                                on screen */
 665     unsigned short v_ccol;  /* number of pixel columns
 666                                per character */
 667 };
 668 .fi
 669 .in
 670
 671 Any parameter may be set to zero, indicating "no change", but if
 672 multiple parameters are set, they must be self-consistent.
 673 Note that this does not change the videomode.
 674 See
 675 .BR resizecons (8).
 676 (Since 1.3.3.)
 677 .PP
 678 The action of the following ioctls depends on the first byte in the struct
 679 pointed to by
 680 .IR argp ,
 681 referred to here as the
 682 .IR subcode .
 683 These are legal only for the superuser or the owner of the current terminal.
 684 .TP
 685 .B "TIOCLINUX, subcode=0"
 686 Dump the screen.
 687 Disappeared in 1.1.92.  (With kernel 1.1.92 or later, read from
 688 .I /dev/vcsN
 689 or
 690 .I /dev/vcsaN
 691 instead.)
 692 .TP
 693 .B "TIOCLINUX, subcode=1"
 694 Get task information.
 695 Disappeared in 1.1.92.
 696 .TP
 697 .B "TIOCLINUX, subcode=2"
 698 Set selection.
 699 .I argp
 700 points to a
 701 .in +4n
 702 .nf
 703
 704 struct {
 705    char  subcode;
 706    short xs, ys, xe, ye;
 707    short sel_mode;
 708 };
 709
 710 .fi
 711 .in
 712 .I xs
 713 and
 714 .I ys
 715 are the starting column and row.
 716 .I xe
 717 and
 718 .I ye
 719 are the ending
 720 column and row.
 721 (Upper left corner is row=column=1.)
 722 .I sel_mode
 723 is 0 for character-by-character selection,
 724 1 for word-by-word selection,
 725 or 2 for line-by-line selection.
 726 The indicated screen characters are highlighted and saved
 727 in the static array sel_buffer in
 728 .IR devices/char/console.c .
 729 .TP
 730 .B "TIOCLINUX, subcode=3"
 731 Paste selection.
 732 The characters in the selection buffer are
 733 written to
 734 .IR fd .
 735 .TP
 736 .B "TIOCLINUX, subcode=4"
 737 Unblank the screen.
 738 .TP
 739 .B "TIOCLINUX, subcode=5"
 740 Sets contents of a 256-bit look up table defining characters in a "word",
 741 for word-by-word selection.
 742 (Since 1.1.32.)
 743 .TP
 744 .B "TIOCLINUX, subcode=6"
 745 .I argp
 746 points to a char which is set to the value of the kernel
 747 variable
 748 .IR shift_state .
 749 (Since 1.1.32.)
 750 .TP
 751 .B "TIOCLINUX, subcode=7"
 752 .I argp
 753 points to a char which is set to the value of the kernel
 754 variable
 755 .IR report_mouse .
 756 (Since 1.1.33.)
 757 .TP
 758 .B "TIOCLINUX, subcode=8"
 759 Dump screen width and height, cursor position, and all the
 760 character-attribute pairs.
 761 (Kernels 1.1.67 through 1.1.91 only.
 762 With kernel 1.1.92 or later, read from
 763 .I /dev/vcsa*
 764 instead.)
 765 .TP
 766 .B "TIOCLINUX, subcode=9"
 767 Restore screen width and height, cursor position, and all the
 768 character-attribute pairs.
 769 (Kernels 1.1.67 through 1.1.91 only.
 770 With kernel 1.1.92 or later, write to
 771 .I /dev/vcsa*
 772 instead.)
 773 .TP
 774 .B "TIOCLINUX, subcode=10"
 775 Handles the Power Saving
 776 feature of the new generation of monitors.
 777 VESA screen blanking mode is set to
 778 .IR argp[1] ,
 779 which governs what
 780 screen blanking does:
 781 .RS
 782 .IP 0: 3
 783 Screen blanking is disabled.
 784 .IP 1:
 785 The current video adapter
 786 register settings are saved, then the controller is programmed to turn off
 787 the vertical synchronization pulses.
 788 This puts the monitor into "standby" mode.
 789 If your monitor has an Off_Mode timer, then
 790 it will eventually power down by itself.
 791 .IP 2:
 792 The current settings are saved, then both the vertical and horizontal
 793 synchronization pulses are turned off.
 794 This puts the monitor into "off" mode.
 795 If your monitor has no Off_Mode timer,
 796 or if you want your monitor to power down immediately when the
 797 blank_timer times out, then you choose this option.
 798 .RI ( Caution:
 799 Powering down frequently will damage the monitor.)
 800 (Since 1.1.76.)
 801 .RE
 802 .SH RETURN VALUE
 803 On success, 0 is returned.
 804 On error, \-1 is returned, and
 805 .I errno
 806 is set.
 807 .SH ERRORS
 808 .I errno
 809 may take on these values:
 810 .TP
 811 .B EBADF
 812 The file descriptor is invalid.
 813 .TP
 814 .B ENOTTY
 815 The file descriptor is not associated with a character special device,
 816 or the specified request does not apply to it.
 817 .TP
 818 .B EINVAL
 819 The file descriptor or
 820 .I argp
 821 is invalid.
 822 .TP
 823 .B EPERM
 824 Insufficient permission.
 825 .SH NOTES
 826 .BR Warning :
 827 Do not regard this man page as documentation of the Linux console ioctls.
 828 This is provided for the curious only, as an alternative to reading the
 829 source.
 830 Ioctl's are undocumented Linux internals, liable to be changed
 831 without warning.
 832 (And indeed, this page more or less describes the
 833 situation as of kernel version 1.1.94;
 834 there are many minor and not-so-minor
 835 differences with earlier versions.)
 836
 837 Very often, ioctls are introduced for communication between the
 838 kernel and one particular well-known program (fdisk, hdparm, setserial,
 839 tunelp, loadkeys, selection, setfont, etc.), and their behavior will be
 840 changed when required by this particular program.
 841
 842 Programs using these ioctls will not be portable to other versions
 843 of UNIX, will not work on older versions of Linux, and will not work
 844 on future versions of Linux.
 845
 846 Use POSIX functions.
 847 .SH SEE ALSO
 848 .BR dumpkeys (1),
 849 .BR kbd_mode (1),
 850 .BR loadkeys (1),
 851 .BR mknod (1),
 852 .BR setleds (1),
 853 .BR setmetamode (1),
 854 .BR execve (2),
 855 .BR fcntl (2),
 856 .BR ioperm (2),
 857 .BR termios (3),
 858 .BR console (4),
 859 .BR console_codes (4),
 860 .BR mt (4),
 861 .BR sd (4),
 862 .BR tty (4),
 863 .BR tty_ioctl (4),
 864 .BR ttyS (4),
 865 .BR vcs (4),
 866 .BR vcsa (4),
 867 .BR charsets (7),
 868 .BR mapscrn (8),
 869 .BR resizecons (8),
 870 .BR setfont (8)
 871
 872 .IR /usr/include/linux/kd.h ,
 873 .I /usr/include/linux/vt.h