Offset 1, 257 lines modifiedOffset 1, 322 lines modified
1 .\"Ruby·is·copyrighted·by·Yukihiro·Matsumoto·<matz@netlab.jp>. 
2 .Dd·August·11,·2019 
3 .Dt·IRB·\&1·"Ruby·Programmer's·Reference·Guide"1 .TH·IRB·\&1·"Ruby·Programmer's·Reference·Guide"·"August·11,·2019"·"UNIX"
4 .Os·UNIX 
5 .Sh·NAME2 .SH·NAME
6 .Nm·irb3 \fBirb\fP
7 .Nd·Interactive·Ruby·Shell4 \-·Interactive·Ruby·Shell
8 .Sh·SYNOPSIS5 .SH·SYNOPSIS
9 .Nm 
10 .Op·Fl·-version 
11 .Op·Fl·dfUw 
12 .Op·Fl·I·Ar·directory 
13 .Op·Fl·r·Ar·library 
14 .Op·Fl·E·Ar·external·Ns·Op·:·Ns·Ar·internal 
15 .Op·Fl·W·Ns·Op·Ar·level 
16 .Op·Fl·-·Ns·Oo·no·Oc·Ns·inspect 
17 .Op·Fl·-·Ns·Oo·no·Oc·Ns·multiline 
18 .Op·Fl·-·Ns·Oo·no·Oc·Ns·singleline 
19 .Op·Fl·-·Ns·Oo·no·Oc·Ns·echo 
20 .Op·Fl·-·Ns·Oo·no·Oc·Ns·colorize 
21 .Op·Fl·-·Ns·Oo·no·Oc·Ns·autocomplete 
22 .Op·Fl·-·Ns·Oo·no·Oc·Ns·verbose 
23 .Op·Fl·-prompt·Ar·mode 
24 .Op·Fl·-prompt-mode·Ar·mode 
25 .Op·Fl·-inf-ruby-mode 
26 .Op·Fl·-simple-prompt 
27 .Op·Fl·-noprompt 
28 .Op·Fl·-tracer 
29 .Op·Fl·-back-trace-limit·Ar·n 
30 .Op·Fl·-6 .br
 7 \fBirb\fP
 8 [\fB\--version\fP]
 9 [\fB\-dfUw\fP]
 10 [\fB\-I\fP·\fIdirectory\fP]
 11 [\fB\-r\fP·\fIlibrary\fP]
 12 [\fB\-E\fP·\fIexternal\fP[:\fIinternal\fP]]
 13 [\fB\-W\fP[\fIlevel\fP]]
 14 [\fB\--\fP[no]inspect]
 15 [\fB\--\fP[no]multiline]
 16 [\fB\--\fP[no]singleline]
 17 [\fB\--\fP[no]echo]
 18 [\fB\--\fP[no]colorize]
 19 [\fB\--\fP[no]autocomplete]
 20 [\fB\--\fP[no]verbose]
 21 [\fB\--prompt\fP·\fImode\fP]
 22 [\fB\--prompt-mode\fP·\fImode\fP]
 23 [\fB\--inf-ruby-mode\fP]
 24 [\fB\--simple-prompt\fP]
 25 [\fB\--noprompt\fP]
 26 [\fB\--tracer\fP]
 27 [\fB\--back-trace-limit\fP·\fIn\fP]
 28 [\fB\--\fP]
31 .Op·program_file29 [program_file]
32 .Op·argument·...30 [argument·...]
33 .Pp 
34 .Sh·DESCRIPTION31 .SH·DESCRIPTION
35 .Nm32 \fBirb\fP
36 is·the·REPL(read-eval-print·loop)·environment·for·Ruby·programs.33 is·the·REPL(read-eval-print·loop)·environment·for·Ruby·programs.
37 .Pp 
38 .Sh·OPTIONS34 .SH·OPTIONS
39 .Bl·-tag·-width·"1234567890123"·-compact 
40 .Pp 
41 .It·Fl·-version 
 35 .TP
 36 \fB\--version\fP
