ioctl_console(2)

NOME
ioctl_console - ioctls para terminais de console e consoles virtuais

DESCRIÇÃO
As seguintes requisições ioctl(2) específicas do Linux são suportadas para terminais de console e consoles virtuais. Cada uma requer um terceiro argumento, presumido aqui como sendo argp.

KDGETLED
    Obtém os estados dos LEDs. argp aponta para um char. Os três menores bits de *argp são definidos com o estado dos LEDs, como segue:
    LED_CAP | 0x04 | led do caps lock
    LED_NUM | 0x02 | led do num lock
    LED_SCR | 0x01 | led do scroll lock

KDSETLED
    Define os LEDs. Os LEDs são definidos para corresponderem aos três menores bits do inteiro long unsigned de argp. De outra forma, se um bit de ordem maior é definido, os LEDs são revertidos para o estado normal: mostrando o estado das funções do teclado de caps lock, num lock e scroll lock.

Antes do Linux 1.1.54, os LEDs apenas refletiam o estado do correspondente do sinalizador do teclado, e KDGETLED/KDSETLED além disso alteraria o sinalizador do teclado. Desde o Linux 1.1.54 os LEDs podem ser usados para exibir informações arbitrárias, mas por padrão elas mostram o sinalizador de teclado. As duas seguintes ioctls são usadas para acessar o sinalizador de teclado.

KDGKBLED
    Obtém o sinalizador de teclado CapsLock, NumLock, ScrollLock (sem luzes). argp aponta para um caractere no qual é definido com o estado do sinalizador. Os três bits de menor ordem (máscara 0x7) recebem o estado atual do sinalizador, e os bits de menor ordem nos próximos quatro bits (máscara 0x70) obtém o estado padrão do sinalizador. (Desde o Linux 1.1.54.)

KDSKBLED
    Define os sinalizadores de teclado CapsLock, NumLock, ScrollLock (sem luzes). argp é um inteiro longo sem sinal que tem o estado do sinalizador desejado. Os três bits de menor ordem (máscara 0x7) tem o estado do sinalizador, e os bits de menor ordem nos próximos 4 bits (máscara 0x70) tem o estado padrão do sinalizador. (Desde o Linux 1.1.54.)

KDGKBTYPE
    Obtém o tipo de teclado. Este retorna o valor KB_101, definido como 0x02.

KDADDIO
    Adiciona uma porta de E/S como válida. Equivalente a ioperm(arg,1,1).

KDDELIO
    Remove uma porta de E/S como válida. Equivalente a ioperm(arg,1,0).

KDENABIO
    Habilita a E/S para a placa de vídeo. Equivalente a ioperm(0x3b4, 0x3df-0x3b4+1, 1).

KDDISABIO
    Desabilita a E/S para a placa de vídeo. Equivalente a ioperm(0x3b4, 0x3df-0x3b4+1, 0).

KDSETMODE
    Define o modo texto/gráfico. argp é um inteiro sem sinal contendo um destes:
    KD_TEXT | 0x00
    KD_GRAPHICS | 0x01

KDGETMODE
    Obtém o modo texto/gráfico. argp aponta para um int o qual é definido para um dos valores acima para KDSETMODE.

KDMKTONE
    Gera um som de comprimento especificado. Os 16 bits de inteiro longo sem sinal em argp especificam o período em ciclos de relógio, e os 16 bits mais altos entregam a duração em milissegundos. Se a duração é zero, o som é desligado. O controle retorna imediatamente. Por exemplo, argp = (125<<16) + 0x637 especificaria o bipe normalmente associado com Ctrl-G. (Portanto, desde o Linux 0.99pl1; interrompido no Linux 2.1.49-50.)

KIOCSOUND
    Inicia ou termina a geração do som. O 16 bits mais baixos de argp especificam o período em ciclos de relógio (que é, argp = 1193180/frequência). argp = 0 desliga o som. Em ambos os casos, o controle retorna imediatamente.

GIO_CMAP
    Obtém o atual mapa de cores padrão a partir do kernel. argp aponta para um vetor de 48 bytes. (Desde o Linux 1.3.3.)

PIO_CMAP
    Altera o mapa de cores padrão no modo texto. argp aponta para um vetor de 48 bytes o qual contém, em ordem, os valores Vermelho, Verde, e Azul para as 16 cores disponíveis da tela: 0 é desligado, e 255 é intensidade máxima. As cores padrão são, em ordem: preto, vermelho escuro, verde escuro, marrom, azul escuro, violeta escuro, ciano escuro, cinza claro, cinza escuro, vermelho brilhante, verde brilhante, amarelo, azul brilhante, violeta brilhante, ciano brilhante e branco. (Desde o Linux 1.3.3.)

