BF_TAR(1)

💖 BF_TAR — the bogofilter reference manual, but make it a group chat 💖

okay so bestie, this is bf_tar from the Bogofilter Reference Manual and it is literally the chillest little script you will ever meet. no cap. let's get into it 🫶

✨ NAME ✨

bf_tar — a shell script that writes a tar file of a bogofilter directory to stdout 🌸

✨ SYNOPSIS ✨

bf_tar [-r] [-R] bogofilter_directory

✨ DESCRIPTION ✨

So like. bf_tar bundles up a bogofilter working directory in tar format and copies it straight to standard output — that's your console, or wherever you redirect it. (peep the EXAMPLES below if you wanna see the redirect in action 👀)

✨ OPTIONS ✨

• -r — this one makes bf_tar remove inactive log files after the archive has been written successfully. the default, tho? leave those log files alone. periodt. 💅
• -R — this one makes bf_tar remove inactive log files before the archive is written. and okay, heads up bestie, this may reduce the chances that the resulting archive is recoverable should it become damaged 😭 the archive may be smaller though. the default is still: leave log files.

ngl the -r vs -R thing is giving "same energy, opposite order" and the ordering genuinely matters. iykyk.

✨ EXIT STATUS ✨

The script exits with status code 0 if everything went well, and nonzero if it encountered trouble. so if you see a nonzero, something said "not today" 🙈

✨ EXAMPLES ✨

1. ``` bf_tar ~/.bogofilter > outfile.tar

Writes a standard `.tar` file containing the essential files from `~/.bogofilter` to `outfile.tar`.

2. ```
bf_tar ~/.bogofilter | gzip -9 -c > outfile.tar.gz

Writes a gzipped .tar.gz file containing the essential files from ~/.bogofilter to outfile.tar.gz. compression girlies, this one's for you 🎀

3. ``` bf_tar pwd/mydirectory > outfile.tar

Prepend `$(pwd)/` or `` `pwd`/ `` if you want to specify an absolute path instead of a relative path.

---

# ✨ NOTES ✨

- This script is meant for use with <cyan>Berkeley DB</cyan> based bogofilter versions.
- This script requires a <cyan>SUSv2</cyan> compliant `pax` utility. no pax, no party 🦋
- This script expects a <cyan>SUSv2</cyan> compliant shell. Solaris systems should have the `SUNWxcu4` package installed (when bogofilter is configured) so that `/usr/xpg4/bin/sh` can be used.

---

# ✨ AUTHORS ✨

Matthias Andree 👑

---

that's the whole vibe check, bestie — go archive something iconic 💜

<rainbow>**Bogofilter** · `05/19/2019` · **BF_TAR(1)**</rainbow> — mwah, thanks for reading, slay ✨💖