日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
curs_terminfo(3X) curs_terminfo(3X)
名称
del_curterm, mvcur, putp, restartterm, set_curterm, setterm, setupterm,
tigetflag, tigetnum, tigetstr, tiparm, tparm, tputs, vid_attr,
vid_puts, vidattr, vidputs - terminfo データベースへの curses インタ
フェース
書式
#include <curses.h>
#include <term.h>
int setupterm(char *term, int fildes, int *errret);
int setterm(char *term);
TERMINAL *set_curterm(TERMINAL *nterm);
int del_curterm(TERMINAL *oterm);
int restartterm(char *term, int fildes, int *errret);
char *tparm(char *str, ...);
int tputs(const char *str, int affcnt, int (*putc)(int));
int putp(const char *str);
int vidputs(chtype attrs, int (*putc)(int));
int vidattr(chtype attrs);
int vid_puts(attr_t attrs, short pair, void *opts, int (*putc)(int));
int vid_attr(attr_t attrs, short pair, void *opts);
int mvcur(int oldrow, int oldcol, int newrow, int newcol);
int tigetflag(char *capname);
int tigetnum(char *capname);
char *tigetstr(char *capname);
char *tiparm(const char *str, ...);
解説
これらのローレベルのルーチンは、プログラミングファンクションキーのよう
なある端末のケーパビリティを操作するために terminfo データベースを直接
取り扱わなければならないプログラムによって呼び出さなければなりません。
他のすべての機能性については、curses ルーチンがより適切で、また、それら
を使用することを勧めます。
初期設定
最初に、setupterm が呼ばれるべきです。setupterm は、initscr と newterm
によって自動的に呼ばれることに注意してください。これは、[terminfo(5) に
リストされた] 端末従属変数の集合を定義します。
各初期設定ルーチンは、直接 (ヘッダ定義によって) または特別の関数によっ
て端末ケーパビリティがあるアプリケーションを提供します。ヘッダファイル
curses.h と term.h は、これらの文字列、数値とフラグのための定義を取得す
るために (この順序で) 含まれているべきです。
terminfo 変数 lines と columns は、setupterm によって、次のように初期化
されます:
• use_env(FALSE) が呼び出されたなら、terminfo の中で指定された lines
と columns のための値が使用されます。
• そうでなければ、環境変数 LINES と COLUMNS が存在するなら、それらの
値が使用されます。これらの環境変数が存在せず、プログラムがウィンド
ウの中で走っている場合、現在のウィンドウサイズが使用されます。そう
でなければ、環境変数が存在しない場合、terminfo データベースの中で
指定された lines および columns のために値が使用されます。
パラメータ化された文字列は、それらを具体化するために tparm を通して渡さ
れるべきです。すべての terminfo 文字列 [tparm の出力を含んで] は、tputs
または putp で印刷 (表示) されるべきです。終了する前に tty モードを復旧
するために reset_shell_mode を呼び出します [curs_kernel(3X) 参照]。
カーソルアドレシングを使用するプログラムは、次のようにするべきです。
• 開始時に enter_ca_mode を出力するべきであり、そして、
• 終了する前に exit_ca_mode を出力するべきです。
シェルサブプロセスを実行するプログラムは、次のようにするべきです。
• シェルが呼び出される前に、reset_shell_mode を呼び出し、exit_ca_mode
を出力します、そして、
• シェルから返った後に、enter_ca_mode を出力して、reset_prog_mode を
呼び出します。
setupterm ルーチンは、terminfo データベースを読み込み、terminfo 構造体
を初期化しますが、curses によって使用される出力仮想化構造体を設定しませ
ん。端末のタイプは、文字列 term です。term が NULL の場合、環境変数
TERM が使用されます。すべての出力は、出力のために初期化されるファイル記
述子 fildes に行なわれます。errret が NULL でない場合、setupterm は、OK
か ERR を返し、errret で指される整数にステータス値を格納します。errret
の中の 1 のステータスと結合された OK の返り値は、正常です。ERR が返され
る場合は、次の errret を検査してください。
1 端末は、ハードコピーで、curses アプリケーションのために使用できな
いことを意味します。
setupterm は、エントリが hc (hardcopy) ケーパビリティのチェックに
よって、ハードコピーのタイプかどうか判断します。
0 端末を見つけることができないか、curses アプリケーションを走らせる
ためにあまりにもわずかの情報しかない、ジェネリックタイプであること
を意味します。
setupterm は、エントリが gn (generic) ケーパビリティのチェックに
よって一般的なタイプかどうか判断します。
-1 terminfo データベースを見つけることができないことを意味します。
errret が NULL の場合、setupterm は、エラーが見つかったならエラーメッ
セージを印刷して終了します。したがって、最も単純な呼び出しは、次の通り
です。
setupterm((char *)0, 1, (int *)0);
これは、すべてデフォルトを使用し、出力を stdout に送ります。
setterm ルーチンは、setupterm によって置き換えられました。次の呼び出
し、
setupterm(term, 1, (int *)0)
は、setterm(term) と同じ機能を提供します。setterm ルーチンは、BSD 互換
性のために提供され、新しいプログラムに推薦されません。
端末状態
setupterm ルーチンは、グローバル変数 cur_term によって指される TERMINAL
構造体の端末に関する情報を格納します。それがエラーを検出するか、端末が
不適当である (ハードコピーまたは一般的) と決定するなら、それは、アプリ
ケーションに利用可能でないとマークして、この情報を廃棄します。
setupterm が同じ端末タイプに対して繰り返し呼び出されるなら、それは、情
報を再使用します。それは、メモリで与えられた端末のケーパビリティのたっ
た 1 つのコピーを保守します。それが異なる端末タイプに対して呼び出される
なら、setupterm は、端末のケーパビリティの各セットのために新しい記憶域
を割り付けます。
set_curterm ルーチンは、cur_term を nterm に設定し、terminfo をすべての
ブール値、数値、と文字列変数は、nterm からの値を使用するようにします。
それは、cur_term の古い値を返します。
del_curterm ルーチンは、oterm によって指される空間を解放し、それを将来
の使用のために利用可能にします。oterm が cur_term と同じである場合、
terminfo のブール値、数値および文字列変数のいずれかの参照は、その後、別
の setupterm が呼ばれるまで、無効のメモリ位置を参照するかもしれません。
restartterm ルーチンは、前の状態 (例えば、コアイメージダンプとして保存
されたゲームを再ロードするとき) にメモリを戻した後に、それが呼び出され
ることを除いて、setupterm と initscr に似ています。restartterm は、ウィ
ンドウと入力と出力のオプションがメモリが保存されたときと同じであると仮
定しますが、端末タイプとボーレートは、異なるかもしれません。従って、
restartterm は、様々な tty 状態ビットを保存し、setupterm を呼び出し、次
に、ビットを復旧します。
書式設定出力
tparm ルーチンは、パラメータ pi で文字列 str を具体化します。ポインタ
は、適用されたパラメータで str の結果に返されます。
tiparm は、固定のパラメータリストではなく <stdarg.h> を使用する tparm
のより新しい形式です。その数値パラメータは、long ではなく、整数 (int)
です。
出力関数
tputs ルーチンは、文字列 str にパディング情報を適用し、それを出力しま
す。str は、terminfo 文字列変数か tparm、tgetstr または tgoto からの返
り値でなければなりません。適用可能でない場合、affcnt は、影響を受けた行
の数、または 1 です。putc は、一度に 1 つ文字が渡される putchar に似た
ルーチンです。
putp ルーチンは、tputs(str, 1, putchar) を呼びます。putp の出力は、常に
stdout に行き、setupterm で指定された fildes でないことに注意してくださ
い。
vidputs ルーチンは、curses(3X) にリストされた属性の任意の組み合わせであ
る、ビデオ属性モード attrs で端末に文字列を表示します。文字は、putchar
に似たルーチン putc に渡されます。
vidattr ルーチンは、それを putchar を通して出力することを除いて、
vidputs ルーチンに似ています。
vid_attr と vid_puts ルーチンは、それぞれ vidattr と vidputs に対応して
います。それは、ビデオ属性と色を表すために 1 組の引数を使用します。すな
わち、属性のためのタイプ attr_t の 1 つと color_pair 番号のための short
の 1 つです。vid_attr と vid_puts ルーチンは、WA_ 接頭語がある属性定数
を使用するように設計されています。opts 引数は、今後の使用のために予約さ
れています。現在、アプリケーションは、その引数のために NULL ポインタを
供給しなければなりません。
mvcur ルーチンは、ローレベルのカーソル動作を提供します。それは、(次の
refresh ではなく) 直ちに効果を現わします。
端末ケーパビリティ関数
tigetflag、tigetnum と tigetstr ルーチンは、xenl のようにそれらに渡され
た terminfo capname に対応するケーパビリティの値を返します。各ケーパビ
リティのための capname は、terminfo(5) のケーパビリティセクションの
capname コードとタイトルが付けられたテーブルカラムで与えられます。
これらのルーチンは、エラーを表示するために特別の値を返します。
tigetflag ルーチンは、次で、返ります。
-1 capname がブール値のケーパビリティでないなら、または
0 それが取り消されるか、または端末の記述が存在しない場合。
tigetnum ルーチンは、次で、返ります。
-2 capname が数値のケーパビリティでないなら、または
-1 それが取り消されるか、または端末の記述が存在しない場合。
tigetstr ルーチンは、次で、返ります。
(char *)-1
capname が文字列のケーパビリティでないなら、または
0 それが取り消されるか、または端末の記述が存在しない場合。
端末ケーパビリティ名
これらの null で終了する配列は、事前に定義された terminfo 変数の各々の
ための、短い terminfo 名 ("codes")、termcap 名、と長い terminfo 名
("fnames") を含んでいます:
char *boolnames[], *boolcodes[], *boolfnames[]
char *numnames[], *numcodes[], *numfnames[]
char *strnames[], *strcodes[], *strfnames[]
戻り値
整数を返すルーチンは、失敗すると ERR を返します。前のルーチンの記述で他
の注意がない場合、成功して終了すれば、OK (SVr4 は、"ERR 以外の整数値"
とだけ明記されています) を返します。
ポインタを返すルーチンは、エラーの場合、常に NULL を返します。
X/Open は、エラー条件を定義しません。この実行では、
del_curterm
端末パラメータが NULL であるなら、エラーを返します。
putp tputs を呼び出し、同じエラーコードを返します。
restartterm
setupterm への関連する呼び出しがエラーを返すなら、エラーを返
します。
setupterm
十分なメモリを割り付けることができないか、または初期ウィンド
ウ (stdscr、curscr、newscr) を作成することができないなら、エ
ラーを返します。他のエラー条件は、上に文書化されています。
tputs
文字列パラメータが NULL であるなら、エラーを返します。I/O を
検出しません: X/Open は、tputs が出力関数 putc の返り値を無視
すると記載しています。
移植性
X/Open は、vidattr と vidputs がマクロであると記述しています。
関数 setterm は、X/Open に記述されず、移植性がないと見なされます。他の
すべての関数は、X/Open に記述されています。
setupterm は、端末名を配列 ttytype にコピーします。これは、X/Open
Curses の一部ではありませんが、いくつかのアプリケーションでは、当然と思
われています。
端末ドライバを使用するように設定されるなら、例えば、MinGW ポートのため
に
• setupterm は、特別の値 "unknown" として失われた/空の TERM 変数を解
釈します。
• setupterm は、$TERM が "#win32con" に設定されるか、またはその文字列
の省略をチェックすることによって、ウィンドウのコンソールドライバの
使用を明示的な使用を許可します。
ncurses の古いバージョンは、initscr または newterm からの setupterm に
渡されたファイル記述子がバッファリング I/O を使用し、対応するストリーム
に書き込むと仮定していました。端末が (SystemV curses のように) 終了時に
ブロック単位でバッファリングされるモードで残される制限に加えて、ncurses
が SIGTSTP を受信するとき、クリーンアップする信頼できる方法を許可しな
かったので、それは、問題でした。現在のバージョンは、ncurses によって直
接管理された出力バッファを使用します。このマニュアルページに記述された
低レベルの関数のいくつかは、標準出力に書き込まれます。それらは、シグナ
ル-セーフではありません。ncurses の高レベル関数は、より信頼できるバッ
ファリングスキームを使用して、これらの関数の代わりのバージョンを使用し
ます。
System V Release 4 では、set_curterm は、int リターンタイプを持ってお
り、OK または ERR を返します。私たちは、X/Open Curses 動作を実装するこ
とに決めました。
System V Release 4 では、tputs の第 3 引数タイプは、タイプ int
(*putc)(char) を持っています。
X/Open Curses (Solaris) の少なくとも 1 つの実装は、tputs から OK/ERR 以
外の値を返します。それは、文字列の長さを返して、エラーのチェックを行い
ません。
X/Open Curses は、可変引数リストではなく、固定の数のパラメータの tparm
プロトタイプとなっています。この実装は、可変引数リストを使用しますが、
固定のパラメータリストを使用するように設定することができます。移植性の
あるアプリケーションは、形式の後に 9 つのパラメータを用意するべきです。
0 は、この目的のためによいでしょう。
Thomas E. Dickey によるコメントに応えて、X/Open Curses Issue 7 は、2009
年中頃に tiparm 関数を提案しました。
X/Open は、mvcur を呼び出した後 curses の状態は、実際のターミナルの状態
と一致してはならない、そしてアプリケーションは、通常の curses 呼び出し
を再開する前に、ウィンドウを touch および refresh するべきと注記してい
ます。ncurses と System V Release 4 curses の両方は、initscr または
newterm のいずれかで割り付けられた SCREEN データを使用して mvcur を実装
しています。したがって、それは、terminfo 関数として文書化されますが、
mvcur は、実際に、はっきりと明記されていない curses 関数です。
X/Open は、古い位置を mvcur に与えなければならないと記述しています。こ
の実装では、呼び出し側は、古い座標に -1 を使用することができます。その
場合には、古い位置は、未知です。
他の実装は、ケーパビリティの名前の配列を宣言していないかもしれません。
いくつかは、それらを宣言せずに、それらを提供しています。X/Open は、それ
らを明記していません。
例えば、tic -x によって定義されるような、拡張された端末のケーパビリティ
名は、ここで説明される配列に格納されません。
関連項目
curses(3X), curs_initscr(3X), curs_kernel(3X), curs_termcap(3X),
curs_variables(3X), term_variables(3X), putc(3), terminfo(5)
curs_terminfo(3X)