GFSEC-SPLIT(1)

✨ GFSEC-SPLIT ✨ (section 1 of the Gfsecret Manual, bestie)

okay so. this is the manual page for gfsec-split, and it lives in the Gfsecret Manual, section 1. that means it's a user command. get comfy, we're splitting secrets 🎀

---

🌸 NAME 🌸

gfsec-split — split a file into shares and dispatch them 💖

---

🦋 SYNOPSIS 🦋

gfsec-split [-h|--help] [-v|--version] [-n|--threshold N] [-c|--config
            file] [-i|--interactive] [-k|--keep] [-o|--output file]
            [-r|--restore-cmd command] [-d|--destroy-cmd command]
            [-l|--list-supports] file URI...

---

👑 DESCRIPTION 👑

gfsec-split takes a file, splits it up into a bunch of shares, and then dispatches those shares out onto external storage supports. it's giving "divide and conquer" but make it storage 💅

then, later, you can temporarily put the split file back together using its companion program, gfsec-use(1). they're a duo, fr fr 🫶

---

💖 OPTIONS 💖

• -h, --help — shows you the help message. the "hello, what is this" button ✨
• -v, --version — shows you the version message. the "who even are you" button 🌈
• -n, --threshold N — the minimum number of shares you need to re-assemble the split file. the default is 2. so like, lowkey two is the magic number unless you say otherwise 🔥
• -c, --config file — writes the configuration file (the one that lets you reconstruct the secret with gfsec-use(1)) to the file you name. the default is the basename of the split file inside $XDG_CONFIG_HOME/gfsecret. and here's the cute part: if FILE is a single filename with no extension and no directory part, the file gets placed under the $XDG_CONFIG_HOME/gfsecret directory with a .conf extension 🎀
• -i, --interactive — serves you an interactive menu so you get to pick which shares to create. main character energy, you're in charge 💅
• -k, --keep — by default, gfsec-split deletes the original file once it's been successfully split (😭). use this option to stop the file from being deleted. protect the original!!
• -o, --output file — says where gfsec-use should write the reconstructed secret. the default is to use the original location. and if you set it to an empty string, no location gets written in the configuration file. noted 📝
• -r, --restore-cmd command — the command that gfsec-use will call to restore the secret ✨
• -d, --destroy-cmd command — the command that gfsec-use will call to destroy the secret once it's not needed anymore 💀. heads up: the same command also gets called by gfsec-split to destroy the secret once it's been split — unless you used the -k option. so yeah, -k is your seatbelt here 🚗
• -l, --list-supports — lists all the supports currently available that you could use to store shares, then quits. a little window shopping trip 🌸

ngl, that -d + no -k combo is a one-way trip for your original file. just so you know. 🫶

---

🌈 SHARE URIs 🌈

shares are described with a URI-like syntax. for each share, the URI tells you a storage device and a pathname on that device. two-for-one, iconic 🦋

the supported URI schemes are:

• file:/// — points to a file on the local filesystem.
• uuid://uuid/ — points to a file on the external volume identified by the specified UUID.
• label://label/ — points to a file on the external volume identified by the specified label.
• mtp://serial/ — points to a file on the MTP device identified by the specified serial number.
• http://host/ — points to a file on a web server identified by its hostname.
• https://host/ — same as the previous one, but the web server is accessed through a secure connection 🔒

---

🍓 EXAMPLE INVOCATION 🍓

gfsec-split \
  /home/alice/mysecret \
  file:///home/alice/.local/share/gfsecret/mysecret \
  label://USBSTICK/mysecret \
  mtp://RF2GB6X704P/Documents/mysecret \

so what's happening here: that splits the file /home/alice/mysecret into three shares — one on the local filesystem, one on the USB mass storage device with the label USBSTICK, and one on the MTP-compliant device with the serial RF2GB6X704P. and a configuration file gets written in $XDG_CONFIG_HOME/gfsecret/mysecret, which lets you automatically reconstruct the file with gfsec-use(1) — as long as at least one of the two removable supports is actually present. at least one!! that's the threshold doing its thing 🔥

---

🙈 REPORTING BUGS 🙈

found a bug? report it to Damien Goutte-Gattat. be nice about it, they're doing great 💜

---

⭐ SEE ALSO ⭐

gfsec-use(1), gfsplit(1), gfcombine(1), libgfshare(3), gfshare(7)

the whole friend group, honestly 🫶

---

🎀 COPYRIGHT 🎀

Copyright © 2017,2021 Damien Goutte-Gattat

this program is released under the GNU General Public License. see the COPYING file in the source distribution, or check out http://www.gnu.org/licenses/gpl.html.

---

okay that's the whole page!! and for the little sign-off: this is gfsecret version 0.5.1, dated 2021-07-17, and that's the vibe, periodt 💅✨🦋