summaryrefslogtreecommitdiff
path: root/lib/rdoc/README
diff options
context:
space:
mode:
authordave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-09-14 14:49:19 +0000
committerdave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-09-14 14:49:19 +0000
commitf2ff67952fd965bb5751e68d3d51b1c5e668b657 (patch)
treebc8a58131d2dccc7b8cd420cce04c11556df33a6 /lib/rdoc/README
parente02f79dfe9c1a80bdf661d5c5201a06261de9e43 (diff)
Add simple formatter to ri
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6909 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
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