pslurp(1)

💅 pslurp — the girlies' guide to parallel file grabbing ✨

okay so bestie, welcome to pslurp, a whole General Commands Manual moment. she's the sister program to pscp and she's here to snatch files off a bunch of hosts at the same time. no cap. 🦋

---

🌸 SYNOPSIS 🌸

pslurp [-vAr] [-h hosts_file] [-H [user@]host[:port]] [-l user] [-p par]
[-o outdir] [-e errdir] [-t timeout] [-O options] [-x args] [-X arg] [-L
localdir] remote local

---

✨ DESCRIPTION ✨

so like, pslurp is a program for copying files in parallel from a number of hosts, and she does it using the scp program. 💖

she comes with features such as passing a password to scp, saving output to files, and timing out. iconic behavior, honestly.

---

🎀 OPTIONS 🎀

• -h host_file, --hosts host_file — read hosts from the given host_file. lines in the host file are of the form [user@]host[:port] and can include blank lines and comments (lines beginning with #). if you give multiple host files (aka you use -h more than once), then pslurp behaves as though these files were concatenated together. and if a host is specified multiple times, pslurp will connect the given number of times. yes really, she said what she said. 💅
• -H [user@]host[:port], --host [user@]host[:port], -H "[user@]host[:port] [ [user@]host[:port ] ... ]", --host "[user@]host[:port] [ [user@]host[:port ] ... ]" — add the given host strings to the list of hosts. this option may be given multiple times, and may be used in conjunction with the -h option. they're besties, they work together. 🫶
• -l user, --user user — use the given username as the default for any host entries that don't specifically specify a user. she's the fallback queen 👑
• -p parallelism, --par parallelism — use the given number as the maximum number of concurrent connections. multitasking main character energy 🔥
• -t timeout, --timeout timeout — make connections time out after the given number of seconds. with a value of 0, pslurp will not timeout any connections. (zero = no limits, she's unbothered fr)
• -o outdir, --outdir outdir — save standard output to files in the given directory. filenames are of the form [user@]host[:port][.num] where the user and port are only included for hosts that explicitly specify them. the number is a counter that is incremented each time for hosts that are specified more than once. 🍓
• -e errdir, --errdir errdir — save standard error to files in the given directory. filenames are of the same form as with the -o option. same vibe, different stream 💀
• -x args, --extra-args args — passes extra SSH command-line arguments (see the ssh(1) man page for more information about SSH arguments). this option may be specified multiple times. the arguments are processed to split on whitespace, protect text within quotes, and escape with backslashes. to pass arguments without such processing, use the -X option instead. ⭐
• -X arg, --extra-arg arg — passes a single SSH command-line argument (see the ssh(1) man page for more information about SSH arguments). unlike the -x option, no processing is performed on the argument, including word splitting. to pass multiple command-line arguments, use the option once for each argument. she takes you literally, no editing 💅
• -O options, --options options — SSH options in the format used in the SSH configuration file (see the ssh_config(5) man page for more information). this option may be specified multiple times.
• -A, --askpass — prompt for a password and pass it to ssh. the password may be used for either to unlock a key or for password authentication. the password is transferred in a fairly secure manner (e.g., it will not show up in argument lists). however, be aware that a root user on your system could potentially intercept the password. 😭

bestie pls read that last part again. a root user on your system could potentially intercept the password. keep that in mind before you go typing your secrets in, okay? 🙈

• -v, --verbose — include error messages from ssh with the -i and -e options.
• -r, --recursive — recursively copy directories. whole folders, no crumbs left behind 🧚
• -L localdir, --localdir localdir — copy files from the remote host to the given local directory. 🎀

---

💜 TIPS 💜

the ssh_config file can include an arbitrary number of Host sections. each host entry specifies ssh options which apply only to the given host. Host definitions can even behave like aliases if the HostName option is included. this ssh feature, in combination with pssh host files, provides a tremendous amount of flexibility. it's giving customization, it's giving range 🌈

---

🦋 EXIT STATUS 🦋

the exit status codes from pslurp are as follows:

• 0 — Success ✨
• 1 — Miscellaneous error
• 2 — Syntax or usage error
• 3 — At least one process was killed by a signal or timed out.
• 4 — All processes completed, but at least one scp process reported an error (exit status other than 0).

---

👑 AUTHORS 👑

Written by Brent N. Chun <bnc@theether.org> and Andrew McNabb <amcnabb@mcnabbs.org>.

https://github.com/lilydjwg/pssh

---

🌟 SEE ALSO 🌟

ssh(1), ssh_config(5), pssh(1), pscp(1), prsync(1), pnuke(1),

---

and that's the whole page bestie!! this one's dated January 24, 2012, and yeah she's pslurp(1) through and through. go forth and download in parallel, you absolute icon 💖💅✨