OFFPUNK(1)

💖 OFFPUNK(1) 💖

okay bestie, listen UP, this is the manual page for offpunk from the General Commands Manual section, and honestly? she's iconic. sit down, grab a strawberry drink 🍓, and let me tell you everything.

---

✨ NAME ✨

offpunk — a command line gemini client. yeah. that's the whole thing. main character energy in three words, periodt. 👑

---

🌈 SYNOPSIS 🌈

the way she works is you call her like this:

offpunk [--bookmarks] [--config-file FILE] [--command COMMAND] [--sync]
        [--assume-yes] [--disable-http] [--fetch-later] [--depth DEPTH]
        [--images-mode IMAGES_MODE] [--cache-validity CACHE_VALIDITY]
        [URL ...]

and also she has these little quick-exit moments:

offpunk -h | --help
offpunk --version
offpunk --features

no cap, that's the whole vibe check. 🦋

---

🎀 DESCRIPTION 🎀

okay so. Offpunk is a command-line browser and feed reader and she is dedicated to browsing the Web, Gemini, Gopher and Spartan. yes, all four. she's multi-talented like that. 💅

and here's the tea: because of her permanent cache, she's optimised to be used offline with rare connections — like, she's literally built for the girlies on airplane wifi — but she works just as well when you're connected. obsessed, honestly.

Offpunk is optimised for reading, and she supports:

• readability mode
• displaying pictures
• subscribing to pages or RSS feeds
• managing complex lists of bookmarks

and her integrated help and easy commands make her a perfect tool for command-line novices, while the power-users will be amazed by her shell integration. it's giving "everyone is welcome at this party". 🫶

---

🌸 Positional arguments 🌸

• URL — start with this URL. simple as that, bestie.

---

💜 Keyword arguments 💜

• -h, --help — shows you a help message and then dips. classic. 😌
• --bookmarks — start with your list of bookmarks. straight to the good stuff.
• --config-file FILE — use this particular config file instead of the default one. you can have a whole different personality, go off. 🎀
• --command COMMAND — launch this command (or these commands, she's flexible) after startup, and yes that includes the config file.
• --sync — runs non-interactively to build the cache by exploring your bookmarks. like, she's doing chores while you sleep.
• --assume-yes — assume-yes when she asks you questions about certificates/redirections during sync. ⚠️ heads up bestie, this is lower security, ok? she said what she said.
• --disable-http — do not try to get http(s) links (but anything already cached will still be displayed). no new http, but the old http is staying, she's not deleting her history. 💀
• --fetch-later — run non-interactively with a URL as argument to fetch it later.
• --depth DEPTH — the depth of the cache to build. default is 1. more is crazy. use at your own risks! 🚨 (she's serious, don't be a hero.)
• --images-mode IMAGES_MODE — the mode used to choose which images to download in a HTML page. it's one of (None, readable, full). ⚠️ warning: full will slowdown your sync. you've been warned, gorgeous.
• --cache-validity CACHE_VALIDITY — the duration for which a cache is valid before sync, in seconds.
• --version — display version information and quit. quick lil peek. 👀
• --features — display available features and dependencies then quit. show-off behaviour, we love it. ✨

---

💀 EXIT STATUS 💀

the offpunk utility exits 0 on success, and >0 if an error occurs. so if you get a zero, she's happy. if you get more than zero... something went sideways, sending thoughts and prayers. 🙈

---

🔥 SEE ALSO 🔥

go read these too, they're the friend group:

• ansicat(1)
• migrate-offpunk-cache(1)
• netcache(1)
• openk(1)
• https://offpunk.net/

---

🧚 HISTORY 🧚

the lore!! 📖 offpunk is a fork of the original AV-98 by Solderpunk and was originally called AV-98-offline as an experimental branch. glow-up of the century, no notes.

---

👑 AUTHORS 👑

Lionel Dricot (Ploum) <offpunk2 at ploum.eu> — the icon, the legend, the one who built all this. bow down. 🫶

---

🌟 that's the whole page bestie 🌟

this came to you from Debian, dated February 2, 2025 (the OFFPUNK(1) release, obviously, in case you were wondering which girlie this is). now go browse something cute offline, you've got this. bye!! 💖✨🎀🦋