1# Square sample
2Text filter that demonstrates the use of `parallel_pipeline`. Example program reads a file containing decimal integers in text format, and changes each to its square.
3
4## Building the example
5```
6cmake <path_to_example>
7cmake --build .
8```
9
10## Running the sample
11### Predefined make targets
12* `make run_square` - executes the example with predefined parameters
13* `make perf_run_square` - executes the example with suggested parameters to measure the oneTBB performance
14* `make light_test_square` - executes the example with suggested parameters to reduce execution time.
15
16### Application parameters
17Usage:
18```
19square [n-of-threads=value] [input-file=value] [output-file=value] [max-slice-size=value] [silent] [-h] [n-of-threads [input-file [output-file [max-slice-size]]]]
20```
21* `-h` - prints the help for command line options.
22* `n-of-threads` - the number of threads to use; a range of the form low\[:high\], where low and optional high are non-negative integers or `auto` for a platform-specific default number.
23* `input`- file is an input file name.
24* `output`- file is an output file name.
25* `max-slice-size` - the maximum number of characters in one slice.
26* `silent` - no output except elapsed time.
27