.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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.
.\"
.\"	@(#)tcsetattr.3	8.3 (Berkeley) 1/2/94
.\" %FreeBSD: src/lib/libc/gen/tcsetattr.3,v 1.6.2.3 2001/12/14 18:33:51 ru Exp %
.\"
.\" $FreeBSD$
.Dd January 2, 1994
.Dt TCSETATTR 3
.Os
.Sh 名称
.Nm cfgetispeed ,
.Nm cfsetispeed ,
.Nm cfgetospeed ,
.Nm cfsetospeed ,
.Nm cfsetspeed ,
.Nm cfmakeraw ,
.Nm tcgetattr ,
.Nm tcsetattr
.Nd termios 構造の操作
.Sh ライブラリ
.Lb libc
.Sh 書式
.In termios.h
.Ft speed_t
.Fn cfgetispeed "const struct termios *t"
.Ft int
.Fn cfsetispeed "struct termios *t" "speed_t speed"
.Ft speed_t
.Fn cfgetospeed "const struct termios *t"
.Ft int
.Fn cfsetospeed "struct termios *t" "speed_t speed"
.Ft int
.Fn cfsetspeed "struct termios *t" "speed_t speed"
.Ft void
.Fn cfmakeraw "struct termios *t"
.Ft int
.Fn tcgetattr "int fd" "struct termios *t"
.Ft int
.Fn tcsetattr "int fd" "int action" "const struct termios *t"
.Sh 解説
.Fn cfmakeraw ,
.Fn tcgetattr 
および
.Fn tcsetattr
関数は、termios 構造の取得および設定を行うためのものです。
.Pp
.Fn cfgetispeed ,
.Fn cfsetispeed ,
.Fn cfgetospeed ,
.Fn cfsetospeed
および
.Fn cfsetspeed
関数は、termios 構造におけるボーレートの取得および設定を
行うためのものです。以下に述べる端末に対する関数の効果は、
.Fn tcsetattr
関数が呼び出されるまでは有効にはならず、すべてエラーが検出されます。
.Fn tcsetattr
関数に渡されるボーレートの特定の値は、termios 構造に設定され、
特別な意味を持ちます。これについては、
.Fn tcsetattr
関数を説明しているマニュアルページに述べます。
.Sh ボーレートの取得と設定
入力および出力のボーレートは、termios 構造に入っています。符号なしの整数
.Li speed_t
は、インクルードファイル
.Aq Pa termios.h
の中で typedef されています。しかし、この整数の値は、それが示すボーレートに
直接対応しており、次のような記号で値が定義されています。
.Bd -literal
#define B0      0
#define B50     50
#define B75     75
#define B110    110
#define B134    134
#define B150    150
#define B200    200
#define B300    300
#define B600    600
#define B1200   1200
#define B1800   1800
#define B2400   2400
#define B4800   4800
#define B9600   9600
#define B19200  19200
#define B38400  38400
#ifndef _POSIX_SOURCE
#define EXTA    19200
#define EXTB    38400
#endif  /*_POSIX_SOURCE */
.Ed
.Pp
.Fn cfgetispeed
関数は、
.Fa tp
で参照される termios 構造における入力ボーレートを返します。
.Pp
.Fn cfsetispeed
関数は、
.Fa tp
で参照される termios 構造における入力ボーレートを
.Fa speed
の値に設定します。
.Pp
.Fn cfgetospeed
関数は、
.Fa tp
で参照される termios 構造における出力ボーレートを返します。
.Pp
.Fn cfsetospeed
関数は、
.Fa tp
で参照される termios 構造における出力ボーレートを
.Fa speed
の値に設定します。
.Pp
.Fn cfsetspeed
関数は、
.Fa tp
で参照される termios 構造における入力および出力ボーレートの両方を
.Fa speed
の値に設定します。
.Pp
処理が成功すると、
.Fn cfsetispeed ,
.Fn cfsetospeed 
および
.Fn cfsetspeed
は値 0 を返します。それ以外の場合は -1 という値が返され、エラーを示す
グローバル変数
.Va errno
が設定されます。
.Sh termios状態の取得と設定
このセクションでは、一般端末インタフェースを制御するために用いる
関数について説明します。特定のコマンドについて特に断り書きがない限り、
これらの関数はバックグラウンド処理による使用に対しては制限があります。
このような操作を行なおうとすると、その処理グループには SIGTTOU シグナルが
送られます。呼び出し側処理が SIGTTOU シグナルをブロックまたは無視した場合は、
その処理は操作を実行することを許され、 SIGTTOU シグナルは送信されません。
.Pp
.Fa fd
は開くファイルの記述子ですが、すべての関数においては、関数はそれが
示す特定のファイル記述子に関して開いたファイルの内容だけでなく、潜在的に
関連する端末ファイルにも影響を及ぼします。
.Pp
.Fn cfmakeraw
関数は、termios 構造に保存されたフラグをすべての入力および
出力処理を無効にする状態に設定し、
.Dq 生の I/O パス
を与えます。この効果を
逆転させる関数は存在しないことに注意してください。これは、有効に
戻すことができる処理オプションは沢山あり、正しい方法は
.Fn tcgetattr
関数を使い、まず
.Fn cfmakeraw
関数で次に
.Fn tcsetattr
関数によって生モードを設定し、次にもう一度
.Fn tcsetattr
関数を保存状態で使って元の端末状態に戻して
現在の端末状態のスナップショットを適用するやり方だからです。
.Pp
.Fn tcgetattr
関数は、
.Fa tp
で参照される
termios
構造に入っている
.Fa fd
によって参照される端末に付随するパラメータをコピーします。この関数は、
バックグラウンド処理から使うことが許されていますが、端末アトリビュート
はその後にフォアグラウンド処理によって変更される場合があります。
.Pp
.Fn tcsetattr
関数は、
.Fa tp
によって参照される termios 構造の端末に付随するパラメータを設定します。
.Fa action
フィールドは、インクルードファイル
.Aq Pa termios.h
の中で指定された通りに、以下の値を
.Em or
操作することによって
作成されます。
.Bl -tag -width "TCSADRAIN"
.It Fa TCSANOW
変更は直ちに行われます。
.It Fa TCSADRAIN
変更は、
.Fa fd
に書込まれたすべての出力が端末に送信された後で
行われます。出力に影響を与えるパラメータを変更する場合には、この
.Fa action
値を使わなければなりません。
.It Fa TCSAFLUSH
変更は、
.Fa fd
に書込まれたすべての出力が端末に送信された後で
行われます。その上、受信されたがまだ読み取られていないすべての入力は
廃棄されます。
.It Fa TCSASOFT
この値が
.Fa action
値に
.Em 又は
操作された場合は、
.Em c_cflag ,
.Em c_ispeed
および
.Em c_ospeed
フィールドの値は無視されます。
.El
.Pp
ボーレート値 0 は、接続を終了するために使います。
.Fn tcsetattr
関数に出力速度 0 を指定すると、端末に対してモデム制御を主張せずに、
端末の接続を切ります。
.Pp
関数
.Fn tcsetattr
に入力速度 0 を指定した場合は、入力ボーレートは出力
ボーレートに指定されたものと同じ値に設定されます。
.Pp
関数
.Fn tcsetattr
が要求した変更のいずれをも行うことができない場合は、値 -1 を返して
.Va errno
を設定します。それ以外の場合は、要求された変更すべてを
可能な限り行います。指定した入力および出力のボーレートが異なり、その
組合せがサポートされていない場合には、どちらのボーレートも変更されません。
.Pp
処理が成功して完了すると、関数
.Fn tcgetattr
および
.Fn tcsetattr
は値 0 を返します。それ以外の場合は、値 -1 を返してエラーを示すグローバル変数
.Va errno
が次のように設定されます：
.Bl -tag -width Er
.It Bq Er EBADF
関数
.Fn tcgetattr
または
.Fn tcsetattr
に対する引数
.Fa fd
が有効なファイル記述子ではありません。
.It Bq Er EINTR
関数
.Fn tcsetattr
がシグナルによって中断されました。
.It Bq Er EINVAL
関数
.Fn tcsetattr
の引数
.Fa action
が有効でないか、または termios 構造の中のアトリビュートを
サポートされていない値に変更しようとしています。
.It Bq Er ENOTTY
関数
.Fn tcgetattr
または
.Fn tcsetattr
の引数
.Fa fd
に結びついたファイルが、端末ではありません。
.El
.Sh 関連項目
.Xr tcsendbreak 3 ,
.Xr termios 4
.Sh 規格
関数
.XX cfgetispeed  ,
.XX cfsetispeed  ,
.XX cfgetospeed  ,
.XX cfsetospeed  ,
.Fn tcgetattr ,
.Fn tcsetattr
は、
.St -p1003.1-88
規格に適合していると考えられます。関数
.Fn cfmakeraw
および
.Fn cfsetspeed
は、
.Fn tcsetattr
関数の
.Li TCSASOFT
オプションと同様に
.St -p1003.1-88
規格の拡張です。