RABBIT(1)

🐰 RABBIT(1) — the manual, but make it cute ✨

okay so bestie, you opened the manual for rabbit, and I'm gonna walk you through every single flag like we're texting in the group chat. no cap, nothing gets skipped. 💅

📛 NAME

rabbit — presentation tool using RD, simple text format.

🚀 SYNOPSIS

rabbit [options] [SOURCE_INFOS]

🌈 DESCRIPTION

okay so this is where the options live. buckle up, because there are a lot of them, and they're all lowkey iconic. 🎀

🎨 Theme

• -I, --include=PATH — Add [PATH] to load path.
• -t, --theme=THEME — Use [THEME] as theme. Default: (default).
• --comment-theme=THEME — Use [THEME] for comment. Default: ().
• --allotted-time=TIME — Use [TIME] as allotted time. Default: ().

📚 Source

• -T, --type=TYPE — Specify source type as [TYPE]. Select from [auto, memory, uri, file, argf]. Note: case insensitive. Default: (auto).
• When select Memory — specify [FILENAME_OR_NOT] as [SOURCE_INFOS].
• When select URI — specify URI as [SOURCE_INFOS].
• When select File — specify [FILENAME] as [SOURCE_INFOS].
• When select ARGF — specify none (get from STDIN) or [FILE_NAMES] as [SOURCE_INFOS].
• -e, --encoding=ENCODING — Specify source encoding as [ENCODING]. Default: (auto).
• -B, --base=BASE — Specify base URI or path of source as [BASE]. Default: (auto).

🪟 Initial state

• -f, --[no-]full-screen — Toggle full screen mode. Default: (off).
• --[no-]index-mode — Toggle index mode. Default: (off).
• --initial-slide=N — Show the Nth slide. (zero-based) Default: (0).

📐 Size

• -g, --geometry=GEOMETRY — Set window geometry [GEOMETRY]. Format: WIDTHxHEIGHT+X+Y. Default: (nil).
• -w, --width=WIDTH — Set window width to [WIDTH]. Default: (800).
• -h, --height=HEIGHT — Set window height to [HEIGHT]. Default: (600).
• -S, --size=WIDTH,HEIGHT — Set window width and height to [WIDTH] and [HEIGHT]. Default: (800,600).

💾 Save

• -s, --save-as-image — Save as image and exit.
• -i, --saved-image-type=TYPE — Specify saved image type as [TYPE]. Default: (png).
• -bBASE_NAME, — Specify saved image base name as [BASE_NAME].
• --saved-image-base-name — (Title of slide)
• --saved-image-basename
• --[no-]output-html — Output HTML for viewing saved images. Default: (false).
• --[no-]output-index-html — Output index HTML for navigating slides. Default: (false).
• --rss-base-uri=URI — Specify base URI of RSS as [URI]. RSS is generated only when HTML is output. Default: ().
• --source-filename=FILENAME — Specify source filenam as [FILENAME]. Default: ().

🖨️ Print

• -p, --print — Print and exit.
• -o, --output-filename=FILENAME — Specify printed out filename as [FILENAME]. Default: (#{Title of slide}.pdf).
• --slides-per-page=SLIDES — Set slides per page. Default: (1).
• --[no-]draw-scaled-image — Draw scaled image. Better look for displaying but lesser look for printing. Default: (auto).

📄 Paper

• --paper-width=WIDTH — Set paper width to [WIDTH] Pt. Default: (landscape A4 width).
• --paper-height=HEIGHT — Set paper height to [HEIGHT] Pt. Default: (landscape A4 height).
• --paper-size=WIDTH,HEIGHT — Set paper width and height to [WIDTH] Pt and [HEIGHT] Pt. Default: (landscape A4 size).

📏 Margin

• --margin-left=MARGIN — Set left margin for slides per page mode print. Default: (auto).
• --margin-right=MARGIN — Set right margin for slides per page mode print. Default: (auto).
• --margin-top=MARGIN — Set top margin for slides per page mode print. Default: (auto).
• --margin-bottom=MARGIN — Set bottom margin for slides per page mode print. Default: (auto).
• --margin=[ALL] — Set margin for slides per page mode print.
• --margin=[TOP_BOTTOM],[LEFT_RIGHT] — Set margin for slides per page mode print.
• --margin=[TOP],[LEFT_RIGHT],[BOTTOM] — Set margin for slides per page mode print.
• --margin=[TOP],[RIGHT],[BOTTOM],[LEFT] — Set margin for slides per page mode print.
• --page-margin-left=MARGIN — Set left page margin. Default: (auto).
• --page-margin-right=MARGIN — Set right page margin. Default: (auto).
• --page-margin-top=MARGIN — Set top page margin. Default: (auto).
• --page-margin-bottom=MARGIN — Set bottom page margin. Default: (auto).
• --page-margin=[ALL] — Set page margin.
• --page-margin=[TOP_BOTTOM],[LEFT_RIGHT] — Set page margin.
• --page-margin=[TOP],[LEFT_RIGHT],[BOTTOM] — Set page margin.
• --page-margin=[TOP],[RIGHT],[BOTTOM],[LEFT] — Set page margin.

💎 dRuby

• --[no-]use-druby — Specify whether to use dRuby. Default: (true).
• --druby-uri=URI — Specify dRuby URI. Default: (druby://127.0.0.1:10101).
• --[no-]output-druby-uri — Specify whether to output dRuby URI. Default: (false).

🧼 SOAP

• --[no-]use-soap — Specify whether to use SOAP. Default: (false).
• --soap-host=HOST — Specify SOAP host as [HOST]. Default: (0.0.0.0).
• --soap-port=PORT — Specify SOAP port as [PORT]. Default: (10103).

📡 XML-RPC

• --[no-]use-xmlrpc — Specify whether to use XML-RPC. Default: (false).
• --xmlrpc-host=HOST — Specify XML-RPC host as [HOST]. Default: (0.0.0.0).
• --xmlrpc-port=PORT — Specify XML-RPC port as [PORT]. Default: (10104).

🔓 Public level

• --public-level=LEVEL — Specify public level. Select from the following: [ strict, move, read-size, change-size, size, read-source, change-source, source, control, all ]. Default: (all).

💬 Comment

• --comment-source=FILE — Deprecated. Just ignored. Specify initial comment source. Default: (default source).
• --comment-encoding=ENCODING — Deprecated. Just ignored. Specify comment source encoding. Default: (auto).

🔎 Migemo

• --migemo-dictionary-search-path=PATH1,PATH2,... — Specify search paths for Migemo static dictionary. Default: (/usr/share, /usr/local/share).
• --migemo-dictionary-name=NAME — Specify static dictionary name for Migemo. Default: (migemo-dict).

🧊 3D

• --[no-]use-gl — Specify whether to use OpenGL if available. Default: (false).

🫶 Others

• --check-syntax — Check slide source syntax and exit.
• --[no-]show-native-window-id — Show a native window ID of the Rabbit window if available. e.g. The ID is the ID of X resource on X window system. Default: (false).

🧰 Common options

• --options-file=FILE — Load options from FILE. Default: (none).
• --locale-dir=DIR — Specify locale dir as [DIR]. Default: (auto).
• --logger-type=TYPE — Specify logger type as [TYPE]. Select from [stderr, gui]. Default: (STDERR).
• --log-level=LEVEL — Specify log level as [LEVEL]. Select from [debug, info, warning, error, fatal, unknown]. Default: (info).
• --help — Show this message.
• --version — Show version.

This page is from rabbit 3.0.0, dated August 2020. mwah 💋✨