.\" Copyright (c) 1990, 1993, 1994
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)stty.1	8.4 (Berkeley) 4/18/94
.\" %FreeBSD: src/bin/stty/stty.1,v 1.30 2004/07/03 00:03:26 ru Exp %
.\"
.\" $FreeBSD$
.Dd April 18, 1994
.Dt STTY 1
.Os
.Sh 名称
.Nm stty
.Nd 端末の設定を行なう
.Sh 書式
.Nm
.Op Fl a | Fl e | Fl g
.Op Fl f Ar file
.Op operands
.Sh 解説
.Nm
は、標準入力になっているデバイスの端末属性を設定もしくは表示する
プログラムです。オプションや引数を指定しなかった場合、
設定されている属性の一部や、デフォルト値と違う値が設定されている属性
を表示します。
指定した場合は、指定された引数に従って端末の状態を変更します。
ターミナルの種類によっては相互に排他的な引数の組み合わせもあります。
.Pp
オプションとしては以下のものがあります。
.Bl -tag -width indent
.It Fl a
.St -p1003.2
に規定された形式で、
現在の端末属性をすべて標準出力に出力します。
.It Fl e
.Bx
の伝統的な ``all'' や ``everything'' の形式で、
現在の端末属性をすべて標準出力に出力します。
.It Fl f
標準入力ではなく、
.Ar file
で指定された端末を使います。
このファイルは
.Fn open
関数に
.Dv O_NONBLOCK
フラグを付けてオープンされるので、端末の設定や表示をブロックされず
に行なうことができます。
.It Fl g
端末変更後に端末の状態を復帰させられるように、
.Nm
の引数として指定できる形式で、現在の端末属性を標準出力に
出力します。
この形式は
.St -p1003.2
に規定されています。
.El
.Pp
端末属性の設定には、以下の引数が使えます。
.Ss 制御モード:
.Pp
制御モードのフラグは端末と関連するハードウェアの属性
に影響します。これは termios 構造体の c_cflag に相当します。
.Bl -tag -width Fl
.It Cm parenb Pq Fl parenb
パリティ生成および検出を有効 (無効) にします。
.It Cm parodd Pq Fl parodd
奇数パリティ (偶数パリティ) にします。
.It Cm cs5 cs6 cs7 cs8
可能なら 1 文字のビット幅を設定します。
.It Ar number
可能なら、端末のボーレートを
.Ar number
に設定します。0 を指定した場合は、モデムの制御を切ります。
.It Cm ispeed Ar number
可能なら、入力のボーレートを
.Ar number
に設定します。0 を設定した場合は、出力のボーレートと同じ値に設定されます。
.It Cm ospeed Ar number
可能なら、出力のボーレートを
.Ar number
に設定します。0 を設定した場合は、モデムの制御を切ります。
.It Cm speed Ar number
.Cm ispeed
と
.Cm ospeed
の両方を
.Ar number
に設定します。
.It Cm hupcl Pq Fl hupcl
そのデバイスをオープンしているプロセスがクローズ処理を行ったとき、ほか
にこのデバイスをオープンしているプロセスがなければ、モデムの制御機能に
より切断処理を行います (行いません)。
.It Cm hup Pq Fl hup
hupcl
.Pq Fl hupcl
と同じです。
.It Cm cstopb Pq Fl cstopb
ストップビットを 2 ビット (1 ビット) にします。
.It Cm cread Pq Fl cread
受話器を有効 (無効) にします。
.It Cm clocal Pq Fl clocal
回線に対してモデム制御が不要である (必要である) とみなします。
.It Cm crtscts Pq Fl crtscts
RTS/CTS フロー制御を有効 (無効) にします。
.El
.Ss 入力モード:
これは termios 構造体の c_iflag に相当します。
.Bl -tag -width Fl
.It Cm ignbrk Pq Fl ignbrk
入力のブレーク信号を無視します (無視しません)。
.It Cm brkint Pq Fl brkint
ブレークを受信したとき、シグナル
.Dv INTR
を出します (出しません)。
.It Cm ignpar Pq Fl ignpar
パリティエラーを無視します (無視しません)。
.It Cm parmrk Pq Fl parmrk
パリティエラーをマークします (マークしません)。
.It Cm inpck Pq Fl inpck
入力のパリティチェックを有効 (無効) にします。
.It Cm istrip Pq Fl istrip
入力した文字の 8 ビット目を捨てて 7 ビットにします (8 ビット目
を捨てません)。
.It Cm inlcr Pq Fl inlcr
入力の
.Dv NL
を
.Dv CR
に変換します (変換しません)。
.It Cm igncr Pq Fl igncr
入力の
.Dv CR
を無視します (無視しません)。
.It Cm icrnl Pq Fl icrnl
入力の
.Dv CR
を
.Dv NL
に変換します (変換しません)。
.It Cm ixon Pq Fl ixon
制御コードの
.Dv START/STOP
を使った出力フロー制御を有効 (無効) にします。
システムから端末への出力において、システムが
.Dv STOP
を受信したら出力を中断し、
.Dv START
を受信するか、
.Cm ixany
が設定されている場合は何らかの文字を受信すると、
出力を再開するようになります。
.It Cm ixoff Pq Fl ixoff
システムの入力キューが
空/満杯に近づいたら、それぞれ
.Dv START/STOP
を出力するようにします (近づいても、出力しません)。
.It Cm ixany Pq Fl ixany
どんな文字が来ても (
.Dv START
が来た場合のみ) 出力を再開します。
.It Cm imaxbel Pq Fl imaxbel
システムによって入力キューの
.Dv MAX_INPUT
(一般的には 255) の最大文字数が規定されており、
.Cm imaxbel
がセットされていると、入力キューの制限を越えた入力に対して
ASCII BEL キャラクタを出力キューに送ります (端末が鳴ります)。
.Cm imaxbel
がセットされていなくて入力キューが一杯になった場合、次の文字入力で
すべての入力、出力キューは捨てられます。
.El
.Ss 出力モード:
これは termios 構造体の c_oflag に相当します。
.Bl -tag -width Fl
.It Cm opost Pq Fl opost
プロセス後の処理を行った上で出力をします
(プロセス後の処理を行わずに出力します。
この指定をすると、他のすべての出力モードが無視されます)。
.It Cm onlcr Pq Fl onlcr
出力の
.Dv NL
を
.Dv CR-NL
に変換します (変換しません)。
.It Cm ocrnl Pq Fl ocrnl
.Dv CR
を
.Dv NL
へマップします (マップしません)。
.It Cm oxtabs Pq Fl oxtabs
出力のタブをスペースに展開します (展開しません)。
.It Cm onocr Pq Fl onocr
桁 0 において CR を出力します (出力しません)。
.It Cm onlret Pq Fl onlret
端末上で NL が CR の機能を実行します (実行しません)。
.El
.Ss ローカルモード:
.Pp
ローカルモードのフラグ (lflags) は端末処理のさまざまな属性に影響します。
歴史的には、"local" という名前のつけられた新しいジョブコントロール機能
は Jim Kulp によって
.Tn IIASA
の
.Tn Pdp 11/70
に実装されました。
その後このドライバは、
Evans Hall, UC Berkeley の最初の
.Tn VAX
上で走りました。その際ジョブコントロールの細部は大幅に変更されましたが、
構造体の定義と名前は根本的には変わりませんでした。
lflag の 'l' の 2 つ目の解釈は、
.Ar termios
構造体の
.Ar c_lflag
に相当する ``line discipline flag''(行制御規則フラグ) です。
.Bl -tag -width Fl
.It Cm isig Pq Fl isig
特殊な制御文字
.Dv INTR , QUIT ,
.Dv SUSP
に対する処理を有効 (無効) にします。
.It Cm icanon Pq Fl icanon
.Dv ERASE
と
.Dv KILL
処理による入力制御を有効 (無効) にします。
.It Cm iexten Pq Fl iexten
icanon, isig, ixon で制御に使われているもの以外の特殊な
制御文字の処理を有効 (無効) にします。
.It Cm echo Pq Fl echo
タイプされた文字をエコーバックします (エコーバックしません)。
.It Cm echoe Pq Fl echoe
.Dv ERASE
文字の入力があった場合、可能ならディスプレイ上に見える現在の出力行の
最後の文字を消します (消しません)。
.It Cm echok Pq Fl echok
.Dv KILL
文字の入力があった場合、そのあとに
.Dv NL
を出力します (出力しません)。
.It Cm echoke Pq Fl echoke
可能なら、
.Dv KILL
文字でディスプレイ上の現在の行を消します (消しません)。
.It Cm echonl Pq Fl echonl
echo が無効になっているときでも
.Dv NL
文字だけはエコーバックさせます (エコーバックしません)。
.It Cm echoctl Pq Fl echoctl
.Cm echoctl
をセットすると、制御文字は ^X のように表示されます。
セットしなければ、その文字自身が表示されます。
.It Cm echoprt Pq Fl echoprt
プリンタ端末に対するもので、設定された場合、削除された文字を
``\\'' と ``/'' で囲んで逆方向にエコーします。
設定されていなければ、この機能を無効にします。
.It Cm noflsh Pq Fl noflsh
.Dv INTR , QUIT , SUSP
のあとのフラッシュ処理を無効 (有効) にします。
.It Cm tostop Pq Fl tostop
バックグラウンドジョブが出力を行おうとした時に
.Dv SIGTTOU
を送ります (送りません)。これによってバックグラウンドジョブは画面出力を
行おうとすると停止するようになります。
.It Cm altwerase Pq Fl altwerase
.Dv WERASE
文字を処理するときに、別の単語消去アルゴリズムを用います (用いません)。
このアルゴリズムは英数字とアンダスコアの並びを単語とみなします。
また、分類上直前の文字をスキップします (便宜的に、直前の文字を
.Dv ERASE
一文字で消すことができるようにするため)。
.It Cm mdmbuf Pq Fl mdmbuf
セットされると、CD 信号の検出によるフロー制御の出力を行います。
セットされなければ、CD 信号の低下に対してエラーを出力します
(キャリア信号は
.Dv CLOCAL
フラグによっても無視されません)。
.It Cm flusho Pq Fl flusho
出力を捨てます (捨てません)。
.It Cm pendin Pq Fl pendin
入力を非標準 (non-canonical) モードから標準 (canonical) モードへ切り換えた
あと、入力を保留します
(保留しません)。読み込みが保留されたとき、または更に入力があったときに
再入力されます。
.El
.Ss 制御文字:
.Bl -tag -width Fl
.It Ar control-character Ar string
.Ar string
に
.Ar control-character
を割り当てます。もし string が 1 文字だけなら、その文字に
.Ar control-character
が割り当てられます。
string が 2 文字の "^-" もしくは "undef" の場合は
.Ar control-character
は無効にされます (つまり、
.Pf { Dv _POSIX_VDISABLE Ns }
になります)。
.Pp
認識される制御文字:
.Bd -ragged -offset indent
.Bl -column character Subscript
.It 制御文字 Ta 記号 Ta 説明
.It _________ Ta _________ Ta _______________
.It eof Ta Tn VEOF Ta EOF No character
.It eol Ta Tn VEOL Ta EOL No character
.It eol2 Ta Tn VEOL2 Ta EOL2 No character
.It erase Ta Tn VERASE Ta ERASE No character
.It erase2 Ta Tn VERASE2 Ta ERASE2 No character
.It werase Ta Tn VWERASE Ta WERASE No character
.It intr Ta Tn VINTR Ta INTR No character
.It kill Ta Tn VKILL Ta KILL No character
.It quit Ta Tn VQUIT Ta QUIT No character
.It susp Ta Tn VSUSP Ta SUSP No character
.It start Ta Tn VSTART Ta START No character
.It stop Ta Tn VSTOP Ta STOP No character
.It dsusp Ta Tn VDSUSP Ta DSUSP No character
.It lnext Ta Tn VLNEXT Ta LNEXT No character
.It reprint Ta Tn VREPRINT Ta REPRINT No character
.It status Ta Tn VSTATUS Ta STATUS No character
.El
.Ed
.It Cm min Ar number
.It Cm time Ar number
min あるいは time の値を
.Ar number
にします。
.Dv MIN
と
.Dv TIME
は非標準的なモード (-icanon) での入力処理に使われます。
.El
.Ss 複合モード:
.Pp
.Bl -tag -width Fl
.It Ar saved settings
現在の端末属性を
.Fl g
オプションによって保存された属性にします。
.It Cm evenp No or Cm parity
parenb と cs7 を有効にし、parodd を無効にします。
.It Cm oddp
parenb, cs7, parodd を有効にします。
.It Fl parity , evenp , oddp
parenb を無効にして、cs8 をセットします。
.It Cm \&nl Pq Fl \&nl
icrnl を有効 (無効) にします。
それに加えて、-nl は inlcr と igncr を解除します。
.It Cm ek
.Dv ERASE ,
.Dv ERASE2 ,
.Dv KILL
に割り当てられている文字をシステムのデフォルトのものに戻します。
.It Cm sane
すべてのモードを対話的な端末利用に妥当な値にリセットします。
.It Cm tty
行制御規則を標準端末の規則
.Dv TTYDISC
に設定します。
.It Cm crt Pq Fl crt
CRT ディスプレイ用に適合するモードをすべて有効 (無効) にします。
.It Cm kerninfo Pq Fl kerninfo
.Dv STATUS
文字 (通常 ^T に設定されています) に結びつけられた
システムステータス行の生成を有効 (無効) にします。
このステータス行はシステムの負荷、現在のコマンドの名前、プロセス ID、
プロセスが待っているイベント (あるいはプロセスの状態)、
ユーザ時間とシステム時間、CPU 利用率、現在のメモリ使用状況
からなっています。
.It Cm columns Ar number
端末の大きさを
.Ar number
列とします。
.It Cm cols Ar number
.Cm columns
の別名定義です。
.It Cm rows Ar number
端末の大きさを
.Ar number
行とします。
.It Cm dec
Digital Equipment Corporation systems の端末設定にします。
(
.Dv ERASE ,
.Dv KILL ,
.Dv INTR
をそれぞれ ^?, ^U, ^Cとし、
.Dv ixany
を無効、
.Dv crt
を有効にします)
.It Cm extproc Pq Fl extproc
設定されると、一部の端末処理が端末機器ないし pty に接続されたリモート側
で行なわれるようになります。
.It Cm raw Pq Fl raw
端末モードを全く入出力処理を行なわないモードにします。
これを無効にすると、端末を入出力処理を行なう普通のモードに戻します。
注意すべきなのは、端末用のドライバは単一の
.Dv RAW
ビットを持つわけではないので、
.Cm raw
モードに設定する前にどのようなフラグが設定してあったのかを知ることがで
きないということです。つまり、
.Cm raw
モードを解除するだけでは、
.Cm raw
モード設定前の状態には戻りません。
端末を raw 状態にして、それを正確に元に戻すためには、以下のような
シェルコマンドを使うことを薦めます。
.Bd -literal
save_state=$(stty -g)
stty raw
\&...
stty "$save_state"
.Ed
.It Cm size
端末の大きさを行、列の順に並べた 1 行で表示します。
.El
.Ss 互換モード:
.Pp
以下のモードは旧バージョンの stty コマンドとの互換性保持のために残され
ています。
.Bl -tag -width Fl
.It Cm all
縦覧式でコントロール文字を表示する以外は、
.Cm stty Fl a
と同様に端末設定を表示します。
.It Cm everything
.Cm all
と同じです。
.It Cm cooked
.Cm sane
と同じです。
.It Cm cbreak
.Cm brkint , ixon , imaxbel , opost ,
.Cm isig , iexten ,
.Fl icanon
を有効にします。
解除した場合は
.Cm sane
と同じです。
.It Cm new
.Cm tty
と同じです。
.It Cm old
.Cm tty
と同じです。
.It Cm newcrt Pq Fl newcrt
.Cm crt
と同じです。
.It Cm pass8
.Cm parity
の反対です。
.It Cm tandem Pq Fl tandem
.Cm ixoff
と同じです。
.It Cm decctlq Pq Fl decctlq
.Cm ixany
の反対です。
.It Cm crterase Pq Fl crterase
.Cm echoe
と同じです。
.It Cm crtbs Pq Fl crtbs
.Cm echoe
と同じです。
.It Cm crtkill Pq Fl crtkill
.Cm echoke
と同じです。
.It Cm ctlecho Pq Fl ctlecho
.Cm echoctl
と同じです。
.It Cm prterase Pq Fl prterase
.Cm echoprt
と同じです。
.It Cm litout Pq Fl litout
.Cm opost
の反対です。
.It Cm tabs Pq Fl tabs
.Cm oxtabs
の反対です。
.It Cm brk Ar value
制御文字
.Cm eol
と同じです。
.It Cm flush Ar value
制御文字
.Cm discard
と同じです。
.It Cm rprnt Ar value
制御文字
.Cm reprint
と同じです。
.El
.Sh 診断
.Ex -std
.Sh 関連項目
.Xr termios 4
.Sh 規格
.Nm
ユーティリティは、
.St -p1003.2
互換です。
.Fl e
と
.Fl f
のフラグは規格を拡張しています。