Man page - setterm(1)

Packages contains this manual

Available languages:

en pl ja uk ro

Manual

SETTERM

名 前
書 式
説 明
オ プ シ ョ ン
互 換 性
バ グ
関 連 項 目
入 手 方 法

名 前

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

書 式

setterm [options]

説 明

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

オ プ シ ョ ン

引 き 数 に ブ ー ル 値 ( on ま た は off ) を 取 る オ プ シ ョ ン は 、 デ フ ォ ル ト で は on に な っ て い る (訳 注 : 現 在 で は 、 デ フ ォ ル ト が on の も の も off の も の も あ る 。 た と え ば 、 --bold の デ フ ォ ル ト は 、 た ぶ ん off で あ る )。

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

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

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

指 定 す る か し な い か が 任 意 の 引 き 数 で は 、 オ プ シ ョ ン と 引 き 数 の 間 に ス ペ ー ス で は な く 、 ’=’ (等 号 ) が 必 要 で あ る 。 た と え ば 、 --option=argument の よ う に (訳 注 ： 実 際 の と こ ろ 、 util-linux 2.36 で は 、 --clear の よ う な 例 外 も あ る が 、 た い て い の 場 合 ス ペ ー ス も 使 え る )。
--appcursorkeys on|off

カ ー ソ ル キ ー ア プ リ ケ ー シ ョ ン モ ー ド を on ま た は off に す る 。 on の 場 合 は 、 カ ー ソ ル キ ー を 押 し た と き 、 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 は 、 キ ー が 押 さ れ て も 、 ス ク リ ー ン を 消 灯 し た ま ま に す る 。 (訳 注 : --blank =force を 指 定 す る と 、 仮 想 コ ン ソ ー ル は 即 座 に 消 灯 す る 。 そ し て 、 ど の キ ー を 押 し て も 消 灯 は 解 除 さ れ な い 。 )

引 き 数 poke は 、 ス ク リ ー ン の 消 灯 を 解 除 す る 。 (訳 注 : --blank =force で 消 灯 し た と き 、 そ れ を 解 除 す る の に setterm --blank =poke を 使 用 す る 。 )

[ 訳 注 ]

--blank に 引 き 数 を 付 け な か っ た と き の 動 作 が よ く 分 か ら な い 。 訳 者 の と こ ろ で は 、 消 灯 し て い る は ず の 仮 想 コ ン ソ ー ル が 他 に あ っ て も 、 そ の 番 号 を 示 さ ず 、 常 に 0 が 返 っ て く る 。 1 つ の コ ン ピ ュ ー タ に 複 数 の 端 末 が つ な が っ て い た 時 代 の 話 な の だ ろ う か 。 つ ま り 、 vt と は 、 virtual terminal で は な く 、 video terminal の こ と な の か 。

--bfreq [= number ]

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

--blength [=0-2000]

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

--blink on|off

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

--bold on|off

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

--clear [=all|rest]

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

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

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

--cursor on|off

端 末 の カ ー ソ ル を on ま た は off に す る 。

--default

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

--dump [= console_number ]

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

--file filename

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

--foreground 8-color |default

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

--half-bright on|off

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

--hbcolor [bright] 16-color

半 輝 度 の 文 字 の 色 を 設 定 す る (訳 注 : 減 光 す る 代 わ り に 、 色 を 変 更 す る 端 末 で 使 用 )。

--initialize

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

--inversescreen on|off

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

--linewrap on|off

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

--msg on|off

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

[ 訳 注 ]

コ ン ソ ー ル 出 力 の 閾 値 で あ る ロ ギ ン グ レ ベ ル が 、 現 在 い く つ に 設 定 さ れ て い る か を 知 る に は 、 cat /proc/sys/kernel/printk を 実 行 す れ ば よ い 。 そ の 出 力 の 一 番 左 側 の 数 値 が 現 在 の ロ ギ ン グ レ ベ ル で あ る 。 各 数 値 の 意 味 に つ い て は 、 syslog (2) に 説 明 が あ る 。 次 の 項 目 --msglevel も 参 照 。

--msglevel 0-8

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

仮 想 コ ン ソ ー ル 専 用 。

[ 訳 注 ]

ロ ギ ン グ レ ベ ル は 、 0 か ら 7 ま で あ り 、 そ れ ぞ れ emerg, alert, crit, err, warning, notice, info, debug と い う 重 大 度 に 対 応 す る 。 詳 し く は 、 syslog (2) の The log level セ ク シ ョ ン な ど を 参 照 し て い た だ き た い 。

--powerdown [=0-60]

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

--powersave mode

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

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

hsync

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

powerdown

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

off

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

--regtabs [=1-160]

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

--repeat on|off

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

--reset

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

--resize

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

--reverse on|off

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

--store

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

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

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

--term terminal_name

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

--ulcolor [bright] 16-color

下 線 を 引 か れ る 文 字 の 色 を 設 定 す る (訳 注 : 下 線 を 引 く 代 わ り に 、 色 を 変 更 す る 端 末 で 使 用 )。 仮 想 コ ン ソ ー ル 専 用 。

--underline on|off

下 線 モ ー ド を on ま た は off に す る 。

--version

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

--help

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

互 換 性

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

バ グ

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

関 連 項 目

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

入 手 方 法

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