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 とする。
52 LED の状態を取得する。 \fIargp\fP は \fIchar\fP のポインターである。 \fI*argp\fP の下位 3 ビットに以下のように LED
56 LED_CAP 0x04 キャピタルロック LED 点灯
57 LEC_NUM 0x02 ナンバーロック LED 点灯
58 LED_SCR 0x01 スクロールロック LED 点灯
62 LEDを点灯させる。LEDは \fIargp\fP の下位 3 ビットに従い点灯される。 しかし、より高位のビットがセットされている時には、キャピタルロック、
63 ナンバーロック、スクロールロックのキーボード機能の状態を表示する LED は 通常状態に戻る。
65 カーネル 1.1.54 以前は、LED はそれぞれのキーボードフラグの状態を反映するだけで、KDGETLED/KDSETLED
66 もキーボードフラグを変更するだけであった。 カーネル 1.1.54 からは LED に任意の表示をすることができるようになったが、
67 デフォルトではキーボードフラグを表示する。 次に示す 2 つの ioctl はキーボードフラグにアクセスするのに用いられる。
70 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示では なく)キーボードフラグを得る。 \fIargp\fP
71 はフラグの状態がセットされる文字変数を指す。 (0x7)でマスクして得られる下位 3 ビットが現在のフラグの状態を示し、
72 (0x70)でマスクして得られる次の 3 ビットがデフォルトのフラグの状態を 示す。(カーネル 1.1.54以降)
75 キャピタルロック、ナンバーロック、スクロールロックの(LED の表示ではなく) キーボードフラグをセットする。 \fIargp\fP
76 がセットしたいフラグである。 (0x7)でマスクして得られる下位 3 ビットがフラグの状態で、(0x70)でマスクして 得られる次の 3
77 ビットがデフォルトのフラグの状態である。(カーネル 1.1.54以降)
80 キーボードの種類を得る。これは値 0x02 と定義されている KB_101を返す。
83 I/Oポートを有効な物として加える。これは \fIioperm(arg,1,1)\fP と等価である。
86 I/Oポートを有効な物から外す。これは \fIioperm(arg,1,0)\fP と等価である。
89 ビデオボードへの I/O を可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 1)\fP と等価である。
92 ビデオボードへの I/O を不可能にする。 これは \fIioperm(0x3b4, 0x3df\-0x3b4+1, 0)\fP と等価である。
95 テキスト/グラフィクスモードを設定する。 \fIargp\fP は次のうちのどれか:
104 テキスト/グラフィクスモードを取得する。 \fIargp\fP が指す \fIlong\fP 型変数に 上述の値のどちらかがセットされる。
107 指定された長さのトーンを発生する。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位にして周期を指定し、 上位 16 ビットが msec
108 の単位で表した、(トーンを発生させる)時間を指定する。 トーンを発生させる時間がゼロのときは、サウンドはオフになる。 制御は直ちに戻る。
109 例えば、\fIargp\fP = (125<<16) + 0x637 とすれば、通常 ctrl\-G を押した時に 発生する音になる。
110 (カーネル 0.99pl1 以降;この機能は カーネル 2.1.49 から 2.1.50 ではバグのため動作しない)
113 音の発生の開始や停止を行う。 \fIargp\fP の下位 16 ビットはクロックサイクルを単位として周期を示す。 (つまり \fIargp\fP =
114 1193180/周波数)。 \fIargp\fP = 0 の場合、サウンドはオフになる。 どちらの場合でも、ただちに制御は戻る。
117 現在のデフォルトのカラーマップをカーネルより取得する。
120 デフォルトのテキストモードのカラーマップを変更する。 \fIargp\fP が指す 48 バイトの配列中には、16 の可能なスクリーンの色を、
121 赤、緑、青の順に 0 をオフ、255を最大強度とした値として納める。 デフォルトの色は順に、黒、濃い赤、濃い緑、茶、濃い青、濃い紫、濃いシアン、
122 明るい灰色、濃い灰色、明るい赤、明るい緑、黄、明るい青、明るい紫、 明るいシアン、白である。(カーネル 1.3.3以降)
125 拡張された形式で 256 文字のスクリーンフォントを得る。 \fIargp\fP は 8192 バイトの配列を指す。 現在ロードされているフォントが 512
126 文字のフォントであるか、コンソールが テキストモードでない時には失敗し \fBEINVAL\fP のエラーコードを返す。
129 Gets screen font and associated information. \fIargp\fP points to a \fIstruct
130 consolefontdesc\fP (see \fBPIO_FONTX\fP). On call, the \fIcharcount\fP field should
131 be set to the maximum number of characters that would fit in the buffer
132 pointed to by \fIchardata\fP. On return, the \fIcharcount\fP and \fIcharheight\fP
133 are filled with the respective data for the currently loaded font, and the
134 \fIchardata\fP array contains the font data if the initial value of
135 \fIcharcount\fP indicated enough space was available; otherwise the buffer is
136 untouched and \fIerrno\fP is set to \fBENOMEM\fP. (Since 1.3.1.)
139 256 文字のフォントをセットする。EGA/VGA キャラクタージェネレーター (character generator) にフォントをロードする。
140 \fIargp\fP は、8192 バイト(一文字 32 バイト)のマップを指す。 マップのうち、最初の \fIN\fP のみが 8x\fIN\fP のフォントのために
141 用いられる(0 < \fIN\fP <= 32)。 この呼び出しをすると Unicode のマッピングが無効になる。
144 スクリーンフォントと、それに関連するレンダリング情報をセットする。 \fIargp\fP は、以下の構造体を指す。
150 struct consolefontdesc {
151 unsigned short charcount; /* フォントの文字数
153 unsigned short charheight; /* 一文字の走査線の数
155 char *chardata; /* 展開されたフォントデータ */
160 必要ならスクリーンは適当にサイズ変更され、\fBSIGWINCH\fP が適切な プロセスに送られる。 このコールにより Unicode
164 スクリーンフォント、サイズ、 Unicode マッピングをブート時のデフォルト値に リセットする。\fIargp\fP は用いられないが、将来のバージョンの
165 Linux との互換性を保つために NULL にセットすべきである。
168 スクリーンマッピングをカーネルより取得する。\fIargp\fP はサイズ E_TABSZ の
169 領域を指す。その領域には各キャラクターを表示するのに用いられるフォントの 位置がロードされている。 この呼び出しは現在ロードされているフォントが 256
170 文字よりも多い時には 無意味な情報を返す事が多い。
173 Get full Unicode screen mapping from kernel. \fIargp\fP points to an area of
174 size \fIE_TABSZ*sizeof(unsigned short)\fP, which is loaded with the Unicodes
175 each character represent. A special set of Unicodes, starting at U+F000,
176 are used to represent "direct to font" mappings. (Since 1.3.1.)
179 「ユーザー定義可能な(user definable)」(4番目の)テーブルをカーネルに
180 ロードする。そのテーブルは各バイトをスクリーンシンボルにマッピングする。 \fIargp\fP はサイズE_TABSZの領域を指す。
183 「ユーザー定義可能な」(4番目の)テーブルをカーネルにロードする。 そのテーブルは各バイトをユニコードにマッピングし、その後、
184 現在ロードされているユニコードからフォントへのマップに従い スクリーンシンボルに変換される。 U+F000
185 に始まるユニコードは直接フォントシンボルにマッピングするのに 使える(カーネル 1.3.1 以降)
188 Unicode からフォントへのマッピングをカーネルから取得する。 \fIargp\fP は、
193 unsigned short entry_ct;
194 struct unipair *entries;
199 という構造体を指す。 ここで \fIentries\fP は以下の構造体の配列へのポインターである。
204 unsigned short unicode;
205 unsigned short fontpos;
213 Unicode からフォントへのマッピングをカーネルにセットする。 \fIargp\fP は構造体 \fIstruct unimapdesc\fP
214 へのポインターである。 (カーネル 1.1.92 以降)
217 テーブルをクリアし、その事をハシュアルゴリズムに伝える。 \fIargp\fPは
222 unsigned short advised_hashsize; /* 0 if no opinion */
223 unsigned short advised_hashstep; /* 0 if no opinion */
224 unsigned short advised_hashlevel; /* 0 if no opinion */
232 現在のキーボードモードを取得する。\fIargp\fP の指す \fIlong\fP 型変数が、 次のうちのどれかに設定される。
243 現在のキーボードモードを設定する。 \fIargp\fP は上記の値のうちのどれかに等しい \fIlong\fP にする。
246 メタキーハンドリングモード(meta key handling mode)を取得する。 \fIargp\fP が指す \fIlong\fP
251 K_METABIT 0x03 上位ビットをセット
252 K_ESCPREFIX 0x04 エスケーププレフィックス
256 メタキーハンドリングモードを設定する。 \fIargp\fP は上記の値のどれかに等しい \fIlong\fP にする。
259 キーコードをアクションコードに変換するキー変換表のエントリーの一つを 取得する。 \fIargp\fP は、
264 unsigned char kb_table;
265 unsigned char kb_index;
266 unsigned short kb_value;
271 へのポインターである。 最初の2つの要素、\fIkb_table\fP には選択するキーテーブル (0 <= \fIkb_table\fP <
272 MAX_NR_KEYMAPS)、\fIkb_index\fP にはキーコード(0 <= \fIkb_index\fP <
273 NR_KEYS)を設定する。 \fIkb_value\fP は対応するアクションコード、または、そのようなキーが ないときには
274 K_HOLE、\fIkb_table\fP が無効な時には K_NOSUCHMAP に設定される。
277 変換テーブルのエントリーの一つを設定する。\fIargp\fP は 構造体 \fIstruct kbentry\fP へのポインターである。
280 ファンクションキーの文字列を取得する。\fIargp\fP は 以下の構造体へのポインターである。
285 unsigned char kb_func;
286 unsigned char kb_string[512];
291 \fIkb_func\fP 番目のファンクションキーのアクションコードに対応する (NULL で終端された) 文字列が \fIkb_string\fP
295 ファンクションキーの文字列のエントリーを設定する。\fIargp\fP は、 構造体 \fIstruct kbsentry\fP へのポインターである。
298 カーネルのアクセントテーブル(accent table)を読み込む。\fIargp\fPは、 次の構造体へのポインターである。
304 struct kbdiacr kbdiacr[256];
309 ここで、\fIkb_cnt\fP は配列中のエントリーの個数で、個々のエントリーは 以下の構造体である。
316 unsigned char result;
322 カーネルの(スキャンコードからキーコードへ 変換する)キーコードテーブルエントリーを読み込む。 \fIargp\fP は、
327 unsigned int scancode;
328 unsigned int keycode;
333 へのポインターである。 \fIkeycode\fP は、\fIscancode\fP に対応した値に設定される。(ただし、89 <= \fIscancode\fP
334 <= 255 のみについて。1 <= \fIscancode\fP <= 88 では \fIkeycode\fP ==
335 \fIscancode\fP である。) (カーネル 1.1.63 以降)
338 カーネルのキーコードテーブルエントリーを書き込む。\fIargp\fP は構造体 \fIstruct kbkeycode\fP へのポインターである。 (カーネル
342 この関数呼び出しは、特別な組合せでキーを押した時に発生するシグナル \fIargp\fP (1 <= \fIargp\fP <= NSIG)
343 を進んで受け付けるかどうかを示す。 (\fIlinux/drivers/char/keyboard.c\fP の \fIspawn_console\fP()
347 最初の空いている(まだオープンされていない)コンソールを返す。 \fIargp\fP の指す \fIint\fP 型の整数には、vt の番号がセットされる (1
348 <= \fI*argp\fP <= MAX_NR_CONSOLES)。
351 アクティブな vt のモードを取得する。 \fIargp\fP は、
356 char mode; /* vt mode */
357 char waitv; /* if set, hang on writes if not active */
358 short relsig; /* signal to raise on release req */
359 short acqsig; /* signal to raise on acquisition */
360 short frsig; /* unused (set to 0) */
365 という構造体を指すポインタであり、 アクティブな vt のモードがセットされる。 \fImode\fP は次のどれかに設定される。
375 アクティブな vt のモードを設定する。\fIargp\fP は構造体 \fIstruct vt_mode\fP への ポインターである。
378 グローバルな vt の状態の情報を取得する。\fIargp\fPは、
383 unsigned short v_active; /* active vt */
384 unsigned short v_signal; /* signal to send */
385 unsigned short v_state; /* vt bit mask */
390 へのポインターである。 使用されているそれぞれの vt につき \fIv_state\fP の対応するビットが セットされる。 (カーネルl 1.0 から
397 \fIargp\fP (1 <= \fIargp\fP <= MAX_NR_CONSOLES)の vt に切替える。
400 \fIargp\fPの vt がアクティブになるまで待つ。
403 \fIargp\fP の vt に結びつけられたメモリーを解放する。 (カーネル 1.1.54 以降)
406 カーネルが認識するスクリーンサイズを設定する。\fIargp\fP は、
411 unsigned short v_rows; /* # rows */
412 unsigned short v_cols; /* # columns */
413 unsigned short v_scrollsize; /* no longer used */
418 へのポインターである。 これはビデオモードを変更しない事に注意。 \fBresizecons\fP(8) を見よ(カーネル 1.1.54 以降)。
421 カーネルが認識する各種のスクリーンパラメータを設定する。\fIargp\fP は、 以下の構造体へのポインターである。
426 unsigned short v_rows; /* number of rows */
427 unsigned short v_cols; /* number of columns */
428 unsigned short v_vlin; /* number of pixel rows
430 unsigned short v_clin; /* number of pixel rows
432 unsigned short v_vcol; /* number of pixel columns
434 unsigned short v_ccol; /* number of pixel columns
440 パラメータはゼロであってもよい。そのときは「変更しないこと」を 意味するが、複数のパラメータが設定された時にはそれらの間で矛盾が
441 ないようにしなければならない。 この関数呼び出しによってもビデオモードは変更されない事に注意。 \fBresizecons\fP(8) を参照の事(カーネル
444 以下の ioctl がどのように動作をするかは、\fIargp\fP が指す構造体の 最初のバイト(ここでは \fIsubcode\fP と呼ぶ)に依存する。
445 これらの呼出しは、スーパーユーザーか現在の端末のオーナにのみ許される。
447 \fBTIOCLINUX, subcode=0\fP
448 スクリーンをダンプ(dump)する カーネル 1.1.92 以降でなくなった(1.1.92 以降では、代わりに \fI/dev/vcsN\fP または
449 \fI/dev/vcsaN\fP より読み込む)。
451 \fBTIOCLINUX, subcode=1\fP
452 タスク情報を取得する。カーネル 1.1.92 でなくなった。
454 \fBTIOCLINUX, subcode=2\fP
455 選択を設定する。 \fIargp\fP が指すのは、
461 short xs, ys, xe, ye;
467 であり、ここで \fIxs\fP と \fIys\fP は始めの桁と行で、\fIxe\fP と \fIye\fP は終りの桁と 行である。 (左上の隅が 桁=行=1 )
468 \fIsel_mode\fP は 0 が文字毎の選択で、1は語毎の選択、2は行毎の選択を 意味する。 示されたスクリーン上の文字はハイライト表示され
469 \fIdevices/char/console.c\fP の 静的配列 sel_buffer に保存される。
471 \fBTIOCLINUX, subcode=3\fP
472 選択したものをペーストする。 選択バッファ中の文字 が \fIfd\fP に書き出される。
474 \fBTIOCLINUX, subcode=4\fP
475 スクリーンをアンブランク(unblank)する。
477 \fBTIOCLINUX, subcode=5\fP
478 語毎の選択のための「語」中の文字を規定している 256 ビットのルックアップ テーブルの内容を設定する(カーネル 1.1.32 以降)。
480 \fBTIOCLINUX, subcode=6\fP
481 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIshift_state\fPの値に設定される(カーネル 1.1.32 以降)。
483 \fBTIOCLINUX, subcode=7\fP
484 \fIargp\fP は文字変数を指すポインタで、その内容がカーネル変数 \fIreport_mouse\fP の値に設定される(カーネル 1.1.33 以降)。
486 \fBTIOCLINUX, subcode=8\fP
487 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組をダンプする (カーネル 1.1.67 から 1.1.91までのみ。 カーネル
488 1.1.92 以降では \fI/dev/vcsa*\fP より読み込む)。
490 \fBTIOCLINUX, subcode=9\fP
491 スクリーン幅、スクリーン高さ、カーソル位置、全ての文字属性の組を復元する (カーネル 1.1.67 から 1.1.91 までのみ。 カーネル
492 1.1.92 以降では \fI/dev/vcsa*\fP に書き込む)。
494 \fBTIOCLINUX, subcode=10\fP
495 新世代モニターのパワーセーブ機能を制御する。 VESA スクリーンブランキングモードが \fIargp[1]\fPに設定される。
496 その値はスクリーンブランキングがどのように行われるかを示す。以下がその 値である。
501 現在のビデオアダプターレジスタが保存されたあと、 コントローラは垂直同期パルスをオフにするようプログラムされる。 これにより
502 モニターは「スタンバイ」モードに入る。 モニターに Off_Mode タイマが備わっておれば、 最終的にはモニターが自分で電源を落とす。
504 現在の設定を保存した後、垂直、水平同期パルスがオフになる。 これによりモニターは「オフ」モードになる。 モニターに Off_Mode
505 タイマーがない時、または、blank_timer がタイムアウトしたらすぐにモニターの電源を落したいときにこの選択肢を選ぶ。
506 (\fI注意\fP:頻繁にモニターの電源を切るとモニターを痛める。) (1.1.76 以降)
509 成功時には 0 が返される。エラーの場合 \-1 が返され、 \fIerrno\fP が設定される。
511 \fIerrno\fP は次のような値をとる:
517 ファイルディスクリプタがキャラクタ・スペシャルデバイスと関連付けられて いない。または、要求されたものがそれに当てはまらない。
520 ファイルディスクリプタまたは \fIargp\fP が無効。
525 \fB警告\fP: このマニュアルページを Linux のコンソール ioctl を文書化したものと思わない事。
526 これは、興味がある人がソースを読むことの代わりになるように用意した物である。 ioctl は文書化されない Linux の内部機能であって、警告なしに
527 変更されることがある。 (そして、このページはカーネル 1.1.94 のときの状況を記述した物で、それは 以前のバージョンと比べれば、多くの違いがある)
529 ioctl はカーネルと、ある特定のよく知られたプログラムとの情報交換のために 導入される事が非常に多い(fdisk, hdparm,
530 setserial,tunelp, loadkeys, selection, setfont など)。そのため ioctl
531 の動作は、その特定のプログラムが 必要とした時には変更になる。
533 これらの ioctl を使ったプログラムは他のバージョンの UNIX との互換性が ないし、古いバージョンの Linux
534 では、走らない。さらに将来のバージョンの Linux では走らなくなるかも知れない。
538 \fBdumpkeys\fP(1), \fBkbd_mode\fP(1), \fBloadkeys\fP(1), \fBmknod\fP(1), \fBsetleds\fP(1),
539 \fBsetmetamode\fP(1), \fBexecve\fP(2), \fBfcntl\fP(2), \fBioperm\fP(2), \fBtermios\fP(3),
540 \fBconsole\fP(4), \fBconsole_codes\fP(4), \fBmt\fP(4), \fBsd\fP(4), \fBtty\fP(4),
541 \fBtty_ioctl\fP(4), \fBttyS\fP(4), \fBvcs\fP(4), \fBvcsa\fP(4), \fBcharsets\fP(7),
542 \fBmapscrn\fP(8), \fBresizecons\fP(8), \fBsetfont\fP(8)
544 \fI/usr/include/linux/kd.h\fP, \fI/usr/include/linux/vt.h\fP
546 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
547 である。プロジェクトの説明とバグ報告に関する情報は
548 http://www.kernel.org/doc/man\-pages/ に書かれている。