1 .\" Copyright (c) 1995 Jim Van Zandt <jrv@vanzandt.mv.com> and aeb
2 .\" Sun Feb 26 11:46:23 MET 1995
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.
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.
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.
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/>.
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)
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)
40 .\"*******************************************************************
42 .\" This file was generated with po4a. Translate the source file.
44 .\"*******************************************************************
46 .\" Japanese Version Copyright (c) 1996,1997 TAKAHASHI Mutsuji
47 .\" 1998 ISHIKAWA Mutsumi
48 .\" all rights reserved.
49 .\" Translated Sun Jan 11 03:24:14 JST 1998
50 .\" by TAKAHASHI Mutsuji <muz@ilp.iijnet.or.jp>
51 .\" and ISHIKAWA Mutsumi <ishikawa@linux.or.jp>
52 .\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
53 .\" Updated 2013-07-22, Akihiro MOTOKI <amotoki@gmail.com>
54 .\" Updated 2013-07-31, Akihiro MOTOKI <amotoki@gmail.com>
55 .\" Updated 2013-08-16, Akihiro MOTOKI <amotoki@gmail.com>
57 .TH CONSOLE_IOCTL 4 2009\-02\-28 Linux "Linux Programmer's Manual"
59 console_ioctl \- コンソール端末と仮想コンソールの ioctl
61 次のような Linux 固有の \fBioctl\fP(2) がサポートされている。 それぞれ3番目の引数が必要である、ここでは \fIargp\fP とする。
64 LED の状態を取得する。 \fIargp\fP は \fIchar\fP のポインターである。 \fI*argp\fP の下位 3 ビットに以下のように LED
68 LED_CAP 0x04 キャピタルロック LED 点灯
69 LEC_NUM 0x02 ナンバーロック LED 点灯
70 LED_SCR 0x01 スクロールロック LED 点灯
74 LEDを点灯させる。LEDは \fIargp\fP の下位 3 ビットに従い点灯される。 しかし、より高位のビットがセットされている時には、キャピタルロック、
75 ナンバーロック、スクロールロックのキーボード機能の状態を表示する LED は 通常状態に戻る。
77 カーネル 1.1.54 以前は、LED はそれぞれのキーボードフラグの状態を反映するだけで、KDGETLED/KDSETLED
78 もキーボードフラグを変更するだけであった。 カーネル 1.1.54 からは LED に任意の表示をすることができるようになったが、
79 デフォルトではキーボードフラグを表示する。 次に示す 2 つの ioctl はキーボードフラグにアクセスするのに用いられる。
82 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示では なく)キーボードフラグを得る。 \fIargp\fP
83 はフラグの状態がセットされる文字変数を指す。 (0x7)でマスクして得られる下位 3 ビットが現在のフラグの状態を示し、
84 (0x70)でマスクして得られる次の 3 ビットがデフォルトのフラグの状態を 示す。(カーネル 1.1.54以降)
87 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示ではなく) キーボードフラグをセットする。 \fIargp\fP
88 がセットしたいフラグである。 (0x7)でマスクして得られる下位 3 ビットがフラグの状態で、(0x70)でマスクして 得られる次の 3
89 ビットがデフォルトのフラグの状態である。(カーネル 1.1.54以降)
92 キーボードの種類を得る。これは値 0x02 と定義されている KB_101を返す。
95 I/Oポートを有効な物として加える。これは \fIioperm(arg,1,1)\fP と等価である。
98 I/Oポートを有効な物から外す。これは \fIioperm(arg,1,0)\fP と等価である。
101 ビデオボードへの I/O を可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 1)\fP と等価である。
104 ビデオボードへの I/O を不可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 0)\fP と等価である。
107 テキスト/グラフィクスモードを設定する。 \fIargp\fP は次のうちのどれか:
116 テキスト/グラフィクスモードを取得する。 \fIargp\fP が指す \fIlong\fP 型変数に 上述の値のどちらかがセットされる。
119 指定された長さのトーンを発生する。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位にして周期を指定し、 上位 16 ビットが msec
120 の単位で表した、(トーンを発生させる)時間を指定する。 トーンを発生させる時間がゼロのときは、サウンドはオフになる。 制御は直ちに戻る。
121 例えば、\fIargp\fP = (125<<16) + 0x637 とすれば、通常 ctrl\-G を押した時に 発生する音になる。
122 (カーネル 0.99pl1 以降;この機能は カーネル 2.1.49 から 2.1.50 ではバグのため動作しない)
125 音の発生の開始や停止を行う。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位として周期を示す。 (つまり \fIargp\fP =
126 1193180/周波数)。 \fIargp\fP = 0 の場合、サウンドはオフになる。 どちらの場合でも、ただちに制御は戻る。
129 現在のデフォルトのカラーマップをカーネルより取得する。
132 デフォルトのテキストモードのカラーマップを変更する。 \fIargp\fP が指す 48 バイトの配列中には、16 の可能なスクリーンの色を、
133 赤、緑、青の順に 0 をオフ、255を最大強度とした値として納める。 デフォルトの色は順に、黒、濃い赤、濃い緑、茶、濃い青、濃い紫、濃いシアン、
134 明るい灰色、濃い灰色、明るい赤、明るい緑、黄、明るい青、明るい紫、 明るいシアン、白である。(カーネル 1.3.3以降)
137 拡張された形式で 256 文字のスクリーンフォントを得る。 \fIargp\fP は 8192 バイトの配列を指す。 現在ロードされているフォントが 512
138 文字のフォントであるか、コンソールが テキストモードでない時には失敗し \fBEINVAL\fP のエラーコードを返す。
141 スクリーンフォントとそれに関連した情報を取得する。 \fIargp\fP は構造体 consolefontdesc (\fBPIO_FONTX\fP
142 を参照のこと)を指す。 関数呼び出しのときには、\fIcharcount\fP には、\fIchardata\fP が指す
143 バッファにおさまる最大の文字数をセットしなければならない。 関数呼び出しから戻った時には \fIcharcount\fP と \fIcharheight\fP
144 には、 現在ロードされているフォントの該当するデータが収められている。 配列 \fIchardata\fP には、最初に \fIcharcount\fP
145 にいれた値によって フォントを収めるのに十分なスペースがあるとわかればフォントデータが収められる。 そうでない時には、バッファは変更されず、
146 \fIerrno\fP に \fBENOMEM\fP が セットされる(カーネル 1.3.1 以降)。
149 256 文字のフォントをセットする。EGA/VGA キャラクタージェネレーター (character generator) にフォントをロードする。
150 \fIargp\fP は、8192 バイト(一文字 32 バイト)のマップを指す。 マップのうち、最初の \fIN\fP のみが 8x\fIN\fP のフォントのために
151 用いられる(0 < \fIN\fP <= 32)。 この呼び出しをすると Unicode のマッピングが無効になる。
154 スクリーンフォントと、それに関連するレンダリング情報をセットする。 \fIargp\fP は、以下の構造体を指す。
160 struct consolefontdesc {
161 unsigned short charcount; /* フォントの文字数
163 unsigned short charheight; /* 一文字の走査線の数
165 char *chardata; /* 展開されたフォントデータ */
170 必要ならスクリーンは適当にサイズ変更され、\fBSIGWINCH\fP が適切な プロセスに送られる。 このコールにより Unicode
174 スクリーンフォント、サイズ、 Unicode マッピングをブート時のデフォルト値に リセットする。\fIargp\fP は用いられないが、将来のバージョンの
175 Linux との互換性を保つために NULL にセットすべきである。
178 スクリーンマッピングをカーネルより取得する。\fIargp\fP はサイズ E_TABSZ の
179 領域を指す。その領域には各キャラクターを表示するのに用いられるフォントの 位置がロードされている。 この呼び出しは現在ロードされているフォントが 256
180 文字よりも多い時には 無意味な情報を返す事が多い。
183 フル Unicode スクリーンマッピングをカーネルより取得する。 \fIargp\fP はサイズ \fIE_TABSZ*sizeof(unsigned
184 short)\fP の領域を指す。 その領域には各キャラクターを示す Unicode がロードされている。 U+F000 に始まる Unicode
185 の特別な集合は、「フォント直接な (direct to font)」 マッピングを示すのに用いられる (カーネル 1.3.1 以降)。
188 「ユーザー定義可能な(user definable)」(4番目の)テーブルをカーネルに
189 ロードする。そのテーブルは各バイトをスクリーンシンボルにマッピングする。 \fIargp\fP はサイズE_TABSZの領域を指す。
192 「ユーザー定義可能な」(4番目の)テーブルをカーネルにロードする。 そのテーブルは各バイトをユニコードにマッピングし、その後、
193 現在ロードされているユニコードからフォントへのマップに従い スクリーンシンボルに変換される。 U+F000
194 に始まるユニコードは直接フォントシンボルにマッピングするのに 使える(カーネル 1.3.1 以降)
197 Unicode からフォントへのマッピングをカーネルから取得する。 \fIargp\fP は、
202 unsigned short entry_ct;
203 struct unipair *entries;
208 という構造体を指す。 ここで \fIentries\fP は以下の構造体の配列へのポインターである。
213 unsigned short unicode;
214 unsigned short fontpos;
222 Unicode からフォントへのマッピングをカーネルにセットする。 \fIargp\fP は構造体 \fIstruct unimapdesc\fP
223 へのポインターである。 (カーネル 1.1.92 以降)
226 テーブルをクリアし、その事をハシュアルゴリズムに伝える。 \fIargp\fPは
231 unsigned short advised_hashsize; /* 0 if no opinion */
232 unsigned short advised_hashstep; /* 0 if no opinion */
233 unsigned short advised_hashlevel; /* 0 if no opinion */
241 現在のキーボードモードを取得する。\fIargp\fP の指す \fIlong\fP 型変数が、 次のうちのどれかに設定される。
252 現在のキーボードモードを設定する。 \fIargp\fP は上記の値のうちのどれかに等しい \fIlong\fP にする。
255 メタキーハンドリングモード(meta key handling mode)を取得する。 \fIargp\fP が指す \fIlong\fP
260 K_METABIT 0x03 上位ビットをセット
261 K_ESCPREFIX 0x04 エスケーププレフィックス
265 メタキーハンドリングモードを設定する。 \fIargp\fP は上記の値のどれかに等しい \fIlong\fP にする。
268 キーコードをアクションコードに変換するキー変換表のエントリーの一つを 取得する。 \fIargp\fP は、
273 unsigned char kb_table;
274 unsigned char kb_index;
275 unsigned short kb_value;
280 へのポインターである。 最初の2つの要素、\fIkb_table\fP には選択するキーテーブル (0 <= \fIkb_table\fP <
281 MAX_NR_KEYMAPS)、\fIkb_index\fP にはキーコード(0 <= \fIkb_index\fP <
282 NR_KEYS)を設定する。 \fIkb_value\fP は対応するアクションコード、または、そのようなキーが ないときには
283 K_HOLE、\fIkb_table\fP が無効な時には K_NOSUCHMAP に設定される。
286 変換テーブルのエントリーの一つを設定する。\fIargp\fP は 構造体 \fIstruct kbentry\fP へのポインターである。
289 ファンクションキーの文字列を取得する。\fIargp\fP は 以下の構造体へのポインターである。
294 unsigned char kb_func;
295 unsigned char kb_string[512];
300 \fIkb_func\fP 番目のファンクションキーのアクションコードに対応する (NULL で終端された) 文字列が \fIkb_string\fP
304 ファンクションキーの文字列のエントリーを設定する。\fIargp\fP は、 構造体 \fIstruct kbsentry\fP へのポインターである。
307 カーネルのアクセントテーブル(accent table)を読み込む。\fIargp\fPは、 次の構造体へのポインターである。
313 struct kbdiacr kbdiacr[256];
318 ここで、\fIkb_cnt\fP は配列中のエントリーの個数で、個々のエントリーは 以下の構造体である。
325 unsigned char result;
331 カーネルの(スキャンコードからキーコードへ 変換する)キーコードテーブルエントリーを読み込む。 \fIargp\fP は、
336 unsigned int scancode;
337 unsigned int keycode;
342 へのポインターである。 \fIkeycode\fP は、\fIscancode\fP に対応した値に設定される。(ただし、89 <= \fIscancode\fP
343 <= 255 のみについて。1 <= \fIscancode\fP <= 88 では \fIkeycode\fP ==
344 \fIscancode\fP である。) (カーネル 1.1.63 以降)
347 カーネルのキーコードテーブルエントリーを書き込む。\fIargp\fP は構造体 \fIstruct kbkeycode\fP へのポインターである。 (カーネル
351 この関数呼び出しは、特別な組合せでキーを押した時に発生するシグナル \fIargp\fP (1 <= \fIargp\fP <= NSIG)
352 を進んで受け付けるかどうかを示す。 (\fIlinux/drivers/char/keyboard.c\fP の \fIspawn_console\fP()
356 最初の空いている(まだオープンされていない)コンソールを返す。 \fIargp\fP の指す \fIint\fP 型の整数には、vt の番号がセットされる (1
357 <= \fI*argp\fP <= MAX_NR_CONSOLES)。
360 アクティブな vt のモードを取得する。 \fIargp\fP は、
365 char mode; /* vt mode */
366 char waitv; /* if set, hang on writes if not active */
367 short relsig; /* signal to raise on release req */
368 short acqsig; /* signal to raise on acquisition */
369 short frsig; /* unused (set to 0) */
374 という構造体を指すポインタであり、 アクティブな vt のモードがセットされる。 \fImode\fP は次のどれかに設定される。
384 アクティブな vt のモードを設定する。\fIargp\fP は構造体 \fIstruct vt_mode\fP への ポインターである。
387 グローバルな vt の状態の情報を取得する。\fIargp\fPは、
392 unsigned short v_active; /* active vt */
393 unsigned short v_signal; /* signal to send */
394 unsigned short v_state; /* vt bit mask */
399 へのポインターである。 使用されているそれぞれの vt につき \fIv_state\fP の対応するビットが セットされる。 (カーネルl 1.0 から
406 \fIargp\fP (1 <= \fIargp\fP <= MAX_NR_CONSOLES)の vt に切替える。
409 \fIargp\fPの vt がアクティブになるまで待つ。
412 \fIargp\fP の vt に結びつけられたメモリーを解放する。 (カーネル 1.1.54 以降)
415 カーネルが認識するスクリーンサイズを設定する。\fIargp\fP は、
420 unsigned short v_rows; /* # rows */
421 unsigned short v_cols; /* # columns */
422 unsigned short v_scrollsize; /* no longer used */
427 へのポインターである。 これはビデオモードを変更しない事に注意。 \fBresizecons\fP(8) を見よ(カーネル 1.1.54 以降)。
430 カーネルが認識する各種のスクリーンパラメータを設定する。\fIargp\fP は、 以下の構造体へのポインターである。
435 unsigned short v_rows; /* number of rows */
436 unsigned short v_cols; /* number of columns */
437 unsigned short v_vlin; /* number of pixel rows
439 unsigned short v_clin; /* number of pixel rows
441 unsigned short v_vcol; /* number of pixel columns
443 unsigned short v_ccol; /* number of pixel columns
449 パラメータはゼロであってもよい。そのときは「変更しないこと」を 意味するが、複数のパラメータが設定された時にはそれらの間で矛盾が
450 ないようにしなければならない。 この関数呼び出しによってもビデオモードは変更されない事に注意。 \fBresizecons\fP(8) を参照の事(カーネル
453 以下の ioctl がどのように動作をするかは、\fIargp\fP が指す構造体の 最初のバイト(ここでは \fIsubcode\fP と呼ぶ)に依存する。
454 これらの呼出しは、スーパーユーザーか現在の端末のオーナにのみ許される。
456 \fBTIOCLINUX, subcode=0\fP
457 スクリーンをダンプ(dump)する カーネル 1.1.92 以降でなくなった(1.1.92 以降では、代わりに \fI/dev/vcsN\fP または
458 \fI/dev/vcsaN\fP より読み込む)。
460 \fBTIOCLINUX, subcode=1\fP
461 タスク情報を取得する。カーネル 1.1.92 でなくなった。
463 \fBTIOCLINUX, subcode=2\fP
464 選択を設定する。 \fIargp\fP が指すのは、
470 short xs, ys, xe, ye;
476 であり、ここで \fIxs\fP と \fIys\fP は始めの桁と行で、\fIxe\fP と \fIye\fP は終りの桁と 行である。 (左上の隅が 桁=行=1 )
477 \fIsel_mode\fP は 0 が文字毎の選択で、1は語毎の選択、2は行毎の選択を 意味する。 示されたスクリーン上の文字はハイライト表示され
478 \fIdevices/char/console.c\fP の 静的配列 sel_buffer に保存される。
480 \fBTIOCLINUX, subcode=3\fP
481 選択したものをペーストする。 選択バッファ中の文字 が \fIfd\fP に書き出される。
483 \fBTIOCLINUX, subcode=4\fP
484 スクリーンをアンブランク(unblank)する。
486 \fBTIOCLINUX, subcode=5\fP
487 語毎の選択のための「語」中の文字を規定している 256 ビットのルックアップ テーブルの内容を設定する(カーネル 1.1.32 以降)。
489 \fBTIOCLINUX, subcode=6\fP
490 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIshift_state\fPの値に設定される(カーネル 1.1.32 以降)。
492 \fBTIOCLINUX, subcode=7\fP
493 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIreport_mouse\fP の値に設定される(カーネル 1.1.33 以降)。
495 \fBTIOCLINUX, subcode=8\fP
496 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組をダンプする (カーネル 1.1.67 から 1.1.91までのみ。 カーネル
497 1.1.92 以降では \fI/dev/vcsa*\fP より読み込む)。
499 \fBTIOCLINUX, subcode=9\fP
500 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組を復元する (カーネル 1.1.67 から 1.1.91 までのみ。 カーネル
501 1.1.92 以降では \fI/dev/vcsa*\fP に書き込む)。
503 \fBTIOCLINUX, subcode=10\fP
504 新世代モニターのパワーセーブ機能を制御する。 VESA スクリーンブランキングモードが \fIargp[1]\fPに設定される。
505 その値はスクリーンブランキングがどのように行われるかを示す。以下がその 値である。
510 現在のビデオアダプターレジスタが保存されたあと、 コントローラは垂直同期パルスをオフにするようプログラムされる。 これにより
511 モニターは「スタンバイ」モードに入る。 モニターに Off_Mode タイマが備わっておれば、 最終的にはモニターが自分で電源を落とす。
513 現在の設定を保存した後、垂直、水平同期パルスがオフになる。 これによりモニターは「オフ」モードになる。 モニターに Off_Mode
514 タイマーがない時、または、blank_timer がタイムアウトしたらすぐにモニターの電源を落したいときにこの選択肢を選ぶ。
515 (\fI注意\fP:頻繁にモニターの電源を切るとモニターを痛める。) (1.1.76 以降)
518 成功時には 0 が返される。エラーの場合 \-1 が返され、 \fIerrno\fP が設定される。
520 \fIerrno\fP は次のような値をとる:
526 ファイルディスクリプタがキャラクタ・スペシャルデバイスと関連付けられて いない。または、要求されたものがそれに当てはまらない。
529 ファイルディスクリプタまたは \fIargp\fP が無効。
534 \fB警告\fP: このマニュアルページを Linux のコンソール ioctl を文書化したものと思わない事。
535 これは、興味がある人がソースを読むことの代わりになるように用意した物である。 ioctl は文書化されない Linux の内部機能であって、警告なしに
536 変更されることがある。 (そして、このページはカーネル 1.1.94 のときの状況を記述した物で、それは 以前のバージョンと比べれば、多くの違いがある)
538 ioctl はカーネルと、ある特定のよく知られたプログラムとの情報交換のために 導入される事が非常に多い(fdisk, hdparm,
539 setserial,tunelp, loadkeys, selection, setfont など)。そのため ioctl
540 の動作は、その特定のプログラムが 必要とした時には変更になる。
542 これらの ioctl を使ったプログラムは他のバージョンの UNIX との互換性が ないし、古いバージョンの Linux
543 では、走らない。さらに将来のバージョンの Linux では走らなくなるかも知れない。
547 \fBdumpkeys\fP(1), \fBkbd_mode\fP(1), \fBloadkeys\fP(1), \fBmknod\fP(1), \fBsetleds\fP(1),
548 \fBsetmetamode\fP(1), \fBexecve\fP(2), \fBfcntl\fP(2), \fBioperm\fP(2), \fBtermios\fP(3),
549 \fBconsole\fP(4), \fBconsole_codes\fP(4), \fBmt\fP(4), \fBsd\fP(4), \fBtty\fP(4),
550 \fBtty_ioctl\fP(4), \fBttyS\fP(4), \fBvcs\fP(4), \fBvcsa\fP(4), \fBcharsets\fP(7),
551 \fBmapscrn\fP(8), \fBresizecons\fP(8), \fBsetfont\fP(8)
553 \fI/usr/include/linux/kd.h\fP, \fI/usr/include/linux/vt.h\fP
555 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
556 である。プロジェクトの説明とバグ報告に関する情報は
557 http://www.kernel.org/doc/man\-pages/ に書かれている。