KOReader(1)

📦 version 2026.03, in alpine 3.24, nixos 26.05, nixpkgs unstable

💖 KOReader(1) — the girlies' guide to the document viewer 💖

okay so bestie, welcome to the KOReader(1) page from the General Commands Manual — this is the whole vibe check on koreader, the document viewer. sit down, grab a strawberry 🍓, we're doing this.

✨ NAME ✨

koreader — literally a document viewer. that's the whole job. she reads documents. iconic behavior.

🌸 SYNOPSIS 🌸

koreader [-dvp] [file]

short, sweet, slays. no cap.

🦋 DESCRIPTION 🦋

So KOReader is a document viewer that is primarily aimed at e-ink readers — yes, the little bookish screens, main character energy fr fr. But this manual page? It documents briefly its desktop usage. so like, the desktop girlies get the quick tour. 💅

🎀 OPTIONS 🎀

okay so first things first — call KOReader followed by a file to open it directly. like, hand her the book and she reads it. simple as that. ✨

The supported document formats include:

  • PDF
  • DjVu
  • XPS
  • CBZ
  • FB2
  • PDB
  • TXT
  • HTML
  • RTF
  • CHM
  • EPUB
  • DOC
  • MOBI
  • ZIP

like. the range. she contains multitudes. 😭👑

If you pass no file at all, KOReader will start using user settings among:

  • a file manager (this one's the default 👑)
  • a history
  • the last document opened

so she just picks up where the vibe left off, iykyk.

A list of flags and their descriptions — here we go bestie:

  • -d — start in debug mode 🐛
  • -v — debug in verbose mode (yes, more words. more debug. she's chatty) 💬
  • -p — enable Lua code profiling 🔥

🧚 SETTINGS 🧚

User settings are stored in ~/.config/koreader. that's her little diary folder. 🎀 put some respect on it.

🌈 SEE ALSO 🌈

Online documentation, bestie, go read it:

https://github.com/koreader/koreader/wiki

ok that's the whole page, no crumbs left behind. every flag, every format, every path — all accounted for. slay. 💅✨

alright that's a wrap! this little love letter was brought to you by May 4, 2020 and the KOReader(1) girlies of the General Commands Manual — mwah, ily, go read a book 🫶💖

📦 where this page comes from