summaryrefslogtreecommitdiff
path: root/lib/rdoc/README
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rdoc/README')
-rw-r--r--lib/rdoc/README5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/rdoc/README b/lib/rdoc/README
index cfc99cb50f..5e90d792a2 100644
--- a/lib/rdoc/README
+++ b/lib/rdoc/README
@@ -164,7 +164,10 @@ Options are:
include line numbers in the source code
[<tt>--main</tt> _name_]
- set the class, module, or file to appear on the index page
+ the class of module _name_ will appear on the index page. If you
+ want to set a particular file as a main page (a README, for
+ example) simply specifiy its name as the first on the command
+ line.
[<tt>--merge</tt>]
when generating _ri_ output, if classes being processed already