UMEGAYA(1)

📦 version 1.0, in debian bookworm, ubuntu jammy, ubuntu noble

💖 UMEGAYA — the manual page, but make it a group chat 💖

okay so bestie, pull up a chair, we're reading UMEGAYA(1) together and it's genuinely so much cooler than it sounds. it's a User Contributed Perl Documentation page, which is giving ✨community-made, no gatekeeping✨ energy. let's go 🫶

✨ NAME ✨

Umegaya — and the name is literally an acronym, no cap: Umegaya is a MEtadata GAtherer using YAml. yes she named herself. iconic behaviour honestly 👑

🌈 SYNOPSIS 🌈

here's how you actually call her. three flavours, all of them a vibe:

curl http://localhost/umegaya/package/key

/usr/lib/cgi-bin/umegaya package=package key=key
curl http://localhost/umegaya/table/key

/usr/lib/cgi-bin/umegaya table=1 key=key
curl http://localhost/umegaya/yaml/key

/usr/lib/cgi-bin/umegaya yaml=1 key=key

like, curl it or CGI it, whichever your little heart desires 💅

🦋 DESCRIPTION 🦋

so what is Umegaya? she's a gatherer. a collector. a little magpie of meta information about the software packaged in Debian 🎀

here's the tea: this metadata gets accumulated by the package maintainer, and they stash it inside the version control system that holds the Debian source package — in a file called debian/upstream/metadata. it just lives there. and then every single time the Umegaya web service gets accessed, she goes and collects it. every time. dedicated fr fr 🫶

after that, the Umegaya web service aggregates info about all the packages she knows about, and spits it out as tables or YAML records that can be loaded into central information hubs — like the Ultimate Debian Database. it's giving central hub energy, it's giving data pipeline, it's giving slay 🌸

and optionally? Umegaya will keep a local copy of the files she retrieves from the VCS — if a path is indicated in the store_files configuration variable. no path, no copy. that's the deal bestie ✨

👑 SPECIAL KEYS 👑

these ones are special. remember them:

  • YAML-ALL
  • YAML-REFRESH-DATE
  • YAML-URL

🎀 FILES 🎀

one file, and she's important:

  • /etc/umegaya/umegaya.conf

💜 SEE ALSO 💜

go look at these, iykyk:

🌟 SOURCE 🌟

the source lives here, go be nosy:

💀 LIMITATIONS 💀

okay, real talk, she's not perfect yet, and we respect honesty:

  • Only source packages stored in Subversion and Git are supported for the moment. that's it. that's the list. no others 😭
  • The CGI interface of Umegaya is currently read-only. but — and this is the exciting part — PUT and DELETE operations are considered 👀 so watch this space.
not me hyping up future features that literally do not exist yet. the manpage said "considered" and i'm just repeating it, bestie, don't come for me 🙈

and that's the whole page, you ate it, you understood it, you're basically a Debian metadata expert now 💅

this beauty was written by the Perl crew, and the docs are from perl v5.32.0, dated 2021-01-09 — so if you're reading this, hi from the past, hope your debian/upstream/metadata is thriving 🌸💖✨

📦 where this page comes from