get-publicfile-docs(1)

💖 get-publicfile-docs — the manual, but make it cute ✨

okay bestie, this is the General Commands Manual page for get-publicfile-docs, section 1. it's short, it's sweet, it grabs docs for you, let's go 🫶

---

🌸 NAME 🌸

get-publicfile-docs — get and install publicfile documentation 🎀

---

✨ SYNOPSIS ✨

get-publicfile-docs

no flags, no arguments, no drama. just run it, queen. 💅

---

🦋 DESCRIPTION 🦋

so like, get-publicfile-docs downloads the publicfile documentation from the publicfile upstream website ⟨https://cr.yp.to/⟩ and drops it at /var/lib/publicfile/doc. then it makes that available from /usr/share/doc/publicfile via a symlink. iconic behaviour, honestly. 🌈

💡 bestie advice incoming: you're advised to run the script under a non-root useraccount. yes fr fr, non-root.

and if the permissions you need aren't there? no stress. the script will literally hand you instructions on how to create the needed directories. it's giving helpful. 😌

oh and the actual downloading part? that's not even the script doing the heavy lifting — it uses wcurl(1) to do the actual downloading. teamwork makes the dream work, periodt. 🍓

---

💀 BUGS 💀

okay so here's the tea, and it's a lil messy:

• the script does not check whether the local copy of the downloaded documentation is up to date. so yeah, it could be stale, it could be fresh, it does not know, it does not care. 🙈
• the script is a zsh shell script. reimplementing it to use only Bourne shell features — so that it can run with smaller shells (like e.g. dash or the Almquist SHell) — is planned. so like, not yet. someday tho. ⭐

---

👑 AUTHOR 👑

written by Joost van Baal-Ilić. 💜

no copyright is claimed. the get-publicfile-docs code and this manpage are in the public domain; do with it what you wish. literally go off, it's yours. 🎀

---

🌟 SEE ALSO 🌟

the authors publicfile website ⟨http://mdcc.cx/publicfile/⟩. iykyk 💅

---

publicfile version 0.52-7, dated 2015-05-19 — that's the whole page bestie, thanks for reading, mwah 🫶✨💖