Adding pipe mode to generate_manual.sh, README.md. Add test_pipe_mode_wc_blocksize_100kib.

Author: aaronriekenberg

README.md

@@ -19,6 +19,7 @@ Listed in [Awesome Rust - utilities](https://github.com/rust-unofficial/awesome-
 Similar interface to [GNU Parallel](https://www.gnu.org/software/parallel/parallel_examples.html) or [xargs](https://man7.org/linux/man-pages/man1/xargs.1.html) plus useful features:
 * More than 10x faster than GNU Parallel [in benchmarks](https://github.com/aaronriekenberg/rust-parallel/wiki/Benchmarks)
 * Run commands from [stdin](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#commands-from-stdin), [input files](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#reading-multiple-inputs), or [`:::` arguments](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#commands-from-arguments)
+* [Pipe mode](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#pipe-mode) to read blocks from stdin and pass to parallel commands automatically.
 * Automatic parallelism to all cpus, or [configure manually](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#parallelism)
 * Transform inputs with [variables](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#automatic-variables) or [regular expressions](https://github.com/aaronriekenberg/rust-parallel/wiki/Manual#regular-expression)
 * Prevent [output interleaving](https://github.com/aaronriekenberg/rust-parallel/wiki/Output-Interleaving) and maintain input order with `-k`/`--keep-order`

scripts/generate_manual.sh

@@ -15,6 +15,7 @@ echo '
 1. [Commands from stdin](#commands-from-stdin)
 1. [Command and initial arguments on command line](#command-and-initial-arguments-on-command-line)
 1. [Reading multiple inputs](#reading-multiple-inputs)
+1. [Pipe Mode](#pipe-mode)
 1. [Parallelism](#parallelism)
 1. [Keep Output Order](#keep-output-order)
 1. [Dry run](#dry-run)
@@ -142,6 +143,30 @@ rm -f test
 
 echo '```'
 
+echo '## Pipe Mode
+
+The `--pipe` option can be used to enable pipe mode.
+
+In pipe mode input from stdin is split into blocks and each block is passed to a separate instance of the command via stdin.  Command instances are run in parallel.  
+
+The default block size is 1 MiB, which can be changed with the `--block-size` option.
+
+Here we use `--pipe` to run `wc -l`
+'
+
+echo '```'
+echo '$ cat /usr/share/dict/words | rust-parallel --pipe wc -l'
+cat /usr/share/dict/words | $RUST_PARALLEL --pipe wc -l
+echo '```'
+
+echo 'Here we use pipe mode with with a smaller block size of 500 KiB:'
+
+echo '```'
+echo '$ cat /usr/share/dict/words | rust-parallel --pipe --block-size=500KiB wc -l'
+cat /usr/share/dict/words | $RUST_PARALLEL --pipe --block-size=500KiB wc -l
+echo '```'
+
+
 echo '
 ## Parallelism
 

tests/integration_tests.rs

@@ -671,7 +671,26 @@ E"#;
 }
 
 #[test]
-fn test_pipe_mode_wc_blocksize1() {
+fn test_pipe_mode_wc_blocksize_100kib() {
+    let stdin = r#"A
+B
+C
+D
+E"#;
+    rust_parallel()
+        .write_stdin(stdin)
+        .arg("--pipe")
+        .arg("--block-size=100KiB")
+        .arg("wc")
+        .arg("-l")
+        .assert()
+        .success()
+        .stdout(predicate::str::contains("5\n").count(1))
+        .stderr(predicate::str::is_empty());
+}
+
+#[test]
+fn test_pipe_mode_wc_blocksize_1() {
     let stdin = r#"A
 B
 C