]> git.pld-linux.org Git - packages/ruby.git/commitdiff
- added manpages for ruby (from Debian)
authortwittner <twittner@pld-linux.org>
Mon, 26 Dec 2005 00:59:14 +0000 (00:59 +0000)
committercvs2git <feedback@pld-linux.org>
Sun, 24 Jun 2012 12:13:13 +0000 (12:13 +0000)
Changed files:
    erb.1 -> 1.1
    irb.1 -> 1.2
    rdoc.1 -> 1.1
    ri.1 -> 1.1
    testrb.1 -> 1.1

erb.1 [new file with mode: 0644]
irb.1
rdoc.1 [new file with mode: 0644]
ri.1 [new file with mode: 0644]
testrb.1 [new file with mode: 0644]

diff --git a/erb.1 b/erb.1
new file mode 100644 (file)
index 0000000..2a847bb
--- /dev/null
+++ b/erb.1
@@ -0,0 +1,72 @@
+.TH ERB1.8 1 "April 2003"
+.SH NAME
+.PP
+erb \- an embedded Ruby language interpreter
+.SH SYNOPSIS
+.PP
+erb1.8 [switches] [inputfile]
+.SH DESCRIPTION
+.PP
+erb interprets a Ruby code embedded text file. For example, erb
+enables you to embed a Ruby code to a HTML file.
+A Ruby block starts with `<%' and ends with `%>'. erb replaces
+the block with its output.
+If `<%' is followed by `=', eRuby replaces the block with a value
+of the block.
+If `<%' is followed by `#', the block is ignored as a comment.
+.SH OPTIONS
+.PP
+
+.TP
+.fi
+.B
+\-x
+print ruby script
+.TP
+.fi
+.B
+\-n
+print ruby script with line number
+.TP
+.fi
+.B
+\-v
+enables verbose mode
+.TP
+.fi
+.B
+\-d
+set debugging flags (set $DEBUG to true)
+.TP
+.fi
+.B
+\-r library
+load a library
+.TP
+.fi
+.B
+\-K kcode
+specifies KANJI code\-set (euc or sjis) or UTF\-8 (utf8)
+.TP
+.fi
+.B
+\-S safe_level
+set $SAFE (0..4)
+.TP
+.fi
+.B
+\-T trim_mode
+specify trim_mode (0..2)
+.TP
+.fi
+.B
+\-P
+disregard the lin which starts in "%" 
+.SH SEE ALSO
+.PP
+eruby(1)
+.SH AUTHOR
+.PP
+This document stands on eruby(1) which is written by Shugo Maeda
+<shugo@ruby\-lang.org>.
+
diff --git a/irb.1 b/irb.1
index 7fc98287e12e483d47d85a523cc5146014fe6268..5261ba42e67f172c914b16e0d3f17f68e3847c58 100644 (file)
--- a/irb.1
+++ b/irb.1
@@ -1,27 +1,19 @@
-.\" DO NOT MODIFY THIS FILE! it was generated by rd2
-.TH irb-beta 1 "May 2001"
-.SH What is irb?
+.TH IRB "1" "December 2002"
+.SH NAME
+irb \- interactive ruby
+.SH SYNOPSIS
+.B irb
+[\fIoptions\fR]
+.SH DESCRIPTION
 .PP
 irb stands for `interactive ruby'. irb is a tool to execute interactively
 ruby expressions read from stdin. 
-.SH Invoking
-.PP
-.nf
-\&    % ruby \-r irb \-e0
-\&    % irb
-.fi
-Either of the aboves. In the former style, options can be specified
-as follows:
-.nf
-\&    % ruby \-r irb \-e0 \-\- \-v
-.fi
-.SH Usage
-.PP
 Use of irb is easy if you know ruby.  Executing irb, prompts are 
 displayed as follows. Then, enter expression of ruby. A input is
 executed when it is syntacticaly completed. 
+
 .nf
-\&    dim% irb
+\&    $ irb1.8
 \&    irb(main):001:0> 1+2
 \&    3
 \&    irb(main):002:0> class Foo
@@ -32,54 +24,108 @@ executed when it is syntacticaly completed.
 \&    nil
 \&    irb(main):007:0> 
 .fi
+
 And, Readline extesion module can be used with irb. Using Readline
 is the standard default action if Readline is installed. 
-.SH Command line option
+.SH OPTIONS
+
 .PP
-.nf
-\&    irb.rb [options] file_name opts
-\&    options:
-\&    \-f                  suppress read ~/.irbrc 
-\&    \-m                  bc mode (fraction or matrix are available)
-\&    \-d                set $DEBUG  to true (same as `ruby \-d')
-\&    \-r load\-module    same as `ruby \-r'
-\&    \-\-inspect          uses `inspect' for output (the default except bc mode)
-\&    \-\-noinspect        doesn't uses inspect for output
-\&    \-\-readline         uses Readline extension module
-\&    \-\-noreadline       doesn't use Readline extension module
-\&    \-\-prompt prompt\-mode
-\&    \-\-prompt\-mode prompt\-mode
+
+.TP
 .fi
