summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authoryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-10-25 16:44:13 (GMT)
committeryugui <yugui@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2008-10-25 16:44:13 (GMT)
commit4dd24d6ba6d1da23d708a7395ae2f3814bd5ab59 (patch)
treeda2d4908c4ccfc303089abb321faf3d770c67334 /man
parent92d172e9c3814860fdec497feeb7462e874d7e60 (diff)
* man/irb.1: new manual page.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@19938 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
-rw-r--r--man/irb.1127
1 files changed, 127 insertions, 0 deletions
diff --git a/man/irb.1 b/man/irb.1
new file mode 100644
index 0000000..63726f0
--- /dev/null
+++ b/man/irb.1
@@ -0,0 +1,127 @@
+.\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>.
+.Dd October 25, 2008
+.Dt IRB(1) "" "Ruby Programmers Reference Guide"
+.Os UNIX
+.Sh NAME
+.Nm irb
+.Nd Interactive Ruby Shell
+.Sh SYNOPSIS
+.Nm
+.Op Fl -version
+.Op Fl Idfmrv
+.Op Fl - Ns Oo no Oc Ns inspect
+.Op Fl - Ns Oo no Oc Ns readline
+.Op Fl -prompt Ar mode
+.Op Fl -prompt-mode Ar mode
+.Op Fl -inf-ruby-mode
+.Op Fl -simple-prompt
+.Op Fl -noprompt
+.Op Fl -tracer
+.Op Fl -back-trace-limit Ar n
+.Op Fl -irb_debug Ar n
+.Op Fl -
+.Op program_file
+.Op argument ...
+.Pp
+.Sh DESCRIPTION
+irb is the REPL(read-eval&print loop) environment for Ruby programs.
+.Pp
+.Sh OPTIONS
+.Bl -tag -width "1234567890123" -compact
+.Pp
+.It Fl d
+Sets
+.Li $DEBUG
+to true (same as `ruby -d')
+.Pp
+.It Fl f
+Suppresses read of ~/.irbrc
+.Pp
+.It Fl m
+Bc mode (load mathn, fraction or matrix are available)
+.Pp
+.It Fl -r Ar load-module
+Same as `ruby -r'
+.Pp
+.It Fl I Ar path
+Specifies
+.Li $LOAD_PATH
+directory
+.Pp
+.It Fl -inspect
+Uses `inspect' for output (default except for bc mode)
+.Pp
+.It Fl -noinspect
+Doesn't use inspect for output
+.Pp
+.It Fl -readline
+Uses Readline extension module.
+.Pp
+.It Fl -noreadline
+Doesn't use Readline extension module.
+.Pp
+.It Fl -prompt Ar mode
+.It Fl -prompt-mode Ar mode
+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.
+.Pp
+.It Fl -simple-prompt
+Makes prompts simple.
+.Pp
+.It Fl -noprompt
+No prompt mode.
+.Pp
+.It Fl -tracer
+Displays trace for each execution of commands.
+.Pp
+.It Fl -back-trace-limit Ar n
+Displays backtrace top
+.Ar n
+and tail
+.Ar n Ns .
+The default value is 16.
+.Pp
+.It Fl -irb_debug Ar n
+Sets internal debug level to n (not for popular use)
+.Pp
+.El
+.Pp
+.Sh ENVIRONMENT
+.Bl -tag -width "RUBYLIB_PREFIX" -compact
+.It Ev IRBRC
+.Pp
+.El
+.Pp
+Also
+.Nm
+depends on same variables as
+.Xr ruby 1 .
+.Pp
+.Sh FILES
+.Bl -tag -width "RUBYLIB_PREFIX" -compact
+.It Pa ~/.irbrc
+Personal irb initialization.
+.Pp
+.El
+.Pp
+.Sh SEE ALSO
+.Xr ruby 1 .
+.Pp
+.Sh REPORTING BUGS
+.Bl -bullet
+.Li Security vulnerabilities should be reported via an email to
+.Aq security@ruby-lang.org Ns
+.Li .
+Reported problems will be published after fixed.
+.Pp
+.Li And you can report other bugs and feature requests via the
+Ruby Issue Tracking System (http://redmine.ruby-lang.org).
+Do not report security vulnerabilities
+via the system because it publishes the vulnerabilities immedately.
+.El
+.Sh AUTHORS
+Written by Keiju ISHITSUKA.