GIO_FONT
    Obtém os 256 caracteres da fonte da tela em forma expandida. argp aponta para um vetor de 8192 bytes. Falha com código de erro EINVAL se a fonte atualmente carregado é uma fonte de 512 caracteres, ou se o console não está em modo texto.

GIO_FONTX
    Obtém a fonte da tela e informações associadas. argp aponta para um struct consolefontdesc (consulte PIO_FONTX). Na chamada, o campo charcount deve ser definido para o número máximo de caracteres que caberia no buffer apontado por chardata. No retorno, o charcount e charheight são preenchidos com os respectivos dados para a fonte atualmente carregada, e o vetor chardata contém o dados da fonte se o valor inicial de charcount indicava espaço suficiente disponível; caso contrário, o buffer fica intocado e errno é definido com ENOMEM. (Desde o Linux 1.3.1.)

PIO_FONT
    Define uma fonte da tela de 256 caracteres. Carrega a fonte dentro do gerador de caracteres EGA/VGA. argp aponta para um mapa de bits de 8192, com 32 bytes por caractere. Somente o primeiro N deles são usados para uma fonte 8xN (0 < N <= 32). Esta chamada também elimina o mapeamento Unicode.

PIO_FONTX
    Define a fonte da tela e associa informações de desenho. argp aponta para um

        struct consolefontdesc {
            unsigned short charcount;  /* caracteres na fonte
                                          (256 ou 512) */
            unsigned short charheight; /* linhas rastreadas
                                          por caracteres (1-32) */
            char          *chardata;   /* dados da fonte em
                                          forma expandida */
        };

    Se necessário a tela será apropriadamente redimensionada, e SIGWINCH enviada para o processo apropriado. Esta chamada também elimina o mapeamento Unicode. (Desde o Linux 1.3.1.)

PIO_FONTRESET
    Redefine o fonte da tela, tamanho e mapeamento Unicode para a inicialização padrão. argp não é usado, mas seria definido para NULL para assegurar compatibilidade com futuras versões do Linux. (Desde o Linux 1.3.28.)

GIO_SCRNMAP
    Obtém o mapeamento da tela a partir do kernel. argp aponta para uma área de tamanho E_TABSZ, o qual é carregado com a posicionamento da fonte usada para exibir cada caractere. Esta chamada é provavelmente para retornar informações imprestáveis se a fonte atualmente carregada é maior que 256 caracteres.

GIO_UNISCRNMAP
    Obtém o mapeamento completo Unicode da tela a partir do kernel. argp aponta para uma área de tamanho E_TABSZ*sizeof(unsigned short), o qual é carregado com a representação Unicode de cada caractere. Um conjunto especial de Unicode, começando em U+F000, é usado para representar o mapeamento "direto para a fonte". (Desde o Linux 1.3.1.)

PIO_SCRNMAP
    Carrega a (quarta) tabela "definível pelo usuário" no kernel o qual mapeia bytes dentro dos símbolos da tela da console. argp aponta para uma área de tamanho E_TABSZ.

PIO_UNISCRNMAP
    Carrega a (quarta) tabela “definível pelo usuário” no kernel a qual mapeia bytes dentro dos Unicodes, o qual são então traduzidos em símbolos da tela de acordo com o mapa atualmente carregado de Unicode para fonte. Unicodes especiais iniciam em U+F000 e podem ser usados para mapear diretamente para os símbolos da fonte. (Desde o Linux 1.3.1.)

GIO_UNIMAP
    Obtém o mapeamento Unicode para fonte a partir do kernel. argp aponta para uma

        struct unimapdesc {
            unsigned short  entry_ct;
            struct unipair *entries;
        };

    onde entries aponta para um vetor de

        struct unipair {
            unsigned short unicode;
            unsigned short fontpos;
        };

    (Desde o Linux 1.1.92.)

PIO_UNIMAP
    Coloca o mapeamento Unicode para fonte no kernel. argp aponta para uma struct unimapdesc. (Desde o Linux 1.1.92)

PIO_UNIMAPCLR
    Limpa a tabela, possivelmente aconselha um algoritmo de hash. argp aponta para uma

        struct unimapinit {
            unsigned short advised_hashsize;  /* 0 se não tem opinião */
            unsigned short advised_hashstep;  /* 0 se não tem opinião */
            unsigned short advised_hashlevel; /* 0 se não tem opinião */
        };

    (Desde o Linux 1.1.92.)