42 Prints·the·version·of37 Prints·the·version·of
43 .Nm·. 
44 .Pp 
45 .It·Fl·E·Ar·external·Ns·Op·:·Ns·Ar·internal 
46 .It·Fl·-encoding·Ar·external·Ns·Op·:·Ns·Ar·internal38 \fB.\fP
  
 39 .TP
 40 \fB\-E\fP·\fIexternal\fP[:\fIinternal\fP]
 41 .TP
 42 \fB\--encoding\fP·\fIexternal\fP[:\fIinternal\fP]
47 Same·as·`ruby·-E'·.43 Same·as·`ruby·-E'·.
48 Specifies·the·default·value(s)·for·external·encodings·and·internal·encoding.·Values·should·be·separated·with·colon·(:).44 Specifies·the·default·value(s)·for·external·encodings·and·internal·encoding.·Values·should·be·separated·with·colon·(:).
49 .Pp 
50 You·can·omit·the·one·for·internal·encodings,·then·the·value45 You·can·omit·the·one·for·internal·encodings,·then·the·value
51 .Pf·(·Li·"Encoding.default_internal"·)·will·be·nil.46 ("Encoding.default_internal")·will·be·nil.
52 .Pp 
53 .It·Fl·I·Ar·path 
 47 .TP
 48 \fB\-I\fP·\fIpath\fP
54 Same·as·`ruby·-I'·.49 Same·as·`ruby·-I'·.
55 Specifies50 Specifies
56 .Li·$LOAD_PATH51 $LOAD_PATH
57 directory52 directory
58 .Pp 
59 .It·Fl·U 
 53 .TP
 54 \fB\-U\fP
60 Same·as·`ruby·-U'·.55 Same·as·`ruby·-U'·.
61 Sets·the·default·value·for·internal·encodings56 Sets·the·default·value·for·internal·encodings
62 .Pf·(·Li·"Encoding.default_internal"·)·to·UTF-8.57 ("Encoding.default_internal")·to·UTF-8.
63 .Pp 
64 .It·Fl·d 
 58 .TP
 59 \fB\-d\fP
65 Same·as·`ruby·-d'·.60 Same·as·`ruby·-d'·.
66 Sets61 Sets
67 .Li·$DEBUG62 $DEBUG
68 to·true.63 to·true.
69 .Pp 
70 .It·Fl·f 
 64 .TP
 65 \fB\-f\fP
71 Suppresses·read·of66 Suppresses·read·of
72 .Pa·~/.irbrc·. 
73 .Pp 
74 .It·Fl·w67 \fI~/.irbrc\fP.
  
 68 .TP
 69 \fB\-w\fP
75 Same·as·`ruby·-w'·.70 Same·as·`ruby·-w'·.
76 .Pp 
77 .Pp 
78 .It·Fl·W 
  
 71 .TP
 72 \fB\-W\fP
79 Same·as·`ruby·-W'·.73 Same·as·`ruby·-W'·.
80 .Pp 
81 .It·Fl·h 
82 .It·Fl·-help 
 74 .TP
 75 \fB\-h\fP
 76 .TP
 77 \fB\--help\fP
83 Prints·a·summary·of·the·options.78 Prints·a·summary·of·the·options.
84 .Pp 
85 .It·Fl·r·Ar·library 
 79 .TP
 80 \fB\-r\fP·\fIlibrary\fP
86 Same·as·`ruby·-r'.81 Same·as·`ruby·-r'.
87 Causes·irb·to·load·the·library·using·require.82 Causes·irb·to·load·the·library·using·require.
88 .Pp 
89 .It·Fl·-inspect 
 83 .TP
 84 \fB\--inspect\fP
90 Uses·`inspect'·for·output·(default·except·for·bc·mode)85 Uses·`inspect'·for·output·(default·except·for·bc·mode)
91 .Pp 
92 .It·Fl·-noinspect 
 86 .TP
 87 \fB\--noinspect\fP
