LEECHCRAFT(1)

💖 LEECHCRAFT(1) — the leechcraft manual page, bestie edition 🦋

okay so. hi. welcome to the General Commands Manual entry for LeechCraft, and honestly? she's a whole vibe. buckle up 🎀

---

✨ NAME ✨

LeechCraft — an extensible, modular internet-client. that's the whole pitch and honestly it ate 💅

---

🌸 SYNOPSIS 🌸

leechcraft-qt6 [options] [entity]

---

🦋 DESCRIPTION 🦋

so LeechCraft is an extensible, cross-platform, modular internet-client ✨ and "modular" here literally means it's plugin-based — every single task is handled by its own separate plugin. like, one job, one plugin, main character energy for each of them 👑

right now the plugin lineup includes (but is not limited to, periodt) the following:

• Aggregator — an RSS/Atom feed reader 📰
• Azoth — a multiprotocol IM client, currently supporting XMPP/IRC and lots of other stuff 💬
• BitTorrent — well… a BitTorrent client 🏴‍☠️
• LackMan — a userspace package manager for easy installation of iconsets, emoticons, themes, scripting plugins and other similar things 📦
• LMP — a feature-rich collection-oriented audio player 🎧
• Monocle — a modular document viewer 📄
• Poshuku — a WebKit-based web browser 🌐

---

💅 OPTIONS 💅

🎀 Common Qt Options

• -style style, -style=style — tells Qt which widget style to use. examples given: plastique, cleanlooks. pick your aesthetic bestie 💖
• -stylesheet stylesheet, -stylesheet=stylesheet — sets the user stylesheet to use when rendering widgets. yes you can dress her up ✨
• -reverse — flips the application's layout direction to right-to-left. mirror mirror 🪞

🔥 Options Specific to LeechCraft

• entity — the entity for LeechCraft to handle. this could be, like, a torrent file name or an URL. no cap 🧚
• -v [ --version ] — prints the LeechCraft version and dips. exit stage left 🚪
• --automatic — says "don't consider this entity to be added as a result of user's action." this way LeechCraft tries to minimize the number of dialogs with the user. suitable for adding entities from cron or some other sources, where the user could be AFK 😴

lowkey this only makes sense if an entity has been specified. fr fr.

• -H [ --handle ] — the item must be handled, not downloaded. useful when setting LeechCraft as your default browser: this way it won't ask if the item should be opened in Poshuku or downloaded 🙅‍♀️

again — only makes sense if an entity has been specified.

• -D [ --download ] — the item must be downloaded only, not handled. this is similar to the -H option, but does the reverse 🔄

once more for the people in the back: only makes sense if an entity has been specified.

• -T [ --type ] arg — defines the type of the passed entity. it could be one of:
  • url — for URLs that come from user input 🔗
  • url_encoded — for percent-encoded URLs 🔡
  • file — for local file paths 📁

by default, url is assumed. and yup — this only makes sense if an entity has been specified 💫

• -P [ --plugin ] path — ⚠️ use this option only if you know what you are doing. seriously.

loads only a plugin from the given path. specifying this option effectively disables loading plugins from standard places, so only the given plugin would be loaded. moreover, the given plugin's dependencies aren't evaluated, so you should load them by hand, specifying multiple -P options 🫶

and like — as already said — multiple -P options can be specified, resulting in multiple plugins being loaded.

also: if this option is specified, LeechCraft doesn't check if it's already running, it just starts up and loads the given plugin(s). so be careful with this option: you could either end up with lots of LeechCraft instances running, or have your data corrupt if the specified plugin doesn't support sharing data between multiple running instances. that's not a vibe 💀

• --nolog — disables the custom logger that writes logs to ~/.leechcraft/{debug,warning,critical}.log and prints everything to stdout/stderr instead 🗒️
• --bt — prints a backtrace along with warning-level log entries. helps trace where the warning entries come from 🔍
• --clrsckt — clears the stalled local socket. useful when LeechCraft doesn't start up and you know that no other instances are running 🧹
• --no-app-catch — disables catching all the exceptions in QApplication::notify(). useful for debugging purposes only and shouldn't be used for live setups 🙈
• --autorestart — automatically restarts if closed. this is done via Session Manager, so it won't work everywhere 🌀
• --help — prints a short help message. classic 🫡

---

🌈 FILES 🌈

LeechCraft stores user-specific stuff in two places:

• ~/.config/Deviant — for settings ⚙️
• ~/.leechcraft — for more "heavy" data, like RSS reader databases 🗃️

the XDG spec is not followed for the latter, and the reason is, and i quote, "for hysterical raisins" 🍇 (iconic honestly).

caches are stored in $XDG_CACHE_HOME/Deviant/leechcraft 💾

plug-ins are loaded from:

• /usr/local/lib/leechcraft-qt6/plugins
• /usr/lib/leechcraft-qt6/plugins

---

💀 BUGS 💀

there are many of them. 😭 please report bugs to https://dev.leechcraft.org/projects/leechcraft/issues or via the Dolozhu plugin right from LeechCraft 🐛

---

👑 AUTHOR 👑

the authors of LeechCraft are listed in its About dialog, as well as on this web page: https://leechcraft.org/our-team 🫶

this manual page was written by Georg Rudoy <0xd34df00d@gmail.com>.

permission is granted to copy, distribute and/or modify this document under the terms of the Boost Software License, Version 1.0. Boost Software License - Version 1.0 - August 17th, 2003 📜

on Debian systems, the complete text of the Boost Software License can be found in /usr/share/common-licenses/BSL.

---

and that's the whole page bestie 💜 this manual page is from Apr 2013, and the source/version on the footer is LEECHCRAFT(1) — General Commands Manual. go forth and modularize ✨🎀🦋