.\" Copyright 1990 Gordon Irlam (gordoni@cs.ua.oz.au)
.\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
.\" Most of this was copied from the source code.
.\" Do not restrict distribution.
.\" May be distributed under the GNU General Public License
.\"
.\" Most options documented by Colin Watson (cjw44@cam.ac.uk)
.\" Undocumented: -snow, -softscroll, -standout; these are
.\" commented out in the source
.\"
.\" Japanese Version Copyright (c) 2001-2004 Yuichi SATO
.\"         all rights reserved.
.\" Translated Sun Feb 11 00:25:28 JST 2001
.\"         by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
.\" Updated & Modified Sat May  1 17:54:48 JST 2004
.\"         by Yuchis SATO <ysato444@yahoo.co.jp>
.\"
.\"WORD:	terminal	端末
.\"WORD:	virtual		仮想
.\"WORD:	extra bright	高輝度
.\"WORD:	half-brigtness	半輝度
.\"WORD:	blink		点滅
.\"WORD:	extra bright	高輝度
.\"WORD:	dim		薄暗色
.\"WORD:	foreground	前景
.\"WORD:	background	背景
.\"WORD:	line-wrapping	行の折り返し
.\"
.TH SETTERM 1 "7 January 2000" "Util-Linux 2.10" "Linux Programmer's Manual"
.SH 名前
setterm \- 端末の属性を設定する
.SH 書式
.nf
.BR "setterm " [ options ]
.fi
.SH 説明
.B setterm
は指定した端末の機能を呼び出す文字列を標準出力に書き出す。
このとき、使用する文字列を見付けるために
.I terminfo
が参照される。
しかし、(以下で「仮想コンソールのみ」とマークされた)
いくつかのオプションは、
.BR terminfo (5)
の機能に対応しない。
この際、端末タイプが "con" または "linux" であると、
指定された機能を PC Minix の仮想コンソールドライバ上で
呼び出すための文字列が出力される。
端末で実装されていないオプションは無視される。
.SH オプション
ブール値のオプション (\fBon\fP または \fBoff\fP) では、
デフォルトは \fBon\fP である。
.P
簡単に表すため、
\fBblack\fP, \fBred\fP, \fBgreen\fP, \fByellow\fP, 
\fBblue\fP, \fBmagenta\fP, \fBcyan\fP, \fBwhite\fP
を以下では \fI8-color\fP とする。
.P
\fI8-color\fP と \fBgrey\fP と
\fBbright red\fP, \fBbright green\fP, \fBbright yellow\fP,
\fBbright blue\fP, \fBbright magenta\fP, \fBbright cyan\fP, \fBbright white\fP
を \fI16-color\fP とする。
.P
様々な色オプションが、少なくとも仮想コンソールでは、独立に設定できる。
しかし、マルチモード (例えば、
.BR \-underline " や " \-half-bright )
の設定の結果は、ハードウェア依存である。
.TP
.BR \-term " terminal_name"
環境変数 TERM を上書きする。
.TP
.B \-reset
端末リセット文字列を表示する。
通常は、端末をパワーオンの状態にリセットする。
.TP
.B \-initialize
端末の初期化文字列を表示する。
通常は、端末のレンダリングオプションを設定し、
その他の属性をデフォルト値に設定する。
.TP
.BR \-cursor " [" on | off ]
端末のカーソルを on または off にする。
.TP
.BR \-repeat " [" on | off "] (仮想コンソールのみ)"
キーボードリピートを on または off にする。
.TP
.BR \-appcursorkeys " [" on | off "] (仮想コンソールのみ)"
カーソルキーアプリケーションモードを on または off に設定する。
on の場合、ESC [ A, ESC [ B などではなく、
ESC O A, ESC O B などがカーソルキーとして送信される。
vi ユーザーに対してこれがどのような問題を引き起こすかについては、
Text-Terminal-HOWTO の "vi とカーソルキー" のセクションを参照すること。
.TP
.BR \-linewrap " [" on | off "] (仮想コンソールのみ)"
自動的な行の折り返しを on または off にする。
.TP
.B \-default
端末のレンダリングオプションをデフォルトの値に設定する。
.TP
\fB\-foreground\fP \fI8-color\fP|\fBdefault\fP (仮想コンソールのみ)
テキストの前景色を設定する。
.TP
\fB\-background\fP \fI8-color\fP|\fBdefault\fP (仮想コンソールのみ)
テキストの背景色を設定する。
.TP
\fB\-ulcolor\fP \fI16-color\fP (仮想コンソールのみ)
下線文字の色を設定する。
.TP
\fB\-hbcolor\fP \fI16-color\fP (仮想コンソールのみ)
半輝度文字の色を設定する。
.TP
.BR \-inversescreen " [" on | off "] (仮想コンソールのみ)"
スクリーンの色を反転させる。
前景色と背景色を入れ換える。
同様にして、下線文字と半輝度文字も色を反転する。
.TP
.BR \-bold " [" on | off ]
太字 (高輝度) モードを on または off にする。
仮想コンソールの場合は例外であるが、
\fB\-bold off\fP により (太字・半輝度・点滅・反転といった)
全ての属性が off にされる。
.TP
.BR \-half-bright " [" on | off ]
薄暗色 (半輝度) モードを on または off にする
(\fB\-hbcolor\fP を参照すること)。
仮想コンソールの場合は例外であるが、
\fB\-half-bright off\fP により (太字・半輝度・点滅・反転といった)
全ての属性が off にされる。
.TP
.BR \-blink " [" on | off ]
点滅モードを on または off にする。
仮想コンソールの場合は例外であるが、
\fB\-blink off\fP により (太字・半輝度・点滅・反転といった)
全ての属性が off にされる。
.TP
.BR \-reverse " [" on | off ]
反転モードを on または off にする。
仮想コンソールの場合は例外であるが、
\fB\-reverse off\fP により (太字・半輝度・点滅・反転といった)
全ての属性が off にされる。
.TP
.BR \-underline " [" on | off ]
下線モードを on または off にする (\fB\-ulcolor\fP を参照すること)。
.TP
.BR \-store " (仮想コンソールのみ)"
端末の現在のレンダリングオプション (前景色と背景色) を、
デフォルトにリセットする際に使用される値として保存する。
.TP
.BR \-clear " [" all ]
.BR clear (1)
と同じように、スクリーンをクリアしてカーソルをホームポジションに移動する。
.TP
.B \-clear rest
現在のカーソル位置からスクリーンの最下行までをクリアする。
.TP
.BR \-tabs " [tab1 tab2 tab3 ...] (仮想コンソールのみ)"
指定された水平方向のカーソル位置にタブストップを設定する。
範囲は 1 〜 160 である。
引き数が指定されない場合、現在のタブストップの設定を表示する。
.TP
.BR \-clrtabs " [tab1 tab2 tab3 ...] (仮想コンソールのみ)"
指定された水平方向のカーソル位置のタブストップを解除する。
範囲は 1 〜 160 である。
引き数が指定されない場合、全てのタブストップを解除する。
.TP
.BR \-regtabs " [1-160] (仮想コンソールのみ)"
全てのタブストップを解除し、通常のタブストップパターンを設定する。
指定した数値の位置ごとにタブが置かれる。
引き数が指定されない場合、デフォルトは 8 である。
.TP
.BR \-blank " [0-60] (仮想コンソールのみ)"
(APM が使用できる場合に) スクリーンが自動的に消灯されるまでの
無活動時間を分単位で指定する。
引き数が指定されない場合、デフォルトは 0 である
(コンソールの消灯は無効である)。
.TP
.BR \-dump " [1-NR_CONS]"
指定された仮想コンソールのスナップショットを (属性とともに)
\fB\-file\fP オプションで指定されたファイルに書き込む。
ファイルの内容は上書きされる。
デフォルトのファイルは screen.dump である。
引き数が指定されない場合、現在の仮想コンソールをダンプする。
\fB\-append\fP より優先される。
.TP
.BR \-append " [1-NR_CONS]"
\fB\-dump\fP と似ているが、スナップショットファイルを上書きせずに追加する。
\fB\-dump\fP オプションが指定されていない場合にのみ機能する。
.TP
.BR \-file " dumpfilename"
\fB\-dump\fP または \fB\-append\fP オプションで使う
スナップショットファイルを同じコマンドライン上で設定する。
このオプションが指定されない場合、
デフォルトはカレントディレクトリの screen.dump である。
.TP
.BR \-msg " [" on | off "] (仮想コンソールのみ)"
カーネル \fBprintk()\fP メッセージを
コンソールに送信するか否かを設定する。
.TP
.BR \-msglevel " 1-8 (仮想コンソールのみ)"
カーネル \fBprintk()\fP メッセージのログ記録レベルを設定する。
ここで指定された以上の重要度である全てのメッセージが表示される。
よって、ログ記録レベル 0 は \fB\-msg on\fP と同じ効果がある。
また、ログ記録レベル 8 では全てのカーネルメッセージを表示する。
.BR klogd (8)
はカーネルメッセージをログに記録するための
さらに使いやすいインターフェースである。
.TP
.BR "\-powersave on" | vsync
モニタを VESA vsync サスペンドモードにする。
.TP
.B \-powersave hsync
モニタを VESA hsync サスペンドモードにする。
.TP
.B \-powersave powerdown
モニタを VESA パワーダウンモードにする。
.TP
.BR \-powersave " [" off "]"
モニタの VESA パワーセーブ機能を off にする。
.TP
.BR \-powerdown " [0-60]"
VESA パワーダウンまでの時間を分単位で設定する。
引き数が指定されない場合、デフォルトは 0 である (パワーダウンは行われない)。
この時間が経過すると、
コンソールが消灯している場合は垂直同期サスペンドモードになり、
モニタがサスペンドモードの場合はパワーダウンモードになる。
.TP
.BR \-blength " [0-2000]"
ベルの継続時間をミリ秒単位で設定する。
引き数が指定されない場合、デフォルトは 0 である。
.TP
.BR \-bfreq " [freqnumber]"
ベルの周波数をヘルツ (Hz) で指定する。
引き数が指定されない場合、デフォルトは 0 である。
.SH 関連項目
.BR tput (1),
.BR stty (1),
.BR terminfo (5),
.BR tty (4)
.SH バグ
Minix 版と Linux 版の違いが、この文書には書かれていない。