summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-10-26 06:44:31 (GMT)
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2009-10-26 06:44:31 (GMT)
commit66f5c5eb30feefcd2fbfce771ae206e14a9354fc (patch)
tree75343b12e300cebac1230200a6a1839a35e5418c /man
parentdc28ce1b0b6cfc531ac2c3d19745d7c7301ed45d (diff)
* man/*.1: suppressed warnings.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@25489 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
-rw-r--r--man/erb.131
-rw-r--r--man/irb.116
-rw-r--r--man/rake.124
-rw-r--r--man/ri.128
-rw-r--r--man/ruby.120
5 files changed, 59 insertions, 60 deletions
diff --git a/man/erb.1 b/man/erb.1
index 87a0a6f..80b564a 100644
--- a/man/erb.1
+++ b/man/erb.1
@@ -18,14 +18,14 @@
.Pp
.Sh DESCRIPTION
.Nm
-is a command line front-end for
+is a command line front-end for
.Li "ERB"
library, which is an implementation of eRuby.
-
-eRuby provdes an easy to use but powerful templating system for Ruby.
+.Pp
+eRuby provdes an easy to use but powerful templating system for Ruby.
Using eRuby, actual Ruby code can be added to any plain text document for the
purposes of generating document information details and/or flow control.
-
+.Pp
.Nm
is a part of
.Nm Ruby .
@@ -34,18 +34,18 @@ is a part of
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl -version
-Prints the version of
+Prints the version of
.Nm .
.Pp
.It Fl E Ar external Ns Op : Ns Ar internal
.It Fl -encoding Ar external Ns Op : Ns Ar internal
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-
+.Pp
You can ommit the one for internal encodings, then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
.It Fl P
-Evaluates lines starting with
+Evaluates lines starting with
.Li "%"
as Ruby code and removes the tailing EOLs.
.Pp
@@ -53,7 +53,7 @@ as Ruby code and removes the tailing EOLs.
Specifies the safe level in which eRuby script will run.
.Pp
.It Fl T Ar mode
-Specifies trim mode (default 0).
+Specifies trim mode (default 0).
.Ar mode
can be one of
.Bl -hang -offset indent
@@ -96,10 +96,10 @@ Prints a summry of the options.
.It Fl n
Used with
.Fl x .
-Prepends the line number to each line in the output.
+Prepends the line number to each line in the output.
.Pp
.It Fl v
-Enables verbose mode.
+Enables verbose mode.
.Li "$VERBOSE"
will be set to true.
.Pp
@@ -119,7 +119,7 @@ Here is an eRuby script
<library><%= Prime.each(10).to_a.join(", ") %></library>
</erb-example>
.Ed
-
+.Pp
Command
.Dl "% erb -T - example.erb"
prints
@@ -134,17 +134,16 @@ prints
.Pp
.Sh SEE ALSO
.Xr ruby 1 .
-
-And see
+.Pp
+And see
.Xr ri 1
-documentation for
+documentation for
.Li "ERB"
class.
-.El
.Pp
.Sh REPORTING BUGS
.Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
+.Li Security vulnerabilities should be reported via an email to
.Aq security@ruby-lang.org Ns
.Li .
Reported problems will be published after fixed.
diff --git a/man/irb.1 b/man/irb.1
index 20e97e3..dc78bae 100644
--- a/man/irb.1
+++ b/man/irb.1
@@ -40,7 +40,7 @@ Prints the version of
.It Fl -encoding Ar external Ns Op : Ns Ar internal
Same as `ruby -E' .
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-
+.Pp
You can ommit the one for internal encodings, then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
@@ -62,7 +62,7 @@ Sets
to true.
.Pp
.It Fl f
-Suppresses read of
+Suppresses read of
.Pa ~/.irbrc .
.Pp
.It Fl h
@@ -93,9 +93,9 @@ Doesn't use Readline extension module.
Switch prompt mode. Pre-defined prompt modes are
`default', `simple', `xmp' and `inf-ruby'.
.Pp
-.It Fl -inf-ruby-mode
-Uses prompt appropriate for inf-ruby-mode on emacs.
-Suppresses --readline.
+.It Fl -inf-ruby-mode
+Uses prompt appropriate for inf-ruby-mode on emacs.
+Suppresses --readline.
.Pp
.It Fl -simple-prompt
Makes prompts simple.
@@ -111,7 +111,7 @@ Displays backtrace top
.Ar n
and tail
.Ar n Ns .
-The default value is 16.
+The default value is 16.
.Pp
.It Fl -irb_debug Ar n
Sets internal debug level to n (not for popular use)
@@ -152,14 +152,14 @@ Personal irb initialization.
.Dl :ok
.Dl => :ok
.Dl irb(main):009:0> Ic quit
-.Dl %
+.Dl %
.Pp
.Sh SEE ALSO
.Xr ruby 1 .
.Pp
.Sh REPORTING BUGS
.Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
+.Li Security vulnerabilities should be reported via an email to
.Aq security@ruby-lang.org Ns
.Li .
Reported problems will be published after fixed.
diff --git a/man/rake.1 b/man/rake.1
index 3872026..2f80dbf 100644
--- a/man/rake.1
+++ b/man/rake.1
@@ -22,17 +22,17 @@
.Ar target ...
.Sh DESCRIPTION
.Nm Rake
-is a simple
+is a simple
.Xr ruby 1
-build program with capabilities similar to the regular
+build program with capabilities similar to the regular
.Xr make 1
command.
-
+.Pp
.Nm Rake
has the following features:
.Bl -bullet
.It
-Rakefiles (Rake's version of Makefiles) are completely defined in standard Ruby syntax.
+Rakefiles (Rake's version of Makefiles) are completely defined in standard Ruby syntax.
No XML files to edit. No quirky Makefile syntax to worry about (is that a tab or a space?).
.It
Users can specify tasks with prerequisites.
@@ -41,7 +41,7 @@ Rake supports rule patterns to sythesize implicit tasks.
.It
Flexible FileLists that act like arrays but know about manipulating file names and paths.
.It
-A library of prepackaged tasks to make building rakefiles easier.
+A library of prepackaged tasks to make building rakefiles easier.
.El
.Pp
.Sh OPTIONS
@@ -56,7 +56,7 @@ Put Task and FileTask in the top level namespace
.Pp
.It Fl D Op Ar PATTERN
.It Fl -describe Op Ar PATTERN
-Describe the tasks (matching optional
+Describe the tasks (matching optional
.Ar PATTERN Ns
), then exit.
.Pp
@@ -71,7 +71,7 @@ Use standard project Rakefile search paths, ignore system wide rakefiles.
.Pp
.It Fl I Ar LIBDIR
.It Fl -libdir Ar LIBDIR
-Include
+Include
.Ar LIBDIR
in the search path for required modules.
.Pp
@@ -89,7 +89,7 @@ Display the tasks and dependencies, then exit.
.It Fl -rakelibdir Ar RAKELIBDIR
Auto-import any .rake files in
.Ar RAKELIBDIR .
-(default is
+(default is
.Pa rakelib
)
.Pp
@@ -113,7 +113,7 @@ Prints a summary of options.
.Pp
.It Fl g
.It Fl -system
-Using system wide (global) rakefiles (usually
+Using system wide (global) rakefiles (usually
.Pa ~/.rake/*.rake
).
.Pp
@@ -135,7 +135,7 @@ Require MODULE before executing rakefile.
.Pp
.It Fl s
.It Fl -silent
-Like
+Like
.Fl -quiet ,
but also suppresses the 'in directory' announcement.
.Pp
@@ -158,12 +158,12 @@ Trace the rules resolution.
.Pp
http://rake.rubyforge.org/
.Sh REPORTING BUGS
-Bugs, features requests and other issues can be logged at
+Bugs, features requests and other issues can be logged at
<\fBhttp://onestepback.org/redmine/projects/show/rake\fR>.
.Pp
You will need an account to before you can post issues. Register at <\fBhttp://onestepback.org/redmine/account/register\fR>.
Or you can send an email to the author.
.Sh AUTHOR
.Nm Rake
-is written by
+is written by
.An Jim Weirich Aq jim@weirichhouse.org
diff --git a/man/ri.1 b/man/ri.1
index f414adb..baced73 100644
--- a/man/ri.1
+++ b/man/ri.1
@@ -4,7 +4,7 @@
.Os UNIX
.Sh NAME
.Nm ri
-.Nd Ruby API reference front end
+.Nd Ruby API reference front end
.Sh SYNOPSIS
.Nm
.Op Fl Ti
@@ -12,19 +12,19 @@
.Op Fl f Ar format
.Op Fl -list-doc-dirs
.Op Fl -no-standard-docs
-.Op Fl - Ns Oo Cm no- Oc Ns Cm Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc
+.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc
.Op Fl - Ns Oo Cm no- Oc Ns Cm use-cache
.Op Fl -width Ns = Ns Ar width
.Op Ar target ...
.Sh DESCRIPTION
.Nm
-is a CUI front end for the Ruby API reference.
+is a CUI front end for the Ruby API reference.
You can search and read API reference for classes and methods with
.Nm .
-
+.Pp
.Nm
is a part of Ruby.
-
+.Pp
.Ar target
can be one of the following forms:
.Bl -diag -offset indent
@@ -39,10 +39,10 @@ for both class and instance methods
.It method
for both class and instance methods
.El
-
+.Pp
All class names may be abbreviated to their minimum unambiguous form. If a name
is ambiguous, all valid options will be listed.
-
+.Pp
For example:
.Bd -literal -offset indent
ri Fil
@@ -50,7 +50,7 @@ ri File
ri File.new
ri zip
.Ed
-
+.Pp
Note that shell quoting may be required for method names containing
punctuation:
.Bd -literal -offset indent
@@ -61,7 +61,7 @@ ri compact\!
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl -version
-Prints the version of
+Prints the version of
.Nm .
.Pp
.It Fl T
@@ -84,7 +84,7 @@ pager or tell the pager to allow control characters.
.Pp
.It Fl i
.It Fl -interactive
-This makes
+This makes
.Nm
go into interactive mode.
.Pp
@@ -103,8 +103,8 @@ Do not include documentation from the Ruby standard library,
.Pa site_lib ,
installed gems, or
.Pa ~/.rdoc .
-
-Equivalent to specifying the options
+.Pp
+Equivalent to specifying the options
.Fl -no-system , Fl -no-site , Fl -no-gems ,
and
.Fl -no-home .
@@ -122,7 +122,7 @@ Include documentation from RubyGems. Defaults to true.
Include documentation stored in ~/.rdoc. Defaults to true.
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm use-cache
-Whether or not to use
+Whether or not to use
.Nm Ns
.Ns 's cache. True by default.
.Pp
@@ -165,7 +165,7 @@ Searches user-wide documents here.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
+.Li Security vulnerabilities should be reported via an email to
.Aq security@ruby-lang.org Ns
.Li .
Reported problems will be published after fixed.
diff --git a/man/ruby.1 b/man/ruby.1
index 62a097d..9ac2324 100644
--- a/man/ruby.1
+++ b/man/ruby.1
@@ -95,7 +95,7 @@ Ruby has a bunch of text processing features like in Perl.
.Pp
.It Sy "M17N, character set independent"
Ruby supports multilingualized programming. Easy to process texts
-written in many different natural languages and encoded in many
+written in many different natural languages and encoded in many
different character encodings, without dependence on Unicode.
.Pp
.It Sy "Bignums"
@@ -122,7 +122,7 @@ on-the-fly.
.It Sy "Rich libraries"
Libraries called "builtin libraries" and "standard libraries" are bundled with Ruby.
And you can obtain more libraries via the package management system called `RubyGems'.
-
+.Pp
Moreover there are thousands of Ruby projects in Rubyforge
.Pf ( "http://www.rubyforge.org" ) and RAA
.Pf ( "http://raa.ruby-lang.org" ) Ns .
@@ -160,7 +160,7 @@ Causes Ruby to switch to the directory.
.It Fl E Ar external Ns Op : Ns Ar internal
.It Fl -encoding Ar external Ns Op : Ns Ar internal
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
-
+.Pp
You can ommit the one for internal encodings, then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
@@ -177,7 +177,7 @@ will be added to the load-path variable
Specifies KANJI (Japanese) encoding. The default value for script encodings
.Pf ( Li "__ENCODING__" ) and external encodings ( Li "Encoding.default_external" ) will be the specified one.
.Ar kcode
-can be one of
+can be one of
.Bl -hang -offset indent
.It Sy e
EUC-JP
@@ -213,7 +213,7 @@ Sets the defalut value for internal encodings
.Pf ( Li "Encoding.default_internal" ) to UTF-8.
.Pp
.It Fl W Ns Op Ar level=2
-Turns on verbose mode at the specified level, without printing version
+Turns on verbose mode at the specified level, without printing version
message at the beginning. The level can be;
.Bl -hang -offset indent
.It Sy 0
@@ -375,7 +375,7 @@ before executing script.
.It Fl y
.It Fl -yydebug
DO NOT USE.
-
+.Pp
Turns on compiler debug mode. Ruby will print a bunch of internal
state messages during compiling scripts. You don't have to specify
this switch, unless you are going to debug the Ruby interpreter.
@@ -406,8 +406,8 @@ Disables (or enables) all features.
.El
.Pp
.It Fl -dump Ns = Ns Ar target
-DO NOT USE.
-
+DO NOT USE.
+.Pp
Prints the specified target.
.Ar target
can be one of;
@@ -494,7 +494,7 @@ Ruby Application Archive.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
-.Li Security vulnerabilities should be reported via an email to
+.Li Security vulnerabilities should be reported via an email to
.Aq security@ruby-lang.org Ns
.Li .
Reported problems will be published after fixed.
@@ -507,5 +507,5 @@ via the system because it publishes the vulnerabilities immedately.
.Sh AUTHORS
Ruby is designed and implemented by
.An Yukihiro Matsumoto Aq matz@netlab.jp .
-
+.Pp
See <\fBhttp://redmine.ruby-lang.org/wiki/ruby/Contributors\fR> for contributors to Ruby.