UMEGAYA-ADM(1)

πŸ“¦ version 1.0, in debian bookworm, ubuntu jammy, ubuntu noble

πŸ’– UMEGAYA-ADM πŸ’–

okay bestie, so you know umegaya-adm(1)? that's the manual page we're doing, section 1, and it lives in the User Contributed Perl Documentation corner of the world. it's a whole little command-line bestie for the Umegaya database and honestly? she's iconic. let's get into it. πŸŽ€


✨ NAME ✨

umegaya-adm β€” a tool to administrate the Umegaya database. no cap, that's literally the whole job description. πŸ’…


🌸 SYNOPSIS 🌸

here's the vibe, in code:

umegaya-adm -p package -k key -v value [--delete] [--verbose]

umegaya-adm -h, --help

so like, package + key + value, or just ask for help. simple as. ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so umegaya-adm interrogates or modifies the Berkeley database where all the gathered metadata is stored. yes, interrogates. she's a little dramatic but she gets results. πŸ’…

here's the tea: if you give her a combination of package, key and value, she'll set the value. but if you don't, she'll give you the appropriate info using whichever of package or key you handed over as the argument.

for example, watch this slay:

$ umegaya-adm -p package -k key -v value
$ umegaya-adm -p package -k key
value
$ umegaya-adm -p package -k key2 -v value2
$ umegaya-adm -p package -k key2
value2
$ umegaya-adm -p package
key value
key2    value2
$ umegaya-adm -p package2 -k key -v value3
$ umegaya-adm -k key
package value
package2    value3
$ umegaya-adm -p package2 -k key --delete
$ umegaya-adm -k key
package value

see how she just knows? main character energy fr fr. 🌈


πŸ’… OPTIONS πŸ’…

  • -d, --delete β€” when you use this with --key or --package, she deletes the value(s) instead of showing them. bye bestie πŸ‘‹
  • --list-entries, --show-entry, --delete-entry β€” list all the entries, or show / delete one entry of the Umegaya database. these entries are package names joined to a Umegaya key by a colon. examples: Xumegaya:NameX, Xumegaya:YAML-URLX. 🫢
  • -k, --key β€” if you set it all alone, umegaya-adm will display all the package-values pairs for the given key. if you set it together with --package, she'll display the corresponding value instead.
  • -p, --package β€” if you set it all alone, umegaya-adm will display all the key-values pairs for the given package. if you set it together with --key, she'll display the corresponding value instead.
  • --purge β€” deletes the umegaya database without asking for confirmation. 😭 no takebacks, no "are you sure", nothing. she just does it. be careful bestie, this one is not playing.
  • -v, --value β€” when this is set together with --key and --package, umegaya-adm sets the given value for the given key of the given package. πŸ’–
  • --verbose β€” returns the set value to the standard output when used in conjunction with --key, --package, and --value. so you get the receipts. 🧾

πŸ‘‘ ADVANCED USAGE πŸ‘‘

use umegaya-adm to set special keys for the packages. that's it, that's the tip. iykyk. ⭐


🌈 SEE ALSO 🌈

  • umegaya(7)
  • upstream-metadata.debian.net(7)

go read those too, they're giving lore. πŸ“


πŸŽ€ AUTHOR πŸŽ€

Charles Plessy <plessy@debian.org> β€” the actual legend who made this. give them their flowers. πŸ’


πŸ’œ LICENCE πŸ’œ

BOLA - Buena Onda License Agreement (v1.1)
------------------------------------------

This work is provided 'as-is', without any express or implied warranty. In no
event will the authors be held liable for any damages arising from the use of
this work.

To all effects and purposes, this work is to be considered Public Domain.

However, if you want to be "buena onda", you should:

1. Not take credit for it, and give proper recognition to the authors.
2. Share your modifications, so everybody benefits from them.
3. Do something nice for the authors.
4. Help someone who needs it: sign up for some volunteer work or help your
   neighbour paint the house.
5. Don't waste. Anything, but specially energy that comes from natural
   non-renewable resources. Extra points if you discover or invent something
   to replace them.
6. Be tolerant. Everything that's good in nature comes from cooperation.

okay but this license is actually so wholesome?? rule 4 is "help your neighbour paint the house" and rule 6 is "be tolerant" 😭 she ate and left no crumbs. literally be buena onda bestie. 🫢


⭐ SOURCE ⭐

http://anonscm.debian.org/gitweb/?p=collab-maint/umegaya.git;a=blob;f=scripts/umegaya-adm

the source code is right there, go peek. πŸ‘€


πŸ™ˆ POD ERRORS πŸ™ˆ

hey! the above document had some coding errors, which are explained below. not me snitching on the manpage itself but okay, here's what happened:

  • around line 9:
    • Unterminated B<...> sequence
  • around line 73:
    • Non-ASCII character seen before =encoding in 'Xumegaya:NameX,'. Assuming UTF-8

we've all been there. coding errors happen. growth. 🌱


and that's the whole page, bestie πŸ’– she's documented by perl v5.32.0 and dated 2021-01-09 β€” so this is a vintage drop, and honestly it aged like fine wine. periodt. πŸ‘‘βœ¨

πŸ“¦ where this page comes from