.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "perl6 1" .TH perl6 1 "2019-01-09" "perl v5.26.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" perl6 \- Rakudo Perl 6 Compiler .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& perl6 [switches] [\-\-] [programfile] [arguments] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" With no arguments, enters a \s-1REPL.\s0 With a \f(CW\*(C`[programfile]\*(C'\fR or the \f(CW\*(C`\-e\*(C'\fR option, compiles the given program and by default also executes the compiled code. .PP .Vb 10 \& \-c check syntax only (runs BEGIN and CHECK blocks) \& \-\-doc extract documentation and print it as text \& \-e program one line of program, strict is enabled by default \& \-h, \-\-help display this help text \& \-n run program once for each line of input \& \-p same as \-n, but also print $_ at the end of lines \& \-I path adds the path to the module search path \& \-M module loads the module prior to running the program \& \-\-target=[stage] specify compilation stage to emit \& \-\-optimize=[level] use the given level of optimization (0..3) \& \-\-encoding=[mode] specify string encoding mode \& \-o, \-\-output=[name] specify name of output file \& \-v, \-\-version display version information \& \-\-stagestats display time spent in the compilation stages \& \-\-ll\-exception display a low level backtrace on errors \& \-\-profile write profile information as HTML file (MoarVM) \& \-\-profile\-filename provide a different filename (also allows .json) \& \-\-doc=[module] Use Pod::To::[module] to render inline documentation. .Ve .PP Note that only boolean single-letter options may be bundled. .PP The supported values for \f(CW\*(C`\-\-target\*(C'\fR are: .PP .Vb 5 \& Target Backend Description \& ====== ======= =========== \& parse all a representation of the parse tree \& ast all an abstract syntax tree (before optimizations) \& optimize all an abstract syntax tree (after optimizations) \& \& mbc MoarVM MoarVM byte code \& jar JVM JVM archive .Ve .PP For \f(CW\*(C`\-\-profile\-filename\*(C'\fR, specifying a name ending in \f(CW\*(C`.json\*(C'\fR will write a raw \s-1JSON\s0 profile dump. The default if this is omitted is \f(CW\*(C`profile\-\f(CI[timestamp]\f(CW.html\*(C'\fR. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" Rakudo's behavior can be tweaked by a (growing) number of environment variables; this section attempts to document all those currently in use. .SS "Module Loading" .IX Subsection "Module Loading" .ie n .IP """RAKUDOLIB"", ""PERL6LIB"" (\fIStr\fR; \fIsrc/core/Inc.pm\fR)" 4 .el .IP "\f(CWRAKUDOLIB\fR, \f(CWPERL6LIB\fR (\fIStr\fR; \fIsrc/core/Inc.pm\fR)" 4 .IX Item "RAKUDOLIB, PERL6LIB (Str; src/core/Inc.pm)" Appends a comma-delimited list of paths to \f(CW@INC\fR. \f(CW\*(C`RAKUDOLIB\*(C'\fR is evaluated first. .ie n .IP """RAKUDO_MODULE_DEBUG"" (\fIBool\fR; \fIsrc/Perl6/ModuleLoader.pm\fR)" 4 .el .IP "\f(CWRAKUDO_MODULE_DEBUG\fR (\fIBool\fR; \fIsrc/Perl6/ModuleLoader.pm\fR)" 4 .IX Item "RAKUDO_MODULE_DEBUG (Bool; src/Perl6/ModuleLoader.pm)" Causes the module loader to print debugging information to standard error. .SS "Error Message Verbosity and Strictness" .IX Subsection "Error Message Verbosity and Strictness" .ie n .IP """RAKUDO_NO_DEPRECATIONS"" (\fIBool\fR; \fIsrc/core/Deprecations.pm\fR)" 4 .el .IP "\f(CWRAKUDO_NO_DEPRECATIONS\fR (\fIBool\fR; \fIsrc/core/Deprecations.pm\fR)" 4 .IX Item "RAKUDO_NO_DEPRECATIONS (Bool; src/core/Deprecations.pm)" If true, suppresses deprecation warnings triggered by the \f(CW\*(C`is DEPRECATED\*(C'\fR trait. .ie n .IP """RAKUDO_DEPRECATIONS_FATAL"" (\fIBool\fR; \fIsrc/core/Deprecations.pm\fR)" 4 .el .IP "\f(CWRAKUDO_DEPRECATIONS_FATAL\fR (\fIBool\fR; \fIsrc/core/Deprecations.pm\fR)" 4 .IX Item "RAKUDO_DEPRECATIONS_FATAL (Bool; src/core/Deprecations.pm)" If true, deprecation warnings become thrown exceptions. .ie n .IP """RAKUDO_VERBOSE_STACKFRAME"" (\fIUInt\fR; \fIsrc/core/Backtrace.pm\fR)" 4 .el .IP "\f(CWRAKUDO_VERBOSE_STACKFRAME\fR (\fIUInt\fR; \fIsrc/core/Backtrace.pm\fR)" 4 .IX Item "RAKUDO_VERBOSE_STACKFRAME (UInt; src/core/Backtrace.pm)" Displays source code in stack frames surrounded by the specified number of lines of context. .ie n .IP """RAKUDO_BACKTRACE_SETTING"" (\fIBool\fR; \fIsrc/core/Backtrace.pm\fR)" 4 .el .IP "\f(CWRAKUDO_BACKTRACE_SETTING\fR (\fIBool\fR; \fIsrc/core/Backtrace.pm\fR)" 4 .IX Item "RAKUDO_BACKTRACE_SETTING (Bool; src/core/Backtrace.pm)" Controls whether .setting files are included in backtraces. .SS "Affecting Precompilation" .IX Subsection "Affecting Precompilation" .ie n .IP """RAKUDO_PREFIX"" (\fIStr\fR; \fIsrc/core/CompUnit/RepositoryRegistry.pm\fR)" 4 .el .IP "\f(CWRAKUDO_PREFIX\fR (\fIStr\fR; \fIsrc/core/CompUnit/RepositoryRegistry.pm\fR)" 4 .IX Item "RAKUDO_PREFIX (Str; src/core/CompUnit/RepositoryRegistry.pm)" When this is set, Rakudo will look for the standard repositories (perl, vendor, site) in the specified directory. This is intended as an escape hatch for build-time bootstrapping issues, where Rakudo may be built as an unprivileged user without write access to the runtime paths in \s-1NQP\s0's config. .ie n .IP """RAKUDO_PRECOMP_DIST"" (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .el .IP "\f(CWRAKUDO_PRECOMP_DIST\fR (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .IX Item "RAKUDO_PRECOMP_DIST (src/core/CompUnit/PrecompilationRepository.pm)" .PD 0 .ie n .IP """RAKUDO_PRECOMP_LOADING"" (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .el .IP "\f(CWRAKUDO_PRECOMP_LOADING\fR (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .IX Item "RAKUDO_PRECOMP_LOADING (src/core/CompUnit/PrecompilationRepository.pm)" .ie n .IP """RAKUDO_PRECOMP_WITH"" (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .el .IP "\f(CWRAKUDO_PRECOMP_WITH\fR (\fIsrc/core/CompUnit/PrecompilationRepository.pm\fR)" 4 .IX Item "RAKUDO_PRECOMP_WITH (src/core/CompUnit/PrecompilationRepository.pm)" .PD These are internal variables for passing serialized state to precompilation jobs in child processes. Please do not set them manually. .SS "Other" .IX Subsection "Other" .ie n .IP """RAKUDO_ERROR_COLOR"" (\fIBool\fR; \fIsrc/core/Exception.pm\fR)" 4 .el .IP "\f(CWRAKUDO_ERROR_COLOR\fR (\fIBool\fR; \fIsrc/core/Exception.pm\fR)" 4 .IX Item "RAKUDO_ERROR_COLOR (Bool; src/core/Exception.pm)" Controls whether to emit \s-1ANSI\s0 codes for error highlighting. Defaults to true if unset, except on Win32. .ie n .IP """RAKUDO_MAX_THREADS"" (\fIUInt\fR; \fIsrc/core/ThreadPoolScheduler.pm\fR)" 4 .el .IP "\f(CWRAKUDO_MAX_THREADS\fR (\fIUInt\fR; \fIsrc/core/ThreadPoolScheduler.pm\fR)" 4 .IX Item "RAKUDO_MAX_THREADS (UInt; src/core/ThreadPoolScheduler.pm)" Override the default maximum number of threads used by a thread pool. .ie n .IP """TMPDIR"", ""TEMP"", ""TMP"" (\fIStr\fR; \fIsrc/core/IO/Spec/\fR)" 4 .el .IP "\f(CWTMPDIR\fR, \f(CWTEMP\fR, \f(CWTMP\fR (\fIStr\fR; \fIsrc/core/IO/Spec/\fR)" 4 .IX Item "TMPDIR, TEMP, TMP (Str; src/core/IO/Spec/)" The \f(CW\*(C`IO::Spec::Unix.tmpdir\*(C'\fR method will return \f(CW$TMPDIR\fR if it points to a directory with full access permissions for the current user, with a fallback default of \f(CW\*(Aq/tmp\*(Aq\fR. .Sp \&\f(CW\*(C`IO::Spec::Cygwin\*(C'\fR and \f(CW\*(C`IO::Spec::Win32\*(C'\fR use more Win32\-appropriate lists which also include the \&\f(CW\*(C`%TEMP%\*(C'\fR and \f(CW\*(C`%TMP%\*(C'\fR environment variables. .ie n .IP """PATH"", ""Path"" (\fIStr\fR; \fIsrc/core/IO/Spec/\fR)" 4 .el .IP "\f(CWPATH\fR, \f(CWPath\fR (\fIStr\fR; \fIsrc/core/IO/Spec/\fR)" 4 .IX Item "PATH, Path (Str; src/core/IO/Spec/)" The \f(CW\*(C`IO::Spec::Unix.path\*(C'\fR method splits \f(CW$PATH\fR as a shell would; i.e. as a colon-separated list. \&\f(CW\*(C`IO::Spec::Cygwin\*(C'\fR inherits this from \f(CW\*(C`IO::Spec::Unix\*(C'\fR. .Sp \&\f(CW\*(C`IO::Spec::Win32.path\*(C'\fR will read the first defined of either \f(CW\*(C`%PATH%\*(C'\fR or \f(CW\*(C`%Path%\*(C'\fR as a semicolon-delimited list. .SH "AUTHORS" .IX Header "AUTHORS" Written by the Rakudo contributors, see the \s-1CREDITS\s0 file. .PP This manual page was written by Reini Urban, Moritz Lenz and the Rakudo contributors.