home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 December (Special) / PCWorld_2005-12_Special_cd.bin / Bezpecnost / lsti / lsti.exe / framework-2.5.exe / ri < prev    next >
Text File  |  2005-01-18  |  1KB  |  50 lines
  1. #!/usr/bin/ruby
  2. # usage:
  3. #
  4. #   ri  name...
  5. #
  6. # where name can be 
  7. #
  8. #   Class | Class::method | Class#method | Class.method | method
  9. #
  10. # All names may be abbreviated to their minimum unbiguous form. If a name
  11. # _is_ ambiguous, all valid options will be listed.
  12. #
  13. # The form '.' method matches either class or instance methods, while 
  14. # #method matches only instance and ::method matches only class methods.
  15. #
  16. #
  17. # == Installing Documentation
  18. #
  19. # 'ri' uses a database of documentation built by the RDoc utility.
  20. # 
  21. # So, how do you install this documentation on your system?
  22. # It depends on how you installed Ruby.
  23. #
  24. # <em>If you installed Ruby from source files</em> (that is, if it some point
  25. # you typed 'make' during the process :), you can install the RDoc
  26. # documentation yourself. Just go back to the place where you have 
  27. # your Ruby source and type
  28. #
  29. #    make install-doc
  30. #
  31. # You'll probably need to do this as a superuser, as the documentation
  32. # is installed in the Ruby target tree (normally somewhere under 
  33. # <tt>/usr/local</tt>.
  34. #
  35. # <em>If you installed Ruby from a binary distribution</em> (perhaps
  36. # using a one-click installer, or using some other packaging system),
  37. # then the team that produced the package probably forgot to package
  38. # the documentation as well. Contact them, and see if they can add
  39. # it to the next release.
  40. #
  41.  
  42.  
  43. require 'rdoc/ri/ri_driver'
  44.  
  45. ######################################################################
  46.  
  47. ri = RiDriver.new
  48. ri.process_args
  49.  
  50.