Skip to content

Commit 3de171f

Browse files
committed
Adds more env vars from the wiki by @MasterDuke17
This would close #949.
1 parent 469bdb4 commit 3de171f

File tree

1 file changed

+35
-10
lines changed

1 file changed

+35
-10
lines changed

doc/Programs/03-environment-variables.pod6

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
=begin pod
22
3-
=TITLE Shell environment variables used by the interpreter
3+
=TITLE Shell environment variables used by Perl 6
44
55
=SUBTITLE What variables you can declare to alter its behavior.
66
7-
Rakudo's behavior can be tweaked by a (growing) number of environment variables;
8-
this section attempts to document all those currently in use.
7+
The behavior of the interpreter can be tweaked by a (growing) number of
8+
environment variables; this section attempts to document all those currently in
9+
use. All these variables correspond to the L<Rakudo|https://rakudo.org>, and
10+
they are interpreter specific in all cases, except where some use conventional
11+
names such as C<PATH>.
12+
13+
The underlying virtual machine is also sensitive to a series of environment variables, they are listed L<in this wiki page|https://github.com/rakudo/rakudo/wiki/dev-env-vars#moarvm>
914
1015
=head2 Module Loading
1116
@@ -17,9 +22,15 @@ information to standard error.
1722
1823
=head2 Error Message Verbosity and Strictness
1924
25+
=item C<RAKUDO_EXCEPTIONS_HANDLER> If present, the print_exception routine will
26+
use a class of that name to process the exception for output. Rakudo currently
27+
ships with Exceptions::JSON (invoked by setting this variable to C<JSON>, to
28+
override the default output.
29+
2030
=item C<RAKUDO_NO_DEPRECATIONS>
2131
22-
If true, suppresses deprecation warnings triggered by the C<is DEPRECATED> trait.
32+
If true, suppresses deprecation warnings triggered by the C<is DEPRECATED>
33+
trait.
2334
2435
=item C<RAKUDO_DEPRECATIONS_FATAL>
2536
@@ -33,22 +44,36 @@ Displays source code in stack frames surrounded by the specified number of lines
3344
3445
Controls whether .setting files are included in backtraces.
3546
36-
=back
37-
3847
=head2 Affecting Precompilation
3948
4049
=item C<RAKUDO_PREFIX>
4150
42-
When this is set, Rakudo will look for the standard repositories (perl, vendor, site) in the
43-
specified directory. This is intended as an escape hatch for build-time bootstrapping issues,
44-
where Rakudo may be built as an unprivileged user without write access to the runtime paths
45-
in NQP's config.
51+
When this is set, Rakudo will look for the standard repositories (perl, vendor,
52+
site) in the specified directory. This is intended as an escape hatch for
53+
build-time bootstrapping issues, where Rakudo may be built as an unprivileged
54+
user without write access to the runtime paths in NQP's config.
4655
4756
=item C<RAKUDO_PRECOMP_DIST>, C<RAKUDO_PRECOMP_LOADING> C<RAKUDO_PRECOMP_WITH>: These are internal variables for passing serialized state to precompilation jobs in child processes. Please do not set them manually.
4857
58+
=item C<RAKUDO_LOG_PRECOMP> If set to 1, diagnostic information about the precompilation process is emitted.
59+
60+
=head2 Line editor
61+
62+
=item C<RAKUDO_LINE_EDITOR> This specifies the preferred line editor to use;
63+
valid values are Readline, Linenoise, and none. A value of none is useful if you
64+
want to avoid the recommendation message upon REPL startup.
65+
66+
=item C<RAKUDO_DISABLE_MULTILINE> Set to 1, will disable multiline input for the REPL
67+
68+
=item C<RAKUDO_HIST> This specifies the location of the history file used by the
69+
line editor; the default is F<~/.perl6/rakudo-history>.
70+
4971
5072
=head2 Other
5173
74+
=item C<RAKUDO_DEFAULT_READ_ELEMS> Defaults to 65536; the default number of
75+
characters to read on an IO::Handle.
76+
5277
=item C<RAKUDO_ERROR_COLOR> Controls whether to emit ANSI codes for error
5378
highlighting. Defaults to true if unset, except on Win32.
5479

0 commit comments

Comments
 (0)