https://github.com/ged/rdtool
RD is Ruby's POD. RDtool is a formatter for RD. With this fork, I'm intending to package rdtool as a gem, and update it as necessary for later versions of Ruby.
https://github.com/ged/rdtool
Last synced: about 1 year ago
JSON representation
RD is Ruby's POD. RDtool is a formatter for RD. With this fork, I'm intending to package rdtool as a gem, and update it as necessary for later versions of Ruby.
- Host: GitHub
- URL: https://github.com/ged/rdtool
- Owner: ged
- Created: 2011-01-04T20:44:19.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2011-01-25T17:15:59.000Z (over 15 years ago)
- Last Synced: 2025-02-10T20:57:36.746Z (over 1 year ago)
- Language: Ruby
- Homepage: http://rubyforge.org/projects/rdtool/
- Size: 215 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.rd
- Changelog: HISTORY.rd
Awesome Lists containing this project
README
=begin
= RDtool 0.6.21
== What is RDtool
RD is Ruby's POD. RDtool is a formatter for RD. This is a re-packaging of
rdtool as a Rubygem.
== What is Changed
See HISTORY.
== How to Install
((%sudo gem install rdtool%))
== 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 loads "${HOME}/.rd2rc" when it runs, so you can use it to set
default options.
== How to write RD?
Please read doc/rd-draft.rd.
== About bug reports
This is a re-packaged version
If you find a bug in RDtool, please E-mail me
(()).
== 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.
=end