aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStan Lo <stan.lo@shopify.com>2022-12-06 00:53:28 +0000
committergit <svn-admin@ruby-lang.org>2022-12-06 00:53:32 +0000
commit9aa18f61f297fcb2ee0cbd4be0772607745274b7 (patch)
tree93dda6c9752026426c6505ae5f1a972148d64105 /README.md
parente31d645da58abce67a0fb8b27251ee532adcfab5 (diff)
downloadruby-9aa18f61f297fcb2ee0cbd4be0772607745274b7.tar.gz
[ruby/irb] Allow disabling autocompletion with
`IRB_USE_AUTOCOMPLETE=false` (https://github.com/ruby/irb/pull/469) * Allow using IRB_USE_AUTOCOMPLETE=false to disable autocompletion Currently, the only 2 ways to disable autocompletion are: 1. Create `.irbrc` and set `IRB.conf[:USE_AUTOCOMPLETE] = false` 2. Add the `--noautocomplete` flag when using the `irb` executable Both of them are less convenient than setting a env var and are lesser known to devs. And given the number of problems the autocompletion has (see #445), I think we should allow disabling it with a simple `IRB_USE_AUTOCOMPLETE=false`. * Mention some env var configs in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 35ef2d9e89..c17b901728 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,15 @@ see [Building Ruby](doc/contributing/building_ruby.md)
https://www.ruby-lang.org/
+## Configuration
+
+### Environment Variables
+
+- `NO_COLOR`: Assigning a value to it disables IRB's colorization.
+- `IRB_USE_AUTOCOMPLETE`: Setting it to `false` disables IRB's autocompletion.
+- `EDITOR`: Its value would be used to open files by the `edit` command.
+- `IRBRC`: The file specified would be evaluated as IRB's rc-file.
+
## Documentation
- [English](https://docs.ruby-lang.org/en/master/index.html)