[DOC] Update PTY documents

- Fix markups as RDoc.
- Remove already descriptions of removed methods.
This commit is contained in:
Nobuyoshi Nakada 2024-04-07 13:35:20 +09:00
parent 6bfabd076b
commit eaa6e4b228
No known key found for this signature in database
GPG Key ID: 3582D74E1FEE4465
2 changed files with 39 additions and 43 deletions

View File

@ -1,4 +1,4 @@
README for expect
= README for expect
by A. Ito, 28 October, 1998
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 にマッチするまでに読みこ
まれた内容の文字列です2番目以降の要素はpattern の正規表現
返します.配列の最初の要素は,_pattern_ にマッチするまでに読みこ
まれた内容の文字列です2番目以降の要素は_pattern_ の正規表現
の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
もしタイムアウトが起きた場合はこのメソッドはnilを返します
もしタイムアウトが起きた場合は,このメソッドは +nil+ を返します.
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
配列がブロック引数として渡され,ブロックが評価されます.

View File

@ -1,4 +1,4 @@
pty 拡張モジュール version 0.3 by A.ito
= pty 拡張モジュール version 0.3 by A.ito
1. はじめに
@ -9,19 +9,18 @@ pty 拡張モジュール version 0.3 by A.ito
次のようにしてインストールしてください.
(1) ruby extconf.rb
1. <tt>ruby extconf.rb</tt>
を実行すると Makefile が生成されます.
(2) make; make install を実行してください.
2. <tt>make; make install</tt> を実行してください.
3. 何ができるか
この拡張モジュールはPTY というモジュールを定義します.その中
には,次のようなモジュール関数が含まれています.
getpty(command)
spawn(command)
[PTY.getpty(command)]
[PTY.spawn(command)]
この関数は仮想ttyを確保し指定されたコマンドをその仮想tty
の向こうで実行し配列を返します戻り値は3つの要素からなる
@ -35,12 +34,7 @@ pty 拡張モジュール version 0.3 by A.ito
のみ例外が発生します.子プロセスをモニターしているスレッドはブロッ
クを抜けるときに終了します.
protect_signal
reset_signal
廃止予定です.
PTY.open
[PTY.open]
仮想ttyを確保しマスター側に対応するIOオブジェクトとスレーブ側に
対応するFileオブジェクトの配列を返しますブロック付きで呼び出さ
@ -48,7 +42,7 @@ pty 拡張モジュール version 0.3 by A.ito
クから返された結果を返しますまた、このマスターIOとスレーブFile
は、ブロックを抜けるときにクローズ済みでなければクローズされます.
PTY.check(pid[, raise=false])
[PTY.check(pid[, raise=false])]
pidで指定された子プロセスの状態をチェックし実行中であればnilを
返します.終了しているか停止している場合、第二引数が偽であれば、