KDGKBMODE
    Obtém o modo atual do teclado. argp aponta para um long o qual é definido para um destes:
    K_RAW | 0x00 /* Modo bruto (scancode) */
    K_XLATE | 0x01 /* Traduz códigos de tecla usando mapa de teclado */
    K_MEDIUMRAW | 0x02 /* Modo bruto médio (scancode) */
    K_UNICODE | 0x03 /* Modo Unicode */
    K_OFF | 0x04 /* Modo desabilitado; desde o Linux 2.6.39 */

KDSKBMODE
    Define o modo atual do teclado. argp é um long igual a um dos valores mostrados para KDGKBMODE.

KDGKBMETA
    Obtém o modo de manipulação da tecla meta. argp aponta para um long o qual é define para um destes:
    K_METABIT | 0x03 | define bit de alta ordem
    K_ESCPREFIX | 0x04 | prefixo de escape

KDSKBMETA
    Define o modo de manipulação da tecla meta. argp é um long igual a um dos valores mostras acima para KDGKBMETA.

KDGKBENT
    Obtém uma entrada na tabela de translação da tecla (código de tecla para código de ação). argp aponta para uma

        struct kbentry {
            unsigned char  kb_table;
            unsigned char  kb_index;
            unsigned short kb_value;
        };

    com o primeiro dos dos membros preenchido em: kb_table seleciona a tabela de tecla (0 <= kb_table < MAX_NR_KEYMAPS), e kb_index é o código de tecla (0 <= kb_index < NR_KEYS). kb_value é define para o código de ação correspondente, ou K_HOLE se não existe tal tecla, ou K_NOSUCHMAP se kb_table é invalido.

KDSKBENT
    Define uma entrada na tabela de tradução. argp aponta para uma struct kbentry.

KDGKBSENT
    Obtém uma string tecla de função. argp aponta para uma

        struct kbsentry {
            unsigned char kb_func;
            unsigned char kb_string[512];
        };

    kb_string é definida para a string (com terminação NULA) correspondente ao código de ação da kb_func-ésima tecla de função.

KDSKBSENT
    Define a entrada de string para uma tecla de função. argp aponta para uma struct kbsentry.

KDGKBDIACR
    Lê a tabela de acentuação do kernel. argp aponta para uma

        struct kbdiacrs {
            unsigned int   kb_cnt;
            struct kbdiacr kbdiacr[256];
        };

    onde kb_cnt é o número de entradas no vetor, cada qual é uma

        struct kbdiacr {
            unsigned char diacr;
            unsigned char base;
            unsigned char result;
        };

KDGETKEYCODE
    Lê a tabela de entrada código de tecla do kernel (código de varredura para código de tecla). argp aponta para uma

        struct kbkeycode {
            unsigned int scancode;
            unsigned int keycode;
        };

    O código de tecla keycode é definido para corresponder ao código de varredura scancode fornecido. (89 <= scancode <= 255 somente. Para 1 <= scancode <= 88, keycode==scancode.) (Desde o Linux 1.1.63.)

KDSETKEYCODE
    Escreve no kernel a entrada da tabela de códigos de tecla. argp aponta para uma estrutura kbkeycode. (Desde o Linux 1.1.63.)

KDSIGACCEPT
    O processo chamante indicado dele concordância para aceita o sinal argp quando ele é gerado pelo pressionamento de uma combinação de teclas apropriadas. (1 <= argp <= NSIG). (Veja spawn_console() em linux/drivers/char/keyboard.c.)

VT_OPENQRY
    Retorna o primeiro console disponível (fechado). argp aponta para um int o qual é definido com um número de vt (1 <= *argp <= MAX_NR_CONSOLES).

VT_GETMODE
    Obtém o modo de ativação do vt. argp aponta para uma

        struct vt_mode {
            char  mode;    /* modo vt */
            char  waitv;   /* se definida, trava em escritas se não está ativo */
            short relsig;  /* sinal para aumentar na liberação da requisição */
            short acqsig;  /* sinal para aumentar na aquisição */
            short frsig;   /* sem uso (definido para 0) */
        };

    que é definido para o modo do vt ativo. mode é definido para um destes valores:
    VT_AUTO | troca automática de vt
    VT_PROCESS | troca de controles de processo
    VT_ACKACQ | reconhece a troca

VT_SETMODE
    Define o modo de ativação do vt. argp aponta para uma struct vt_mode.

VT_GETSTATE
    Obtém a informação global do estado de vt. argp aponta para uma

        struct vt_stat {
            unsigned short v_active;  /* vt ativo */
            unsigned short v_signal;  /* sinal para enviar */
            unsigned short v_state;   /* máscara de bits do vt */
        };

    For each vt in use, the corresponding bit in the v_state member is set. (Linux 1.0 through Linux 1.1.92.)

