PCP(1)

📦 version 5.2.3, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 PCP(1) — the S3QL girlies' guide to copyin' trees in parallel 💖

okay bestie, so this is the pcp page from the S3QL manual, section 1, and honestly? it's a whole vibe. let's get into it 🦋

✨ NAME ✨

pcp — Recursive, parallel copy of directory trees 🌳🌳🌳

✨ SYNOPSIS ✨

pcp [options] <source> [<source> ...] <destination>

✨ DESCRIPTION ✨

So like, pcp is a wrapper — a lil delegating queen 👑 — that starts up several sync processes to copy directory trees in parallel. and why would you do that? because it allows much better copying performance on file systems that have relatively high latency when retrieving individual files. like… S3QL. iykyk 💅

⚠️ note, bestie, this matters: using this program only improves performance when copying from an S3QL file system. when you're copying to an S3QL file system, using pcp is more likely to decrease performance. so… read the room, okay? 🙈

✨ OPTIONS ✨

the pcp command accepts the following options, and we're going through all of them, no skips, periodt ✨

  • --log <target> — where your log messages go. write none for standard output, or syslog for the system logging daemon. anything else? it gets interpreted as a file name, simple as that. log files get rotated when they hit 1 MiB, and at most 5 old log files will be kept. default: None 📝
  • --quiet — be really quiet 🤫
  • --debug-modules <modules> — activate debugging output from the modules you name (use commas to separate multiple modules, or 'all' for everything, because why not). debug messages get written to whatever target you set with the --log option.
  • --debug — activate debugging output from all S3QL modules. debug messages go to the target specified by the --log option. it's giving "turn it all the way up" 🔥
  • --version — just print program version and exit. short, sweet, iconic 🎀
  • -a — pass the -aHAX option to rsync.
  • --processes <no> — number of rsync processes to use (default: 10). ten lil workers doing the most 💪

✨ EXIT CODES ✨

pcp may terminate with the following exit codes, and yes we list every single one:

  • 0 — Everything went well. 🎉 slay.
  • 1 — An unexpected error occurred. This may indicate a bug in the program. 💀 not slay.
  • 2 — Invalid command line argument or configuration file key. 🚫

✨ SEE ALSO ✨

pcp is shipped as part of S3QL, https://github.com/s3ql/s3ql/. go look, bestie 🫶

© 2008 Nikolaus Rath <Nikolaus@rath.org> — iconic behavior, honestly 💜

okay and that's the whole page!! this was S3QL version 5.2.3, dated Nov 02, 2024, and it lives in the PCP(1) manual. tysm for reading, go copy some trees in parallel, you got this 💅✨🌸

📦 where this page comes from