summaryrefslogtreecommitdiff
path: root/debian/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpages')
-rw-r--r--debian/manpages/gem2.3.142
-rw-r--r--debian/manpages/gem2.3.rd41
-rw-r--r--debian/manpages/rdoc2.3.1209
-rw-r--r--debian/manpages/rdoc2.3.rd147
-rw-r--r--debian/manpages/testrb2.3.160
-rw-r--r--debian/manpages/testrb2.3.rd57
6 files changed, 556 insertions, 0 deletions
diff --git a/debian/manpages/gem2.3.1 b/debian/manpages/gem2.3.1
new file mode 100644
index 0000000..f03495c
--- /dev/null
+++ b/debian/manpages/gem2.3.1
@@ -0,0 +1,42 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH GEM2.3 1 "July 2014"
+.SH NAME
+.PP
+gem2.3 \- frontend to RubyGems, the Ruby package manager
+.SH SYNOPSIS
+.PP
+gem2.3 command [arguments...] [options...]
+.SH DESCRIPTION
+.PP
+gem2.3 is the frontend to RubyGems, the standard package manager for Ruby.
+This is a basic help message containing pointers to more information.
+.PP
+Further help:
+.TP
+.fi
+.B
+gem2.3 help commands
+list all gem2.3 commands
+.TP
+.fi
+.B
+gem2.3 help examples
+shows some examples of usage
+.TP
+.fi
+.B
+gem2.3 help COMMAND
+show help on COMMAND, (e.g. 'gem2.3 help install')
+.SH LINKS
+.PP
+http://rubygems.org/
+.SH EXAMPLES
+.PP
+gem2.3 install rake
+gem2.3 list \-\-local
+gem2.3 build package.gemspec
+gem2.3 help install
+.SH SEE ALSO
+.PP
+bundle(1)
+
diff --git a/debian/manpages/gem2.3.rd b/debian/manpages/gem2.3.rd
new file mode 100644
index 0000000..0bb63b1
--- /dev/null
+++ b/debian/manpages/gem2.3.rd
@@ -0,0 +1,41 @@
+=begin
+= NAME
+
+gem2.3 - frontend to RubyGems, the Ruby package manager
+
+= SYNOPSIS
+
+gem2.3 command [arguments...] [options...]
+
+= DESCRIPTION
+
+gem2.3 is the frontend to RubyGems, the standard package manager for Ruby.
+This is a basic help message containing pointers to more information.
+
+Further help:
+
+: gem2.3 help commands
+ list all gem2.3 commands
+
+: gem2.3 help examples
+ shows some examples of usage
+
+: gem2.3 help ((|COMMAND|))
+ show help on COMMAND, (e.g. 'gem2.3 help install')
+
+= LINKS
+
+http://rubygems.org/
+
+= EXAMPLES
+
+gem2.3 install rake
+gem2.3 list --local
+gem2.3 build package.gemspec
+gem2.3 help install
+
+= SEE ALSO
+
+bundle(1)
+
+=end
diff --git a/debian/manpages/rdoc2.3.1 b/debian/manpages/rdoc2.3.1
new file mode 100644
index 0000000..fb6e61c
--- /dev/null
+++ b/debian/manpages/rdoc2.3.1
@@ -0,0 +1,209 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH RDOC2.3 1 "July 2014"
+.SH NAME
+.PP
+rdoc2.3 \- Generate documentation from Ruby script files
+.SH SYNOPSIS
+.PP
+rdoc2.3 [options] [names...]
+.SH DESCRIPTION
+.PP
+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.
+.PP
+Available output formatters: chm, html, ri, xml
+.PP
+For information on where the output goes, use:
+.nf
+\& rdoc \-\-help\-output
+.fi
+.SH OPTIONS
+.TP
+.fi
+.B
+\-\-accessor, \-A accessorname[,..]
+comma separated list of additional class methods that should be treated
+like 'attr_reader' and friends. Option may be repeated. Each accessorname
+may have '=text' appended, in which case that text appears where the
+r/w/rw appears for normal accessors.
+.TP
+.fi
+.B
+\-\-all, \-a
+include all methods (not just public) in the output.
+.TP
+.fi
+.B
+\-\-charset, \-c charset
+specifies HTML character\-set
+.TP
+.fi
+.B
+\-\-debug, \-D
+displays lots on internal stuff
+.TP
+.fi
+.B
+\-\-diagram, \-d
+generate diagrams showing modules and classes. You need dot V1.8.6 or
+later to use the \-\-diagram option correctly. Dot is available from
+<URL:http://www.research.att.com/sw/tools/graphviz/>.
+.TP
+.fi
+.B
+\-\-exclude, \-x pattern
+do not process files or directories matching pattern. Files given
+explicitly on the command line will never be excluded.
+.TP
+.fi
+.B
+\-\-extension, \-E new = old
+treat files ending with .new as if they ended with .old. Using '\-E cgi=rb'
+will cause xxx.cgi to be parsed as a Ruby file
+.TP
+.fi
+.B
+\-\-fileboxes, \-F
+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.
+.TP
+.fi
+.B
+\-\-fmt, \-f formatname
+set the output formatter (see below).
+.TP
+.fi
+.B
+\-\-help, \-h
+print usage.
+.TP
+.fi
+.B
+\-\-help\-output, \-O
+explain the various output options.
+.TP
+.fi
+.B
+\-\-image\-format, \-I 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.
+.TP
+.fi
+.B
+\-\-include, \-i dir[,dir...]
+set (or add to) the list of directories to be searched when satisfying
+:include: requests. Can be used more than once.
+.TP
+.fi
+.B
+\-\-inline\-source, \-S
+show method source code inline, rather than via a popup link.
+.TP
+.fi
+.B
+\-\-line\-numbers, \-N
+include line numbers in the source code
+.TP
+.fi
+.B
+\-\-main, \-m name
+name will be the initial page displayed.
+.TP
+.fi
+.B
+\-\-merge, \-M
+when creating ri output, merge processed classes into previously
+documented classes of the name name.
+.TP
+.fi
+.B
+\-\-one\-file, \-1
+put all the output into a single file.
+.TP
+.fi
+.B
+\-\-op, \-o dir
+set the output directory.
+.TP
+.fi
+.B
+\-\-opname, \-n name
+set the name of the output. Has no effect for HTML.
+.TP
+.fi
+.B
+\-\-promiscuous, \-p
+When documenting a file that contains a module or class also defined in
+other files, show all stuff for that module/class in each files page. By
+default, only show stuff defined in that particular file.
+.TP
+.fi
+.B
+\-\-quiet, \-q
+don't show progress as we parse.
+.TP
+.fi
+.B
+\-\-ri, \-r
+generate output for use by 'ri.' The files are stored in the '.rdoc'
+directory under your home directory unless overridden by a subsequent \-\-op
+parameter, so no special privileges are needed.
+.TP
+.fi
+.B
+\-\-ri\-site, \-R
+generate output for use by 'ri.' The files are stored in a site\-wide
+directory, making them accessible to others, so special privileges are
+needed.
+.TP
+.fi
+.B
+\-\-ri\-system, \-Y
+generate output for use by 'ri.' The files are stored in a system\-level
+directory, making them accessible to others, so special privileges are
+needed. This option is intended to be used during Ruby installations.
+.TP
+.fi
+.B
+\-\-show\-hash, \-H
+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.
+.TP
+.fi
+.B
+\-\-style, \-s stylesheet\-url
+specifies the URL of a separate stylesheet.
+.TP
+.fi
+.B
+\-\-tab\-width, \-w n
+set the width of tab characters (default 8).
+.TP
+.fi
+.B
+\-\-template, \-T template\-name
+set the template used when generating output.
+.TP
+.fi
+.B
+\-\-title, \-t text
+set text as the title for the output.
+.TP
+.fi
+.B
+\-\-version, \-v
+display RDoc's version.
+.TP
+.fi
+.B
+\-\-webcvs, \-W url
+specify a URL for linking to a web frontend to CVS. If the URL contains a
+'%s', the name of the current file will be substituted; if the URL doesn't
+contain a '%s', the filename will be appended to it.
+
diff --git a/debian/manpages/rdoc2.3.rd b/debian/manpages/rdoc2.3.rd
new file mode 100644
index 0000000..b68d411
--- /dev/null
+++ b/debian/manpages/rdoc2.3.rd
@@ -0,0 +1,147 @@
+=begin
+= NAME
+
+rdoc2.3 - Generate documentation from Ruby script files
+
+= SYNOPSIS
+
+rdoc2.3 [options] [names...]
+
+= 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.
+
+Available output formatters: chm, html, ri, xml
+
+For information on where the output goes, use:
+
+ rdoc --help-output
+
+= OPTIONS
+
+: --accessor, -A ((|accessorname[,..]|))
+ comma separated list of additional class methods that should be treated
+ like 'attr_reader' and friends. Option may be repeated. Each accessorname
+ may have '=text' appended, in which case that text appears where the
+ r/w/rw appears for normal accessors.
+
+: --all, -a
+ include all methods (not just public) in the output.
+
+: --charset, -c ((|charset|))
+ specifies HTML character-set
+
+: --debug, -D
+ displays lots on internal stuff
+
+: --diagram, -d
+ generate diagrams showing modules and classes. You need dot V1.8.6 or
+ later to use the --diagram option correctly. Dot is available from
+ ((<URL:http://www.research.att.com/sw/tools/graphviz/>)).
+
+: --exclude, -x ((|pattern|))
+ do not process files or directories matching pattern. Files given
+ explicitly on the command line will never be excluded.
+
+: --extension, -E ((|new|))=((|old|))
+ treat files ending with .new as if they ended with .old. Using '-E cgi=rb'
+ will cause xxx.cgi to be parsed as a Ruby file
+
+: --fileboxes, -F
+ 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.
+
+: --fmt, -f ((|formatname|))
+ set the output formatter (see below).
+
+: --help, -h
+ print usage.
+
+: --help-output, -O
+ explain the various output options.
+
+: --image-format, -I ((|(('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.
+
+: --include, -i ((|dir[,dir...]|))
+ set (or add to) the list of directories to be searched when satisfying
+ ((':include:')) requests. Can be used more than once.
+
+: --inline-source, -S
+ show method source code inline, rather than via a popup link.
+
+: --line-numbers, -N
+ include line numbers in the source code
+
+: --main, -m ((|name|))
+ ((|name|)) will be the initial page displayed.
+
+: --merge, -M
+ when creating ri output, merge processed classes into previously
+ documented classes of the name name.
+
+: --one-file, -1
+ put all the output into a single file.
+
+: --op, -o ((|dir|))
+ set the output directory.
+
+: --opname, -n ((|name|))
+ set the ((|name|)) of the output. Has no effect for HTML.
+
+: --promiscuous, -p
+ When documenting a file that contains a module or class also defined in
+ other files, show all stuff for that module/class in each files page. By
+ default, only show stuff defined in that particular file.
+
+: --quiet, -q
+ don't show progress as we parse.
+
+: --ri, -r
+ generate output for use by 'ri.' The files are stored in the '.rdoc'
+ directory under your home directory unless overridden by a subsequent --op
+ parameter, so no special privileges are needed.
+
+: --ri-site, -R
+ generate output for use by 'ri.' The files are stored in a site-wide
+ directory, making them accessible to others, so special privileges are
+ needed.
+
+: --ri-system, -Y
+ generate output for use by 'ri.' The files are stored in a system-level
+ directory, making them accessible to others, so special privileges are
+ needed. This option is intended to be used during Ruby installations.
+
+: --show-hash, -H
+ 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.
+
+: --style, -s ((|stylesheet-url|))
+ specifies the URL of a separate stylesheet.
+
+: --tab-width, -w ((|n|))
+ set the width of tab characters (default 8).
+
+: --template, -T ((|template-name|))
+ set the template used when generating output.
+
+: --title, -t ((|text|))
+ set ((|text|)) as the title for the output.
+
+: --version, -v
+ display RDoc's version.
+
+: --webcvs, -W ((|url|))
+ specify a URL for linking to a web frontend to CVS. If the URL contains a
+ '%s', the name of the current file will be substituted; if the URL doesn't
+ contain a '%s', the filename will be appended to it.
+
+=end
diff --git a/debian/manpages/testrb2.3.1 b/debian/manpages/testrb2.3.1
new file mode 100644
index 0000000..efd4ce1
--- /dev/null
+++ b/debian/manpages/testrb2.3.1
@@ -0,0 +1,60 @@
+.\" DO NOT MODIFY THIS FILE! it was generated by rd2
+.TH TESTRB2.3 1 "July 2014"
+.SH NAME
+.PP
+testrb2.3 \- Automatic runnter for Test::Unit of Ruby
+.SH SYNOPSIS
+.PP
+testrb2.3 [options] [\-\- untouched arguments] test ...
+.SH DESCRIPTION
+.PP
+testrb2.3 loads and runs unit\-tests. If test is directory name, testrb2.3
+testrb2.3 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>
+
diff --git a/debian/manpages/testrb2.3.rd b/debian/manpages/testrb2.3.rd
new file mode 100644
index 0000000..7ac38d0
--- /dev/null
+++ b/debian/manpages/testrb2.3.rd
@@ -0,0 +1,57 @@
+=begin
+
+= NAME
+
+testrb2.3 - Automatic runnter for Test::Unit of Ruby
+
+= SYNOPSIS
+
+testrb2.3 [options] [-- untouched arguments] test ...
+
+= DESCRIPTION
+
+testrb2.3 loads and runs unit-tests. If test is directory name, testrb2.3
+testrb2.3 traverses the directory.
+
+= OPTIONS
+
+: -r, --runner=RUNNER
+
+ Use the given RUNNER. (t[k], c[onsole], g[tk], f[ox])
+
+: -a, --add=TORUN
+
+ Add TORUN to the list of things to run; can be a file or a directory.
+
+: -p, --pattern=PATTERN
+
+ Match files to collect against PATTERN. (default pattern is
+ /\Atest_.*\.rb\Z/.)
+
+: -n, --name=NAME
+
+ Runs tests matching NAME. (patterns may be used.)
+
+: -t, --testcase=TESTCASE
+
+ Runs tests in TestCases matching TESTCASE. (patterns may be used.)
+
+: -v, --verbose=[LEVEL]
+
+ Set the output level (default is verbose). (p[rogress], n[ormal],
+ v[erbose], s[ilent])
+
+: --
+
+ Stop processing options so that the remaining options will be passed to
+ the test.
+
+: -h, --help
+
+ Display help.
+
+= AUTHOR
+
+This manpage was contributed by akira yamada <akira@debian.org>
+
+=end