VT_RELDISP
    Libera um monitor.

VT_ACTIVATE
    Troca para o vt argp (1 <= argp <= MAX_NR_CONSOLES).

VT_WAITACTIVE
    Aguarda até o vt argp ser ativado.

VT_DISALLOCATE
    Desaloca a memória associada com o vt argp. (Desde o Linux 1.1.54.)

VT_RESIZE
    Definido o tamanho ideal da tela do kernel. argp aponta para um

        struct vt_sizes {
            unsigned short v_rows;       /* # linhas */
            unsigned short v_cols;       /* # colunas */
            unsigned short v_scrollsize; /* não usado mais */
        };

    Note que isto não é alterado para o modo de vídeo. Veja resizecons(8). (Desde o Linux1.1.54.)

VT_RESIZEX
    Define os vários parâmetros ideais da tela do kernel. argp aponta para um

        struct vt_consize {
            unsigned short v_rows;  /* número de linhas */
            unsigned short v_cols;  /* número de colunas */
            unsigned short v_vlin;  /* número de linhas de pixel
                                       na tela */
            unsigned short v_clin;  /* número de linhas de pixel
                                       por caractere */
            unsigned short v_vcol;  /* número de colunas de pixel
                                       na tela */
            unsigned short v_ccol;  /* número de colunas de pixel
                                       por caractere */
        };

    Qualquer parâmetro pode ser definido para zero, indicando "nenhuma alteração", mas se vários parâmetros são alterados, eles devem ser consistentes. Note que isto não mudou o modo de video. Veja resizecons(8). (Desde o Linux 1.3.3.)

The action of the following ioctls depends on the first byte in the struct pointed to by argp, referred to here as the subcode. These are legal only for the superuser or the owner of the current terminal. Symbolic subcodes are available in <linux/tiocl.h> since Linux 2.5.71.

TIOCLINUX, subcode=0
    Dump the screen. Disappeared in Linux 1.1.92. (With Linux 1.1.92 or later, read from /dev/vcsN or /dev/vcsaN instead.)

TIOCLINUX, subcode=1
    Obtém a informação da tarefa. Desapareceu no Linux 1.1.92.

TIOCLINUX, subcode=TIOCL_SETSEL
    Define a seleção. argp aponta para uma

        struct {
            char  subcode;
            short xs, ys, xe, ye;
            short sel_mode;
        };

    xs and ys are the starting column and row. xe and ye are the ending column and row. (Upper left corner is row=column=1.) sel_mode is 0 for character-by-character selection, 1 for word-by-word selection, or 2 for line-by-line selection. The indicated screen characters are highlighted and saved in a kernel buffer.

    Since Linux 6.7, using this subcode requires the CAP_SYS_ADMIN capability.

TIOCLINUX, subcode=TIOCL_PASTESEL
    Cola a seleção. Os caracteres no buffer de seleção são escritos para fd.

    Since Linux 6.7, using this subcode requires the CAP_SYS_ADMIN capability.

TIOCLINUX, subcode=TIOCL_UNBLANKSCREEN
    Tela não vazia.

TIOCLINUX, subcode=TIOCL_SELLOADLUT
    Define o conteúdo de uma tabela de visualização de caracteres de 256 bits definida em uma "palavra", para seleção palavra por palavra. (Desde o Linux 1.1.32.)

    Since Linux 6.7, using this subcode requires the CAP_SYS_ADMIN capability.

TIOCLINUX, subcode=TIOCL_GETSHIFTSTATE
    argp aponta para um caractere, o qual é define com o valor da variável do kernel shift_state. (Desde o Linux 1.1.32.)

TIOCLINUX, subcode=TIOCL_GETMOUSEREPORTING
    argp aponta para um caractere o qual é definido para o valor da variável do kernel report_mouse. (Desde o Linux 1.1.33.)

TIOCLINUX, subcode=8
    Dump screen width and height, cursor position, and all the character-attribute pairs. (Linux 1.1.67 through Linux 1.1.91 only. With Linux 1.1.92 or later, read from /dev/vcsa* instead.)

TIOCLINUX, subcode=9
    Restore screen width and height, cursor position, and all the character-attribute pairs. (Linux 1.1.67 through Linux 1.1.91 only. With Linux 1.1.92 or later, write to /dev/vcsa* instead.)

