Subject: | Typos in POD + patch |
Fixed a bunch of POD issues.
I haven't made any updates mentions in the module review (http://cpanratings.perl.org/dist/IPC-Cmd).
Subject: | patch.txt |
99,100c99,100
< IPC::Cmd allows you to run commands, interactively if desired,
< platform independent but have them still work.
---
> IPC::Cmd allows you to run commands platform independently,
> interactively if desired, but have them still work.
112,113c112,113
< If the verbose flag is passed, it will print diagnostic messages
< if C<IPC::Run> can not be found or loaded.
---
> If the C<verbose> flag is passed, it will print diagnostic messages
> if L<IPC::Run> can not be found or loaded.
122c122
< ### ipc::run doesn't run on win98
---
> ### IPC::Run doesn't run on win98
148c148
< ### ipc::open3 is not working on VMS becasue of a lack of fork.
---
> ### IPC::Open3 is not working on VMS becasue of a lack of fork.
152c152
< ### ipc::open3 works on every non-VMS platform platform, but it can't
---
> ### IPC::Open3 works on every non-VMS platform platform, but it can't
186c186
< C<can_run> takes but a single argument: the name of a binary you wish
---
> C<can_run> takes only one argument: the name of a binary you wish
197,199c197,199
< If called in a list context and the global variable C<$INSTANCES> is a true value
< it will return a list of the full paths to instances
< of the binary where found in C<PATH> or an empty list if it was not found.
---
> If called in a list context and the global variable C<$INSTANCES> is a true
> value, it will return a list of the full paths to instances
> of the binary where found in C<PATH>, or an empty list if it was not found.
249c249
< See L<CAVEATS> for remarks on how commands are parsed and their
---
> See L<"Caveats"> for remarks on how commands are parsed and their
256,257c256,257
< require C<IPC::Run> to be installed or your system able to work with
< C<IPC::Open3>).
---
> require L<IPC::Run> to be installed, or your system able to work with
> L<IPC::Open3>).
272c272
< the note on buffers right above.
---
> the note on buffers above.
279c279
< C<IPC::Cmd::TimeOut> class. See the C<errorcode> section below for
---
> C<IPC::Cmd::TimeOut> class. See the L<"error message"> section below for
299c299
< If the first element of the return value (success) was 0, then some
---
> If the first element of the return value (C<success>) was 0, then some
309c309
< This is an arrayreference containing all the output the command
---
> This is an array reference containing all the output the command
311,313c311,313
< Note that buffers are only available if you have C<IPC::Run> installed,
< or if your system is able to work with C<IPC::Open3> -- See below).
< This element will be C<undef> if this is not the case.
---
> Note that buffers are only available if you have L<IPC::Run> installed,
> or if your system is able to work with L<IPC::Open3> -- see below).
> Otherwise, this element will be C<undef>.
317,321c317,318
< This is an arrayreference containing all the output sent to STDOUT the
< command generated.
< Note that buffers are only available if you have C<IPC::Run> installed,
< or if your system is able to work with C<IPC::Open3> -- See below).
< This element will be C<undef> if this is not the case.
---
> This is an array reference containing all the output sent to STDOUT the
> command generated. The notes from L<"full_buffer"> apply.
326,329c323,324
< command generated.
< Note that buffers are only available if you have C<IPC::Run> installed,
< or if your system is able to work with C<IPC::Open3> -- See below).
< This element will be C<undef> if this is not the case.
---
> command generated. The notes from L<"full_buffer"> apply.
>
333c328
< See the C<HOW IT WORKS> Section below to see how C<IPC::Cmd> decides
---
> See the L<"HOW IT WORKS"> section below to see how C<IPC::Cmd> decides
599,600c594,595
< In addition it allows to terminate the program
< which take too long to finish.
---
> In addition, it allows to terminate the program
> if it takes too long to finish.
628c623
< Specify in seconds how long the command may run for before it is killed with with SIG_KILL (9)
---
> Specify in seconds how long to run the command before it is killed with with SIG_KILL (9),
633c628
< Specify some text that will be passed into C<STDIN> of the executed program.
---
> Specify some text that will be passed into the C<STDIN> of the executed program.
637,638c632,633
< You may provide a coderef of a subroutine that will be called a portion of data is received on
< stdout from the executing program.
---
> Coderef of a subroutine to call when a portion of data is received on
> STDOUT from the executing program.
642,643c637,639
< You may provide a coderef of a subroutine that will be called a portion of data is received on
< stderr from the executing program.
---
> Coderef of a subroutine to call when a portion of data is received on
> STDERR from the executing program.
>
672,673c668,669
< Holds the standard output of the executed command
< (or empty string if there were no stdout output or if discard_output was used; it's always defined!)
---
> Holds the standard output of the executed command (or empty string if
> there was no STDOUT output or if C<discard_output> was used; it's always defined!)
677,678c673,674
< Holds the standard error of the executed command
< (or empty string if there were no stderr output or if discard_output was used; it's always defined!)
---
> Holds the standard error of the executed command (or empty string if
> there was no STDERR output or if C<discard_output> was used; it's always defined!)
683c679
< (or empty string if there were no output at all or if discard_output was used; it's always defined!)
---
> (or empty string if there was no output at all or if C<discard_output> was used; it's always defined!)
1259c1255
< ### text::parsewords::shellwordss() uses unix semantics. that will break
---
> ### Text::ParseWords::shellwords() uses unix semantics. that will break
1660c1656
< is set to true (See the C<GLOBAL VARIABLES> Section) use that to execute
---
> is set to true (See the L<"Global Variables"> section) use that to execute
1667,1668c1663,1664
< (See the C<GLOBAL VARIABLES> Section), try to execute the command using
< C<IPC::Open3>. Buffers will be available on all platforms except C<Win32>,
---
> (See the L<"Global Variables"> section), try to execute the command using
> L<IPC::Open3>. Buffers will be available on all platforms except C<Win32>,
1674,1675c1670,1671
< Otherwise, if you have the verbose argument set to true, we fall back
< to a simple system() call. We cannot capture any buffers, but
---
> Otherwise, if you have the C<verbose> argument set to true, we fall back
> to a simple C<system()> call. We cannot capture any buffers, but
1681c1677
< system() call with your command and then re-open STDERR and STDOUT.
---
> C<system()> call with your command and then re-open STDERR and STDOUT.
1695c1691
< commands to the screen or not. The default is 0;
---
> commands to the screen or not. The default is 0.
1709c1705
< This variable controls whether run time warnings should be issued, like
---
> This variable controls whether run-time warnings should be issued, like
1730c1726
< However, if you provide and C<Array Reference>, special rules apply:
---
> However, if you provide an array reference, special rules apply:
1732c1728
< If your command contains C<Special Characters> (< > | &), it will
---
> If your command contains B<special characters> (< > | &), it will
1739c1735
< Therefor, C<IPC::Cmd> will quote any arguments containing whitespace in your
---
> Therefore, C<IPC::Cmd> will quote any arguments containing whitespace in your
1751c1747
< Note however, if there's extra or spurious whitespace in these parts,
---
> Note however, if there are extra or spurious whitespaces in these parts,
1778c1774
< Redirections. For capturing STDOUT or STDERR there is a work around
---
> redirections. For capturing STDOUT or STDERR there is a work around
1784c1780
< bursts of output from a program, ie this sample:
---
> bursts of output from a program, e.g. this sample,
1791c1787
< the output looks like 1 line on each, namely '13' on STDOUT and '24' on STDERR.
---
> the output looks like '13' on STDOUT and '24' on STDERR, instead of
1793c1789,1792
< It should have been 1, 2, 3, 4.
---
> 1
> 2
> 3
> 4
1796c1795
< STDOUT and STDERR
---
> STDOUT and STDERR.
1802c1801
< C<IPC::Run>, C<IPC::Open3>
---
> L<IPC::Run>, L<IPC::Open3>
1807c1806
< help in getting IPC::Open3 to behave nicely.
---
> help in getting L<IPC::Open3> to behave nicely.
1817c1816,1817
< This module by Jos Boumans E<lt>kane@cpan.orgE<gt>.
---
> Original author: Jos Boumans E<lt>kane@cpan.orgE<gt>.
> Current maintainer: Chris Williams E<lt>bingos@cpan.orgE<gt>.