名前

setterm - 端末の属性を設定する

書式

setterm [options]

説明

setterm は、指定された端末機能 (terminal capabilities) を呼び出すための文字列を標準出力に出力する。 その際、使用すべき文字列を見つけるために、 可能なかぎり terminfo を参照する。 もっとも、一部のオプション (以下で「仮想コンソール専用」と断り書きがあるもの) は、 terminfo(5) にある機能と対応していない。 その場合は、端末のタイプが "con" か "linux" ならば、指定された機能を PC Minix の仮想コンソールドライバーで呼び出すための文字列を出力する。 端末に実装されていないオプションは無視する。

オプション

引数にブール値 (on または off) を取るオプションは、デフォルトでは on になっている。

以下で 8-color と書いてあるところには、black, red, green, yellow, blue, magenta, cyan, white が使える。

16-color と書いてあるところには、8-colorgrey、それに bright を前に付けた red, green, yellow, blue, magenta, cyan, white が使える。

さまざまなカラーオプションは、 少なくとも仮想端末では、 それぞれ独立して設定できる。 ただし、複数のモード (たとえば、--underline--half-bright) を同時に設定したときの結果は、ハードウェア次第である。

任意指定の引数では、 オプションと引数の間にスペースではなく、 '=' (等号) が推奨される。 たとえば --option=argument とするものである。 setterm では、 次にオプション引数ではないものが現れても、 オプション引数として扱うこともできる。

--appcursorkeys on|off

