README

   1
   2                          GNU Parallel README
   3
   4 Please send problems and feedback to bug-parallel@gnu.org.
   5
   6
   7 = Presentation of GNU Parallel =
   8
   9 GNU Parallel is a shell tool for executing jobs in parallel using one
  10 or more computers. A job can be a single command or a small script
  11 that has to be run for each of the lines in the input. The typical
  12 input is a list of files, a list of hosts, a list of users, a list of
  13 URLs, or a list of tables. A job can also be a command that reads from
  14 a pipe. GNU Parallel can then split the input and pipe it into
  15 commands in parallel.
  16
  17 If you use xargs and tee today you will find GNU Parallel very easy to
  18 use as GNU Parallel is written to have the same options as xargs. If
  19 you write loops in shell, you will find GNU Parallel may be able to
  20 replace most of the loops and make them run faster by running several
  21 jobs in parallel.
  22
  23 GNU Parallel makes sure output from the commands is the same output as
  24 you would get had you run the commands sequentially. This makes it
  25 possible to use output from GNU Parallel as input for other programs.
  26
  27
  28 = 10 seconds installation =
  29
  30 For security reasons it is recommended you use your package manager to
  31 install. But if you cannot do that then you can use this 10 seconds
  32 installation.
  33
  34 The 10 seconds installation will try to do a full installation; if
  35 that fails, a personal installation; if that fails, a minimal
  36 installation.
  37
  38     $ (wget -O - pi.dk/3 || lynx -source pi.dk/3 || curl pi.dk/3/ || \
  39        fetch -o - http://pi.dk/3 ) > install.sh
  40     $ sha1sum install.sh | grep 3374ec53bacb199b245af2dda86df6c9
  41     12345678 3374ec53 bacb199b 245af2dd a86df6c9
  42     $ md5sum install.sh | grep 029a9ac06e8b5bc6052eac57b2c3c9ca
  43     029a9ac0 6e8b5bc6 052eac57 b2c3c9ca
  44     $ sha512sum install.sh | grep f517006d9897747bed8a4694b1acba1b
  45     40f53af6 9e20dae5 713ba06c f517006d 9897747b ed8a4694 b1acba1b 1464beb4
  46     60055629 3f2356f3 3e9c4e3c 76e3f3af a9db4b32 bd33322b 975696fc e6b23cfb
  47     $ bash install.sh
  48
  49 This will literally install faster than reading the rest of this
  50 document.
  51
  52
  53 = Full installation =
  54
  55 Full installation of GNU Parallel is as simple as:
  56
  57     wget https://ftpmirror.gnu.org/parallel/parallel-20190722.tar.bz2
  58     wget https://ftpmirror.gnu.org/parallel/parallel-20190722.tar.bz2.sig
  59     gpg parallel-20190722.tar.bz2.sig
  60     bzip2 -dc parallel-20190722.tar.bz2 | tar xvf -
  61     cd parallel-20190722
  62     ./configure && make && sudo make install
  63
  64
  65 = Personal installation =
  66
  67 If you are not root you can add ~/bin to your path and install in
  68 ~/bin and ~/share:
  69
  70     wget https://ftpmirror.gnu.org/parallel/parallel-20190722.tar.bz2
  71     wget https://ftpmirror.gnu.org/parallel/parallel-20190722.tar.bz2.sig
  72     gpg parallel-20190722.tar.bz2.sig
  73     bzip2 -dc parallel-20190722.tar.bz2 | tar xvf -
  74     cd parallel-20190722
  75     ./configure --prefix=$HOME && make && make install
  76
  77 Or if your system lacks 'make' you can simply copy src/parallel
  78 src/sem src/niceload src/sql to a dir in your path.
  79
  80
  81 = Minimal installation =
  82
  83 If you just need parallel and do not have 'make' installed (maybe the
  84 system is old or Microsoft Windows):
  85
  86     wget https://git.savannah.gnu.org/cgit/parallel.git/plain/src/parallel
  87     chmod 755 parallel
  88     cp parallel sem
  89     mv parallel sem dir-in-your-$PATH/bin/
  90
  91
  92 = Test the installation =
  93
  94 After this you should be able to do:
  95
  96     parallel -j0 ping -nc 3 ::: qubes-os.org gnu.org freenetproject.org
  97
  98 This will send 3 ping packets to 3 different hosts in parallel and print
  99 the output when they complete.
 100
 101 Watch the intro video for a quick introduction:
 102 https://www.youtube.com/playlist?list=PL284C9FF2488BC6D1
 103
 104 Walk through the tutorial (man parallel_tutorial). You command line
 105 will love you for it.
 106
 107 When using programs that use GNU Parallel to process data for
 108 publication please cite:
 109
 110     O. Tange (2018): GNU Parallel 2018, Mar 2018, ISBN 9781387509881,
 111     DOI https://doi.org/10.5281/zenodo.11460
 112
 113
 114 = New versions =
 115
 116 New versions will be released at: https://ftp.gnu.org/gnu/parallel/
 117
 118
 119 = Dependencies =
 120
 121 GNU Parallel should work with a normal full Perl installation. However,
 122 if you system has split up Perl into multiple packages then these are
 123 the important ones:
 124
 125     opkg install perlbase-getopt perlbase-ipc procps-ng-ps perlbase-mime