.\" Copyright 1990 Gordon Irlam (gordoni@cs.ua.oz.au)
.\" Copyright 1992 Rickard E. Faith (faith@cs.unc.edu)
.\" Copyright 2000 Colin Watson (cjw44@cam.ac.uk)
.\" Do not restrict distribution.
.\" May be distributed under the GNU General Public License
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" Japanese Version Copyright (c) 2001-2021 Yuichi SATO
.\"         and 2021 Yoichi Chonan,
.\"         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>
.\" Updated & Modified (util-linux 2.36) Sun Feb 21 09:42:44 JST 2021
.\"         by Yuchis SATO <ysato444@ybb.ne.jp>
.\"         and Yoichi Chonan <cyoichi@maple.ocn.ne.jp>
.\"
.\" WORD:        extra bright    高輝度
.\" WORD:        half-brigtness  半輝度
.\" WORD:        blink           点滅
.\" WORD:        dim             減光
.\"
.TH SETTERM 1 "May 2014" util\-linux "User Commands"
.SH 名前
setterm \- 端末の属性を設定する
.SH 書式
\fBsetterm\fP [options]
.SH 説明
\fBsetterm\fP は、指定された端末機能 (terminal capabilities)
を呼び出すための文字列を標準出力に出力する。
その際、使用すべき文字列を見つけるために、
可能なかぎり \fIterminfo\fP を参照する。もっとも、一部のオプション
(以下で「仮想コンソール専用」と断り書きがあるもの) は、\fBterminfo\fP(5)
にある機能と対応していない。その場合は、端末のタイプが
"con" か "linux" ならば、指定された機能を PC Minix
の仮想コンソールドライバで呼び出すための文字列を出力する。
端末に実装されていないオプションは、無視する。
.SH オプション
引き数にブール値 (\fBon\fP または \fBoff\fP) を取るオプションは、デフォルトでは
\fBon\fP になっている (訳注: 現在では、デフォルトが \fBon\fP のものも \fBoff\fP
のものもある。たとえば、\fB\-\-bold\fP のデフォルトは、たぶん \fBoff\fP である)。
.P
以下で \fI8\-color\fP と書いてあるところには、\fBblack\fP, \fBred\fP, \fBgreen\fP,
\fByellow\fP, \fBblue\fP, \fBmagenta\fP, \fBcyan\fP, \fBwhite\fP が使える。
.P
\fI16\-color\fP と書いてあるところには、\fI8\-color\fP と \fBgrey\fP、それに
\fBbright\fP を前に付けた  \fBred\fP, \fBgreen\fP, \fByellow\fP, \fBblue\fP,
\fBmagenta\fP, \fBcyan\fP, \fBwhite\fP が使える。
.P
様々なカラーオプションは、少なくとも仮想端末では、それぞれ独立して設定できる。
ただし、複数のモード (たとえば、\fB\-\-underline\fP と \fB\-\-half\-bright\fP)
を同時に設定したときの結果は、ハードウェア次第である。
.PP
指定するかしないかが任意の引き数では、オプションと引き数の間にスペースではなく、'='
(等号) が必要である。たとえば、\-\-option=argument のように
(訳注：実際のところ、util\-linux 2.36 では、\fB\-\-clear\fP
のような例外もあるが、たいていの場合スペースも使える)。
.TP 
\fB\-\-appcursorkeys\fP on|off
カーソルキーアプリケーションモードを on または off にする。on
の場合は、カーソルキーを押したとき、ESC [ A, ESC [ B
などの代わりに、ESC O A, ESC O B などが送出される。それが \fBvi\fP
ユーザーに対して引き起こしかねない問題については、\fIText\-Terminal\-HOWTO\fP
の「vi and Cursor\-Keys」セクションをご覧いただきたい。仮想コンソール専用。
.TP 
\fB\-\-append\fP \fIconsole_number\fP
\fB\-\-dump\fP と似ているが、既存のスナップショットファイルを上書きせず、その末尾に追記する。
\fB\-\-dump\fP オプションが指定されていない場合にのみ効果がある。
.TP 
\fB\-\-background\fP \fI8\-color\fP|default
テキストの背景色を設定する。
.TP 
\fB\-\-blank\fP[=0\-60|force|poke]
スクリーンが自動的に消灯されるまでの無活動時間を分単位で指定する
(自動消灯には、使用できれば APM
を使用する)。引き数を指定しない場合は、消灯状態を返す
(どの vt が消灯されたかを返す。消灯されていない vt については、0
を返す)。仮想コンソール専用。
.sp
引き数 \fBforce\fP は、キーが押されても、スクリーンを消灯したままにする。
(訳注: \fB\-\-blank\fP=force を指定すると、仮想コンソールは即座に消灯する。
そして、どのキーを押しても消灯は解除されない。)
.sp
引き数 \fBpoke\fP は、スクリーンの消灯を解除する。(訳注: \fB\-\-blank\fP=force
で消灯したとき、それを解除するのに \fBsetterm \-\-blank\fP=poke を使用する。)
.RS
.IP "[\fB訳注\fP]" 8
\fB\-\-blank\fP に引き数を付けなかったときの動作がよく分からない。
訳者のところでは、消灯しているはずの仮想コンソールが他にあっても、その番号を示さず、常に
0 が返ってくる。1 つのコンピュータに複数の端末がつながっていた時代の話なのだろうか。
つまり、vt とは、virtual terminal ではなく、video terminal のことなのか。
.RE
.TP 
\fB\-\-bfreq\fP[=\fInumber\fP]
ベルの周波数をヘルツ (Hz) で指定する。引き数が指定されていない場合は、デフォルトの
\fB0\fP になる。仮想コンソール専用。
.TP 
\fB\-\-blength\fP[=0\-2000]
ベルの継続時間をミリ秒単位で設定する。引き数が指定されていない場合は、デフォルトの
\fB0\fP になる。仮想コンソール専用。
.TP 
\fB\-\-blink\fP on|off
点滅モードを on または off にする。 仮想コンソール以外では、\fB\-\-blink off\fP
にすると、(太字・半輝度・点滅・反転といった) 全ての属性が off になる。
.TP 
\fB\-\-bold\fP on|off
太字 (高輝度) モードを on または off にする。仮想コンソール以外では、\fB\-\-bold off\fP
にすると (太字・半輝度・点滅・反転といった) 全ての属性が off になる。
.TP 
\fB\-\-clear\fP[=all|rest]
引き数なし、または引き数 \fBall\fP が指定された場合は、\fBclear\fP(1)
コマンドとまったく同じように、スクリーン全体をクリアしてカーソルをホームポジションに移動する。
引き数 \fBrest\fP
が指定された場合は、現在のカーソル位置からスクリーンの最下行までをクリアする。
.TP 
\fB\-\-clrtabs\fP[=\fItab1 tab2 tab3\fP ...]
指定された水平方向のカーソル位置にあるタブストップを解除する。範囲は \fB1\-160\fP
である。引き数が指定されない場合は、全てのタブストップを解除する。仮想コンソール専用。
.TP 
\fB\-\-cursor\fP on|off
端末のカーソルを on または off にする。
.TP 
\fB\-\-default\fP
端末のレンダリングオプションをデフォルト値に戻す。
.TP 
\fB\-\-dump\fP[=\fIconsole_number\fP]
番号で指定された仮想コンソールのスナップショットを \fB\-\-file\fP
オプションで指定されたファイルに書き出す。ファイルの内容は上書きされる。
デフォルトのファイルは \fIscreen.dump\fP
である。引き数が指定されない場合は、現在使用中の仮想コンソールをダンプする。
このオプションは、\fB\-\-append\fP を無効にする。
.TP 
\fB\-\-file\fP \fIfilename\fP
同じコマンドライン上に \fB\-\-dump\fP や \fB\-\-append\fP
オプションがある場合に、それに使うスナップショットファイルの名前を設定する。
このオプションが指定されない場合、デフォルトのファイル名はカレントディレクトリの
\fIscreen.dump\fP である。システムの規定する長さの上限を越えたパス名は、切り詰められる。
linux/limits.h の PATH_MAX の値を参照すること。
.TP 
\fB\-\-foreground\fP \fI8\-color\fP|default
テキストの前景色を設定する。
.TP 
\fB\-\-half\-bright\fP on|off
減光 (半輝度) モードを on または off
にする。仮想コンソール以外では、\fB\-\-half\-bright off\fP
にすると、(太字・半輝度・点滅・反転といった) 全ての属性が off になる。
.TP 
\fB\-\-hbcolor\fP [bright] \fI16\-color\fP
半輝度の文字の色を設定する (訳注: 減光する代わりに、色を変更する端末で使用)。
.TP 
\fB\-\-initialize\fP
端末の初期化文字列を出力する。
通常、それは、端末のレンダリングオプションを設定し、その他の属性をデフォルトの値にする。
.TP 
\fB\-\-inversescreen\fP on|off
スクリーン全体で前景色と背景色を入れ換える。
.TP 
\fB\-\-linewrap\fP on|off
行がいっぱいになったとき、端末上の表示を次の行に続けるか否かを設定する。
.TP 
\fB\-\-msg\fP on|off
カーネルの \fBprintk\fP()
によるメッセージをコンソールに送出するか否かを設定する。仮想コンソール専用。
.RS
.IP "[\fB訳注\fP]" 8
コンソール出力の閾値であるロギングレベルが、現在いくつに設定されているかを知るには、
\fBcat /proc/sys/kernel/printk\fP を実行すればよい。
その出力の一番左側の数値が現在のロギングレベルである。
各数値の意味については、\fBsyslog\fP(2)
に説明がある。次の項目 \fB\-\-msglevel\fP も参照。
.RE
.TP 
\fB\-\-msglevel\fP 0\-8
カーネルの \fBprintk()\fP
によるメッセージに対する、コンソールのロギングレベルを設定する。
ここで設定したレベルよりも高い重大度を持つ (等しいレベルは含まない)
全てのメッセージが、コンソールに表示されることになる
(訳注: レベルの数値が小さいほど、重大度は高い)。
従って、ロギングレベルを \fB8\fP に設定すると、全てのカーネルメッセージが表示される。
なお、ロギングレベル \fB0\fP は \fB\-\-msg on\fP
と同じ効果がある。カーネルメッセージのロギングのインターフェースとしては、
\fBklogd\fP(8) の方が使いやすいかもしれない。
.sp
仮想コンソール専用。
.RS
.IP "[\fB訳注\fP]" 8
ロギングレベルは、0 から 7 まであり、それぞれ emerg, alert, crit, err,
warning, notice, info, debug という重大度に対応する。詳しくは、\fBsyslog\fP(2)
の \fBThe log level\fP セクションなどを参照していただきたい。
.RE
.TP 
\fB\-\-powerdown\fP[=0\-60]
VESA パワーダウンまでの時間を分単位で設定する。引き数を指定しない場合は、デフォルトの
\fB0\fP になる (すなわち、パワーダウンを行わない)。この時間が経過すると、
コンソールが消灯している場合は vsync
サスペンドモードになり、モニタがサスペンドモードの場合はパワーダウンモードになる。
.TP 
\fB\-\-powersave\fP \fImode\fP
以下の値が \fImode\fP に指定できる。
.RS
.TP 
\fBvsync|on\fP
モニタを VESA vsync サスペンドモードにする。
.TP 
\fBhsync\fP
モニタを VESA hsync サスペンドモードにする。
.TP 
\fBpowerdown\fP
モニタを VESA パワーダウンモードにする。
.TP 
\fBoff\fP
モニタの VESA パワーセーブ機能を off にする。
.RE
.TP 
\fB\-\-regtabs\fP[=1\-160]
全てのタブストップを解除して、通常のタブストップパターンを設定する。
タブ位置は、指定した数値ごとに置かれる。引き数を指定しない場合は、デフォルトの
\fB8\fP が使用される。仮想コンソール専用。
.TP 
\fB\-\-repeat\fP on|off
キーボードリピートを on または off にする。仮想コンソール専用。
.TP 
\fB\-\-reset\fP
端末リセット文字列を出力する。通常、それは、端末を起動時の状態にリセットする。
.TP 
\fB\-\-resize\fP
行と列の最大の大きさを見積もって、端末のサイズをリセットする。
これは、実際の大きさとカーネルの端末ドライバーがうまく噛み合っていないとき、役に立つ。
特筆すべき使用例は、シリアルコンソールの場合だ。そこでは \fBioctl\fP(3p)
を使わず、バイトストリームとブレークのみを使用しているのである。
.TP 
\fB\-\-reverse\fP on|off
ビデオの反転モードを on または off にする。仮想コンソール以外では、\fB\-\-reverse off\fP
にすると、(太字・半輝度・点滅・反転といった) 全ての属性が off になる。
.TP 
\fB\-\-store\fP
端末の現在のレンダリングオプション (前景色と背景色)
を、デフォルトにリセットする際に使用する値として保存する。仮想コンソール専用。
.TP 
\fB\-\-tabs\fP[=\fItab1 tab2 tab3\fP ...]
指定された水平方向のカーソル位置にタブストップを設定する。範囲は \fB1\-160\fP
である。引き数を指定しない場合は、現在のタブストップの設定を表示する。
.TP 
\fB\-\-term\fP \fIterminal_name\fP
環境変数 TERM を上書きする。
.TP 
\fB\-\-ulcolor\fP [bright] \fI16\-color\fP
下線を引かれる文字の色を設定する
(訳注: 下線を引く代わりに、色を変更する端末で使用)。仮想コンソール専用。
.TP 
\fB\-\-underline\fP on|off
下線モードを on または off にする。
.TP 
\fB\-\-version\fP
バージョン情報を表示して終了する。
.TP 
\fB\-\-help\fP
ヘルプを表示して終了する。
.SH 互換性
バージョン 2.25 以来、\fBsetterm\fP は、昔からのハイフン 1 つの長いオプション
(たとえば \fB\-help\fP) に加えて、ハイフン 2 つの長いオプション
(たとえば \fB\-\-help\fP) をサポートしている。スクリプト内では、後方互換のため、ハイフン
2 つよりハイフン 1 つを使う方がよい。現在のところ、ハイフン
1 つの互換性を止める計画はなく、またそうする正当な理由もない。
.SH バグ
Minix 版と Linux 版の違いが、この文書には書かれていない。
.SH 関連項目
\fBstty\fP(1), \fBtput\fP(1), \fBtty\fP(4), \fBterminfo\fP(5)
.SH 入手方法
この setterm コマンドは、util\-linux パッケージの一部であり、Linux Kernel Archive
<https://www.kernel.org/pub/linux/utils/util\-linux/>
から入手できる。