RDOC3.3(1)

✨ NAME ✨

okay so this is rdoc3.3 💖 it's the tool that turns your Ruby script files into docs. the whole vibe is "generate documentation from Ruby script files" and it's giving main character energy 👑

🌸 SYNOPSIS 🌸

rdoc3.3 [options]  [names...]

🦋 DESCRIPTION 🦋

okay bestie, listen. rdoc doesn't output anything right away. it parses every file first and collects all the info, then it spits out the output. that's how it resolves cross references between all your files, and it's so iconic 🫶

if a name you give it is a directory, rdoc goes through it. if you don't give it any names at all, it grabs every Ruby file in the current directory and its subdirectories 💅

Available output formatters: chm, html, ri, xml ✨

wanna know where the output ends up? just run:

rdoc --help-output

🎀 OPTIONS 🎀

• --accessor, -A accessorname[,..] — a comma separated list of extra class methods that should act like attr_reader and friends 🦋 you can repeat this option. each accessorname can have =text tacked on, and then that text shows up where the r/w/rw goes for normal accessors
• --all, -a — includes all methods in the output, not just the public ones 👀
• --charset, -c charset — sets the HTML character-set 🌈
• --debug, -D — shows a LOT of internal stuff 🙈 (very chaotic, very detailed)
• --diagram, -d — generates diagrams showing modules and classes 🧚 you need dot V1.8.6 or later to use --diagram correctly. dot is available from <URL:http://www.research.att.com/sw/tools/graphviz/> 💜
• --exclude, -x pattern — skips files or directories matching the pattern 🚫 files you pass explicitly on the command line are never excluded, so you're safe there ✨
• --extension, -E new = old — treats files ending in .new like they end in .old. for example, -E cgi=rb makes xxx.cgi get parsed as a Ruby file 🍓
• --fileboxes, -F — puts classes into boxes that represent the files they live in 📦 classes shared between more than one file get a list of the files sharing them. this gets silently discarded if --diagram isn't given. it's also Experimental, so 🧪 be warned
• --fmt, -f formatname — sets the output formatter (see below) 🎨
• --help, -h — prints usage 📖
• --help-output, -O — explains the different output options 🔥
• --image-format, -I gif|png|jpg|jpeg — sets the output image format for diagrams. png, gif, jpeg, and jpg are all valid. if you leave this off, png is used. it requires --diagram 🖼️
• --include, -i dir[,dir...] — sets (or adds to) the list of directories searched when resolving :include: requests. you can use it more than once 📂
• --inline-source, -S — shows method source code inline instead of behind a popup link 🫧
• --line-numbers, -N — includes line numbers in the source code 🔢
• --main, -m name — the name becomes the initial page that gets displayed 🏠
• --merge, -M — when making ri output, merges the processed classes into previously documented classes of the same name 🧩
• --one-file, -1 — crams all the output into one single file 📄
• --op, -o dir — sets the output directory 📁
• --opname, -n name — sets the name of the output. this has no effect for HTML 🙅‍♀️
• --promiscuous, -p — when documenting a file that has a module or class also defined in other files, this shows all the stuff for that module/class on each file's page 💋 by default, it only shows the stuff defined in that particular file
• --quiet, -q — stops showing progress while it parses 🤫
• --ri, -r — generates output for ri to use. the files get stored in the .rdoc directory under your home directory unless a later --op overrides it, so no special privileges needed 🏡
• --ri-site, -R — generates output for ri, stored in a site-wide directory so others can access it. this one needs special privileges 🔐
• --ri-system, -Y — generates output for ri, stored in a system-level directory so others can access it. it also needs special privileges. this option is meant for use during Ruby installations 🛠️
• --show-hash, -H — a name like #name in a comment becomes a possible hyperlink to an instance method name. when it's displayed, the # gets removed unless you specify this option 🔗
• --style, -s stylesheet-url — specifies the URL of a separate stylesheet 💅
• --tab-width, -w n — sets the width of tab characters (the default is 8) 📏
• --template, -T template-name — sets the template used when generating output 🎭
• --title, -t text — sets the text as the title of the output 🏷️
• --version, -v — displays RDoc's version 🎀
• --webcvs, -W url — specifies a URL for linking to a web frontend for CVS. if the URL contains a %s, the filename gets appended to it 🌐

Pssst, that's the whole manual, bestie! 💖 It's the RDOC3.3(1) page from the General Commands Manual, last updated July 2014. Now go make some docs that slay ✨💅