home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ruby164.zip / rbemx164.zip / ruby / share / doc / rdtool-0.6.10 / README.rd < prev    next >
Text File  |  2001-06-06  |  2KB  |  74 lines
  1. =begin
  2. = RDtool 0.6.10
  3. == What is RDtool
  4.  
  5. RD is Ruby's POD. RDtool is formatter for RD.
  6.  
  7. == What is Changed
  8.  
  9. See HISTORY.
  10.  
  11. == How to Install
  12.  
  13. RDtool requires:
  14.   * Racc 1.3 or later.  -- Ruby's yacc
  15.     ((- ((<URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=Racc>)) -))
  16.   * strscan. (Racc archive includes it.) -- lexer extension library
  17.     ((- ((<URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=strscan>)) -))
  18.   * OptionParser 0.7 or later. -- command-line option parser.
  19.     ((- ((<URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=OptionParser>)) -))
  20.   * forwardable -- fundamental library for flexible delegation.
  21.     ((- ((<URL:http://www.ruby-lang.org/en/raa-list.rhtml?name=forwardable>)) -))
  22.  
  23. Please install Racc before installation of RDtool.
  24.  
  25. The following site (maintained by Nakada) supplies the binary archives of Racc.
  26.  
  27.   * ((<URL:http://www.geocities.co.jp/SiliconValley-Bay/4076/archive/>))
  28.  
  29. And...
  30.  
  31.  (1)((%ruby rdtoolconf.rb%))
  32.  (2)Check and modify Makefile if needed.
  33.  (3)((%make all%)) in src dir.
  34.  (4)((%su%)) if you install into public directories.
  35.  (5)((%make install%))
  36.  (6)If you want to use , utils/rdswap.rb, utils/rd-mode.el,
  37.     install it ((*by hand*)).
  38.  (7)((%make clean%)) if you want.
  39.  
  40. == How to use
  41.  
  42. Simply,
  43.   % rd2 rdfile.rd > outputfile
  44.  
  45. If you want to indicate format-library, do
  46.   % rd2 -r library rdfile.rd > outputfile
  47.  
  48. Use ((% rd2 --help %)) for more options.
  49.  
  50. For options depend on format-library, enter ((%--help%)) after
  51. the indication of format-library. For example,
  52.  
  53.   % rd2 -r rd/rd2html-lib.rb --help
  54.  
  55. rd2 load "${HOME}/.rd2rc" when it runs.
  56.  
  57. == How to write RD?
  58.  
  59. Please read doc/rd-draft.rd.
  60.  
  61. == About bug report
  62.  
  63. If you find a bug in RDtool, please E-mail me
  64. ((<URL:mailto:toshirok@yb3.so-net.ne.jp>)).
  65.  
  66. == License
  67.  
  68. You can use/re-distribute/change RDtool under Ruby's License or GPL.
  69. This distribution of RDtool include files that are copyrighted by
  70. somebody else, and these files can be re-distributed under those own license.
  71. These files include the condition of those licenses in themselves.
  72.  
  73. =end
  74.