Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete the missing documentation abount the environment variables #1028

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,10 @@ irb(main):002> a.first. # Completes Integer methods
- `VISUAL`: Its value would be used to open files by the `edit` command.
- `EDITOR`: Its value would be used to open files by the `edit` command if `VISUAL` is unset.
- `IRBRC`: The file specified would be evaluated as IRB's rc-file.
- `XDG_CONFIG_HOME`: If it is set and `IRBRC` is unset, the file `$XDG_CONFIG_HOME/irb/irbrc` would be evaluated as IRB's rc-file.
- `RI_PAGER`: The command specified would be used as a pager.
- `PAGER`: The command specified would be used as a pager if `RI_PAGER` is unset.
- `IRB_LANG`, `LC_MESSAGES`, `LC_ALL`, `LANG`: The first of these that is set would be used as the locale value.

## Documentation

Expand Down
37 changes: 35 additions & 2 deletions man/irb.1
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ The default value is 16.
.El
.Pp
.Sh ENVIRONMENT
.Bl -tag -compact -width "XDG_CONFIG_HOME"
.Bl -tag -compact -width "IRB_USE_AUTOCOMPLETE"
.It Ev IRB_LANG
The locale used for
.Nm .
Expand All @@ -190,10 +190,43 @@ The path to the personal initialization file.
.Pp
.It Ev XDG_CONFIG_HOME
.Nm
respects XDG_CONFIG_HOME. If this is set, load
respects XDG_CONFIG_HOME. If it is set and
.Ev IRBRC
is unset, load
.Pa $XDG_CONFIG_HOME/irb/irbrc
as a personal initialization file.
.Pp
.It Ev RI_PAGER
The command specified would be used as a pager.
.Pp
.It Ev PAGER
The command specified would be used as a pager if
.Ev RI_PAGER
is unset.
.Pp
.It Ev VISUAL
Its value would be used to open files by the edit command.
.Pp
.It Ev EDITOR
Its value would be used to open files by the edit command if
.Ev VISUAL
is unset.
.Pp
.It Ev NO_COLOR
Assigning a value to it disables colorization.
.Pp
.It Ev IRB_USE_AUTOCOMPLETE
Assigning
.Sy false
to it disables autocompletion.
.Pp
.It Ev IRB_COMPLETOR
Autocompletion behavior. Allowed values are
.Sy regexp
or
.Sy type
.
.Pp
.El
.Pp
Also
Expand Down
Loading