https://github.com/nishidayuya/rdtool

RD formater and utilities. (RD is Ruby's POD)
https://github.com/nishidayuya/rdtool

Last synced: about 1 month ago
JSON representation

RD formater and utilities. (RD is Ruby's POD)

• Host: GitHub
• URL: https://github.com/nishidayuya/rdtool
• Owner: nishidayuya
• Created: 2009-03-24T13:48:10.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2009-03-24T16:51:18.000Z (almost 16 years ago)
• Last Synced: 2023-04-14T02:06:05.528Z (over 1 year ago)
• Homepage: http://rubyforge.org/projects/rdtool/
• Size: 191 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.html
  • Changelog: HISTORY

Awesome Lists containing this project

README

        


README

RDtool 0.6.21

What is RDtool

RD is Ruby's POD. RDtool is formatter for RD.

What is Changed

See HISTORY.

How to Install





su if you install into public directories.

ruby setup.rb

If you want to use , utils/rd-mode.el, install it by hand.



How to use

Simply,

% rd2 rdfile.rd > outputfile

If you want to indicate format-library, do

% rd2 -r library rdfile.rd > outputfile

Use  rd2 --help  for more options.

For options depend on format-library, enter --help after

the indication of format-library. For example,

% rd2 -r rd/rd2html-lib.rb --help

rd2 load "${HOME}/.rd2rc" when it runs.

How to write RD?

Please read doc/rd-draft.rd.

About bug report

If you find a bug in RDtool, please E-mail me

<URL:mailto:[email protected]>.

License

You can use/re-distribute/change RDtool under Ruby's License or GPL.

This distribution of RDtool include files that are copyrighted by

somebody else, and these files can be re-distributed under those own license.

These files include the condition of those licenses in themselves.