You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/Programs/03-environment-variables.pod6
+35-10Lines changed: 35 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,16 @@
1
1
=beginpod
2
2
3
-
=TITLEShell environment variables used by the interpreter
3
+
=TITLEShell environment variables used by Perl 6
4
4
5
5
=SUBTITLEWhat variables you can declare to alter its behavior.
6
6
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>
9
14
10
15
=head2Module Loading
11
16
@@ -17,9 +22,15 @@ information to standard error.
17
22
18
23
=head2Error Message Verbosity and Strictness
19
24
25
+
=itemC<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
+
20
30
=itemC<RAKUDO_NO_DEPRECATIONS>
21
31
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.
23
34
24
35
=itemC<RAKUDO_DEPRECATIONS_FATAL>
25
36
@@ -33,22 +44,36 @@ Displays source code in stack frames surrounded by the specified number of lines
33
44
34
45
Controls whether .setting files are included in backtraces.
35
46
36
-
=back
37
-
38
47
=head2Affecting Precompilation
39
48
40
49
=itemC<RAKUDO_PREFIX>
41
50
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.
46
55
47
56
=itemC<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.
48
57
58
+
=itemC<RAKUDO_LOG_PRECOMP> If set to 1, diagnostic information about the precompilation process is emitted.
59
+
60
+
=head2Line editor
61
+
62
+
=itemC<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
+
=itemC<RAKUDO_DISABLE_MULTILINE> Set to 1, will disable multiline input for the REPL
67
+
68
+
=itemC<RAKUDO_HIST> This specifies the location of the history file used by the
69
+
line editor; the default is F<~/.perl6/rakudo-history>.
70
+
49
71
50
72
=head2Other
51
73
74
+
=itemC<RAKUDO_DEFAULT_READ_ELEMS> Defaults to 65536; the default number of
75
+
characters to read on an IO::Handle.
76
+
52
77
=itemC<RAKUDO_ERROR_COLOR> Controls whether to emit ANSI codes for error
53
78
highlighting. Defaults to true if unset, except on Win32.
0 commit comments