diff options
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | man/irb.1 | 127 |
2 files changed, 131 insertions, 0 deletions
@@ -1,3 +1,7 @@ +Sun Oct 26 01:42:45 2008 Yuki Sonoda (Yugui) <yugui@yugui.jp> + + * man/irb.1: new manual page. + Sun Oct 26 00:11:48 2008 Yuki Sonoda (Yugui) <yugui@yugui.jp> * man/ruby.1: moved into man/. added some descriptions. diff --git a/man/irb.1 b/man/irb.1 new file mode 100644 index 0000000000..63726f0a7a --- /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. |