summaryrefslogtreecommitdiff
path: root/debian/manpages/rdoc2.3.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpages/rdoc2.3.1')
-rw-r--r--debian/manpages/rdoc2.3.1209
1 files changed, 209 insertions, 0 deletions
diff --git a/debian/manpages/rdoc2.3.1 b/debian/manpages/rdoc2.3.1
new file mode 100644
index 0000000..fb6e61c
--- /dev/null
+++ b/debian/manpages/rdoc2.3.1
@@ -0,0 +1,209 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH RDOC2.3 1 "July 2014"
+.SH NAME
+.PP
+rdoc2.3 \- Generate documentation from Ruby script files
+.SH SYNOPSIS
+.PP
+rdoc2.3 [options] [names...]
+.SH DESCRIPTION
+.PP
+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.
+.PP
+Available output formatters: chm, html, ri, xml
+.PP
+For information on where the output goes, use:
+.nf
+\& rdoc \-\-help\-output
+.fi
+.SH OPTIONS
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-all, \-a
+include all methods (not just public) in the output.
+.TP
+.fi
+.B
+\-\-charset, \-c charset
+specifies HTML character\-set
+.TP
+.fi
+.B
+\-\-debug, \-D
+displays lots on internal stuff
+.TP
+.fi
+.B
+\-\-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/>.
+.TP
+.fi
+.B
+\-\-exclude, \-x pattern
+do not process files or directories matching pattern. Files given
+explicitly on the command line will never be excluded.
+.TP
+.fi
+.B
+\-\-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
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-fmt, \-f formatname
+set the output formatter (see below).
+.TP
+.fi
+.B
+\-\-help, \-h
+print usage.
+.TP
+.fi
+.B
+\-\-help\-output, \-O
+explain the various output options.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-inline\-source, \-S
+show method source code inline, rather than via a popup link.
+.TP
+.fi
+.B
+\-\-line\-numbers, \-N
+include line numbers in the source code
+.TP
+.fi
+.B
+\-\-main, \-m name
+name will be the initial page displayed.
+.TP
+.fi
+.B
+\-\-merge, \-M
+when creating ri output, merge processed classes into previously
+documented classes of the name name.
+.TP
+.fi
+.B
+\-\-one\-file, \-1
+put all the output into a single file.
+.TP
+.fi
+.B
+\-\-op, \-o dir
+set the output directory.
+.TP
+.fi
+.B
+\-\-opname, \-n name
+set the name of the output. Has no effect for HTML.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-quiet, \-q
+don't show progress as we parse.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-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.
+.TP
+.fi
+.B
+\-\-style, \-s stylesheet\-url
+specifies the URL of a separate stylesheet.
+.TP
+.fi
+.B
+\-\-tab\-width, \-w n
+set the width of tab characters (default 8).
+.TP
+.fi
+.B
+\-\-template, \-T template\-name
+set the template used when generating output.
+.TP
+.fi
+.B
+\-\-title, \-t text
+set text as the title for the output.
+.TP
+.fi
+.B
+\-\-version, \-v
+display RDoc's version.
+.TP
+.fi
+.B
+\-\-webcvs, \-W url
+specify a URL for linking to a web frontend to CVS. If the URL contains a
+'%s', the name of the current file will be substituted; if the URL doesn't
+contain a '%s', the filename will be appended to it.
+