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 .\"*******************************************************************
45 .TH CONSOLE_IOCTL 4 2009\-02\-28 Linux "Linux Programmer's Manual"
47 console_ioctl \- コンソール端末と仮想コンソールの ioctl
49 次のような Linux 固有の \fBioctl\fP(2) がサポートされている。 それぞれ3番目の引数が必要である、ここでは \fIargp\fP とする。
51 LED の状態を取得する。 \fIargp\fP は \fIchar\fP のポインターである。 \fI*argp\fP の下位 3 ビットに以下のように LED
54 LED_CAP 0x04 キャピタルロックが点灯
55 LEC_NUM 0x02 ナンバーロックが点灯
56 LED_SCR 0x01 スクロールロックが点灯
58 LEDを点灯させる。LEDは \fIargp\fP の下位 3 ビットに従い点灯される。 しかし、より高位のビットがセットされている時には、キャピタルロック、
59 ナンバーロック、スクロールロックのキーボード機能の状態を表示する LED は 通常状態に戻る。
61 カーネル 1.1.54 以前は、LED はそれぞれのキーボードフラグの状態を反映する だけで、KDGETLED/KDSETLED
62 もキーボードフラグを変更するだけであった。 カーネルl 1.1.54 からは LED に任意の表示をする事ができるようになったが、
63 デフォルトではキーボードフラグを表示する。 次に示す 2 つの ioctl はキーボードフラグにアクセスするのに用いられる。
65 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示では なく)キーボードフラグを得る。 \fIargp\fP
66 はフラグの状態がセットされる文字変数を指す。 (0x7)でマスクして得られる下位 3 ビットが現在のフラグの状態を示し、
67 (0x70)でマスクして得られる次の 3 ビットがデフォルトのフラグの状態を 示す。(カーネル 1.1.54以降)
69 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示ではなく) キーボードフラグをセットする。 \fIargp\fP
70 がセットしたいフラグである。 (0x7)でマスクして得られる下位 3 ビットがフラグの状態で、(0x70)でマスクして 得られる次の 3
71 ビットがデフォルトのフラグの状態である。(カーネル 1.1.54以降)
73 キーボードの種類を得る。これは値 0x02 と定義されている KB_101を返す。
75 I/Oポートを有効な物として加える。これは \fIioperm(arg,1,1)\fP と等価である。
77 I/Oポートを有効な物から外す。これは \fIioperm(arg,1,0)\fP と等価である。
79 ビデオボードへの I/O を可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 1)\fP と等価である。
81 ビデオボードへの I/O を不可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 0)\fP と等価である。
83 テキスト/グラフィクスモードを設定する。 \fIargp\fP は次のうちのどれか:
88 テキスト/グラフィクスモードを取得する。 \fIargp\fP が指す \fIlong\fP 型変数に 上述の値のどちらかがセットされる。
90 指定された長さのトーンを発生する。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位にして周期を指定し、 上位 16 ビットが msec
91 の単位で表した、(トーンを発生させる)時間を指定する。 トーンを発生させる時間がゼロのときは、サウンドはオフになる。 制御は直ちに戻る。
92 例えば、\fIargp\fP = (125<<16) + 0x637 とすれば、通常 ctrl\-G を押した時に 発生する音になる。
93 (カーネル 0.99pl1 以降;この機能は カーネル 2.1.49 から 2.1.50 ではバグのため動作しない)
95 音の発生の開始や停止を行う。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位として周期を示す。 (つまり \fIargp\fP =
96 1193180/周波数)。 \fIargp\fP = 0 の場合、サウンドはオフになる。 どちらの場合でも、ただちに制御は戻る。
98 現在のデフォルトのカラーマップをカーネルより取得する。
100 デフォルトのテキストモードのカラーマップを変更する。 \fIargp\fP が指す 48 バイトの配列中には、16 の可能なスクリーンの色を、
101 赤、緑、青の順に 0 をオフ、255を最大強度とした値として納める。 デフォルトの色は順に、黒、濃い赤、濃い緑、茶、濃い青、濃い紫、濃いシアン、
102 明るい灰色、濃い灰色、明るい赤、明るい緑、黄、明るい青、明るい紫、 明るいシアン、白である。(カーネル 1.3.3以降)
104 拡張された形式で 256 文字のスクリーンフォントを得る。 \fIargp\fP は 8192 バイトの配列を指す。 現在ロードされているフォントが 512
105 文字のフォントであるか、コンソールが テキストモードでない時には失敗し \fBEINVAL\fP のエラーコードを返す。
107 スクリーンフォントとそれに関連した情報を取得する。 \fIargp\fP は構造体 consolefontdesc (\fBPIO_FONTX\fP
108 を参照のこと)を指す。 関数呼び出しのときには、\fIcharcount\fP には、\fIchardata\fP が指す
109 バッファにおさまる最大の文字数をセットしなければならない。 関数呼び出しから戻った時には \fIcharcount\fP と \fIcharheight\fP
110 には、 現在ロードされているフォントの該当するデータが収められている。 配列 \fIchardata\fP には、最初に \fIcharcount\fP
111 にいれた値によって フォントを収めるのに十分なスペースがあるとわかればフォントデータが収められる。 そうでない時には、バッファは変更されず、
112 \fIerrno\fP に \fBENOMEM\fP が セットされる(カーネル 1.3.1 以降)。
114 256 文字のフォントをセットする。EGA/VGA キャラクタージェネレーター (character generator) にフォントをロードする。
115 \fIargp\fP は、8192 バイト(一文字 32 バイト)のマップを指す。 マップのうち、最初の \fIN\fP のみが 8x\fIN\fP のフォントのために
116 用いられる(0 < \fIN\fP <= 32)。 この呼び出しをすると Unicode のマッピングが無効になる。
118 スクリーンフォントと、それに関連するレンダリング情報をセットする。 \fIargp\fP は、以下の構造体を指す。
122 struct consolefontdesc {
123 unsigned short charcount; /* フォントの文字数
125 unsigned short charheight; /* 一文字の走査線の数
127 char *chardata; /* 展開されたフォントデータ */
132 必要ならスクリーンは適当にサイズ変更され、\fBSIGWINCH\fP が適切な プロセスに送られる。 このコールにより Unicode
134 .IP \fBPIO_FONTRESET\fP
135 スクリーンフォント、サイズ、 Unicode マッピングをブート時のデフォルト値に リセットする。\fIargp\fP は用いられないが、将来のバージョンの
136 Linux との互換性を保つために NULL にセットすべきである。
137 .IP \fBGIO_SCRNMAP\fP
138 スクリーンマッピングをカーネルより取得する。\fIargp\fP はサイズ E_TABSZ の
139 領域を指す。その領域には各キャラクターを表示するのに用いられるフォントの 位置がロードされている。 この呼び出しは現在ロードされているフォントが 256
140 文字よりも多い時には 無意味な情報を返す事が多い。
141 .IP \fBGIO_UNISCRNMAP\fP
142 フル Unicode スクリーンマッピングをカーネルより取得する。 \fIargp\fP はサイズ E_TABSZ*sizeof(unsigned
143 short) の領域を指す。 その領域には各キャラクターを示す Unicode がロードされている。 U+F000 に始まる Unicode
144 の特別な集合は、「フォント直接な(direct to font)」 マッピングを示すのに用いられる(カーネル 1.3.1 以降)。
145 .IP \fBPIO_SCRNMAP\fP
146 「ユーザー定義可能な(user definable)」(4番目の)テーブルをカーネルに
147 ロードする。そのテーブルは各バイトをスクリーンシンボルにマッピングする。 \fIargp\fP はサイズE_TABSZの領域を指す。
148 .IP \fBPIO_UNISCRNMAP\fP
149 「ユーザー定義可能な」(4番目の)テーブルをカーネルにロードする。 そのテーブルは各バイトをユニコードにマッピングし、その後、
150 現在ロードされているユニコードからフォントへのマップに従い スクリーンシンボルに変換される。 U+F000
151 に始まるユニコードは直接フォントシンボルにマッピングするのに 使える(カーネル 1.3.1 以降)
153 Unicode からフォントへのマッピングをカーネルから取得する。 \fIargp\fP は、
158 unsigned short entry_ct;
159 struct unipair *entries;
164 という構造体を指す。 ここで \fIentries\fP は以下の構造体の配列へのポインターである。
169 unsigned short unicode;
170 unsigned short fontpos;
177 Unicode からフォントへのマッピングをカーネルにセットする。
178 \fIargp\fP は構造体 \fIstruct unimapdesc\fP へのポインターである。
180 .IP \fBPIO_UNIMAPCLR\fP
181 テーブルをクリアし、その事をハシュアルゴリズムに伝える。 \fIargp\fPは
186 unsigned short advised_hashsize; /* 0 if no opinion */
187 unsigned short advised_hashstep; /* 0 if no opinion */
188 unsigned short advised_hashlevel; /* 0 if no opinion */
195 現在のキーボードモードを取得する。\fIargp\fP の指す \fIlong\fP 型変数が、 次のうちのどれかに設定される。
202 現在のキーボードモードを設定する。 \fIargp\fP は上記の値のうちのどれかに等しい \fIlong\fP にする。
204 メタキーハンドリングモード(meta key handling mode)を取得する。 \fIargp\fP が指す \fIlong\fP
207 K_METABIT 0x03 set high order bit
208 K_ESCPREFIX 0x04 escape prefix
210 メタキーハンドリングモードを設定する。 \fIargp\fP は上記の値のどれかに等しい \fIlong\fP にする。
212 キーコードをアクションコードに変換するキー変換表のエントリーの一つを 取得する。 \fIargp\fP は、
217 unsigned char kb_table;
218 unsigned char kb_index;
219 unsigned short kb_value;
224 へのポインターである。 最初の2つの要素、\fIkb_table\fP には選択するキーテーブル (0 <= \fIkb_table\fP <
225 MAX_NR_KEYMAPS)、\fIkb_index\fP にはキーコード(0 <= \fIkb_index\fP <
226 NR_KEYS)を設定する。 \fIkb_value\fP は対応するアクションコード、または、そのようなキーが ないときには
227 K_HOLE、\fIkb_table\fP が無効な時には K_NOSUCHMAP に設定される。
229 変換テーブルのエントリーの一つを設定する。\fIargp\fP は 構造体 \fIstruct kbentry\fP へのポインターである。
231 ファンクションキーの文字列を取得する。\fIargp\fP は 以下の構造体へのポインターである。
236 unsigned char kb_func;
237 unsigned char kb_string[512];
242 \fIkb_func\fP 番目のファンクションキーのアクションコードに対応する (NULL で終端された) 文字列が \fIkb_string\fP
245 ファンクションキーの文字列のエントリーを設定する。\fIargp\fP は、 構造体 \fIstruct kbsentry\fP へのポインターである。
247 カーネルのアクセントテーブル(accent table)を読み込む。\fIargp\fPは、 次の構造体へのポインターである。
253 struct kbdiacr kbdiacr[256];
258 ここで、\fIkb_cnt\fP は配列中のエントリーの個数で、個々のエントリーは 以下の構造体である。
265 unsigned char result;
269 .IP \fBKDGETKEYCODE\fP
270 カーネルの(スキャンコードからキーコードへ 変換する)キーコードテーブルエントリーを読み込む。 \fIargp\fP は、
275 unsigned int scancode;
276 unsigned int keycode;
281 へのポインターである。 \fIkeycode\fP は、\fIscancode\fP に対応した値に設定される。(ただし、89 <= \fIscancode\fP
282 <= 255 のみについて。1 <= \fIscancode\fP <= 88 では \fIkeycode\fP ==
283 \fIscancode\fP である。) (カーネル 1.1.63 以降)
284 .IP \fBKDSETKEYCODE\fP
285 カーネルのキーコードテーブルエントリーを書き込む。\fIargp\fP は構造体 \fIstruct kbkeycode\fP へのポインターである。 (カーネル
287 .IP \fBKDSIGACCEPT\fP
288 この関数呼び出しは、特別な組合せでキーを押した時に発生するシグナル \fIargp\fP (1 <= \fIargp\fP <= NSIG)
289 を進んで受け付けるかどうかを示す。 (linux/drivers/char/keyboard.c の Spawn_console() を見よ。)
291 最初の空いている(まだオープンされていない)コンソールを返す。 \fIargp\fP の指す \fIint\fP 型の整数には、vt の番号がセットされる (1
292 <= \fI*argp\fP <= MAX_NR_CONSOLES)。
294 アクティブな vt のモードを取得する。\fIargp\fPは、
299 char mode; /* vt mode */
300 char waitv; /* if set, hang on writes if not active */
301 short relsig; /* signal to raise on release req */
302 short acqsig; /* signal to raise on acquisition */
303 short frsig; /* unused (set to 0) */
308 という構造体を指すポインタであり、アクティブな vt のモードが セットされる。 \fImode\fP は次のどれかに設定される:
311 VT_PROCESS プロセスコントロール切替え
314 アクティブな vt のモードを設定する。\fIargp\fP は構造体 \fIstruct vt_mode\fP への ポインターである。
315 .IP \fBVT_GETSTATE\fP
316 グローバルな vt の状態の情報を取得する。\fIargp\fPは、
321 unsigned short v_active; /* active vt */
322 unsigned short v_signal; /* signal to send */
323 unsigned short v_state; /* vt bit mask */
328 へのポインターである。 使用されているそれぞれの vt につき \fIv_state\fP の対応するビットが セットされる。 (カーネルl 1.0 から
332 .IP \fBVT_ACTIVATE\fP
333 \fIargp\fP (1 <= \fIargp\fP <= MAX_NR_CONSOLES)の vt に切替える。
334 .IP \fBVT_WAITACTIVE\fP
335 \fIargp\fPの vt がアクティブになるまで待つ。
336 .IP \fBVT_DISALLOCATE\fP
337 \fIargp\fP の vt に結びつけられたメモリーを解放する。 (カーネル 1.1.54 以降)
339 カーネルが認識するスクリーンサイズを設定する。\fIargp\fP は、
344 unsigned short v_rows; /* # rows */
345 unsigned short v_cols; /* # columns */
346 unsigned short v_scrollsize; /* no longer used */
351 へのポインターである。 これはビデオモードを変更しない事に注意。 \fBresizecons\fP(8) を見よ(カーネル 1.1.54 以降)。
353 カーネルが認識する各種のスクリーンパラメータを設定する。\fIargp\fP は、 以下の構造体へのポインターである。
358 unsigned short v_rows; /* number of rows */
359 unsigned short v_cols; /* number of columns */
360 unsigned short v_vlin; /* number of pixel rows
362 unsigned short v_clin; /* number of pixel rows
364 unsigned short v_vcol; /* number of pixel columns
366 unsigned short v_ccol; /* number of pixel columns
372 パラメータはゼロであってもよい。そのときは「変更しないこと」を 意味するが、複数のパラメータが設定された時にはそれらの間で矛盾が
373 ないようにしなければならない。 この関数呼び出しによってもビデオモードは変更されない事に注意。 \fBresizecons\fP(8) を参照の事(カーネル
376 以下の ioctl がどのように動作をするかは、\fIargp\fP が指す構造体の 最初のバイト(ここでは \fIsubcode\fP と呼ぶ)に依存する。
377 これらの呼出しは、スーパーユーザーか現在の端末のオーナにのみ許される。
378 .IP "\fBTIOCLINUX, subcode=0\fP"
379 スクリーンをダンプ(dump)する カーネル 1.1.92 以降でなくなった(1.1.92 以降では、代わりに /dev/vcsN または
381 .IP "\fBTIOCLINUX, subcode=1\fP"
382 タスク情報を取得する。カーネル 1.1.92 でなくなった。
383 .IP "\fBTIOCLINUX, subcode=2\fP"
384 選択を設定する。 \fIargp\fP が指すのは、
390 short xs, ys, xe, ye;
396 であり、ここで \fIxs\fP と \fIys\fP は始めの桁と行で、\fIxe\fP と \fIye\fP は終りの桁と 行である。 (左上の隅が 桁=行=1 )
397 \fIsel_mode\fP は 0 が文字毎の選択で、1は語毎の選択、2は行毎の選択を 意味する。 示されたスクリーン上の文字はハイライト表示され
398 devices/char/console.c の 静的配列 sel_buffer に保存される。
399 .IP "\fBTIOCLINUX, subcode=3\fP"
400 選択したものをペーストする。 選択バッファ中の文字 が \fIfd\fP に書き出される。
401 .IP "\fBTIOCLINUX, subcode=4\fP"
402 スクリーンをアンブランク(unblank)する。
403 .IP "\fBTIOCLINUX, subcode=5\fP"
404 語毎の選択のための「語」中の文字を規定している 256 ビットのルックアップ テーブルの内容を設定する(カーネル 1.1.32 以降)。
405 .IP "\fBTIOCLINUX, subcode=6\fP"
406 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIshift_state\fPの値に設定される(カーネル 1.1.32 以降)。
407 .IP "\fBTIOCLINUX, subcode=7\fP"
408 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIreport_mouse\fP の値に設定される(カーネル 1.1.33 以降)。
409 .IP "\fBTIOCLINUX, subcode=8\fP"
410 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組をダンプする (カーネル 1.1.67 から 1.1.91までのみ。 カーネル
411 1.1.92 以降では /dev/vcsa*より読み込む)。
412 .IP "\fBTIOCLINUX, subcode=9\fP"
413 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組を復元する (カーネル 1.1.67 から 1.1.91 までのみ。 カーネル
414 1.1.92 以降では /dev/vcsa* に書き込む)。
415 .IP "\fBTIOCLINUX, subcode=10\fP"
416 新世代モニターのパワーセーブ機能を制御する。 VESA スクリーンブランキングモードが \fIargp\fP[1]に設定される。
417 その値はスクリーンブランキングがどのように行われるかを示す。以下がその 値である。
419 \fI0\fP: スクリーンブランキングなし。
421 \fI1\fP:現在のビデオアダプターレジスタが保存されたあと、
422 コントローラは垂直同期パルスをオフにするようプログラムされる。
423 これにより モニターは「スタンバイ」モードにはいる。
424 モニターに Off_Mode タイマが備わっておれば、
427 \fI2\fP:現在の設定を保存した後、垂直、水平同期パルスがオフになる。
428 これによりモニターは「オフ」モードになる。
429 モニターに Off_Mode タイマーがない時、または、blank_timer がタイムアウトしたら
430 すぐにモニターの電源を落したいときにこの選択肢を選ぶ。
431 (注意:頻繁にモニターの電源を切るとモニターを痛める。)
435 成功時には 0 が返される。エラーに対しては \-1 が返され、 \fIerrno\fP が設定される。
437 \fIerrno\fP は次のような値をとる:
443 ファイルディスクリプタがキャラクタ・スペシャルデバイスと関連付けられて いない。または、要求されたものがそれに当てはまらない。
446 ファイルディスクリプタまたは \fIargp\fP が無効。
451 \fB警告\fP: このマニュアルページを Linux のコンソール ioctl を文書化したものと思わない事。
452 これは、興味がある人がソースを読むことの代わりになるように用意した物である。 ioctl は文書化されない Linux の内部機能であって、警告なしに
453 変更されることがある。 (そして、このページはカーネル 1.1.94 のときの状況を記述した物で、それは 以前のバージョンと比べれば、多くの違いがある)
455 ioctl はカーネルと、ある特定のよく知られたプログラムとの情報交換のために 導入される事が非常に多い(fdisk, hdparm,
456 setserial,tunelp, loadkeys, selection, setfont など)。そのため ioctl
457 の動作は、その特定のプログラムが 必要とした時には変更になる。
459 これらの ioctl を使ったプログラムは他のバージョンの UNIX との互換性が ないし、古いバージョンの Linux
460 では、走らない。さらに将来のバージョンの Linux では走らなくなるかも知れない。
464 \fBdumpkeys\fP(1), \fBkbd_mode\fP(1), \fBloadkeys\fP(1), \fBmknod\fP(1), \fBsetleds\fP(1),
465 \fBsetmetamode\fP(1), \fBexecve\fP(2), \fBfcntl\fP(2), \fBioperm\fP(2), \fBtermios\fP(3),
466 \fBconsole\fP(4), \fBconsole_codes\fP(4), \fBmt\fP(4), \fBsd\fP(4), \fBtty\fP(4),
467 \fBtty_ioctl\fP(4), \fBttyS\fP(4), \fBvcs\fP(4), \fBvcsa\fP(4), \fBcharsets\fP(7),
468 \fBmapscrn\fP(8), \fBresizecons\fP(8), \fBsetfont\fP(8)
470 \fI/usr/include/linux/kd.h\fP, \fI/usr/include/linux/vt.h\fP
472 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
473 である。プロジェクトの説明とバグ報告に関する情報は
474 http://www.kernel.org/doc/man\-pages/ に書かれている。