TIOCLINUX, subcode=TIOCL_SETVESABLANK
    Manipula a característica de economia de energia da nova geração de monitores. O modo de esvaziamento de tela VESA é definido para argp[1], o qual gerencia o que esvaziamento de tela fará:

    0   Esvaziamento de tela é desabilitado.

    1   As configurações de registro do atual adaptador de vídeo são guardadas, então o controlador é programado para desligar os pulsos de sincronização vertical. Isto coloca o monitor em modo "standby". Se o monitor tiver um temporizador Off_Mode, então ele irá eventualmente desligar a si próprio.

    2   As configurações atuais são guardadas, então ambos os pulsos de sincronização vertical e horizontal são desligados. Isto coloca o monitor em modo "off". Se o monitor tem um temporizador Off_Mode, ou se você deseja que seu monitor desligue imediadamente quando o tempo de blank_timer termina, então escolha esta opção. (Cuidado: Desligar o monitor com frequência irá danificar o monitor.) (Desde o Linux 1.1.76.)

TIOCLINUX, subcode=TIOCL_SETKMSGREDIRECT
    Change target of kernel messages ("console"): by default, and if this is set to 0, messages are written to the currently active VT. The VT to write to is a single byte following subcode. (Since Linux 2.5.36.)

TIOCLINUX, subcode=TIOCL_GETFGCONSOLE
    Returns the number of VT currently in foreground. (Since Linux 2.5.36.)

TIOCLINUX, subcode=TIOCL_SCROLLCONSOLE
    Scroll the foreground VT by the specified amount of lines down, or half the screen if 0. lines is *(((int32_t *)&subcode) + 1). (Since Linux 2.5.67.)

TIOCLINUX, subcode=TIOCL_BLANKSCREEN
    Blank the foreground VT, ignoring "pokes" (typing): can only be unblanked explicitly (by switching VTs, to text mode, etc.). (Since Linux 2.5.71.)

TIOCLINUX, subcode=TIOCL_BLANKEDSCREEN
    Returns the number of VT currently blanked, 0 if none. (Since Linux 2.5.71.)

TIOCLINUX, subcode=16
    Never used.

TIOCLINUX, subcode=TIOCL_GETKMSGREDIRECT
    Returns target of kernel messages. (Since Linux 2.6.17.)

VALOR DE RETORNO
On success, 0 is returned (except where indicated). On failure, -1 is returned, and errno is set to indicate the error.

ERROS

EBADF
    O descritor de arquivo é inválido.

EINVAL
    O descritor de arquivo ou argp é invalido.

ENOTTY
    Um descritor de arquivo não está associado com um dispositivo especial de caractere, ou a requisição especificada não se aplica a ele.

EPERM
    Permissão insuficiente.

NOTAS
Aviso: Não considere esta página man como documentação das chamadas de console ioctls do Linux. Isto é fornecido para curiosos somente, com uma alternativa a estudar o código-fonte. Ioctls são chamadas não documentadas do Linux, propensas a serem alteradas sem nenhum aviso. (E, de fato, esta página descreve mais ou menos a situação da versão do kernel 1.1.94; há muitas diferenças pequenas e não tão pequenas com as versão mais recentes.)

Muito frequentemente, ioctls são introduzidos para comunicação ente o kernel e um programa particular bem conhecido, (fdisk, hdparm, setserial, tunelp, loadkeys, selection, setfont etc.), e o comportamento deles será alterado quando requerido por este programa particular.

Programas usando estas ioctls podem não ser portáveis para outras versões de UNIX, podem não trabalhar em versões antigas do Linux, e podem não trabalhar nas futuras versões do Linux.

Usa as funções POSIX.

VEJA TAMBÉM
dumpkeys(1), kbd_mode(1), loadkeys(1), mknod(1), setleds(1), setmetamode(1), execve(2), fcntl(2), ioctl_tty(2), ioperm(2), termios(3), console_codes(4), mt(4), sd(4), tty(4), ttyS(4), vcs(4), vcsa(4), charsets(7), mapscrn(8), resizecons(8), setfont(8)

/usr/include/linux/kd.h, /usr/include/linux/vt.h

TRADUÇÃO
A tradução para português brasileiro desta página man foi criada por André Luiz Fassone <lonely_wolf@ig.com.br>, Carlos Augusto Horylka <horylka@conectiva.com.br> e Rafael Fontenelle <rafaelff@gnome.org>.

Esta tradução é uma documentação livre; leia a Licença Pública Geral GNU Versão 3 (https://www.gnu.org/licenses/gpl-3.0.html) ou posterior para as condições de direitos autorais. Nenhuma responsabilidade é aceita.

Se você encontrar algum erro na tradução desta página de manual, envie um e-mail para a lista de discussão de tradutores (debian-l10n-portuguese@lists.debian.org).