[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,21 +1,23 @@
README for expect = README for expect
by A. Ito, 28 October, 1998 by A. Ito, 28 October, 1998
Expectライブラリはtcl の expect パッケージと似たような機能を Expectライブラリはtcl の expect パッケージと似たような機能を
IOクラスに追加します 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+ を返します.
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
配列がブロック引数として渡され,ブロックが評価されます. 配列がブロック引数として渡され,ブロックが評価されます.

View File

@ -1,27 +1,26 @@
pty 拡張モジュール version 0.3 by A.ito = pty 拡張モジュール version 0.3 by A.ito
1. はじめに 1. はじめに
この拡張モジュールは仮想tty (pty) を通して適当なコマンドを この拡張モジュールは仮想tty (pty) を通して適当なコマンドを
実行する機能を ruby に提供します. 実行する機能を ruby に提供します.
2. インストール 2. インストール
次のようにしてインストールしてください. 次のようにしてインストールしてください.
(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を
返します.終了しているか停止している場合、第二引数が偽であれば、 返します.終了しているか停止している場合、第二引数が偽であれば、
@ -57,20 +51,20 @@ pty 拡張モジュール version 0.3 by A.ito
4. 利用について 4. 利用について
伊藤彰則が著作権を保有します. 伊藤彰則が著作権を保有します.
ソースプログラムまたはドキュメントに元の著作権表示が改変されずに ソースプログラムまたはドキュメントに元の著作権表示が改変されずに
表示されている場合に限り,誰でも,このソフトウェアを無償かつ著作 表示されている場合に限り,誰でも,このソフトウェアを無償かつ著作
権者に無断で利用・配布・改変できます.利用目的は限定されていませ 権者に無断で利用・配布・改変できます.利用目的は限定されていませ
ん. ん.
このプログラムの利用・配布その他このプログラムに関係する行為によ このプログラムの利用・配布その他このプログラムに関係する行為によ
って生じたいかなる損害に対しても,作者は一切責任を負いません. って生じたいかなる損害に対しても,作者は一切責任を負いません.
5. バグ報告等 5. バグ報告等
バグレポートは歓迎します. バグレポートは歓迎します.
aito@ei5sun.yz.yamagata-u.ac.jp aito@ei5sun.yz.yamagata-u.ac.jp
まで電子メールでバグレポートをお送りください. まで電子メールでバグレポートをお送りください.