Current File : //opt/alt/ruby18/share/ri/1.8/system/Options/OptionList/cdesc-OptionList.yaml
--- !ruby/object:RI::ClassDescription
attributes: []
class_methods:
- !ruby/object:RI::MethodSummary
name: error
- !ruby/object:RI::MethodSummary
name: help_output
- !ruby/object:RI::MethodSummary
name: options
- !ruby/object:RI::MethodSummary
name: strip_output
- !ruby/object:RI::MethodSummary
name: usage
comment:
constants:
- !ruby/object:RI::Constant
comment:
name: OPTION_LIST
value: "[ [ \"--accessor\", \"-A\", \"accessorname[,..]\", \"comma separated list of additional class methods\\n\" + \"that should be treated like 'attr_reader' and\\n\" + \"friends. Option may be repeated. Each accessorname\\n\" + \"may have '=text' appended, in which case that text\\n\" + \"appears where the r/w/rw appears for normal accessors.\"], [ \"--all\", \"-a\", nil, \"include all methods (not just public)\\nin the output\" ], [ \"--charset\", \"-c\", \"charset\", \"specifies HTML character-set\" ], [ \"--debug\", \"-D\", nil, \"displays lots on internal stuff\" ], [ \"--diagram\", \"-d\", nil, \"Generate diagrams showing modules and classes.\\n\" + \"You need dot V1.8.6 or later to use the --diagram\\n\" + \"option correctly. Dot is available from\\n\"+ \"http://www.research.att.com/sw/tools/graphviz/\" ], [ \"--exclude\", \"-x\", \"pattern\", \"do not process files or directories matching\\n\" + \"pattern. Files given explicitly on the command\\n\" + \"line will never be excluded.\" ], [ \"--extension\", \"-E\", \"new=old\", \"Treat files ending with .new as if they ended with\\n\" + \".old. Using '-E cgi=rb' will cause xxx.cgi to be\\n\" + \"parsed as a Ruby file\"], [ \"--fileboxes\", \"-F\", nil, \"classes are put in boxes which represents\\n\" + \"files, where these classes reside. Classes\\n\" + \"shared between more than one file are\\n\" + \"shown with list of files that sharing them.\\n\" + \"Silently discarded if --diagram is not given\\n\" + \"Experimental.\" ], [ \"--force-update\", \"-U\", nil, \"forces to scan all sources even if newer than\\n\" + \"the flag file.\" ], [ \"--fmt\", \"-f\", \"format name\", \"set the output formatter (see below)\" ], [ \"--help\", \"-h\", nil, \"you're looking at it\" ], [ \"--help-output\", \"-O\", nil, \"explain the various output options\" ], [ \"--image-format\", \"-I\", \"gif/png/jpg/jpeg\", \"Sets output image format for diagrams. Can\\n\" + \"be png, gif, jpeg, jpg. If this option is\\n\" + \"omitted, png is used. Requires --diagram.\" ], [ \"--include\", \"-i\", \"dir[,dir...]\", \"set (or add to) the list of directories\\n\" + \"to be searched when satisfying :include:\\n\" + \"requests. Can be used more than once.\" ], [ \"--inline-source\", \"-S\", nil, \"Show method source code inline, rather\\n\" + \"than via a popup link\" ], [ \"--line-numbers\", \"-N\", nil, \"Include line numbers in the source code\" ], [ \"--main\", \"-m\", \"name\", \"'name' will be the initial page displayed\" ], [ \"--merge\", \"-M\", nil, \"when creating ri output, merge processed classes\\n\" + \"into previously documented classes of the name name\"], [ \"--one-file\", \"-1\", nil, \"put all the output into a single file\" ], [ \"--op\", \"-o\", \"dir\", \"set the output directory\" ], [ \"--opname\", \"-n\", \"name\", \"Set the 'name' of the output. Has no\\n\" + \"effect for HTML.\" ], [ \"--promiscuous\", \"-p\", nil, \"When documenting a file that contains a module\\n\" + \"or class also defined in other files, show\\n\" + \"all stuff for that module/class in each files\\n\" + \"page. By default, only show stuff defined in\\n\" + \"that particular file.\" ], [ \"--quiet\", \"-q\", nil, \"don't show progress as we parse\" ], [ \"--ri\", \"-r\", nil, \"generate output for use by 'ri.' The files are\\n\" + \"stored in the '.rdoc' directory under your home\\n\"+ \"directory unless overridden by a subsequent\\n\" + \"--op parameter, so no special privileges are needed.\" ], [ \"--ri-site\", \"-R\", nil, \"generate output for use by 'ri.' The files are\\n\" + \"stored in a site-wide directory, making them accessible\\n\"+ \"to others, so special privileges are needed.\" ], [ \"--ri-system\", \"-Y\", nil, \"generate output for use by 'ri.' The files are\\n\" + \"stored in a system-level directory, making them accessible\\n\"+ \"to others, so special privileges are needed. This option\\n\"+ \"is intended to be used during Ruby installations\" ], [ \"--show-hash\", \"-H\", nil, \"A name of the form #name in a comment\\n\" + \"is a possible hyperlink to an instance\\n\" + \"method name. When displayed, the '#' is\\n\" + \"removed unless this option is specified\" ], [ \"--style\", \"-s\", \"stylesheet url\", \"specifies the URL of a separate stylesheet.\" ], [ \"--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 'txt' as the title for the output\" ], [ \"--version\", \"-v\", nil, \"display RDoc's version\" ], [ \"--webcvs\", \"-W\", \"url\", \"Specify a URL for linking to a web frontend\\n\" + \"to CVS. If the URL contains a '\\%s', the\\n\" + \"name of the current file will be substituted;\\n\" + \"if the URL doesn't contain a '\\%s', the\\n\" + \"filename will be appended to it.\" ], ]"
full_name: Options::OptionList
includes: []
instance_methods: []
name: OptionList
superclass: