diff options
author | akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-12-04 15:21:32 +0000 |
---|---|---|
committer | akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2008-12-04 15:21:32 +0000 |
commit | 49b10fd508850e396f181101770948aaf8517922 (patch) | |
tree | 2acd869bf43e7842d6081ed51efc9858e9ba1a93 /io.c | |
parent | f149326740c4d684de70564ecec88263e01bd3d3 (diff) |
rdoc update.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@20522 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'io.c')
-rw-r--r-- | io.c | 27 |
1 files changed, 20 insertions, 7 deletions
@@ -4684,14 +4684,27 @@ pop_last_hash(int *argc_p, VALUE *argv) * * Runs the specified command as a subprocess; the subprocess's * standard input and output will be connected to the returned - * <code>IO</code> object. If _cmd_ is a +String+ - * ``<code>-</code>'', then a new instance of Ruby is started as the - * subprocess. If <i>cmd</i> is an +Array+ of +String+, then it will - * be used as the subprocess's +argv+ bypassing a shell. + * <code>IO</code> object. + * + * _cmd_ is a string or an array as follows. + * + * cmd: + * "-" : fork + * commandline : command line string which is passed to a shell + * [env, cmdname, arg1, ..., opts] : command name and arguments (no shell) + * [env, [cmdname, argv0], arg1, ..., opts] : command name and arguments including argv[0] (no shell) + * (env and opts are optional.) + * + * If _cmd_ is a +String+ ``<code>-</code>'', + * then a new instance of Ruby is started as the subprocess. + * + * If <i>cmd</i> is an +Array+ of +String+, + * then it will be used as the subprocess's +argv+ bypassing a shell. * The array can contains a hash at first for environments and - * a hash at last for options similar to <code>spawn</code>. The default - * mode for the new file object is ``r'', but <i>mode</i> may be set - * to any of the modes listed in the description for class IO. + * a hash at last for options similar to <code>spawn</code>. + * + * The default mode for the new file object is ``r'', + * but <i>mode</i> may be set to any of the modes listed in the description for class IO. * The last argument <i>opt</i> qualifies <i>mode</i>. * * # set IO encoding |