os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
doc/ja_JP.eucJP/man/man3/ncurses.3
Kazuo Horikawa cb5d1a9147 Replace jpman project specific RCS keyword with $FreeBSD. 
jpman project specific RCS keyword (jpman %Id) is obsolete,
after manual entries are stored in freefall CVS repository.
This old Id is useless and more worse it confuses users and bug reporters.
So, this old Id is removed.

Submitted by:jpman project <man-jp@jp.FreeBSD.org>
2001-05-14 01:10:24 +00:00

419 lines
17 KiB
Groff
Raw Blame History

.\" $FreeBSD$
.TH ncurses 3 ""
.ds n 5
.ds d @TERMINFO@
.SH 名称
\fBncurses\fR - CRT screen handling and optimization package
.SH 書式
\fB#include <ncurses.h>\fR
.br
.SH 解説
\fBncurses\fR ライブラリルーチンでは、端末に依存しない方法で、それなりに
最適化してキャラクタ画面を更新できます。
\fBncurses\fR ルーチンは、System V Release 4 UNIX の \fBcurses\fR(3)
ライブラリをエミュレートしますが、ソース形式で自由に再分配できます。
System V Release 4 UNIX の curses との違いについては、それぞれの
マニュアルページのバグセクションで説明します。違いは少ししかなく、
ncurses が発展するにつれ、違いは少なくなります。
このルーチンを使用しているプログラムは、\fB-lncurses\fR オプション、
または(生成された場合は) \fB-ldcurses\fR や \fB-lpcurses\fR などの
デバッグライブラリの 1 つを使用してリンクする必要があります。
dcurses ライブラリは、curses アクションを記述したトレースログを生成します。
pcurses ライブラリは、プロファイル化をサポートしています。
\fBncurses\fR パッケージでは、画面全体、ウィンドウ、パッドの操作、
ウィンドウとパッドへの出力、端末入力の読込み、端末、ncurses 入力と出力の
オプションの制御、環境クエリルーチン、カラー操作、ソフトラベルキーの使用、
terminfo 機能、低レベル \fBncurses\fR ルーチンへのアクセスがサポート
されています。
ルーチンを初期化するには、ルーチン \fBinitscr\fR か \fBnewterm\fR
を呼び出してから、ウィンドウと画面を処理するその他のルーチンを使用する
必要があります。終了前には、ルーチン \fBendwin\fR を呼び出してください。
エコーせずに 1 回に 1 キャラクタずつ入力するには (インタラクティブで
画面主導のほとんどのプログラムで必要)、以下のシーケンスを使用します。
\fBinitscr(); cbreak(); noecho();\fR
ほとんどのプログラムでは、以下のシーケンスも使用します。
\fBnonl(); intrflush(stdscr,FALSE); keypad(stdscr,TRUE);\fR
\fBncurses\fR プログラムを実行する前には、端末のタブストップを設定し、
定義されていれば初期化文字列を出力する必要があります。
これは、シェル環境変数 \fBTERM\fR をエクスポートした後でコマンド
\fBtput init\fR を実行すれば行なえます。
[詳細については、\fBterminfo\fR(\*n) を参照してください。]
\fBncurses\fR ライブラリでは、CRT 画面の全体か一部を表すキャラクタの
2 次元配列とみなせる、\fIwindows\fR というデータ構造を操作できます。
デフォルトウィンドウは \fBstdscr\fR というもので、サイズは端末画面のサイズ
になっています。その他のウィンドウは、\fBnewwin\fR で作成できます。
ウィンドウは、\fBWINDOW *\fR のように宣言した変数で参照します。
このデータ構造は、マニュアルセクション 3 のページで解説しているルーチン
(名前が「curs_」で始まるもの)で操作します。このうち最も基本的なルーチンは、
\fBmove\fR と \fBaddch\fRです。このルーチンの一般的なバージョンは、名前が
\fBw\fR で始まります。このバージョンではウィンドウを指定できます。
\fBw\fR で始まらないルーチンは \fBstdscr\fR に影響します。
ルーチンを使用してウィンドウを操作した後では \fBrefresh\fR が呼び出され、
ユーザの CRT 画面を \fBstdscr\fR のように表示する指示が \fBncurses\fR に
出されます。ウィンドウのキャラクタのタイプは実際には \fBchtype\fR
(キャラクタと属性データ)なので、
キャラクタのその他の情報もそれぞれのキャラクタとともに保存できます。
\fIパッド\fRという特殊なウィンドウも操作できます。パッドは画面のサイズに
制限されないウィンドウで、パッドの内容は完全に表示する必要がありません。
詳細については curs_pad(3) を参照してください。
キャラクタの画面への描画の他に、ビデオ属性とカラーもサポート
されているので、下線、リバースビデオ、カラーなどのモードで、このような
表示拡張機能をサポートしている端末にキャラクタを表示できます。ライン描画
キャラクタを出力するように指定することもできます。
\fBncurses\fR は、入力時にエスケープシーケンスを送信する矢印キーと
ファンクションキーを 1 つの値に変換できます。
ビデオ属性、ライン描画キャラクタ、入力値では、\fBA_REVERSE\fR、
\fBACS_HLINE\fR、\fBKEY_LEFT\fR のような、\fB<ncurses.h>\fR に定義された名前が
使用されます。
環境変数 \fBLINES\fR と \fBCOLUMNS\fR を設定した場合、またはウィンドウ環境で
プログラムを実行している場合、\fIterminfo\fR で読み込まれた情報は、環境の行と
カラムの情報で上書きされます。これは、画面のサイズを変更できる、
AT&T 630 レイヤなどで実行しているプログラムに影響します。
環境変数 \fBTERMINFO\fR を定義すると、\fBncurses\fR を使用しているプログラムは、
ローカルの端末定義をチェックしてから標準の場所にチェックインします。
たとえば \fBTERM\fR を \fBatt4424\fR に設定すると、
コンパイルされた端末定義は以下の場所で見つかります。
\fB\*d/a/att4424\fR
(\fBa\fR は、大きなディレクトリの作成を避けるために \fBatt4424\fR の
最初の文字をコピーしたものです。) しかし \fBTERMINFO\fR を
\fB$HOME/myterms\fR に設定すると、\fBncurses\fRは
以下の場所を最初にチェックします。
\fB$HOME/myterms/a/att4424\fR
チェックが失敗に終わると、次に以下をチェックします。
\fB\*d/a/att4424\fR
これは、試験用定義を開発している場合、または \fB\*d\fR の書込み権がない
場合に便利です。
整数変数 \fBLINES\fR と \fBCOLS\fR は、\fB<ncurses.h>\fRに定義されています。
この整数変数には、\fBinitscr\fR が画面のサイズに従って値を入力します。定数
\fBTRUE\fR と \fBFALSE\fR の値は、それぞれ \fB1\fR と \fB0\fR になっています。
\fBncurses\fR ルーチンは、\fBWINDOW *\fR 変数 \fBcurscr\fR も定義します。
この変数は、ごみを含む画面のクリアや再描画など、特定の低レベル操作で
使用します。\fBcurscr\fR は、少数のルーチンでしか使用されないでしょう。
.SS ルーチン名と引数名
多くの \fBncurses\fR ルーチンには複数のバージョンがあります。
\fBw\fR で始まるルーチンにはウィンドウ引数が必要です。
\fBp\fR で始まるルーチンにはパッド引数が必要です。
接頭語がないルーチンは、一般的に \fBstdscr\fR を使用します。
\fBmv\fR で始まるルーチンでは、移動先の \fIy\fR 座標と \fIx\fR 座標が
なければ、適切なアクションを実行できません。ルーチンが \fBmv\fR で
始まるということは、\fBmove\fR が呼び出されてから
別のルーチンが呼び出されるということです。
\fIy\fR 座標はウィンドウの行を、\fIx\fR 座標はカラムを常に表します。
左上は (1,1) ではなく常に (0,0) です。
\fBmvw\fR で始まるルーチンには、ウィンドウ引数と \fIx\fR 座標と
\fIy\fR 座標が必要です。ウィンドウ引数を指定してから座標を指定してください。
どのケースでも、\fIwin\fR は影響を受けるウィンドウで、
\fIpad\fR は影響を受けるパッドです。\fIwin\fR と \fIpad\fR は、
常に \fBWINDOW\fR 型のポインタです。
オプション設定ルーチンでは、値が \fBTRUE\fR か \fBFALSE\fR になっている
論理フラグ \fIbf\fR が必要です。 \fIbf\fR の型は常に \fBbool\fR です。
変数 \fIch\fR と \fIattrs\fR の型は常に \fBchtype\fR です。
型 \fBWINDOW\fR, \fBSCREEN\fR, \fBbool\fR, \fBchtype\fR は、
\fB<ncurses.h>\fR で定義されています。
\fBTERMINAL\fR 型は、\fB<term.h>\fR で定義されています。
その他すべての引数は整数です。
.SS ルーチン名インデックス
以下の表は、各 \fBncurses\fR ルーチン、およびその解説が載っている
マニュアルページの名前をまとめたものです。
.nf
\fBncurses\fR ルーチン名 マニュアルページ名
___________________________________________
addch curs_addch(3)
addchnstr curs_addchstr(3)
addchstr curs_addchstr(3)
addnstr curs_addstr(3)
addstr curs_addstr(3)
attroff curs_attr(3)
attron curs_attr(3)
attrset curs_attr(3)
baudrate curs_termattrs(3)
beep curs_beep(3)
bkgd curs_bkgd(3)
bkgdset curs_bkgd(3)
border curs_border(3)
box curs_border(3)
can_change_color curs_color(3)
cbreak curs_inopts(3)
clear curs_clear(3)
clearok curs_outopts(3)
clrtobot curs_clear(3)
clrtoeol curs_clear(3)
color_content curs_color(3)
copywin curs_overlay(3)
curs_set curs_kernel(3)
def_prog_mode curs_kernel(3)
def_shell_mode curs_kernel(3)
del_curterm curs_terminfo(\*n)
delay_output curs_util(3)
delch curs_delch(3)
deleteln curs_deleteln(3)
delscreen curs_initscr(3)
delwin curs_window(3)
derwin curs_window(3)
doupdate curs_refresh(3)
dupwin curs_window(3)
echo curs_inopts(3)
echochar curs_addch(3)
endwin curs_initscr(3)
erase curs_clear(3)
erasechar curs_termattrs(3)
filter curs_util(3)
flash curs_beep(3)
flushinp curs_util(3)
getbegyx curs_getyx(3)
getch curs_getch(3)
getmaxyx curs_getyx(3)
getparyx curs_getyx(3)
getstr curs_getstr(3)
getsyx curs_kernel(3)
getwin curs_util(3)
getyx curs_getyx(3)
halfdelay curs_inopts(3)
has_colors curs_color(3)
has_ic curs_termattrs(3)
has_il curs_termattrs(3)
hline curs_border(3)
idcok curs_outopts(3)
idlok curs_outopts(3)
immedok curs_outopts(3)
inch curs_inch(3)
inchnstr curs_inchstr(3)
inchstr curs_inchstr(3)
init_color curs_color(3)
init_pair curs_color(3)
initscr curs_initscr(3)
innstr curs_instr(3)
insch curs_insch(3)
insdelln curs_deleteln(3)
insertln curs_deleteln(3)
insnstr curs_insstr(3)
insstr curs_insstr(3)
instr curs_instr(3)
intrflush curs_inopts(3)
is_linetouched curs_touch(3)
is_wintouched curs_touch(3)
isendwin curs_initscr(3)
keyname curs_util(3)
keypad curs_inopts(3)
killchar curs_termattrs(3)
leaveok curs_outopts(3)
longname curs_termattrs(3)
meta curs_inopts(3)
move curs_move(3)
mvaddch curs_addch(3)
mvaddchnstr curs_addchstr(3)
mvaddchstr curs_addchstr(3)
mvaddnstr curs_addstr(3)
mvaddstr curs_addstr(3)
mvcur curs_terminfo(\*n)
mvdelch curs_delch(3)
mvderwin curs_window(3)
mvgetch curs_getch(3)
mvgetstr curs_getstr(3)
mvinch curs_inch(3)
mvinchnstr curs_inchstr(3)
mvinchstr curs_inchstr(3)
mvinnstr curs_instr(3)
mvinsch curs_insch(3)
mvinsnstr curs_insstr(3)
mvinsstr curs_insstr(3)
mvinstr curs_instr(3)
mvprintw curs_printw(3)
mvscanw curs_scanw(3)
mvwaddch curs_addch(3)
mvwaddchnstr curs_addchstr(3)
mvwaddchstr curs_addchstr(3)
mvwaddnstr curs_addstr(3)
mvwaddstr curs_addstr(3)
mvwdelch curs_delch(3)
mvwgetch curs_getch(3)
mvwgetstr curs_getstr(3)
mvwin curs_window(3)
mvwinch curs_inch(3)
mvwinchnstr curs_inchstr(3)
mvwinchstr curs_inchstr(3)
mvwinnstr curs_instr(3)
mvwinsch curs_insch(3)
mvwinsnstr curs_insstr(3)
mvwinsstr curs_insstr(3)
mvwinstr curs_instr(3)
mvwprintw curs_printw(3)
mvwscanw curs_scanw(3)
napms curs_kernel(3)
newpad curs_pad(3)
newterm curs_initscr(3)
newwin curs_window(3)
nl curs_outopts(3)
nocbreak curs_inopts(3)
nodelay curs_inopts(3)
noecho curs_inopts(3)
nonl curs_outopts(3)
noqiflush curs_inopts(3)
noraw curs_inopts(3)
notimeout curs_inopts(3)
overlay curs_overlay(3)
overwrite curs_overlay(3)
pair_content curs_color(3)
pechochar curs_pad(3)
pnoutrefresh curs_pad(3)
prefresh curs_pad(3)
printw curs_printw(3)
putp curs_terminfo(\*n)
putwin curs_util(3)
qiflush curs_inopts(3)
raw curs_inopts(3)
redrawwin curs_refresh(3)
refresh curs_refresh(3)
reset_prog_mode curs_kernel(3)
reset_shell_mode curs_kernel(3)
resetty curs_kernel(3)
restartterm curs_terminfo(\*n)
ripoffline curs_kernel(3)
savetty curs_kernel(3)
scanw curs_scanw(3)
scr_dump curs_scr_dmp(3)
scr_init curs_scr_dmp(3)
scr_restore curs_scr_dmp(3)
scr_set curs_scr_dmp(3)
scrl curs_scroll(3)
scroll curs_scroll(3)
scrollok curs_outopts(3)
set_curterm curs_terminfo(\*n)
set_term curs_initscr(3)
setscrreg curs_outopts(3)
setsyx curs_kernel(3)
setterm curs_terminfo(\*n)
setupterm curs_terminfo(\*n)
slk_attroff curs_slk(3)
slk_attron curs_slk(3)
slk_attrset curs_slk(3)
slk_clear curs_slk(3)
slk_init curs_slk(3)
slk_label curs_slk(3)
slk_noutrefresh curs_slk(3)
slk_refresh curs_slk(3)
slk_restore curs_slk(3)
slk_set curs_slk(3)
slk_touch curs_slk(3)
standend curs_attr(3)
standout curs_attr(3)
start_color curs_color(3)
subpad curs_pad(3)
subwin curs_window(3)
syncok curs_window(3)
termattrs curs_termattrs(3)
termname curs_termattrs(3)
tigetflag curs_terminfo(\*n)
tigetnum curs_terminfo(\*n)
tigetstr curs_terminfo(\*n)
timeout curs_inopts(3)
touchline curs_touch(3)
touchwin curs_touch(3)
tparm curs_terminfo(\*n)
tputs curs_terminfo(\*n)
typeahead curs_inopts(3)
unctrl curs_util(3)
ungetch curs_getch(3)
untouchwin curs_touch(3)
use_env curs_util(3)
vidattr curs_terminfo(\*n)
vidputs curs_terminfo(\*n)
vline curs_border(3)
vwprintw curs_printw(3)
vwscanw curs_scanw(3)
waddch curs_addch(3)
waddchnstr curs_addchstr(3)
waddchstr curs_addchstr(3)
waddnstr curs_addstr(3)
waddstr curs_addstr(3)
wattroff curs_attr(3)
wattron curs_attr(3)
wattrset curs_attr(3)
wbkgd curs_bkgd(3)
wbkgdset curs_bkgd(3)
wborder curs_border(3)
wclear curs_clear(3)
wclrtobot curs_clear(3)
wclrtoeol curs_clear(3)
wcursyncup curs_window(3)
wdelch curs_delch(3)
wdeleteln curs_deleteln(3)
wechochar curs_addch(3)
werase curs_clear(3)
wgetch curs_getch(3)
wgetnstr curs_getstr(3)
wgetstr curs_getstr(3)
whline curs_border(3)
winch curs_inch(3)
winchnstr curs_inchstr(3)
winchstr curs_inchstr(3)
winnstr curs_instr(3)
winsch curs_insch(3)
winsdelln curs_deleteln(3)
winsertln curs_deleteln(3)
winsnstr curs_insstr(3)
winsstr curs_insstr(3)
winstr curs_instr(3)
wmove curs_move(3)
wnoutrefresh curs_refresh(3)
wprintw curs_printw(3)
wredrawln curs_refresh(3)
wrefresh curs_refresh(3)
wscanw curs_scanw(3)
wscrl curs_scroll(3)
wsetscrreg curs_outopts(3)
wstandend curs_attr(3)
wstandout curs_attr(3)
wsyncdown curs_window(3)
wsyncup curs_window(3)
wtimeout curs_inopts(3)
wtouchln curs_touch(3)
wvline curs_border(3)
.fi
.SH 戻り値
ルーチンの解説で特記されていなければ、整数を戻すルーチンは、エラーが
発生した場合は \fBERR\fR を戻し、問題がない場合は \fBERR\fR 以外の
整数値を戻します。
\fBsetscrreg\fR, \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR,
\fBgetmaxyx\fR 以外のすべてのマクロは、\fBw\fR バージョンの値を戻します。
\fBsetscrreg\fR, \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR,
\fBgetmaxyx\fR の戻り値は定義されていません。(すなわち、
割り当てステートメントの右側では使用しないでください。)
ポインタを戻すルーチンは、エラーが発生すると \fBNULL\fR を戻します。
.SH 関連項目
ルーチンの詳細については、\fBterminfo\fR(5)、および名前が「curs_」で始まる
セクション 3 のページを参照してください。
.SH 注
ヘッダファイル \fB<ncurses.h>\fR を取り込むと、ヘッダファイル
\fB<stdio.h>\fR と \fB<unctrl.h>\fR が自動的に取り込まれます。
Reference in a new issue View git blame Copy permalink