93 Doesn't·use·inspect·for·output88 Doesn't·use·inspect·for·output
94 .Pp 
95 .It·Fl·-multiline 
 89 .TP
 90 \fB\--multiline\fP
96 Uses·multiline·editor·module.91 Uses·multiline·editor·module.
97 .Pp 
98 .It·Fl·-nomultiline 
 92 .TP
 93 \fB\--nomultiline\fP
99 Doesn't·use·multiline·editor·module.94 Doesn't·use·multiline·editor·module.
100 .Pp 
101 .It·Fl·-singleline 
 95 .TP
 96 \fB\--singleline\fP
102 Uses·singleline·editor·module.97 Uses·singleline·editor·module.
103 .Pp 
104 .It·Fl·-nosingleline 
 98 .TP
 99 \fB\--nosingleline\fP
105 Doesn't·use·singleline·editor·module.100 Doesn't·use·singleline·editor·module.
106 .Pp 
107 .Pp 
108 .It·Fl·-extra-doc-dir 
  
 101 .TP
 102 \fB\--extra-doc-dir\fP
109 Add·an·extra·doc·dir·for·the·doc·dialog.103 Add·an·extra·doc·dir·for·the·doc·dialog.
110 .Pp 
111 .Pp 
112 .It·Fl·-echo 
  
 104 .TP
 105 \fB\--echo\fP
113 Show·result·(default).106 Show·result·(default).
114 .Pp 
115 .It·Fl·-noecho 
 107 .TP
 108 \fB\--noecho\fP
116 Don't·show·result.109 Don't·show·result.
117 .Pp 
118 .Pp 
119 .It·Fl·-echo-on-assignment 
  
 110 .TP
 111 \fB\--echo-on-assignment\fP
120 Show·result·on·assignment.112 Show·result·on·assignment.
121 .Pp 
122 .It·Fl·-noecho-on-assignment 
 113 .TP
 114 \fB\--noecho-on-assignment\fP
123 Don't·show·result·on·assignment.115 Don't·show·result·on·assignment.
124 .Pp 
 116 .TP
125 .It·Fl·-truncate-echo-on-assignment117 \fB\--truncate-echo-on-assignment\fP
126 Show·truncated·result·on·assignment·(default).118 Show·truncated·result·on·assignment·(default).
127 .Pp 
128 .Pp 
129 .It·Fl·-colorize 
  
 119 .TP
 120 \fB\--colorize\fP
130 Use·colorization.121 Use·colorization.
131 .Pp 
132 .It·Fl·-nocolorize 
 122 .TP
 123 \fB\--nocolorize\fP
133 Don't·use·colorization.124 Don't·use·colorization.
134 .Pp 
135 .Pp 
136 .It·Fl·-autocomplete 
  
 125 .TP
 126 \fB\--autocomplete\fP
137 Use·autocompletion.127 Use·autocompletion.
138 .Pp 
139 .It·Fl·-noautocomplete 
 128 .TP
 129 \fB\--noautocomplete\fP
140 Don't·use·autocompletion.130 Don't·use·autocompletion.
141 .Pp 
142 .Pp 
143 .It·Fl·-regexp-completor 
  
 131 .TP
 132 \fB\--regexp-completor\fP
144 Use·regexp·based·completion.133 Use·regexp·based·completion.
145 .Pp 
146 .It·Fl·-type-completor 
 134 .TP
 135 \fB\--type-completor\fP
147 Use·type·based·completion.136 Use·type·based·completion.
148 .Pp 
149 .Pp 
150 .It·Fl·-verbose 
  
 137 .TP
 138 \fB\--verbose\fP
151 Show·details.139 Show·details.
152 .Pp 
153 .It·Fl·-noverbose 
 140 .TP
 141 \fB\--noverbose\fP
154 Don't·show·details.142 Don't·show·details.
155 .Pp 
156 .It·Fl·-prompt·Ar·mode 
157 .It·Fl·-prompt-mode·Ar·mode 
 143 .TP
 144 \fB\--prompt\fP·\fImode\fP
 145 .TP
 146 \fB\--prompt-mode\fP·\fImode\fP
