Skip to content

Commit dfe454c

Browse files
Additions/revisions to help-message (#370)
Changed: Added text to options that said just 'same as ruby -whatever'. Added defaults. Removed an errant tab.
1 parent 986eb16 commit dfe454c

File tree

1 file changed

+41
-40
lines changed

1 file changed

+41
-40
lines changed

lib/irb/lc/help-message

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,52 +10,53 @@
1010
#
1111
#
1212
Usage: irb.rb [options] [programfile] [arguments]
13-
-f Suppress read of ~/.irbrc
14-
-d Set $DEBUG to true (same as `ruby -d')
15-
-r load-module Same as `ruby -r'
16-
-I path Specify $LOAD_PATH directory
17-
-U Same as `ruby -U`
18-
-E enc Same as `ruby -E`
19-
-w Same as `ruby -w`
20-
-W[level=2] Same as `ruby -W`
13+
-f Don't initialize from configuration file.
14+
-d Set $DEBUG and $VERBOSE to true (same as 'ruby -d').
15+
-r load-module Require load-module (same as 'ruby -r').
16+
-I path Specify $LOAD_PATH directory (same as 'ruby -I').
17+
-U Set external and internal encodings to UTF-8.
18+
-E ex[:in] Set default external (ex) and internal (in) encodings
19+
(same as 'ruby -E').
20+
-w Suppress warnings (same as 'ruby -w').
21+
-W[level=2] Set warning level: 0=silence, 1=medium, 2=verbose
22+
(same as 'ruby -W').
2123
--context-mode n Set n[0-4] to method to create Binding Object,
22-
when new workspace was created
23-
--extra-doc-dir Add an extra doc dir for the doc dialog
24-
--echo Show result (default)
25-
--noecho Don't show result
24+
when new workspace was created.
25+
--extra-doc-dir Add an extra doc dir for the doc dialog.
26+
--echo Show result (default).
27+
--noecho Don't show result.
2628
--echo-on-assignment
27-
Show result on assignment
29+
Show result on assignment.
2830
--noecho-on-assignment
29-
Don't show result on assignment
31+
Don't show result on assignment.
3032
--truncate-echo-on-assignment
31-
Show truncated result on assignment (default)
32-
--inspect Use `inspect' for output
33-
--noinspect Don't use inspect for output
34-
--multiline Use multiline editor module
35-
--nomultiline Don't use multiline editor module
36-
--singleline Use singleline editor module
37-
--nosingleline Don't use singleline editor module
38-
--colorize Use colorization
39-
--nocolorize Don't use colorization
40-
--autocomplete Use autocompletion
41-
--noautocomplete Don't use autocompletion
42-
--prompt prompt-mode/--prompt-mode prompt-mode
43-
Switch prompt mode. Pre-defined prompt modes are
44-
`default', `simple', `xmp' and `inf-ruby'
33+
Show truncated result on assignment (default).
34+
--inspect Use 'inspect' for output.
35+
--noinspect Don't use 'inspect' for output.
36+
--multiline Use multiline editor module.
37+
--nomultiline Don't use multiline editor module (default).
38+
--singleline Use single line editor module.
39+
--nosingleline Don't use single line editor module (default).
40+
--colorize Use color-highlighting (default).
41+
--nocolorize Don't use color-highlighting.
42+
--autocomplete Use auto-completion (default).
43+
--noautocomplete Don't use auto-completion.
44+
--prompt prompt-mode, --prompt-mode prompt-mode
45+
Set prompt mode. Pre-defined prompt modes are:
46+
'default', 'classic', 'simple', 'inf-ruby', 'xmp', 'null'.
4547
--inf-ruby-mode Use prompt appropriate for inf-ruby-mode on emacs.
4648
Suppresses --multiline and --singleline.
47-
--sample-book-mode/--simple-prompt
48-
Simple prompt mode
49-
--noprompt No prompt mode
49+
--sample-book-mode, --simple-prompt
50+
Set prompt mode to 'simple'.
51+
--noprompt Don't output prompt.
5052
--single-irb Share self with sub-irb.
51-
--tracer Display trace for each execution of commands.
52-
--back-trace-limit n
53-
Display backtrace top n and tail n. The default
54-
value is 16.
55-
--verbose Show details
56-
--noverbose Don't show details
57-
-v, --version Print the version of irb
58-
-h, --help Print help
59-
-- Separate options of irb from the list of command-line args
53+
--tracer Show stack trace for each command.
54+
--back-trace-limit n[=16]
55+
Display backtrace top n and bottom n.
56+
--verbose Show details.
57+
--noverbose Don't show details.
58+
-v, --version Print the version of irb.
59+
-h, --help Print help.
60+
-- Separate options of irb from the list of command-line args.
6061

6162
# vim:fileencoding=utf-8

0 commit comments

Comments
 (0)