I noticed a spelling error in one of the man pages (and had a bit too much free time) and I went through the .pod pages and tried to fix-up some spelling errors.
There also doesn't seem to be consistency one space or two between sentences. -- Efraim Flashner <[email protected]> אפרים פלשנר GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351 Confidentiality cannot be guaranteed on emails sent or received unencrypted
From 16da9c5f74422f37662759584ecbb8bb5c6d24e6 Mon Sep 17 00:00:00 2001 From: Efraim Flashner <[email protected]> Date: Wed, 1 Aug 2018 20:04:26 +0300 Subject: [PATCH] various spelling corrections --- src/niceload.pod | 10 ++++----- src/parallel.pod | 12 +++++------ src/parallel_alternatives.pod | 38 +++++++++++++++++------------------ src/parallel_book.pod | 10 ++++----- src/parallel_design.pod | 10 ++++----- src/parallel_tutorial.pod | 2 +- 6 files changed, 41 insertions(+), 41 deletions(-) diff --git a/src/niceload.pod b/src/niceload.pod index 064c6c0..abc8529 100644 --- a/src/niceload.pod +++ b/src/niceload.pod @@ -62,7 +62,7 @@ under the limits. The default is B<--soft>. Limit for I/O. The amount of disk I/O will be computed as a value 0 - 10, where 0 is no I/O and 10 is at least one disk is 100% saturated. -B<--io> will set both B<--start-io> and B<run-io>. +B<--io> will set both B<--start-io> and B<--run-io>. =item B<--load> I<loadlimit> @@ -71,7 +71,7 @@ B<--io> will set both B<--start-io> and B<run-io>. Limit for load average. -B<--load> will set both B<--start-load> and B<run-load>. +B<--load> will set both B<--start-load> and B<--run-load>. =item B<--mem> I<memlimit> @@ -87,7 +87,7 @@ I<memlimit> can be postfixed with K, M, G, T, or P which would multiply the size with 1024, 1048576, 1073741824, or 1099511627776 respectively. -B<--mem> will set both B<--start-mem> and B<run-mem>. +B<--mem> will set both B<--start-mem> and B<--run-mem>. =item B<--noswap> @@ -99,7 +99,7 @@ indication that the system is memory stressed. B<--noswap> is over limit if the system is swapping both in and out. -B<--noswap> will set both B<--start-noswap> and B<run-noswap>. +B<--noswap> will set both B<--start-noswap> and B<--run-noswap>. =item B<--net> @@ -260,7 +260,7 @@ B<niceload -L 2 updatedb> =head1 EXAMPLE: Run rsync -rsync can just like updatedb starve the system for disk I/O and thus result in a high load. +rsync can, just like updatedb, starve the system for disk I/O and thus result in a high load. Run rsync but keep load below 3.4. If load reaches 7 sleep for (7-3.4)*12 seconds: diff --git a/src/parallel.pod b/src/parallel.pod index 4319741..b4aeb91 100644 --- a/src/parallel.pod +++ b/src/parallel.pod @@ -118,7 +118,7 @@ replacement string; then the string is not quoted. Input line without extension. This replacement string will be replaced by the input with the extension removed. If the input line contains -B<.> after the last B</> the last B<.> till the end of the string will +B<.> after the last B</>, the last B<.> until the end of the string will be removed and B<{.}> will be replaced with the remaining. E.g. I<foo.jpg> becomes I<foo>, I<subdir/foo.jpg> becomes I<subdir/foo>, I<sub.dir/foo.jpg> becomes I<sub.dir/foo>, @@ -659,7 +659,7 @@ equivalent: B<--delay 100000> and B<--delay 1d3.5h16.6m4s>. Print the job to run on stdout (standard output), but do not run the job. Use B<-v -v> to include the wrapping that GNU Parallel generates (for remote jobs, B<--tmux>, B<--nice>, B<--pipe>, B<--pipepart>, -B<--fifo> and B<--cat>). Do not count on this literaly, though, as the +B<--fifo> and B<--cat>). Do not count on this literally, though, as the job may be scheduled on another computer or the local computer if : is in the list. @@ -773,7 +773,7 @@ may not be used. B<--gnu> is kept for compatibility. =item B<--group> Group output. Output from each job is grouped together and is only -printed when the command is finished. stdout (standard output) first +printed when the command is finished. Stdout (standard output) first followed by stderr (standard error). This takes in the order of 0.5ms per job and depends on the speed of @@ -855,7 +855,7 @@ exit when 3% of the jobs have finished. Kill running jobs. =back -For backwards compability these also work: +For backwards compatibility these also work: =over 12 @@ -3052,11 +3052,11 @@ B<{=> and B<=}> mark a perl expression. B<pQ> perl-quotes the string. B<date +%FT%T> is the date in ISO8601 with time. -=head1 EXAMPLE: Digtal clock with "blinking" : +=head1 EXAMPLE: Digital clock with "blinking" : The : in a digital clock blinks. To make every other line have a ':' and the rest a ' ' a perl expression is used to look at the 3rd input -source. If the value modudo 2 is 1: Use ":" otherwise use " ": +source. If the value modulo 2 is 1: Use ":" otherwise use " ": parallel -k echo {1}'{=3 $_=$_%2?":":" "=}'{2}{3} \ ::: {0..12} ::: {0..5} ::: {0..9} diff --git a/src/parallel_alternatives.pod b/src/parallel_alternatives.pod index 617b697..4093bfc 100644 --- a/src/parallel_alternatives.pod +++ b/src/parallel_alternatives.pod @@ -205,7 +205,7 @@ composed commands and redirection require using B<bash -c>. ls | parallel "wc {} >{}.wc" ls | parallel "echo {}; ls {}|wc" -becomes (assuming you have 8 cores and that none of the file names +becomes (assuming you have 8 cores and that none of the filenames contain space, " or '). ls | xargs -d "\n" -P8 -I {} bash -c "wc {} >{}.wc" @@ -216,9 +216,9 @@ https://www.gnu.org/software/findutils/ =head2 DIFFERENCES BETWEEN find -exec AND GNU Parallel -B<find -exec> offer some of the same possibilities as GNU B<parallel>. +B<find -exec> offers some of the same possibilities as GNU B<parallel>. -B<find -exec> only works on files. So processing other input (such as +B<find -exec> only works on files. Processing other input (such as hosts or URLs) will require creating these inputs as files. B<find -exec> has no support for running commands in parallel. @@ -228,13 +228,13 @@ https://www.gnu.org/software/findutils/ =head2 DIFFERENCES BETWEEN make -j AND GNU Parallel B<make -j> can run jobs in parallel, but requires a crafted Makefile -to do this. That results in extra quoting to get filename containing -newline to work correctly. +to do this. That results in extra quoting to get filenames containing +newlines to work correctly. B<make -j> computes a dependency graph before running jobs. Jobs run -by GNU B<parallel> does not depend on eachother. +by GNU B<parallel> does not depend on each other. -(Very early versions of GNU B<parallel> were coincidently implemented +(Very early versions of GNU B<parallel> were coincidentally implemented using B<make -j>). https://www.gnu.org/software/make/ @@ -250,8 +250,8 @@ into files. The argument replace string ($ITEM) cannot be changed. Arguments must be quoted - thus arguments containing special characters (space '"&!*) -may cause problems. More than one argument is not supported. File -names containing newlines are not processed correctly. When reading +may cause problems. More than one argument is not supported. Filenames +containing newlines are not processed correctly. When reading input from a file null cannot be used as a terminator. B<ppss> needs to read the whole input file before starting any jobs. @@ -615,7 +615,7 @@ https://github.com/cheusov/paexec B<map> sees it as a feature to have less features and in doing so it also handles corner cases incorrectly. A lot of GNU B<parallel>'s code is to handle corner cases correctly on every platform, so you will not -get a nasty surprise if a user for example saves a file called: I<My +get a nasty surprise if a user, for example, saves a file called: I<My brother's 12" records.txt> B<map>'s example showing how to deal with special characters fails on @@ -756,7 +756,7 @@ B<jobflow> can run multiple jobs in parallel. Just like B<xargs> output from B<jobflow> jobs running in parallel mix together by default. B<jobflow> can buffer into files (placed in /run/shm), but these are not cleaned up - not even if B<jobflow> dies -unexpectently. If the total output is big (in the order of RAM+swap) +unexpectedly. If the total output is big (in the order of RAM+swap) it can cause the system to run out of memory. B<jobflow> gives no error if the command is unknown, and like B<xargs> @@ -897,7 +897,7 @@ These do something different from GNU B<parallel> Rust parallel has no remote facilities. It uses /tmp/parallel for tmp files and does not clean up if -terminated abrubtly. If another user on the system uses Rust parallel, +terminated abruptly. If another user on the system uses Rust parallel, then /tmp/parallel will have the wrong permissions and Rust parallel will fail. A malicious user can setup the right permissions and symlink the output file to one of the user's files and next time the @@ -1112,7 +1112,7 @@ B<15. Interrupt jobs by `Ctrl-C`, rush will stop unfinished commands and exit.> ^C B<16. Continue/resume jobs (`-c`). When some jobs failed (by -execution failure, timeout, or cancelling by user with `Ctrl + C`), +execution failure, timeout, or canceling by user with `Ctrl + C`), please switch flag `-c/--continue` on and run again, so that `rush` can save successful commands and ignore them in I<NEXT> run.> @@ -1144,7 +1144,7 @@ Multi-line jobs: B<17. A comprehensive example: downloading 1K+ pages given by three URL list files using `phantomjs save_page.js` (some page -contents are dynamicly generated by Javascript, so `wget` does not +contents are dynamically generated by Javascript, so `wget` does not work). Here I set max jobs number (`-j`) as `20`, each job has a max running time (`-t`) of `60` seconds and `3` retry changes (`-r`). Continue flag `-c` is also switched on, so we can continue @@ -1298,7 +1298,7 @@ double space, ' and ": =item * Commands of multi-lines While you I<can> use multi-lined commands in GNU B<parallel>, to -improve readibilty GNU B<parallel> discourages the use of multi-line +improve readability GNU B<parallel> discourages the use of multi-line commands. In most cases it can be written as a function: seq 1 3 | @@ -1376,7 +1376,7 @@ It can be emulated with GNU B<parallel> using this Bash function: parallel $(_cmds "$@")'|| echo exit status $?' ::: */ } -This works execpt for the B<--exclude> option. +This works except for the B<--exclude> option. =head2 DIFFERENCES BETWEEN pyargs AND GNU Parallel @@ -1432,7 +1432,7 @@ The output is prepended with the job number, and may be incomplete: 7165 When pretty printing it caches output in memory. Output mixes by using -test MIX below wether or not output is cached. +test MIX below whether or not output is cached. There seems to be no way of making a template command and have B<concurrently> fill that with different args. The full commands must @@ -1457,7 +1457,7 @@ B<map> itself, the output also mixes: seq 10 | map i 'echo start-$i && sleep 0.$i && echo end-$i &' -The major difference is that GNU B<parallel> is build for parallelization +The major difference is that GNU B<parallel> is built for parallelization and map is not. So GNU B<parallel> has lots of ways of dealing with the issues that parallelization raises: @@ -1490,7 +1490,7 @@ Here are the 5 examples converted to GNU Parallel: 4$ printf "1\n1\n1\n" | map t 'sleep $t && say done' 4$ printf "1\n1\n1\n" | parallel 'sleep {} && say done' - 4$ paralllel 'sleep {} && say done' ::: 1 1 1 + 4$ parallel 'sleep {} && say done' ::: 1 1 1 5$ printf "1\n1\n1\n" | map t 'sleep $t && say done &' 5$ printf "1\n1\n1\n" | parallel -j0 'sleep {} && say done' diff --git a/src/parallel_book.pod b/src/parallel_book.pod index 66b0c66..c8fc3d9 100644 --- a/src/parallel_book.pod +++ b/src/parallel_book.pod @@ -15,7 +15,7 @@ situations, and to avoid overloading you with information, the most used features are presented first. All the examples are tested in Bash, and most will work in other -shells, too, but there are a few exceptions. So you are recommened to +shells, too, but there are a few exceptions. So you are recommended to use Bash while testing out the examples. @@ -209,8 +209,8 @@ If the input is B<mydir/mysubdir/myfile.myext> then: {#} = the sequence number of the job {%} = the job slot number -When a job is started it gets sequence number that starts at 1 and -increases with 1 for each new job. The job also gets assigned a slot +When a job is started it gets a sequence number that starts at 1 and +increases by 1 for each new job. The job also gets assigned a slot number. This number is from 1 to the number of jobs running in parallel. It is unique between the running jobs, but is re-used as soon as a job finishes. @@ -349,7 +349,7 @@ A shorthand for B<--transfer --return {} --cleanup> is B<--trc {}>. =head1 Advanced usage -parset fifo, cmd substtition, arrayelements, array with var names and cmds, env_parset +parset fifo, cmd substitution, arrayelements, array with var names and cmds, env_parset env_parallel @@ -384,7 +384,7 @@ Interfacing with HTML/? seq 10 | parallel --sshlogin 'ssh -i "key.pem" [email protected]' echo -seq 10 | PARALLLEL_SSH='ssh -i "key.pem"' parallel --sshlogin [email protected] echo +seq 10 | PARALLEL_SSH='ssh -i "key.pem"' parallel --sshlogin [email protected] echo seq 10 | parallel --ssh 'ssh -i "key.pem"' --sshlogin [email protected] echo diff --git a/src/parallel_design.pod b/src/parallel_design.pod index 3f2e0d1..76fa326 100644 --- a/src/parallel_design.pod +++ b/src/parallel_design.pod @@ -213,10 +213,10 @@ error (stderr). GNU B<parallel> pipes output from the command run into the compression program which saves to a tmpfile. GNU B<parallel> records the pid of -the compress program. At the same time a small perl script (called +the compress program. At the same time a small Perl script (called B<cattail> above) is started: It basically does B<cat> followed by B<tail -f>, but it also removes the tmpfile as soon as the first byte -is read, and it continously checks if the pid of the compression +is read, and it continuously checks if the pid of the compression program is dead. If the compress program is dead, B<cattail> reads the rest of tmpfile and exits. @@ -539,7 +539,7 @@ needs to know how to read the function. From version 20150122 GNU B<parallel> tries both the ()-version and the %%-version, and the function definition works on both pre- and -post-shellshock versions of B<bash>. +post-shell shock versions of B<bash>. =head2 The remote system wrapper @@ -1183,7 +1183,7 @@ software, username, password, host, port, database, and table in a single string. The DBURL must point to a table name. The table will be dropped and -created. The reason for not reusing an exising table is that the user +created. The reason for not reusing an existing table is that the user may have added more input sources which would require more columns in the table. By prepending '+' to the DBURL the table will not be dropped. @@ -1239,7 +1239,7 @@ instead? See a list in: B<man parallel_alternatives>. =head2 Multiple processes working together Open3 is slow. Printing is slow. It would be good if they did not tie -up ressources, but were run in separate threads. +up resources, but were run in separate threads. =head2 --rrs on remote using a perl wrapper diff --git a/src/parallel_tutorial.pod b/src/parallel_tutorial.pod index 61c934c..a6895cb 100644 --- a/src/parallel_tutorial.pod +++ b/src/parallel_tutorial.pod @@ -2906,7 +2906,7 @@ Output: =head2 Timeout With B<--semaphoretimeout> you can force running the command anyway after -a period (postive number) or give up (negative number): +a period (positive number) or give up (negative number): sem --id foo -u 'echo Slow started; sleep 5; echo Slow ended' && sem --id foo --semaphoretimeout 1 'echo Forced running after 1 sec' && -- 2.18.0
signature.asc
Description: PGP signature