-.nf
-\&    switches prompt mode. Pre\-defined prompt modes are
-\&    `defalut', `simple', `xmp' and `inf\-ruby'
+.B
+\-f
+suppress read ~/.irbrc 
+.TP
 .fi
-.nf
-\&    \-\-inf\-ruby\-mode   uses prompt appreciate for inf\-ruby\-mode on emacs. 
+.B
+\-m
+bc mode (fraction or matrix are available)
+.TP
 .fi
-.nf
-\&    Suppresses \-\-readline. 
+.B
+\-d
+set $DEBUG  to true (same as `ruby \-d')
+.TP
 .fi
-.nf
-\&    \-\-simple\-prompt   simple prompt mode
-\&    \-\-noprompt         no prompt
-\&    \-\-tracer           display trace for each execution of commands.
-\&    \-\-back\-trace\-limit n
+.B
+\-r load\-module
+same as `ruby \-r'
+.TP
 .fi
-.nf
-\&    displayes backtrace top n and tail n. The default
-\&    value is 16. 
+.B
+\-\-inspect
+uses `inspect' for output (the default except bc mode)
+.TP
 .fi
-.nf
-\&    \-\-irb_debug n      sets internal debug level to n (It shouldn't be used)
-\&    \-v, \-\-version     prints the version of irb
+.B
+\-\-noinspect
+doesn't uses inspect for output
+.TP
+.fi
+.B
+\-\-readline
+uses Readline extension module
+.TP
 .fi
-.SH Configurations
+.B
+\-\-noreadline
+doesn't use Readline extension module
+.TP
+.fi
+.B
+\-\-prompt prompt\-mode
+.TP
+.fi
+.B
+\-\-prompt\-mode prompt\-mode
+switches prompt mode. Pre\-defined prompt modes are
+`default', `simple', `xmp' and `inf\-ruby'
+.TP
+.fi
+.B
+\-\-inf\-ruby\-mode
+uses prompt appreciate for inf\-ruby\-mode on emacs. 
+Suppresses \-\-readline. 
+.TP
+.fi
+.B
+\-\-simple\-prompt
+simple prompt mode
+.TP
+.fi
+.B
+\-\-noprompt
+no prompt
+.TP
+.fi
+.B
+\-\-tracer
+display trace for each execution of commands.
+.TP
+.fi
+.B
+\-\-back\-trace\-limit n
+displayes backtrace top n and tail n. The default
+value is 16. 
+.TP
+.fi
+.B
+\-\-irb_debug n
+sets internal debug level to n (It shouldn't be used)
+.TP
+.fi
+.B
+\-v, \-\-version
+prints the version of irb
+.SH CONFIGURATIONS
+
 .PP
 irb reads `~/.irbrc' when it is invoked. If `~/.irbrb' doesn't exist
 irb try to read in the order `.irbrc', `irb.rc', `_irbrc' then `$irbrc'. 
 The following is altanative to the command line option. To use them
 type as follows in an irb session. 
+
 .nf
 \&    IRB.conf[:IRB_NAME]="irb"
 \&    IRB.conf[:MATH_MODE]=false
@@ -101,12 +147,16 @@ type as follows in an irb session.
 \&    IRB.conf[:VERBOSE]=true
 .fi
 .SH Customizing prompt
+
 .PP
 To costomize the prompt you set a variable
+
 .nf
 \&    IRB.conf[:PROMPT]
 .fi
+
 For example, describe as follows in `.irbrc'. 
+
 .nf
 \&    IRB.conf[:PROMPT][:MY_PROMPT] = { # name of prompt mode
 \&      :PROMPT_I => nil,                # normal prompt
@@ -115,16 +165,22 @@ For example, describe as follows in `.irbrc'.
 \&      :RETURN => "    ==>%s\\n"        # format to return value
 \&    }
 .fi
+
 Then, invoke irb with the above prompt mode by
+
 .nf
-\&    % irb \-\-prompt my\-prompt
+\&    $ irb1.8 \-\-prompt my\-prompt
 .fi
+
 Or add the following in `.irbrc'. 
+
 .nf
 \&    IRB.conf[:PROMPT_MODE] = :MY_PROMPT
 .fi
+
 Constants PROMPT_I, PROMPT_S and PROMPT_C specifies the format. 
 In the prompt specification, some special strings are available. 
+
 .nf
 \&    %N       command name which is running
 \&    %m       to_s of main object (self)
@@ -137,32 +193,25 @@ In the prompt specification, some special strings are available.
 .fi
 For instance, the default prompt mode is defined as follows:
 IRB.conf[:PROMPT_MODE][:DEFAULT] = {
-
 .TP
 .fi
 .B
 PROMPT_I => "%N(%m):%03n:%i> ",
-
-
 .TP
 .fi
 .B
 PROMPT_S => "%N(%m):%03n:%i%l ",
-
-
 .TP
 .fi
 .B
 PROMPT_C => "%N(%m):%03n:%i* ",
-
-
 .TP
 .fi
 .B
-RETURN => "%s\\n"
-} 
+RETURN => "%s\\n"} 
 RETURN is used to printf. 
 .SH Configurating subirb
+
 .PP
 The command line option or IRB.conf specify the default behavior of
 (sub)irb. On the other hand, each conf of in the next sction `6. Command' 
@@ -171,9 +220,9 @@ If proc is set to IRB.conf[:IRB_RC], its subirb will be invoked after
 execution of that proc under giving the context of irb as its
 aregument. By this mechanism each subirb can be configurated. 
 .SH Command
+
 .PP
 For irb commands, both simple name and `irb_'\-prefixed name are prepared. 
-
 .TP
 .fi
 .B
@@ -181,58 +230,44 @@ exit, quit, irb_exit
 Quits (sub)irb. 
 if you've done cb (see below), exit from the binding mode.
 
-
 .TP
 .fi
 .B
 conf, irb_context
 Displays current configuration. Modifing the configuration is
 achieved by sending message to `conf'. 
-
-
 .TP
 .fi
 .B
 conf.back_trace_limit
 Sets display lines of backtrace as top n and tail n. 
 The default value is 16.
-
-
 .TP
 .fi
 .B
 conf.debug_level = N
 Sets debug level of irb. 
-
-
 .TP
 .fi
 .B
 conf.ignore_eof = true/false
 Whether ^D (control\-d) will be ignored or not. 
 If false is set, ^D means quit. 
-
-
 .TP
 .fi
 .B
 conf.ignore_sigint= true/false
 Whether ^C (control\-c) will be ignored or not. 
 If false is set, ^D means quit.  If true, 
-
 .nf
 \&    during input:   cancel inputing then return to top level. 
 \&    during execute: abondon current execution. 
 .fi
-
-
 .TP
 .fi
 .B
 conf.inf_ruby_mode = true/false
 Whether inf\-ruby\-mode or not. The default value is false.
-
-
 .TP
 .fi
 .B
@@ -241,69 +276,50 @@ Specifies inspect mode.
 true:  display inspect
 false: display to_s
 nil:   inspect mode in non math mode, 
-
 .nf
 \&    non inspect mode in math mode. 
 .fi
-
-
 .TP
 .fi
 .B
 conf.irb_level
 The level of cb. 
-
-
 .TP
 .fi
 .B
 conf.math_mode
 Whether bc mode or not. 
-
-
 .TP
 .fi
 .B
 conf.use_loader = true/false
 Whether irb's own file reader method is used when load/require or not. 
 This mode is globaly affected (irb wide). 
-
-
 .TP
 .fi
 .B
 conf.prompt_c
 prompt for a continuating statement (e.g, immediately after of `if')
-
-
 .TP
 .fi
 .B
 conf.prompt_i
 standard prompt
-
-
 .TP
 .fi
 .B
 conf.prompt_s
 prompt for a continuating string
-
-
 .TP
 .fi
 .B
 conf.rc
 Whether ~/.irbrc is read or not. 
-
-
 .TP
 .fi
 .B
 conf.use_prompt = true/false
 Prompting or not. 
-
-
 .TP
 .fi
 .B
@@ -312,65 +328,57 @@ Whether readline is used or not.
 true: uses 
 false: doen't use
 nil: intends to use readline except for inf\-reuby\-mode (default)
-
-
 .TP
 .fi
 .B
 conf.verbose=T/F
 Whether verbose messages are display or not. 
-
-
 .TP
 .fi
 .B
 cb, irb_change_binding [obj]
 Enter new binding which has a distinct scope of local variables. 
 If obj is given, obj will be self. 
-
-
 .TP
 .fi
 .B
 irb [obj]
 Invoke subirb. If obj is given, obj will be self. 
-
-
 .TP
 .fi
 .B
 jobs, irb_jobs
 List of subirb
-
-
 .TP
 .fi
 .B
 fg n, irb_fg n
 Switch into specified subirb. The following is candidates of n:
-
 .nf
 \&    irb number
 \&    thhread
 \&    irb object
 \&    self(obj which is specified of irb obj)
 .fi
-
-
 .TP
 .fi
 .B
 kill n, irb_kill n
 Kill subirb. The means of n is as same as the case of irb_fg. 
 .SH System variable
+
 .PP
-.nf
-\&    _  The latest value of evaluation (it is local)
+
+.TP
 .fi
+.B
+_
+The latest value of evaluation (it is local)
 .SH Session Example
+
 .PP
 .nf
-\&    dim% ruby irb.rb
+\&    $ irb1.8
 \&    irb(main):001:0> irb                        # invoke subirb
 \&    irb#1(main):001:0> jobs                     # list of subirbs
 \&    #0\->irb on main (#<Thread:0x400fb7e4> : stop)
@@ -433,16 +441,18 @@ Kill subirb. The means of n is as same as the case of irb_fg.
 \&    #0\->irb on main (#<Thread:0x400fb7e4> : running)
 \&    nil
 \&    irb(main):010:0> exit                       # exit
-\&    dim% 
 .fi
 .SH Restrictions
+
 .PP
 Because irb evaluates the inputs immediately after the imput is
 syntactically completed, irb gives slight different result than
 directly use ruby. Known difference is pointed out here. 
 .SH Declaration of the local variable
+
 .PP
 The following causes an error in ruby:
+
 .nf
 \&    eval "foo = 0"
 \&    foo
@@ -451,7 +461,9 @@ The following causes an error in ruby:
 \&    \-\-\-
 \&    NameError
 .fi
+
 Though, the above will successfully done by irb. 
+
 .nf
 \&    >> eval "foo = 0"
 .fi
@@ -460,15 +472,19 @@ Though, the above will successfully done by irb.
 \&    >> foo
 \&    => 0
 .fi
+
 Ruby evaluates a code after reading entire of code and determination
 of the scope of local variables. On the other hand, irb do
 immediately. More precisely, irb evaluate at first
+
 .nf
 \&    evel "foo = 0" 
 .fi
+
 then foo is defined on this timing. It is because of this
 incompatibility.
 If you'd like to detect those differences, begin...end can be used:
+
 .nf
 \&    >> begin
 \&    ?>   eval "foo = 0"
@@ -479,9 +495,11 @@ If you'd like to detect those differences, begin...end can be used:
 \&    (irb_local_binding):1:in `eval'
 .fi
 .SH Here\-document
+
 .PP
 Implementation of Here\-document is incomplete. 
 .SH Symbol
+
 .PP
 Irb can not always recognize a symbol as to be Symbol. Concretely, an
 expression have completed, however Irb regard it as continuation line.
diff --git a/rdoc.1 b/rdoc.1
new file mode 100644 (file)
index 0000000..6297e53
--- /dev/null
+++ b/rdoc.1
@@ -0,0 +1,252 @@
+.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  | will give a
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.tr \(*W-|\(bv\*(Tr
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "RDOC 1"
+.TH RDOC 1 "2003-08-19" "perl v5.8.0" "User Contributed Perl Documentation"
+.SH "NAME"
+rdoc \- Generate documentation from ruby source files
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+Usage:
+.PP
+.Vb 1
+\&  rdoc [options]  [names...]
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+Files are parsed, and the information they contain
+collected, before any output is produced. This allows cross
+references between all files to be resolved. If a name is a
+directory, it is traversed. If no names are specified, all
+Ruby files in the current directory (and subdirectories) are
+processed.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+Options:
+.IP "\fB\-a\fR, \fB\-\-all\fR" 8
+.IX Item "-a, --all"
+include all methods (not just public) in the output
+.IP "\fB\-c\fR \fIcharset\fR, \fB\-\-charset\fR \fIcharset\fR" 8
+.IX Item "-c charset, --charset charset"
+specifies \s-1HTML\s0 character-set
+.IP "\fB\-D\fR, \fB\-\-debug\fR" 8
+.IX Item "-D, --debug"
+displays lots on internal stuff
+.IP "\fB\-d\fR, \fB\-\-diagram\fR" 8
+.IX Item "-d, --diagram"
+Generate diagrams showing modules and classes.
+You need dot V1.8.6 or later to use the \-\-diagram
+option correctly. Dot is available from
+http://www.research.att.com/sw/tools/graphviz/
+.IP "\fB\-x\fR \fIpattern\fR, \fB\-\-exclude\fR \fIpattern\fR" 8
+.IX Item "-x pattern, --exclude pattern"
+do not process files or directories matching
+pattern. Files given explicitly on the command
+line will never be excluded.
+.IP "\fB\-F\fR, \fB\-\-fileboxes\fR" 8
+.IX Item "-F, --fileboxes"
+classes are put in boxes which represents
+files, where these classes reside. Classes
+shared between more than one file are
+shown with list of files that sharing them.
+Silently discarded if \-\-diagram is not given
+Experimental.
+.IP "\fB\-f\fR \fIformat_name\fR, \fB\-\-fmt\fR \fIformat_name\fR" 8
+.IX Item "-f format_name, --fmt format_name"
+set the output formatter (see below)
+.IP "\fB\-h\fR, \fB\-\-help\fR" 8
+.IX Item "-h, --help"
+print out a brief help summary
+.IP "\fB\-O\fR, \fB\-\-help\-output\fR" 8
+.IX Item "-O, --help-output"
+explain the various output options
+.IP "\fB\-I\fR \fIgif|jpg|jpg|jpeg\fR, \fB\-\-image\-format\fR \fIgif|png|jpg|jpeg\fR" 8
+.IX Item "-I gif|jpg|jpg|jpeg, --image-format gif|png|jpg|jpeg"
+Sets output image format for diagrams. Can
+be png, gif, jpeg, jpg. If this option is
+omitted, png is used. Requires \-\-diagram.
+.IP "\fB\-i\fR \fIdir[,dir,...]\fR, \fB\-\-include\fR \fIdir[,dir,...]\fR" 8
+.IX Item "-i dir[,dir,...], --include dir[,dir,...]"
+set (or add to) the list of directories
+to be searched when satisfying :include:
+requests. Can be used more than once.
+.IP "\fB\-S\fR, \fB\-\-inline\-source\fR" 8
+.IX Item "-S, --inline-source"
+Show method source code inline, rather
+than via a popup link
+.IP "\fB\-N\fR, \fB\-\-line\-numbers\fR" 8
+.IX Item "-N, --line-numbers"
+Include line numbers in the source code
+.IP "\fB\-m\fR \fIname\fR, \fB\-\-main\fR \fIname\fR" 8
+.IX Item "-m name, --main name"
+\&'name' will be the initial page displayed
+.IP "\fB\-1\fR, \fB\-\-one\-file\fR" 8
+.IX Item "-1, --one-file"
+put all the output into a single file
+.IP "\fB\-o\fR \fIdir\fR, \fB\-\-op\fR \fIdir\fR" 8
+.IX Item "-o dir, --op dir"
+set the output directory
+.IP "\fB\-n\fR \fIname\fR, \fB\-\-opname\fR \fIname\fR" 8
+.IX Item "-n name, --opname name"
+Set the 'name' of the output. Has no
+effect for \s-1HTML\s0.
+.IP "\fB\-q\fR, \fB\-\-quiet\fR" 8
+.IX Item "-q, --quiet"
+don't show progress as we parse
+.IP "\fB\-H\fR, \fB\-\-show\-hash\fR" 8
+.IX Item "-H, --show-hash"
+A name of the form #name in a comment
+is a possible hyperlink to an instance
+method name. When displayed, the '#' is
+removed unless this option is specified
+.IP "\fB\-w\fR \fIwidth\fR, \fB\-\-tab\-width\fR \fIwidth\fR" 8
+.IX Item "-w width, --tab-width width"
+Set the width of tab characters (default 8)
+.IP "\fB\-T\fR \fItemplate_name\fR, \fB\-\-template\fR \fItemplate_name\fR" 8
+.IX Item "-T template_name, --template template_name"
+Set the template used when generating output
+.IP "\fB\-t\fR \fItext\fR, \fB\-\-title\fR \fItext\fR" 8
+.IX Item "-t text, --title text"
+Set 'txt' as the title for the output
+.IP "\fB\-v\fR, \fB\-\-version\fR" 8
+.IX Item "-v, --version"
+display  RDoc's version
+.SH "NOTES"
+.IX Header "NOTES"
+Available output formatters: chm, html, xml
+.PP
+For information on where the output goes, use
+.PP
+.Vb 1
+\&   rdoc --help-output
+.Ve
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+This manpage was contributed by Brian Almeida <bma@debian.org>
diff --git a/ri.1 b/ri.1
new file mode 100644 (file)
index 0000000..6cec4c2
--- /dev/null
+++ b/ri.1
@@ -0,0 +1,82 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH ri 1 "April 2005"
+.SH NAME
+.PP
+ri \- Ruby Information at your fingertips
+.SH SYNOPSIS
+.PP
+ri [options] [names...]
+.SH DESCRIPTION
+.PP
+\fIri\fP displaies information on Ruby classes, modules, and methods.
+You can give the names of classes or methods to see their documentation.
+Partial names may be given: if the names match more than
+one entity, a list will be shown, otherwise details on
+that entity will be displayed.
+.PP
+Nested classes and modules can be specified using the normal
+Name::Name notation, and instance methods can be distinguished
+from class methods using "." (or "#") instead of "::".
+.PP
+For example:
+.nf
+\&    ri File
+\&    ri File.new
+\&    ri F.n
+\&    ri zip
+.fi
+.PP
+Note that shell quoting may be required for method names
+containing punctuation:
+.nf
+\&    ri 'Array.[]'
+\&    ri compact\\!
+.fi
+.SH OPTIONS
+.TP
+.fi
+.B
+\-\-classes, \-c
+Display the names of classes and modules we know about.
+.TP
+.fi
+.B
+\-\-doc\-dir, \-d dirname
+A directory to search for documentation. If not specified, we search the
+standard rdoc/ri directories.
+.TP
+.fi
+.B
+\-\-format, \-f name
+Format to use when displaying output: ansi, bs, html, plain, simple.  Use
+'bs' (backspace) with most pager programs.  To use ANSI, either also use
+the \-T option, or tell your pager to allow control characters.  (for
+example using the \-R option to less.)
+.TP
+.fi
+.B
+\-\-list\-names, \-l
+List all the names known to RDoc, one per line.
+.TP
+.fi
+.B
+\-\-no\-pager, \-T
+Send output directly to stdout.
+.TP
+.fi
+.B
+\-\-width, \-w width
+Set the width of the output.
+.TP
+.fi
+.B
+\-\-version, \-v
+Display the version of ri.
+.TP
+.fi
+.B
+\-\-help, \-h
+Display help.
+.PP
+Options may also be passed in the 'RI' environment variable
+
diff --git a/testrb.1 b/testrb.1
new file mode 100644 (file)
index 0000000..9ba4e35
--- /dev/null
+++ b/testrb.1
@@ -0,0 +1,60 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH testrb 1 "December 2003"
+.SH NAME
+.PP
+testrb \- Automatic runnter for Test::Unit of Ruby
+.SH SYNOPSIS
+.PP
+testrb [options] [\-\- untouched arguments] test ...
+.SH DESCRIPTION
+.PP
+testrb loads and runs unit\-tests.  If test is directory name, testrb1.8
+testrb traverses the directory.
+.SH OPTIONS
+.TP
+.fi
+.B
+\-r, \-\-runner=RUNNER
+Use the given RUNNER.  (t[k], c[onsole], g[tk], f[ox])
+.TP
+.fi
+.B
+\-a, \-\-add=TORUN
+Add TORUN to the list of things to run;  can be a file or a directory.
+.TP
+.fi
+.B
+\-p, \-\-pattern=PATTERN
+Match files to collect against PATTERN.  (default pattern is
+/\\Atest_.*\\.rb\\Z/.)
+.TP
+.fi
+.B
+\-n, \-\-name=NAME
+Runs tests matching NAME.  (patterns may be used.)
+.TP
+.fi
+.B
+\-t, \-\-testcase=TESTCASE
+Runs tests in TestCases matching TESTCASE.  (patterns may be used.)
+.TP
+.fi
+.B
+\-v, \-\-verbose=[LEVEL]
+Set the output level (default is verbose).  (p[rogress], n[ormal],
+v[erbose], s[ilent])
+.TP
+.fi
+.B
+\-\-
+Stop processing options so that the remaining options will be passed to
+the test.
+.TP
+.fi
+.B
+\-h, \-\-help
+Display help.
+.SH AUTHOR
+.PP
+This manpage was contributed by akira yamada <akira@debian.org>
+
This page took 0.066665 seconds and 4 git commands to generate.