]>
Commit | Line | Data |
---|---|---|
92275170 | 1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "RDOC 1" | |
132 | .TH RDOC 1 "2003-08-19" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | rdoc \- Generate documentation from ruby source files | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | Usage: | |
138 | .PP | |
139 | .Vb 1 | |
140 | \& rdoc [options] [names...] | |
141 | .Ve | |
142 | .SH "DESCRIPTION" | |
143 | .IX Header "DESCRIPTION" | |
144 | Files are parsed, and the information they contain | |
145 | collected, before any output is produced. This allows cross | |
146 | references between all files to be resolved. If a name is a | |
147 | directory, it is traversed. If no names are specified, all | |
148 | Ruby files in the current directory (and subdirectories) are | |
149 | processed. | |
150 | .SH "OPTIONS" | |
151 | .IX Header "OPTIONS" | |
152 | Options: | |
153 | .IP "\fB\-a\fR, \fB\-\-all\fR" 8 | |
154 | .IX Item "-a, --all" | |
155 | include all methods (not just public) in the output | |
156 | .IP "\fB\-c\fR \fIcharset\fR, \fB\-\-charset\fR \fIcharset\fR" 8 | |
157 | .IX Item "-c charset, --charset charset" | |
158 | specifies \s-1HTML\s0 character-set | |
159 | .IP "\fB\-D\fR, \fB\-\-debug\fR" 8 | |
160 | .IX Item "-D, --debug" | |
161 | displays lots on internal stuff | |
162 | .IP "\fB\-d\fR, \fB\-\-diagram\fR" 8 | |
163 | .IX Item "-d, --diagram" | |
164 | Generate diagrams showing modules and classes. | |
165 | You need dot V1.8.6 or later to use the \-\-diagram | |
166 | option correctly. Dot is available from | |
167 | http://www.research.att.com/sw/tools/graphviz/ | |
168 | .IP "\fB\-x\fR \fIpattern\fR, \fB\-\-exclude\fR \fIpattern\fR" 8 | |
169 | .IX Item "-x pattern, --exclude pattern" | |
170 | do not process files or directories matching | |
171 | pattern. Files given explicitly on the command | |
172 | line will never be excluded. | |
173 | .IP "\fB\-F\fR, \fB\-\-fileboxes\fR" 8 | |
174 | .IX Item "-F, --fileboxes" | |
175 | classes are put in boxes which represents | |
176 | files, where these classes reside. Classes | |
177 | shared between more than one file are | |
178 | shown with list of files that sharing them. | |
179 | Silently discarded if \-\-diagram is not given | |
180 | Experimental. | |
181 | .IP "\fB\-f\fR \fIformat_name\fR, \fB\-\-fmt\fR \fIformat_name\fR" 8 | |
182 | .IX Item "-f format_name, --fmt format_name" | |
183 | set the output formatter (see below) | |
184 | .IP "\fB\-h\fR, \fB\-\-help\fR" 8 | |
185 | .IX Item "-h, --help" | |
186 | print out a brief help summary | |
187 | .IP "\fB\-O\fR, \fB\-\-help\-output\fR" 8 | |
188 | .IX Item "-O, --help-output" | |
189 | explain the various output options | |
190 | .IP "\fB\-I\fR \fIgif|jpg|jpg|jpeg\fR, \fB\-\-image\-format\fR \fIgif|png|jpg|jpeg\fR" 8 | |
191 | .IX Item "-I gif|jpg|jpg|jpeg, --image-format gif|png|jpg|jpeg" | |
192 | Sets output image format for diagrams. Can | |
193 | be png, gif, jpeg, jpg. If this option is | |
194 | omitted, png is used. Requires \-\-diagram. | |
195 | .IP "\fB\-i\fR \fIdir[,dir,...]\fR, \fB\-\-include\fR \fIdir[,dir,...]\fR" 8 | |
196 | .IX Item "-i dir[,dir,...], --include dir[,dir,...]" | |
197 | set (or add to) the list of directories | |
198 | to be searched when satisfying :include: | |
199 | requests. Can be used more than once. | |
200 | .IP "\fB\-S\fR, \fB\-\-inline\-source\fR" 8 | |
201 | .IX Item "-S, --inline-source" | |
202 | Show method source code inline, rather | |
203 | than via a popup link | |
204 | .IP "\fB\-N\fR, \fB\-\-line\-numbers\fR" 8 | |
205 | .IX Item "-N, --line-numbers" | |
206 | Include line numbers in the source code | |
207 | .IP "\fB\-m\fR \fIname\fR, \fB\-\-main\fR \fIname\fR" 8 | |
208 | .IX Item "-m name, --main name" | |
209 | \&'name' will be the initial page displayed | |
210 | .IP "\fB\-1\fR, \fB\-\-one\-file\fR" 8 | |
211 | .IX Item "-1, --one-file" | |
212 | put all the output into a single file | |
213 | .IP "\fB\-o\fR \fIdir\fR, \fB\-\-op\fR \fIdir\fR" 8 | |
214 | .IX Item "-o dir, --op dir" | |
215 | set the output directory | |
216 | .IP "\fB\-n\fR \fIname\fR, \fB\-\-opname\fR \fIname\fR" 8 | |
217 | .IX Item "-n name, --opname name" | |
218 | Set the 'name' of the output. Has no | |
219 | effect for \s-1HTML\s0. | |
220 | .IP "\fB\-q\fR, \fB\-\-quiet\fR" 8 | |
221 | .IX Item "-q, --quiet" | |
222 | don't show progress as we parse | |
223 | .IP "\fB\-H\fR, \fB\-\-show\-hash\fR" 8 | |
224 | .IX Item "-H, --show-hash" | |
225 | A name of the form #name in a comment | |
226 | is a possible hyperlink to an instance | |
227 | method name. When displayed, the '#' is | |
228 | removed unless this option is specified | |
229 | .IP "\fB\-w\fR \fIwidth\fR, \fB\-\-tab\-width\fR \fIwidth\fR" 8 | |
230 | .IX Item "-w width, --tab-width width" | |
231 | Set the width of tab characters (default 8) | |
232 | .IP "\fB\-T\fR \fItemplate_name\fR, \fB\-\-template\fR \fItemplate_name\fR" 8 | |
233 | .IX Item "-T template_name, --template template_name" | |
234 | Set the template used when generating output | |
235 | .IP "\fB\-t\fR \fItext\fR, \fB\-\-title\fR \fItext\fR" 8 | |
236 | .IX Item "-t text, --title text" | |
237 | Set 'txt' as the title for the output | |
238 | .IP "\fB\-v\fR, \fB\-\-version\fR" 8 | |
239 | .IX Item "-v, --version" | |
240 | display RDoc's version | |
241 | .SH "NOTES" | |
242 | .IX Header "NOTES" | |
243 | Available output formatters: chm, html, xml | |
244 | .PP | |
245 | For information on where the output goes, use | |
246 | .PP | |
247 | .Vb 1 | |
248 | \& rdoc --help-output | |
249 | .Ve | |
250 | .SH "AUTHOR" | |
251 | .IX Header "AUTHOR" | |
252 | This manpage was contributed by Brian Almeida <bma@debian.org> |