1pslurp(1) General Commands Manual pslurp(1)
2
3
4
6 pslurp — parallel file download program
7
8
9
11 pslurp [-vAr] [-h hosts_file] [-H [user@]host[:port]] [-l user] [-p
12 par] [-o outdir] [-e errdir] [-t timeout] [-O options] [-x args] [-X
13 arg] [-L localdir] remote local
14
15
16
18 pslurp is a program for copying files in parallel from a number of
19 hosts using the scp program. It provides features such as passing a
20 password to scp, saving output to files, and timing out.
21
22
23
25 -h host_file
26 --hosts host_file
27 Read hosts from the given host_file. Lines in the host file are
28 of the form [user@]host[:port] and can include blank lines and
29 comments (lines beginning with "#"). If multiple host files are
30 given (the -h option is used more than once), then pslurp
31 behaves as though these files were concatenated together. If a
32 host is specified multiple times, then pslurp will connect the
33 given number of times.
34
35 -H [user@]host[:port]
36 --host [user@]host[:port]
37 -H "[user@]host[:port] [ [user@]host[:port ] ... ]"
38 --host "[user@]host[:port] [ [user@]host[:port ] ... ]"
39 Add the given host strings to the list of hosts. This option
40 may be given multiple times, and may be used in conjunction with
41 the -h option.
42
43 -l user
44 --user user
45 Use the given username as the default for any host entries that
46 don't specifically specify a user.
47
48 -p parallelism
49 --par parallelism
50 Use the given number as the maximum number of concurrent connec‐
51 tions.
52
53 -t timeout
54 --timeout timeout
55 Make connections time out after the given number of seconds.
56 With a value of 0, pslurp will not timeout any connections.
57
58 -o outdir
59 --outdir outdir
60 Save standard output to files in the given directory. Filenames
61 are of the form [user@]host[:port][.num] where the user and port
62 are only included for hosts that explicitly specify them. The
63 number is a counter that is incremented each time for hosts that
64 are specified more than once.
65
66 -e errdir
67 --errdir errdir
68 Save standard error to files in the given directory. Filenames
69 are of the same form as with the -o option.
70
71 -x args
72 --extra-args args
73 Passes extra SSH command-line arguments (see the ssh(1) man page
74 for more information about SSH arguments). This option may be
75 specified multiple times. The arguments are processed to split
76 on whitespace, protect text within quotes, and escape with back‐
77 slashes. To pass arguments without such processing, use the -X
78 option instead.
79
80 -X arg
81 --extra-arg arg
82 Passes a single SSH command-line argument (see the ssh(1) man
83 page for more information about SSH arguments). Unlike the -x
84 option, no processing is performed on the argument, including
85 word splitting. To pass multiple command-line arguments, use
86 the option once for each argument.
87
88 -O options
89 --options options
90 SSH options in the format used in the SSH configuration file
91 (see the ssh_config(5) man page for more information). This
92 option may be specified multiple times.
93
94 -A
95 --askpass
96 Prompt for a password and pass it to ssh. The password may be
97 used for either to unlock a key or for password authentication.
98 The password is transferred in a fairly secure manner (e.g., it
99 will not show up in argument lists). However, be aware that a
100 root user on your system could potentially intercept the pass‐
101 word.
102
103 -v
104 --verbose
105 Include error messages from ssh with the -i and \ options.
106
107 -r
108 --recursive
109 Recursively copy directories.
110
111 -L localdir
112 --localdir localdir
113 Copy files from the remote host to the given local directory.
114
115
116
117
118
120 The ssh_config file can include an arbitrary number of Host sections.
121 Each host entry specifies ssh options which apply only to the given
122 host. Host definitions can even behave like aliases if the HostName
123 option is included. This ssh feature, in combination with pssh host
124 files, provides a tremendous amount of flexibility.
125
126
128 The exit status codes from pslurp are as follows:
129
130 0 Success
131
132 1 Miscellaneous error
133
134 2 Syntax or usage error
135
136 3 At least one process was killed by a signal or timed out.
137
138 4 All processes completed, but at least one scp process reported
139 an error (exit status other than 0).
140
141
143 Written by Brent N. Chun <bnc@theether.org> and Andrew McNabb <amcn‐
144 abb@mcnabbs.org>.
145
146 https://github.com/lilydjwg/pssh
147
148
150 ssh(1), ssh_config(5), pssh(1), pscp(1), prsync(1), pnuke(1),
151
152
153
154 January 24, 2012 pslurp(1)