カーソルキーアプリケーションモードをオンまたはオフにする。 オンの場合は、 カーソルキーを押したとき、 ESC [ A, ESC [ B などの代わりに、 ESC O A, ESC O B などが送出される。 それが vi ユーザーに対して引き起こしかねない問題については、Text-Terminal-HOWTO の「vi and Cursor-Keys」セクションを参照のこと。 仮想コンソール専用。

--append console_number

--dump と似ているが、既存のスナップショットファイルを上書きせず、その末尾に追記する。 --dump オプションが指定されていない場合にのみ効果がある。

--background 8-color|default

テキストの背景色を設定する。

--blank[=0-60|force|poke]

スクリーンが自動的に消灯されるまでの無活動時間を分単位で指定する (自動消灯には、使用できれば APM を使用する)。 引数を指定しない場合は、消灯状態を返す (どの vt が消灯されたかを返す。 消灯されていない vt については、0 を返す)。 仮想コンソール専用。

引数 force は、キーが押されても、スクリーンを消灯したままにする。

引数 poke は、スクリーンの消灯を解除する。

--bfreq[=number]

ベルの周波数をヘルツ (Hz) で指定する。 引数が指定されていない場合は、デフォルトの 0 になる。仮想コンソール専用。

--blength[=0-2000]

ベルの継続時間をミリ秒単位で設定する。引数が指定されていない場合は、デフォルトの 0 になる。仮想コンソール専用。

--blink on|off

点滅モードをオンまたはオフにする。 仮想コンソール以外では、--blink off にすると、(太字、半輝度、点滅、反転といった) 全ての属性がオフになる。

--bold on|off

太字 (高輝度) モードをオンまたはオフにする。仮想コンソール以外では、--bold off にすると (太字、半輝度、点滅、反転といった) 全ての属性がオフになる。

--clear[=all|rest]

引数なし、または引数 all が指定された場合は、clear(1) コマンドとまったく同じように、スクリーン全体をクリアしてカーソルをホームポジションに移動する。 引数 rest が指定された場合は、現在のカーソル位置からスクリーンの最下行までをクリアする。

--clrtabs[=tab1 tab2 tab3 ...]

指定された水平方向のカーソル位置にあるタブストップを解除する。 範囲は 1-160 である。 引数が指定されない場合は、全てのタブストップを解除する。 仮想コンソール専用。

--cursor on|off

端末のカーソルをオンまたはオフにする。

--default

端末のレンダリングオプションをデフォルト値に戻す。

--dump[=console_number]

番号で指定された仮想コンソールのスナップショットを --file オプションで指定されたファイルに書き出す。 ファイルの内容は上書きされる。 デフォルトのファイルは screen.dump である。 引数が指定されない場合は、現在使用中の仮想コンソールをダンプする。 このオプションは、--append を無効にする。

--file filename

同じコマンドライン上に --dump--append オプションがある場合に、それに使うスナップショットファイルの名前を設定する。 このオプションが指定されない場合、デフォルトのファイル名はカレントディレクトリの screen.dump である。システムの規定する長さの上限を越えたパス名は、切り詰められる。 linux/limits.hPATH_MAX の値を参照すること。

--foreground 8-color|default

テキストの前景色を設定する。

--half-bright on|off

減光 (半輝度) モードをオンまたはオフにする。 仮想コンソール以外では、--half-bright off にすると、(太字、半輝度、点滅、反転といった) 全ての属性がオフになる。

--hbcolor [bright] 16-color

半輝度の文字の色を設定する。

--initialize

端末の初期化文字列を出力する。 通常、それは、端末のレンダリングオプションを設定し、その他の属性をデフォルトの値にする。

--inversescreen on|off

スクリーン全体で前景色と背景色を入れ換える。

--linewrap on|off

行がいっぱいになったとき、端末上の表示を次の行に続けるか否かを設定する。

--msg on|off

カーネルの printk() によるメッセージをコンソールに送出するか否かを設定する。 仮想コンソール専用。

--msglevel 0-8

カーネルの printk() によるメッセージに対する、コンソールのロギングレベルを設定する。 ここで設定したレベルよりも高い重大度を持つ (等しいレベルは含まない) 全てのメッセージが、 コンソールに表示されることになる。 したがって、 ロギングレベルを 8 に設定すると、全てのカーネルメッセージが表示される。 なお、ロギングレベル 0--msg on と同じ効果がある。 カーネルメッセージのロギングのインターフェースとしては、 klogd(8) の方が使いやすいかもしれない。

仮想コンソール専用。

--powerdown[=0-60]

VESA パワーダウンまでの時間を分単位で設定する。 引数を指定しない場合は、デフォルトの 0 になる (すなわち、パワーダウンを行わない)。 この時間が経過すると、 コンソールが消灯している場合は vsync サスペンドモードになり、モニターがサスペンドモードの場合はパワーダウンモードになる。

--powersave mode

以下の値が mode に指定できる。

vsync|on

モニターを VESA vsync サスペンドモードにする。

hsync

モニターを VESA hsync サスペンドモードにする。

powerdown

モニターを VESA パワーダウンモードにする。

off

モニターの VESA パワーセーブ機能をオフにする。

--regtabs[=1-160]

全てのタブストップを解除して、 通常のタブストップパターンを設定する。 タブ位置は、 指定した数値ごとに置かれる。 引数を指定しない場合は、 デフォルトの 8 が使用される。 仮想コンソール専用。

--repeat on|off

キーボードリピートをオンまたはオフにする。 仮想コンソール専用。

--reset

端末リセット文字列を出力する。通常、それは、端末を起動時の状態にリセットする。

--resize

行と列の最大の大きさを見積もって、端末のサイズをリセットする。 これは、実際の大きさとカーネルの端末ドライバーがうまく噛み合っていないとき、役に立つ。 特筆すべき使用例は、 シリアルコンソールにおける場合である。 そこでは ioctl(3p) を使わず、 バイトストリームとブレークのみを使用している。

--reverse on|off

ビデオの反転モードをオンまたはオフにする。 仮想コンソール以外では、--reverse off にすると、 (太字、半輝度、点滅、反転といった) 全ての属性がオフになる。

--store

端末の現在のレンダリングオプション (前景色と背景色) を、 デフォルトにリセットする際に使用する値として保存する。 仮想コンソール専用。

--tabs[=tab1 tab2 tab3 ...]

指定された水平方向のカーソル位置にタブストップを設定する。 範囲は 1-160 である。 引数を指定しない場合は、 現在のタブストップの設定を表示する。

--term terminal_name

環境変数 TERM を上書きする。

--ulcolor [bright] 16-color

下線を引く文字の色を設定する。 仮想コンソール専用。

--underline on|off

下線モードをオンまたはオフにする。

-h, --help

ヘルプを表示して終了する。

-V, --version

バージョンを表示して終了する。

互換性

バージョン 2.25 以来、setterm は、昔からのハイフン 1 つの長いオプション (たとえば -help) に加えて、ハイフン 2 つの長いオプション (たとえば --help) をサポートしている。 スクリプト内では、 後方互換のため、 ハイフン 2 つよりハイフン 1 つを使う方がよい。 現在のところ、 ハイフン 1 つの互換性を止める計画はなく、 またそうする正当な理由もない。

バグ

Minix 版と Linux 版の違いが、この文書には書かれていない。

関連項目

stty(1), tput(1), tty(4), terminfo(5)

バグ報告

バグ報告は、 以下にある issue トラッカーを利用すること。 <https://github.com/util-linux/util-linux/issues>.

入手方法

setterm コマンドは util-linux パッケージの一部であり、 以下からダウンロードできる。 Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/>.