Skip to content

nobu/rdtool

Repository files navigation

<?xml version="1.0" ?>
<!DOCTYPE html 
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>README</title>
</head>
<body>
<h1><a name="label-0" id="label-0">RDtool 0.6.21</a></h1><!-- RDLabel: "RDtool 0.6.21" -->
<h2><a name="label-1" id="label-1">What is RDtool</a></h2><!-- RDLabel: "What is RDtool" -->
<p>RD is Ruby's POD. RDtool is formatter for RD.</p>
<h2><a name="label-2" id="label-2">What is Changed</a></h2><!-- RDLabel: "What is Changed" -->
<p>See HISTORY.</p>
<h2><a name="label-3" id="label-3">How to Install</a></h2><!-- RDLabel: "How to Install" -->
<ol>
<li><kbd>su</kbd> if you install into public directories.</li>
<li><kbd>ruby setup.rb</kbd></li>
<li>If you want to use , utils/rd-mode.el, install it <em>by hand</em>.</li>
</ol>
<h2><a name="label-4" id="label-4">How to use</a></h2><!-- RDLabel: "How to use" -->
<p>Simply,</p>
<pre>% rd2 rdfile.rd &gt; outputfile</pre>
<p>If you want to indicate format-library, do</p>
<pre>% rd2 -r library rdfile.rd &gt; outputfile</pre>
<p>Use <kbd> rd2 --help </kbd> for more options.</p>
<p>For options depend on format-library, enter <kbd>--help</kbd> after
the indication of format-library. For example,</p>
<pre>% rd2 -r rd/rd2html-lib.rb --help</pre>
<p>rd2 load "${HOME}/.rd2rc" when it runs.</p>
<h2><a name="label-5" id="label-5">How to write RD?</a></h2><!-- RDLabel: "How to write RD?" -->
<p>Please read doc/rd-draft.rd.</p>
<h2><a name="label-6" id="label-6">About bug report</a></h2><!-- RDLabel: "About bug report" -->
<p>If you find a bug in RDtool, please E-mail me
<a href="mailto:[email protected]">&lt;URL:mailto:[email protected]&gt;</a>.</p>
<h2><a name="label-7" id="label-7">License</a></h2><!-- RDLabel: "License" -->
<p>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.</p>

</body>
</html>

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published