DIRVISH-LOCATE(8)

📦 version 1.2.1, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

💖 NAME 💖

dirvish-locate — ok so bestie, this is the little icon that finds your file versions hiding inside your dirvish images. That's the whole job. Slay. ✨

🌸 SYNOPSIS 🌸

dirvish-locate vault[:branch] pattern

🦋 DESCRIPTION 🦋

So like. Locate versions of files in a dirvish vault. That's the vibe.

Here's the tea 🍓: dirvish-locate goes through the index of every single image in the vault you named, hunting for paths that match your pattern. And when it finds one? It reports that path, and then it gives you the modification time of every version of that file, plus every image that has a link to it. Full receipts. No cap. 💅

You can also hit it with the optional branch thing — vault:branch — and it will restrict the search to just that branch. Keep it focused, queen. 🎀

Images that have an error status get skipped, and so do any images that don't have index files at all (no index, no entry, sorry babe 🙈). Oh and heads up — that index file can be compressed with gzip or bzip2. If you wanna know the deets on that, go look at tree and index in dirvish.conf(5).

Now about the pattern. It's a perl regular expression that matches the final component of the path. So if you want to match any substring of the whole path, you gotta append .* to the end of your pattern. And if you want to anchor it to the end of the path, append $. Go read perlre(1) for the full lore, bestie, it's a whole thing.

Two things that are not getting matched, periodt:

  • Directories — excluded, because otherwise they'd match literally every file inside them anyway. Makes sense, main character energy but no.
  • Symlinks — also excluded. Bye. 👋

Now the important warning: if your pattern matches <em>way</em> too many paths, dirvish-locate will only report the matched paths and not the versions. And as a little sanity check, if the number of matches is <em>really</em> excessive, it'll even limit how many images it searches. Ngl, excessive matches is basically the universe telling you your pattern isn't specific enough. So take that path list it gave you and use it to compose a more specific one. Character development. 🌱

💀 EXIT CODES 💀

Okay so this part exists so you can automate and integrate dirvish-locate with other tools, and it gives you rationalised exit codes. They're range based, which is the key detail here.

⚠️ The code for one specific error might change from one version to the next — but it will always stay inside its specified range. So do not test for specific exit codes, test for a range of values. Fr fr. And to the degree possible, higher value ranges mean more severe errors. The numbers go up, the badness goes up. 😭
  • 0 — success ✨
  • 200-219 — an error was encountered in loading a configuration file. 🙈
  • 220-254 — an error was detected in the configuration. 💀
  • 255 — incorrect usage. bestie. what did you type. 😭

🎀 FILES 🎀

  • /etc/dirvish/master.conf — alternate master configuration file.
  • /etc/dirvish.conf — master configuration file.
  • bank/vault/image/summary — image creation summary.
  • bank/vault/image/index
  • bank/vault/image/index.gz
  • bank/vault/image/index.bz2 — dirvish index file.

(those last three are all the same thing, just one is plain, one is gzipped, one is bzip2'd 🫶)

🌈 SEE ALSO 🌈

🧚 BUGS 🧚

Nothing listed here, bestie. The section is empty. Not a single bug to report. Iconic behaviour, honestly. 👑

And that's the whole page!! 💖 This was dirvish-locate(8) from the <b>System Manager's Manual</b> — go forth and locate your versions, you absolute legend. 🦋✨

📦 where this page comes from