158 Switch·prompt·mode.·Pre-defined·prompt·modes·are147 Switch·prompt·mode.·Pre-defined·prompt·modes·are
159 `default',·`simple',·`xmp'·and·`inf-ruby'.148 `default',·`simple',·`xmp'·and·`inf-ruby'.
160 .Pp 
161 .It·Fl·-inf-ruby-mode 
 149 .TP
 150 \fB\--inf-ruby-mode\fP
162 Uses·prompt·appropriate·for·inf-ruby-mode·on·emacs.151 Uses·prompt·appropriate·for·inf-ruby-mode·on·emacs.
163 Suppresses·--multiline·and·--singleline.152 Suppresses·--multiline·and·--singleline.
164 .Pp 
165 .It·Fl·-simple-prompt 
 153 .TP
 154 \fB\--simple-prompt\fP
166 Makes·prompts·simple.155 Makes·prompts·simple.
167 .Pp 
168 .It·Fl·-noprompt 
 156 .TP
 157 \fB\--noprompt\fP
169 No·prompt·mode.158 No·prompt·mode.
170 .Pp 
171 .It·Fl·-tracer 
 159 .TP
 160 \fB\--tracer\fP
172 Displays·trace·for·each·execution·of·commands.161 Displays·trace·for·each·execution·of·commands.
173 .Pp 
174 .It·Fl·-back-trace-limit·Ar·n 
 162 .TP
 163 \fB\--back-trace-limit\fP·\fIn\fP
175 Displays·backtrace·top164 Displays·backtrace·top
176 .Ar·n165 \fIn\fP
177 and·tail166 and·tail
178 .Ar·n·Ns·.167 \fIn\fP.
179 The·default·value·is·16.168 The·default·value·is·16.
  
180 .El 
181 .Pp 
182 .Sh·ENVIRONMENT169 .SH·ENVIRONMENT
183 .Bl·-tag·-compact·-width·"XDG_CONFIG_HOME"170 .TP
184 .It·Ev·IRB_LANG171 .B·IRB_LANG
185 The·locale·used·for172 The·locale·used·for
186 .Nm·. 
187 .Pp 
188 .It·Ev·IRBRC173 \fB.\fP
  
 174 .TP
 175 .B·IRBRC
189 The·path·to·the·personal·initialization·file.176 The·path·to·the·personal·initialization·file.
190 .Pp 
 177 .TP
191 .It·Ev·XDG_CONFIG_HOME178 .B·XDG_CONFIG_HOME
192 .Nm179 \fBirb\fP
193 respects·XDG_CONFIG_HOME.·If·this·is·set,·load180 respects·XDG_CONFIG_HOME.·If·this·is·set,·load
194 .Pa·$XDG_CONFIG_HOME/irb/irbrc181 \fI$XDG_CONFIG_HOME/irb/irbrc\fP
195 as·a·personal·initialization·file.182 as·a·personal·initialization·file.
  
  
196 .Pp 
197 .El 
198 .Pp 
199 Also183 Also
200 .Nm184 \fBirb\fP
201 depends·on·same·variables·as185 depends·on·same·variables·as
202 .Xr·ruby·1·. 
203 .Pp186 \fBruby\fP(1).
  
204 .Sh·FILES187 .SH·FILES
205 .Bl·-tag·-compact188 .TP
206 .It·Pa·~/.irbrc189 .B·~/.irbrc
207 Personal·irb·initialization.·If190 Personal·irb·initialization.·If
208 .Ev·IRBRC191 .IR·IRBRC
209 is·set,·read192 is·set,·read
210 .Pa·$IRBRC193 \fI$IRBRC\fP
211 instead.·If194 instead.·If
212 .Ev·IRBRC195 .IR·IRBRC
213 is·not·set·and196 is·not·set·and
214 .Ev·XDG_CONFIG_HOME197 .IR·XDG_CONFIG_HOME
215 is·set,198 is·set,
216 .Pa·$XDG_CONFIG_HOME/irb/irbrc199 \fI$XDG_CONFIG_HOME/irb/irbrc\fP
217 is·loaded.200 is·loaded.
  
  
218 .Pp 
219 .El 
220 .Pp 
221 .Sh·EXAMPLES201 .SH·EXAMPLES
222 .Dl·%·irb202 .nf
 203 \&··%·irb
 204 .fi
 205 .nf
