File: README.rd

package info (click to toggle)
rdtool 0.6.34-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 936 kB
  • sloc: ruby: 8,203; lisp: 387; sh: 33; makefile: 22
file content (75 lines) | stat: -rw-r--r-- 2,020 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# -*- mode: rd; coding: utf-8; indent-tabs-mode: nil -*-
=begin
= RDtool 0.6.34
== What is RDtool

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

== What is Changed

See HISTORY.

== How to Install

 (1)((%su%)) if you install into public directories.
 (2)((%ruby setup.rb%))
 (3)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 add new
((<"issues at gihtub"|URL:https://github.com/uwabami/rdtool/issues>)),
or E-mail me ((<URL:mailto:uwabami@gfd-dennou.org>)).

== Copyright and License

You can use/re-distribute/change RDtool under Ruby's License or GPL-2+.
see LICNESE.txt and COPYING.txt. 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. The
license information for every files is as follows.

:Files: */
  * Copyright: 2004 MoonWolf <moonwolf@moonwolf.com>
               2011 Youhei SASAKI <uwabami@gfd-dennou.org>
  * License: Ruby's License or GPL-2+
:Files: lib/rd/rd2man-lib.rb
  * Copyright: 2000  WATANABE Hirofumi
  * License: Ruby's License or GPL-2+
:Files: lib/rd/{head-filter,rd2html-ext-lib,rd2html-ext-opt}.rb
  * Copyright: 2003 Rubikitch
  * License: Ruby's License or GPL-2+
:Files: bin/rdswap
  * Copyright: 1999 C.Hintze
  * License: Ruby's License or GPL-2+
:Files: setup.rb
  * Copyright: 2000-2006 Minero Aoki
  * License: LGPL-2.1
:Files: utils/rd-mode.el
  * Copyright: 1999 Koji Arai, Toshiro Kuwabara.
  * License: GPL-2+

=end