README

   1
   2                              GNU Parallel
   3
   4                 https://www.gnu.org/software/parallel/
   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 See the cheat sheet for examples that cover most of the daily usage:
  28 www.gnu.org/s/parallel/parallel_cheat.pdf
  29
  30
  31 = 10 seconds installation =
  32
  33 For security reasons it is recommended you use your package manager to
  34 install. But if you cannot do that then you can use this 10 seconds
  35 installation.
  36
  37 The 10 seconds installation will try to do a full installation; if
  38 that fails, a personal installation; if that fails, a minimal
  39 installation.
  40
  41     $ (wget -O - pi.dk/3 || lynx -source pi.dk/3 || curl pi.dk/3/ || \
  42        fetch -o - http://pi.dk/3 ) > install.sh
  43     $ sha1sum install.sh | grep 67bd7bc7dc20aff99eb8f1266574dadb
  44     12345678 67bd7bc7 dc20aff9 9eb8f126 6574dadb
  45     $ md5sum install.sh | grep b7a15cdbb07fb6e11b0338577bc1780f
  46     b7a15cdb b07fb6e1 1b033857 7bc1780f
  47     $ sha512sum install.sh | grep 186000b62b66969d7506ca4f885e0c80e02a22444
  48     6f25960b d4b90cf6 ba5b76de c1acdf39 f3d24249 72930394 a4164351 93a7668d
  49     21ff9839 6f920be5 186000b6 2b66969d 7506ca4f 885e0c80 e02a2244 40e8a43f
  50     $ bash install.sh
  51
  52 This will literally install faster than reading the rest of this
  53 document.
  54
  55
  56 = Full installation =
  57
  58 Full installation of GNU Parallel is as simple as:
  59
  60     wget https://ftpmirror.gnu.org/parallel/parallel-20210122.tar.bz2
  61     wget https://ftpmirror.gnu.org/parallel/parallel-20210122.tar.bz2.sig
  62     gpg parallel-20210122.tar.bz2.sig
  63     bzip2 -dc parallel-20210122.tar.bz2 | tar xvf -
  64     cd parallel-20210122
  65     ./configure && make && sudo make install
  66
  67
  68 = Personal installation =
  69
  70 If you are not root you can add ~/bin to your path and install in
  71 ~/bin and ~/share:
  72
  73     wget https://ftpmirror.gnu.org/parallel/parallel-20210122.tar.bz2
  74     wget https://ftpmirror.gnu.org/parallel/parallel-20210122.tar.bz2.sig
  75     gpg parallel-20210122.tar.bz2.sig
  76     bzip2 -dc parallel-20210122.tar.bz2 | tar xvf -
  77     cd parallel-20210122
  78     ./configure --prefix=$HOME && make && make install
  79
  80 Or if your system lacks 'make' you can simply copy src/parallel
  81 src/sem src/niceload src/sql to a dir in your path.
  82
  83
  84 = Minimal installation =
  85
  86 If you just need parallel and do not have 'make' installed (maybe the
  87 system is old or Microsoft Windows):
  88
  89     wget https://git.savannah.gnu.org/cgit/parallel.git/plain/src/parallel
  90     chmod 755 parallel
  91     cp parallel sem
  92     mv parallel sem dir-in-your-$PATH/bin/
  93
  94
  95 = Installation on compute servers =
  96
  97 If you are developing your script to run on a remote server, that does
  98 not have GNU Parallel installed, but you have it installed on you
  99 development machine, then you can use `parallel --embed`.
 100
 101     parallel --embed > newscript.sh
 102
 103 Just edit the last lines of newscript.sh and copy it to the compute
 104 server.
 105
 106
 107 = Test the installation =
 108
 109 After this you should be able to do:
 110
 111     parallel -j0 ping -nc 3 ::: qubes-os.org gnu.org freenetproject.org
 112
 113 This will send 3 ping packets to 3 different hosts in parallel and print
 114 the output when they complete.
 115
 116 Watch the intro video for a quick introduction:
 117 https://www.youtube.com/playlist?list=PL284C9FF2488BC6D1
 118
 119 Walk through the tutorial (man parallel_tutorial). You command line
 120 will love you for it.
 121
 122 When using programs that use GNU Parallel to process data for
 123 publication please cite:
 124
 125     Tange, O. (2021, January 22). GNU Parallel 20210122 ('Capitol Riots').
 126     Zenodo. https://doi.org/10.5281/zenodo.4454976
 127
 128 Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015,
 129 2016, 2017, 2018, 2019, 2020, 2021 Ole Tange, http://ole.tange.dk and
 130 Free Software Foundation, Inc.
 131
 132
 133 = New versions =
 134
 135 New versions will be released at: https://ftp.gnu.org/gnu/parallel/
 136
 137
 138 = Dependencies =
 139
 140 GNU Parallel should work with a normal full Perl installation. However,
 141 if you system has split up Perl into multiple packages then these are
 142 the important ones:
 143
 144     opkg install perlbase-getopt perlbase-ipc procps-ng-ps perlbase-mime