223 .Dl·irb(main):001:0>·Ic·1·+·1206 \&··irb(main):001:0>·\fB1·+·1\fP
224 .Dl·2207 .fi
 208 .nf
 209 \&··2
 210 .fi
 211 .nf
225 .Dl·irb(main):002:0>·Ic·def·t(x)212 \&··irb(main):002:0>·\fBdef·t(x)\fP
226 .Dl·irb(main):003:1>·Ic···x·+·1 
227 .Dl·irb(main):004:1>·Ic·end 
228 .Dl·=>·:t 
229 .Dl·irb(main):005:0>·Ic·t(3) 
230 .Dl·=>·4213 .fi
 214 .nf
 215 \&··irb(main):003:1>·\fBx·+·1\fP
 216 .fi
 217 .nf
 218 \&··irb(main):004:1>·\fBend\fP
 219 .fi
 220 .nf
 221 \&··=>·:t
 222 .fi
 223 .nf
 224 \&··irb(main):005:0>·\fBt(3)\fP
 225 .fi
 226 .nf
 227 \&··=>·4
 228 .fi
 229 .nf
231 .Dl·irb(main):006:0>·Ic·if·t(3)·==·4230 \&··irb(main):006:0>·\fBif·t(3)·==·4\fP
 231 .fi
 232 .nf
232 .Dl·irb(main):007:1>·Ic·p·:ok233 \&··irb(main):007:1>·\fBp·:ok\fP
233 .Dl·irb(main):008:1>·Ic·end 
234 .Dl·:ok 
235 .Dl·=>·:ok 
236 .Dl·irb(main):009:0>·Ic·quit 
237 .Dl·% 
238 .Pp234 .fi
 235 .nf
 236 \&··irb(main):008:1>·\fBend\fP
 237 .fi
 238 .nf
 239 \&··:ok
 240 .fi
 241 .nf
 242 \&··=>·:ok
 243 .fi
 244 .nf
 245 \&··irb(main):009:0>·\fBquit\fP
 246 .fi
 247 .nf
 248 \&··%
 249 .fi
  
239 .Sh·SEE·ALSO250 .SH·SEE·ALSO
240 .Xr·ruby·1·. 
241 .Pp251 \fBruby\fP(1).
  
242 .Sh·REPORTING·BUGS252 .SH·REPORTING·BUGS
 253 .IP·\(bu
243 .Bl·-bullet 
244 .It 
245 Security·vulnerabilities·should·be·reported·via·an·email·to254 Security·vulnerabilities·should·be·reported·via·an·email·to
246 .Mt·security@ruby-lang.org·.255 Mt·security@ruby-lang.org.
247 Reported·problems·will·be·published·after·being·fixed.256 Reported·problems·will·be·published·after·being·fixed.
248 .Pp 
249 .It 
 257 .IP·\(bu
250 Other·bugs·and·feature·requests·can·be·reported·via·the258 Other·bugs·and·feature·requests·can·be·reported·via·the
251 Ruby·Issue·Tracking·System259 Ruby·Issue·Tracking·System
252 .Pq·Lk·https://bugs.ruby-lang.org/·.260 (\fBhttps://bugs.ruby-lang.org/\fP).
253 Do·not·report·security·vulnerabilities261 Do·not·report·security·vulnerabilities
254 via·this·system·because·it·publishes·the·vulnerabilities·immediately.262 via·this·system·because·it·publishes·the·vulnerabilities·immediately.
255 .El 
256 .Sh·AUTHORS263 .SH·AUTHORS
257 Written·by·Keiju·ISHITSUKA.264 Written·by·Keiju·ISHITSUKA.
Generated by diffoscope 277