SOURCES: erb.1 (NEW), rdoc.1 (NEW), ri.1 (NEW), testrb.1 (NEW), ir...
twittner
twittner at pld-linux.org
Mon Dec 26 01:59:20 CET 2005
Author: twittner Date: Mon Dec 26 00:59:19 2005 GMT
Module: SOURCES Tag: HEAD
---- Log message:
- added manpages for ruby (from Debian)
---- Files affected:
SOURCES:
erb.1 (NONE -> 1.1) (NEW), rdoc.1 (NONE -> 1.1) (NEW), ri.1 (NONE -> 1.1) (NEW), testrb.1 (NONE -> 1.1) (NEW), irb.1 (1.1 -> 1.2)
---- Diffs:
================================================================
Index: SOURCES/erb.1
diff -u /dev/null SOURCES/erb.1:1.1
--- /dev/null Mon Dec 26 01:59:19 2005
+++ SOURCES/erb.1 Mon Dec 26 01:59:14 2005
@@ -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 at ruby\-lang.org>.
+
================================================================
Index: SOURCES/rdoc.1
diff -u /dev/null SOURCES/rdoc.1:1.1
--- /dev/null Mon Dec 26 01:59:19 2005
+++ SOURCES/rdoc.1 Mon Dec 26 01:59:14 2005
@@ -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 at debian.org>
================================================================
Index: SOURCES/ri.1
diff -u /dev/null SOURCES/ri.1:1.1
--- /dev/null Mon Dec 26 01:59:19 2005
+++ SOURCES/ri.1 Mon Dec 26 01:59:14 2005
@@ -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
+
================================================================
Index: SOURCES/testrb.1
diff -u /dev/null SOURCES/testrb.1:1.1
--- /dev/null Mon Dec 26 01:59:19 2005
+++ SOURCES/testrb.1 Mon Dec 26 01:59:14 2005
@@ -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 at debian.org>
+
================================================================
Index: SOURCES/irb.1
diff -u SOURCES/irb.1:1.1 SOURCES/irb.1:1.2
--- SOURCES/irb.1:1.1 Fri Sep 7 00:29:15 2001
+++ SOURCES/irb.1 Mon Dec 26 01:59:14 2005
@@ -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 @@
\& 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)
<<Diff was trimmed, longer than 597 lines>>
---- CVS-web:
http://cvs.pld-linux.org/SOURCES/irb.1?r1=1.1&r2=1.2&f=u
More information about the pld-cvs-commit
mailing list