{
    "mode": "ri",
    "parameter": "RDoc::Options",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/ri/RDoc%3A%3AOptions/json",
    "generated": "2026-06-02T15:56:59Z",
    "sections": {
        "RDoc::Options < Object": {
            "content": "(from gem rdoc-7.2.0)\n------------------------------------------------------------------------\nRDoc::Options handles the parsing and storage of options\n",
            "subsections": [
                {
                    "name": "Saved Options",
                    "content": "You can save some options like the markup format in the .rdocoptions\nfile in your gem.  The easiest way to do this is:\n\nrdoc --markup tomdoc --write-options\n\nWhich will automatically create the file and fill it with the options\nyou specified.\n\nThe following options will not be saved since they interfere with the\nuser's preferences or with the normal operation of RDoc:\n\n* --coverage-report\n* --dry-run\n* --encoding\n* --force-update\n* --format\n* --pipe\n* --quiet\n* --template\n* --verbose\n"
                },
                {
                    "name": "Custom Options",
                    "content": "Generators can hook into RDoc::Options to add generator-specific command\nline options.\n\nWhen --format is encountered in ARGV, RDoc calls ::setupoptions on the\ngenerator class to add extra options to the option parser.  Options for\ncustom generators must occur after --format.  rdoc --help will list\noptions for all installed generators.\n\nExample:\n\nclass RDoc::Generator::Spellcheck\nRDoc::RDoc.addgenerator self\n\ndef self.setupoptions rdocoptions\nop = rdocoptions.optionparser\n\nop.on('--spell-dictionary DICTIONARY',\nRDoc::Options::Path) do |dictionary|\nrdocoptions.spelldictionary = dictionary\nend\nend\nend\n\nOf course, RDoc::Options does not respond to spelldictionary by default\nso you will need to add it:\n\nclass RDoc::Options\n\n##\n# The spell dictionary used by the spell-checking plugin.\n\nattraccessor :spelldictionary\n\nend\n"
                },
                {
                    "name": "Option Validators",
                    "content": "OptionParser validators will validate and cast user input values.  In\naddition to the validators that ship with OptionParser (String, Integer,\nFloat, TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.),\nRDoc::Options adds Path, PathArray and Template.\n------------------------------------------------------------------------"
                }
            ]
        },
        "Constants:": {
            "content": "DEFAULTEXCLUDE:\n[not documented]\n\nDEPRECATED:\nThe deprecated options.\n\nDirectory:\nOption validator for OptionParser that matches a directory that exists\non the filesystem.\n\nPath:\nOption validator for OptionParser that matches a file or directory\nthat exists on the filesystem.\n\nPathArray:\nOption validator for OptionParser that matches a comma-separated list\nof files or directories that exist on the filesystem.\n\nSPECIAL:\nRDoc options ignored (or handled specially) by --write-options\n\nTemplate:\nOption validator for OptionParser that matches a template directory\nfor an installed generator that lives in\n\"rdoc/generator/template/#{templatename}\"\n\n",
            "subsections": []
        },
        "Class methods:": {
            "content": "loadoptions\n",
            "subsections": []
        },
        "Instance methods:": {
            "content": "applydefaultexclude\nautolinkexcludedwords\ncanonicalroot\ncharset\ncheckfiles\ncheckgenerator\nclassmodulepathprefix\ncoveragereport\ndefaulttitle=\ndryrun\nembedmixins\nencoding\nexclude\nfilepathprefix\nfiles\nfinish\nfinishpagedir\nfootercontent\nforceoutput\nforceupdate\nformatter\ngenerator\ngeneratordescriptions\ngeneratoroptions\nhyperlinkall\nlinenumbers\nlocale\nlocaledir\nmainpage\nmarkup\nopdir\noptionparser\noutputdecoration\npagedir\nparse\npipe\nquiet\nquiet=\nrdocinclude\nroot\nsanitizepath\nsetupgenerator\nshowhash\nskiptests\nstaticpath\ntabwidth\ntemplate\ntemplatedir\ntemplatedirfor\ntemplatestylesheets\ntitle\nupdateoutputdir\nverbosity\nvisibility\nvisibility=\nwarn\nwarnmissingrdocref\nwebcvs\nwriteoptions\n",
            "subsections": []
        },
        "Attributes:": {
            "content": "attraccessor autolinkexcludedwords\nattraccessor canonicalroot\nattraccessor charset\nattraccessor classmodulepathprefix\nattraccessor coveragereport\nattraccessor dryrun\nattraccessor embedmixins\nattraccessor encoding\nattraccessor filepathprefix\nattraccessor files\nattraccessor footercontent\nattraccessor forceoutput\nattraccessor forceupdate\nattraccessor formatter\nattraccessor generator\nattraccessor generatoroptions\nattraccessor hyperlinkall\nattraccessor linenumbers\nattraccessor locale\nattraccessor localedir\nattraccessor mainpage\nattraccessor markup\nattraccessor opdir\nattraccessor optionparser\nattraccessor outputdecoration\nattraccessor pagedir\nattraccessor pipe\nattraccessor rdocinclude\nattraccessor root\nattraccessor showhash\nattraccessor skiptests\nattraccessor staticpath\nattraccessor tabwidth\nattraccessor template\nattraccessor templatedir\nattraccessor templatestylesheets\nattraccessor title\nattraccessor updateoutputdir\nattraccessor verbosity\nattraccessor warnmissingrdocref\nattraccessor webcvs\nattrreader applydefaultexclude\nattrreader visibility\nattrwriter exclude\n",
            "subsections": []
        }
    },
    "flags": [],
    "examples": [],
    "see_also": []
}