DOXX(1)

👑 DOXX — like, the manual page bestie 💅

doxx is a terminal document viewer for .docx files, and it lives in the General Commands Manual section (that's section 1, for the uninitiated 🎀). Yes babes, you can read Word docs in your terminal now. It's giving main character energy and I'm obsessed.

---

✨ NAME ✨

doxx — terminal document viewer for .docx files 🦋

---

🌸 SYNOPSIS 🌸

doxx [-o | --outline] [-p | --page page] [-s | --search term]
     [--export format] [--images] [--extract-images directory] [options]
     file
doxx --debug-terminal

---

💖 DESCRIPTION 💖

Okay so picture this: doxx is a terminal-based document viewer for Microsoft Word .docx files. She serves an interactive interface for viewing, searching, and navigating Word documents right there in your terminal, and she's got support for outline view, image display, and a whole lineup of export formats. Periodt. 💅

She speaks terminal image protocols — think Kitty, iTerm2, and Sixel — for inline image display, and she's got all the export options you need to convert docs to plain text, Markdown, CSV, or JSON. Versatile queen. 👑

When you invoke her with a file argument, doxx opens the document in interactive mode if a TTY is detected. But if you're in a non-interactive environment (no TTY bestie, tragic), doxx automatically gives you formatted text output with document metadata, showing the first 20 elements of the document. If you want to override that TTY detection and force interactive mode anyway, use --force-ui. No cap.

---

🌈 OPTIONS 🌈

Here are all the options available when viewing documents. Buckle up, there's a lot, and we love that for us. 💖

🎀 Viewing Options

• -o, --outline — Start with outline view. She displays document structure and headings instead of the full content. Structure queen.
• -p, --page page — Jump to a specific page number on startup. Zero scrolling required, we love efficiency.
• -s, --search term — Search and highlight the specified term in the document. Found it instantly, slay.
• --force-ui — Force interactive UI mode, bypassing TTY detection entirely. She said "I'm doing it anyway." 💅
• --color — Enable color support for text rendering. Aesthetic matters, always. 🌈

🦋 Image Options

• --images — Display images inline in the terminal. She automatically detects terminal capabilities and uses the appropriate protocol. Smart AND pretty.
• --no-images — Force text-only mode for images. No inline image display, just vibes and letters.
• --extract-images directory — Extract all images from the document to the specified directory. Get those pics outta there. 🖼️
• --image-width cols — Maximum image width in terminal columns. Default: auto-detect from terminal size.
• --image-height rows — Maximum image height in terminal rows. Default: auto-detect from terminal size.
• --image-scale scale — Image scaling factor. The value must be between 0.1 and 2.0. Default: 1.0.
• --debug-terminal — Test and display terminal image capabilities. Vibe check for your terminal, basically. 🔍

⭐ Export Options

• --export format — Export the document to the specified format and print to stdout. Possible values:
  • markdown — Convert document to Markdown format
  • text — Convert to plain text
  • csv — Export as comma-separated values
  • json — Export document structure as JSON

🫶 General Options

• -h, --help — Print help information. Bestie's always got your back.
• -V, --version — Print version information. Who are you wearing? It's doxx. 💜

---

😭 EXIT STATUS 😭

The doxx utility exits 0 on success, and >0 if an error occurs. Clean exit, no drama. 🙈

---

🔥 EXAMPLES 🔥

View a document in interactive mode:

$ doxx document.docx

Start viewing from page 5:

$ doxx --page 5 document.docx

Open document with outline view:

$ doxx --outline document.docx

Search for a term and highlight it:

$ doxx --search "important" document.docx

Export document to Markdown:

$ doxx --export markdown document.docx > output.md

Export to plain text:

$ doxx --export text document.docx > output.txt

View document with inline images:

$ doxx --images document.docx

Extract all images to a directory:

$ doxx --extract-images ./images document.docx

View with custom image scaling:

$ doxx --images --image-scale 0.8 document.docx

Test terminal image capabilities:

$ doxx --debug-terminal

---

💜 NOTES 💜

🧚 Interactive Controls

When you're running in interactive mode, these keyboard controls are available. Learn them, live them, love them. 💖

📄 Document View

• q — Quit application
• o — Switch to outline view
• s — Enter search mode
• h, F1 — Toggle help overlay
• c — Copy document content to clipboard (as plain text)
• k, Up — Scroll up one line
• j, Down — Scroll down one line
• PageUp — Scroll up one page (10 lines)
• PageDown — Scroll down one page (10 lines)
• Home — Jump to beginning of document
• End — Jump to end of document
• n — Next search result (when search results exist)
• p — Previous search result (when search results exist)
• Mouse wheel — Scroll up/down (3 lines per scroll)

🌸 Outline View

• q, Esc — Return to document view
• k, Up — Move selection up
• j, Down — Move selection down
• Enter — Jump to selected heading and return to document view
• c — Copy document outline to clipboard (with indentation)
• Mouse wheel — Scroll through outline items

🔍 Search Mode

• q, Esc — Return to document view
• characters — Type to build search query
• Backspace — Delete last character from query
• Enter, Down — Next search result
• Up — Previous search result
• F2 — Copy search results to clipboard (formatted list)
• Mouse wheel — Navigate through search results

---

🎀 AUTHORS 🎀

doxx was written by Brandon Greenwell <greenwell.brandon@gmail.com> 💖

This manual page was written by Nadzeya Hutsko <nadzya.info@gmail.com> ✨

---

👑 SEE ALSO 👑

pandoc(1), less(1) — go check them out too bestie, iykyk. 🫶

---

And that's the whole page, babe — this one ships from Debian, dated October 14, 2025. Stay iconic, read your docs in the terminal, and remember: doxx never misses. 💅✨🎀