Skip to content

Commit eaa6e4b

Browse files
committed
[DOC] Update PTY documents
- Fix markups as RDoc. - Remove already descriptions of removed methods.
1 parent 6bfabd0 commit eaa6e4b

File tree

2 files changed

+39
-43
lines changed

2 files changed

+39
-43
lines changed

doc/pty/README.expect.ja

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
README for expect
1+
= README for expect
22
by A. Ito, 28 October, 1998
33

4-
Expectライブラリは,tcl の expect パッケージと似たような機能を
4+
Expectライブラリは,tcl の expect パッケージと似たような機能を
55
IOクラスに追加します.
66

7-
追加されるメソッドの使い方は次の通りです.
7+
追加されるメソッドの使い方は次の通りです.
88

9-
IO#expect(pattern,timeout=9999999)
9+
[IO#expect(pattern,timeout=9999999)]
1010

11-
pattern は String か Regexp のインスタンス,timeout は Fixnum
12-
のインスタンスです.timeout は省略できます.
13-
このメソッドがブロックなしで呼ばれた場合,まずレシーバである
14-
IOオブジェクトから pattern にマッチするパターンが読みこまれる
15-
まで待ちます.パターンが得られたら,そのパターンに関する配列を
16-
返します.配列の最初の要素は,pattern にマッチするまでに読みこ
17-
まれた内容の文字列です.2番目以降の要素は,pattern の正規表現
18-
の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
19-
もしタイムアウトが起きた場合は,このメソッドはnilを返します.
20-
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
21-
配列がブロック引数として渡され,ブロックが評価されます.
11+
_pattern_ は String か Regexp のインスタンス,_timeout_ は Fixnum
12+
のインスタンスです._timeout_ は省略できます.
13+
14+
このメソッドがブロックなしで呼ばれた場合,まずレシーバである
15+
IOオブジェクトから _pattern_ にマッチするパターンが読みこまれる
16+
まで待ちます.パターンが得られたら,そのパターンに関する配列を
17+
返します.配列の最初の要素は,_pattern_ にマッチするまでに読みこ
18+
まれた内容の文字列です.2番目以降の要素は,_pattern_ の正規表現
19+
の中にアンカーがあった場合に,そのアンカーにマッチする部分です.
20+
もしタイムアウトが起きた場合は,このメソッドは +nil+ を返します.
21+
22+
このメソッドがブロック付きで呼ばれた場合には,マッチした要素の
23+
配列がブロック引数として渡され,ブロックが評価されます.

doc/pty/README.ja

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
pty 拡張モジュール version 0.3 by A.ito
1+
= pty 拡張モジュール version 0.3 by A.ito
22

33
1. はじめに
44

5-
この拡張モジュールは,仮想tty (pty) を通して適当なコマンドを
6-
実行する機能を ruby に提供します.
5+
この拡張モジュールは,仮想tty (pty) を通して適当なコマンドを
6+
実行する機能を ruby に提供します.
77

88
2. インストール
99

10-
次のようにしてインストールしてください.
10+
次のようにしてインストールしてください.
1111

12-
(1) ruby extconf.rb
12+
1. <tt>ruby extconf.rb</tt>
13+
を実行すると Makefile が生成されます.
1314

14-
を実行すると Makefile が生成されます.
15-
16-
(2) make; make install を実行してください.
15+
2. <tt>make; make install</tt> を実行してください.
1716

1817
3. 何ができるか
1918

20-
この拡張モジュールは,PTY というモジュールを定義します.その中
21-
には,次のようなモジュール関数が含まれています.
19+
この拡張モジュールは,PTY というモジュールを定義します.その中
20+
には,次のようなモジュール関数が含まれています.
2221

23-
getpty(command)
24-
spawn(command)
22+
[PTY.getpty(command)]
23+
[PTY.spawn(command)]
2524

2625
この関数は,仮想ttyを確保し,指定されたコマンドをその仮想tty
2726
の向こうで実行し,配列を返します.戻り値は3つの要素からなる
@@ -35,20 +34,15 @@ pty 拡張モジュール version 0.3 by A.ito
3534
のみ例外が発生します.子プロセスをモニターしているスレッドはブロッ
3635
クを抜けるときに終了します.
3736

38-
protect_signal
39-
reset_signal
40-
41-
廃止予定です.
42-
43-
PTY.open
37+
[PTY.open]
4438

4539
仮想ttyを確保し,マスター側に対応するIOオブジェクトとスレーブ側に
4640
対応するFileオブジェクトの配列を返します.ブロック付きで呼び出さ
4741
れた場合は,これらの要素はブロックパラメータとして渡され,ブロッ
4842
クから返された結果を返します.また、このマスターIOとスレーブFile
4943
は、ブロックを抜けるときにクローズ済みでなければクローズされます.
5044

51-
PTY.check(pid[, raise=false])
45+
[PTY.check(pid[, raise=false])]
5246

5347
pidで指定された子プロセスの状態をチェックし,実行中であればnilを
5448
返します.終了しているか停止している場合、第二引数が偽であれば、
@@ -57,20 +51,20 @@ pty 拡張モジュール version 0.3 by A.ito
5751

5852
4. 利用について
5953

60-
伊藤彰則が著作権を保有します.
54+
伊藤彰則が著作権を保有します.
6155

62-
ソースプログラムまたはドキュメントに元の著作権表示が改変されずに
63-
表示されている場合に限り,誰でも,このソフトウェアを無償かつ著作
64-
権者に無断で利用・配布・改変できます.利用目的は限定されていませ
65-
ん.
56+
ソースプログラムまたはドキュメントに元の著作権表示が改変されずに
57+
表示されている場合に限り,誰でも,このソフトウェアを無償かつ著作
58+
権者に無断で利用・配布・改変できます.利用目的は限定されていませ
59+
ん.
6660

67-
このプログラムの利用・配布その他このプログラムに関係する行為によ
68-
って生じたいかなる損害に対しても,作者は一切責任を負いません.
61+
このプログラムの利用・配布その他このプログラムに関係する行為によ
62+
って生じたいかなる損害に対しても,作者は一切責任を負いません.
6963

7064
5. バグ報告等
7165

72-
バグレポートは歓迎します.
66+
バグレポートは歓迎します.
7367

7468
aito@ei5sun.yz.yamagata-u.ac.jp
7569

76-
まで電子メールでバグレポートをお送りください.
70+
まで電子メールでバグレポートをお送りください.

0 commit comments

Comments
 (0)