diff options
Diffstat (limited to 'lib/rdoc/README')
| -rw-r--r-- | lib/rdoc/README | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README index 39ce8bb75b..1b8671182f 100644 --- a/lib/rdoc/README +++ b/lib/rdoc/README @@ -166,6 +166,11 @@ Options are: [<tt>--main</tt> _name_] set the class, module, or file to appear on the index page +[<tt>--merge</tt>] + when generating _ri_ output, if classes being processed already + exist in the destination directory, merge in the current details + rather than overwrite them. + [<tt>--one-file</tt>] place all the output into a single file @@ -191,6 +196,13 @@ Options are: [<tt>--quiet</tt>] do not display progress messages +[<tt>--ri</tt> _and_ <tt>--ri-site</tt>] + generate output than can be read by the _ri_ command-line tool. + By default --ri places its output in ~/.rdoc, and --ri-site in + $datadir/ri/<ver>/site. Both can be overridden with a subsequent + --op option. Both default directories are in ri's default search + path. + [<tt>--show-hash</tt>] A name of the form #name in a comment is a possible hyperlink to an instance method name. When displayed, the '#' is removed unless |