UNBURDEN-HOME-DIR(1)

📦
version 0.4.2 · 2 versions
, in debian bookworm, ubuntu noble

✨ UNBURDEN-HOME-DIR 💖

okay bestie, welcome to the unburden-home-dir(1) manual page, section 1, from the "Unburden Your Home Directory" collection 🎀 this one's about unburdening your home dir from caches and trashes, and honestly? it's giving spring cleaning but make it Unix. 🧹✨

🌸 NAME 🌸

unburden-home-dir — unburdens home directories from caches and trashes

🌈 SYNOPSIS 🌈

no cap, this page ships with a SYNOPSIS heading and literally nothing under it. iconic behaviour honestly 💅 the details live in DESCRIPTION and OPTIONS, so keep scrolling.

🦋 DESCRIPTION 🦋

so unburden-home-dir unburdens the home directory from files and directories which cause high I/O or disk usage but are neither important if they are lost, e.g. caches or trash directory. 🗑️💀 your home dir is not a storage unit, bestie, it's a home.

when being run it moves the files and directories given in the configuration file to a location outside the home directory, e.g. /tmp or /scratch, and puts appropriate symbolic links in the home directory instead. 🔗✨

like — the actual data goes and lives somewhere else, and your home dir just keeps a cute little symlink pointing at it. same vibe, zero clutter. main character energy fr fr. 👑

💅 OPTIONS 💅

  • -b — use the given string as basename instead of unburden-home-dir. 🏷️
  • -c — read an additional configuration file. 📖 (extra, on top of the usual suspects)
  • -C — read only the given configuration file. 🙈 nothing else gets a look-in
  • -f — just unburden those directory matched by the given filter (a perl regular expression) — it matches the already unburdened directories if used together with -u. 🔍 (yes, regex, we love to see it)
  • -F — Do not check for files in use with lsof before (re)moving files. ⚠️ heads up, that check is there for a reason
  • -l — read an additional list file. 📝
  • -L — read only the given list file. 🎯
  • -n — dry run (show what would be done). 👀 no actual moving, just vibes and previews
  • -u — undo (reverse the functionality and put stuff back into the home directory). ↩️🫶
  • -h, --help — show this help. 🙋‍♀️
  • --version — show the program's version. 🔢

🍓 EXAMPLES 🍓

example configuration files can be found at /usr/share/doc/unburden-home-dir/examples/ on Debian-based systems and in the etc/ directory of the source tar ball. 📂✨ copy one, tweak it, slay.

🧚 FILES 🧚

the whole squad of paths:

  • /etc/unburden-home-dir
  • /etc/unburden-home-dir.list
  • ~/.unburden-home-dir
  • ~/.unburden-home-dir.list
  • ~/.config/unburden-home-dir/config
  • ~/.config/unburden-home-dir/list
  • /etc/default/unburden-home-dir
  • /etc/X11/Xsession.d/95unburden-home-dir

read the documentation at either /usr/share/doc/unburden-home-dir/html/ on debianoid installations, at https://unburden-home-dir.readthedocs.io/ online, or in the docs/ directory in the source tar ball for an explanation of these files. 📚 the docs are right there, bestie, they're not gonna read themselves.

👑 SEE ALSO 👑

of, course, du(1) can help you to find potential files or directories to handle by unburden-home-dir, but there are quite some du(1)-like tools out there which are way more comfortable, e.g. ncdu(1) (text-mode), baobab(1) (GNOME), filelight(1) (KDE), xdiskusage(1) (X tool calling du(1) itself), or xdu(1) (X tool reading du(1) output from STDIN). 🌈 pick your fighter.

💜 AUTHOR 💜

Unburden Home Dir is written and maintained by Axel Beckert abe@deuxchevaux.org. 🫶 shoutout to the maintainer, doing the lord's work fr.

🎀 LICENSE 🎀

Unburden Home Dir is available under the terms of the GNU General Public License (GPL) version 2 or any later version at your option. 📜

okay that's the whole page bestie, go unburden something 💖

this little manual was brought to you by the Unburden Your Home Directory collection and stamped April 2022 — UNBURDEN-HOME-DIR(1), periodt. 🦋✨

📦 where this page comes from