summaryrefslogtreecommitdiff
path: root/lib/open3.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/open3.rb')
-rw-r--r--lib/open3.rb22
1 files changed, 17 insertions, 5 deletions
diff --git a/lib/open3.rb b/lib/open3.rb
index 59db1a4cc5..f722252b1c 100644
--- a/lib/open3.rb
+++ b/lib/open3.rb
@@ -3,12 +3,24 @@
# which IO#popen does not allow)
#
# Usage:
-# require "open3"
#
-# stdin, stdout, stderr = Open3.popen3('nroff -man')
-# or
-# include Open3
-# stdin, stdout, stderr = popen3('nroff -man')
+# require "open3"
+#
+# stdin, stdout, stderr = Open3.popen3('nroff -man')
+#
+# or:
+#
+# include Open3
+#
+# stdin, stdout, stderr = popen3('nroff -man')
+#
+# popen3 can also take a block which will receive stdin, stdout and stderr as
+# parameters. This ensures stdin, stdout and stderr are closed once the block
+# exits.
+#
+# Such as:
+#
+# Open3.popen3('nroff -man') { |stdin, stdout, stderr| ... }
module Open3
#[stdin, stdout, stderr] = popen3(command);