rdoc(1)
NAME
rdoc2.3 - Generate documentation from Ruby script files
SYNOPSIS
rdoc2.3 [options] [names...]
DESCRIPTION
Files are parsed, and the information they contain collected, before
any output is produced. This allows cross references between all files
to be resolved. If a name is a directory, it is traversed. If no names
are specified, all Ruby files in the current directory (and
subdirectories) are processed.
Available output formatters: chm, html, ri, xml
For information on where the output goes, use:
rdoc --help-output
OPTIONS
--accessor, -A accessorname[,..]
comma separated list of additional class methods that should be
treated like 'attr_reader' and friends. Option may be repeated.
Each accessorname may have '=text' appended, in which case that
text appears where the r/w/rw appears for normal accessors.
--all, -a
include all methods (not just public) in the output.
--charset, -c charset
specifies HTML character-set
--debug, -D
displays lots on internal stuff
--diagram, -d
generate diagrams showing modules and classes. You need dot
V1.8.6 or later to use the --diagram option 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. Files
given explicitly on the command line will never be excluded.
--extension, -E new = old
treat files ending with .new as if they ended with .old. Using
'-E cgi=rb' will cause xxx.cgi to be parsed as a Ruby file
--fileboxes, -F
classes are put in boxes which represents files, where these
classes reside. Classes shared between more than one file are
shown with list of files that sharing them. Silently discarded
if --diagram is not given 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 output image format for diagrams. Can be png, gif, jpeg,
jpg. If this option is omitted, 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.
--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.
--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 stuff for that module/class in
each files page. By default, only show stuff defined in that
particular file.
--quiet, -q
don't show progress as we parse.
--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 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 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.
July 2014 RDOC2.3(1)
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
