RDOC3.1(1)

📦 version 3.1.2, in debian bookworm

💖 RDOC3.1 — the manual, but make it make sense 💖

okay bestie, pull up a chair, because this is rdoc3.1, section 1 of the general commands manual, and she is literally the moment. she generates documentation from Ruby script files. that's it, that's the girl. ✨

✨ NAME ✨

rdoc3.1 — generate documentation from Ruby script files 🎀

🦋 SYNOPSIS 🦋

rdoc3.1 [options]  [names...]

🌸 DESCRIPTION 🌸

okay so here's the vibe: files get parsed first, and all the info they contain gets collected, and only then does any output get produced. why tho? because that way every cross reference between all the files can actually be resolved. it's giving "let's all get ready together before we walk out the door." 💅

  • if a name is a directory, it gets traversed. she goes in. she looks around. 🧚
  • if you specify no names at all, then every Ruby file in the current directory (and all the subdirectories) gets processed. no cap.

available output formatters, bestie, take notes: chm, html, ri, xml

and if you're like "okay but where does the output even go??" — use this:

rdoc --help-output
lowkey important: yes, that's rdoc, exactly like the original says. keep it.

💅 OPTIONS 💅

the main character section. every single one, in order, no skipping, periodt.

  • --accessor, -A accessorname[,..] — a comma separated list of extra class methods that should be treated like attr_reader and friends. you can repeat this option. each accessorname can have =text tacked onto it, and in that case that text shows up wherever the r/w/rw would show up for normal accessors. iconic behavior honestly.
  • --all, -a — include all methods in the output, not just the public ones. she's nosy now. 🙈
  • --charset, -c charset — specifies the HTML character-set.
  • --debug, -D — displays lots on internal stuff. 💀 prepare yourself.
  • --diagram, -d — generate diagrams showing modules and classes. you need dot V1.8.6 or later for this to work correctly. Dot is available from <URL:http://www.research.att.com/sw/tools/graphviz/>.
  • --exclude, -x pattern — do not process files or directories matching pattern. but bestie, files given explicitly on the command line will never be excluded. them's the rules. 🫶
  • --extension, -E new = old — treat files ending with .new as if they ended with .old. so using -E cgi=rb will cause xxx.cgi to be parsed as a Ruby file. ✨
  • --fileboxes, -F — classes get put in boxes, and those boxes represent the files where these classes reside. classes shared between more than one file get shown with a list of the files that share them. it gets silently discarded if --diagram isn't given. also, it's Experimental. ⚠️
  • --fmt, -f formatname — set the output formatter (see below).
  • --help, -h — print usage.
  • --help-output, -O — explain the various output options.
  • --image-format, -I gif|png|jpg|jpeg — sets the output image format for diagrams. can be png, gif, jpeg, jpg. if you omit this option, png is used. requires --diagram. 🎀
  • --include, -i dir[,dir...] — set (or add to) the list of directories to be searched when satisfying :include: requests. can be used more than once.
  • --inline-source, -S — show method source code inline, rather than via a popup link.
  • --line-numbers, -N — include line numbers in the source code.
  • --main, -m name — name will be the initial page displayed. she's the first thing they see. main character energy fr fr. 👑
  • --merge, -M — when creating ri output, merge processed classes into previously documented classes of the name name.
  • --one-file, -1 — put all the output into a single file. minimalism era.
  • --op, -o dir — set the output directory.
  • --opname, -n name — set the name of the output. has no effect for HTML. 🙃
  • --promiscuous, -p — when documenting a file that contains a module or class also defined in other files, show all the stuff for that module/class in each file's page. by default, it only shows the stuff defined in that particular file. she said "share everything." 💖
  • --quiet, -q — don't show progress as we parse. shhh. 🤫
  • --ri, -r — generate output for use by 'ri.' the files are stored in the .rdoc directory under your home directory unless overridden by a subsequent --op parameter, so no special privileges are needed. 🫶
  • --ri-site, -R — generate output for use by 'ri.' the files are stored in a site-wide directory, making them accessible to others, so special privileges are needed. 🔥
  • --ri-system, -Y — generate output for use by 'ri.' the files are stored in a system-level directory, making them accessible to others, so special privileges are needed. this option is intended to be used during Ruby installations.
  • --show-hash, -H — a name of the form #name in a comment is a possible hyperlink to an instance method name. when displayed, the '#' is removed unless you specify this option.
  • --style, -s stylesheet-url — specifies the URL of a separate stylesheet. glow up via external CSS 💅
  • --tab-width, -w n — set the width of tab characters (default 8).
  • --template, -T template-name — set the template used when generating output.
  • --title, -t text — set text as the title for the output.
  • --version, -v — display RDoc's version.
  • --webcvs, -W url — specify a URL for linking to a web frontend to CVS. if the URL contains a contain a '%s', the filename will be appended to it.
⚠️ real talk: --fileboxes gets silently discarded without --diagram, and it's marked Experimental. --image-format requires --diagram. don't come for me, come for the manpage. 🫶

that's the whole page, bestie — no notes, no skips, every flag accounted for. 🦋

this was RDOC3.1(1), dated July 2014, and it's the source/version energy we're sending off with. bye pookie, go document something 💖✨

📦 where this page comes from