[DOC] Update PTY documents
- Fix markups as RDoc. - Remove already descriptions of removed methods.
This commit is contained in:
parent
6bfabd076b
commit
eaa6e4b228
@ -1,4 +1,4 @@
|
|||||||
README for expect
|
= README for expect
|
||||||
by A. Ito, 28 October, 1998
|
by A. Ito, 28 October, 1998
|
||||||
|
|
||||||
Expectライブラリは,tcl の expect パッケージと似たような機能を
|
Expectライブラリは,tcl の expect パッケージと似たような機能を
|
||||||
@ -6,16 +6,18 @@ IOクラスに追加します.
|
|||||||
|
|
||||||
追加されるメソッドの使い方は次の通りです.
|
追加されるメソッドの使い方は次の通りです.
|
||||||
|
|
||||||
IO#expect(pattern,timeout=9999999)
|
[IO#expect(pattern,timeout=9999999)]
|
||||||
|
|
||||||
|
_pattern_ は String か Regexp のインスタンス,_timeout_ は Fixnum
|
||||||
|
のインスタンスです._timeout_ は省略できます.
|
||||||
|
|
||||||
pattern は String か Regexp のインスタンス,timeout は Fixnum
|
|
||||||
のインスタンスです.timeout は省略できます.
|
|
||||||
このメソッドがブロックなしで呼ばれた場合,まずレシーバである
|
このメソッドがブロックなしで呼ばれた場合,まずレシーバである
|
||||||
IOオブジェクトから pattern にマッチするパターンが読みこまれる
|
IOオブジェクトから _pattern_ にマッチするパターンが読みこまれる
|
||||||
まで待ちます.パターンが得られたら,そのパターンに関する配列を
|
まで待ちます.パターンが得られたら,そのパターンに関する配列を
|
||||||
返します.配列の最初の要素は,pattern にマッチするまでに読みこ
|
返します.配列の最初の要素は,_pattern_ にマッチするまでに読みこ
|
||||||
まれた内容の文字列です.2番目以降の要素は,pattern の正規表現
|
まれた内容の文字列です.2番目以降の要素は,_pattern_ の正規表現
|
||||||
の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
|
の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
|
||||||
もしタイムアウトが起きた場合は,このメソッドはnilを返します.
|
もしタイムアウトが起きた場合は,このメソッドは +nil+ を返します.
|
||||||
|
|
||||||
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
|
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
|
||||||
配列がブロック引数として渡され,ブロックが評価されます.
|
配列がブロック引数として渡され,ブロックが評価されます.
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
pty 拡張モジュール version 0.3 by A.ito
|
= pty 拡張モジュール version 0.3 by A.ito
|
||||||
|
|
||||||
1. はじめに
|
1. はじめに
|
||||||
|
|
||||||
@ -9,19 +9,18 @@ pty 拡張モジュール version 0.3 by A.ito
|
|||||||
|
|
||||||
次のようにしてインストールしてください.
|
次のようにしてインストールしてください.
|
||||||
|
|
||||||
(1) ruby extconf.rb
|
1. <tt>ruby extconf.rb</tt>
|
||||||
|
|
||||||
を実行すると Makefile が生成されます.
|
を実行すると Makefile が生成されます.
|
||||||
|
|
||||||
(2) make; make install を実行してください.
|
2. <tt>make; make install</tt> を実行してください.
|
||||||
|
|
||||||
3. 何ができるか
|
3. 何ができるか
|
||||||
|
|
||||||
この拡張モジュールは,PTY というモジュールを定義します.その中
|
この拡張モジュールは,PTY というモジュールを定義します.その中
|
||||||
には,次のようなモジュール関数が含まれています.
|
には,次のようなモジュール関数が含まれています.
|
||||||
|
|
||||||
getpty(command)
|
[PTY.getpty(command)]
|
||||||
spawn(command)
|
[PTY.spawn(command)]
|
||||||
|
|
||||||
この関数は,仮想ttyを確保し,指定されたコマンドをその仮想tty
|
この関数は,仮想ttyを確保し,指定されたコマンドをその仮想tty
|
||||||
の向こうで実行し,配列を返します.戻り値は3つの要素からなる
|
の向こうで実行し,配列を返します.戻り値は3つの要素からなる
|
||||||
@ -35,12 +34,7 @@ pty 拡張モジュール version 0.3 by A.ito
|
|||||||
のみ例外が発生します.子プロセスをモニターしているスレッドはブロッ
|
のみ例外が発生します.子プロセスをモニターしているスレッドはブロッ
|
||||||
クを抜けるときに終了します.
|
クを抜けるときに終了します.
|
||||||
|
|
||||||
protect_signal
|
[PTY.open]
|
||||||
reset_signal
|
|
||||||
|
|
||||||
廃止予定です.
|
|
||||||
|
|
||||||
PTY.open
|
|
||||||
|
|
||||||
仮想ttyを確保し,マスター側に対応するIOオブジェクトとスレーブ側に
|
仮想ttyを確保し,マスター側に対応するIOオブジェクトとスレーブ側に
|
||||||
対応するFileオブジェクトの配列を返します.ブロック付きで呼び出さ
|
対応するFileオブジェクトの配列を返します.ブロック付きで呼び出さ
|
||||||
@ -48,7 +42,7 @@ pty 拡張モジュール version 0.3 by A.ito
|
|||||||
クから返された結果を返します.また、このマスターIOとスレーブFile
|
クから返された結果を返します.また、このマスターIOとスレーブFile
|
||||||
は、ブロックを抜けるときにクローズ済みでなければクローズされます.
|
は、ブロックを抜けるときにクローズ済みでなければクローズされます.
|
||||||
|
|
||||||
PTY.check(pid[, raise=false])
|
[PTY.check(pid[, raise=false])]
|
||||||
|
|
||||||
pidで指定された子プロセスの状態をチェックし,実行中であればnilを
|
pidで指定された子プロセスの状態をチェックし,実行中であればnilを
|
||||||
返します.終了しているか停止している場合、第二引数が偽であれば、
|
返します.終了しているか停止している場合、第二引数が偽であれば、
|
||||||
|
Loading…
x
Reference in New Issue
Block a user