Interactive help: Difference between revisions

Content added Content deleted
(Rename Perl 6 -> Raku, alphabetize, minor clean-up)
m (→‎{{header|Raku}}: Updated, probably could use some more fleshing out)
Line 391: Line 391:
=={{header|Raku}}==
=={{header|Raku}}==
(formerly Perl 6)
(formerly Perl 6)
⚫
Perl 6 help is generally in a specialized text format known as POD (Plain Old Documentation). It is sometimes referred to as POD6 to distinguish it from Perl 5 POD which is slightly different and not completely compatible. Perl 6 has a local command line help app: p6doc. It also has online browsable HTML documentation at [https://docs.perl6.org docs.perl6.org]. If you want to download the HTML docs for a local copy, or just prefer to browse the documentation as a single page [https://docs.perl6.org/perl6.html docs.perl6.org/perl6.html] may be more to your preference. If you prefer a different format, there are [https://modules.perl6.org/search/?q=POD%3A%3ATo utilities available] to convert the POD docs to several different formats; Markdown, PDF, Latex, plain text, etc.


⚫
Raku help is generally in a specialized text format known as POD (Plain Old Documentation). It is sometimes referred to as POD6 to distinguish it from Perl 5 POD which is slightly different and not completely compatible. Raku has a local command line help app: p6doc. <tt>zef install p6doc</tt> It also has online browsable HTML documentation at [https://docs.raku.org docs.raku.org]. If you want to download the HTML docs for a local copy, or just prefer to browse the documentation as a single page [https://docs.raku.org/perl6.html docs.raku.org/perl6.html] may be more to your preference. If you prefer a different format, there are [https://modules.raku.org/search/?q=POD%3A%3ATo utilities available] to convert the POD docs to several different formats; Markdown, PDF, Latex, plain text, etc.
⚫
Individual Perl 6 scripts are to some extent self-documenting. If the script has a MAIN sub, and it is called with improper parameters, it will display an automatically generated help message showing the various possible parameters, which are required, which are optional, and what type each takes:

⚫
Individual Raku scripts are to some extent self-documenting. If the script has a MAIN sub, and it is called with improper parameters, it will display an automatically generated help message showing the various possible parameters, which are required, which are optional, and what type each takes:


<lang perl6>sub MAIN(
<lang perl6>sub MAIN(
Str $run, #= Task or file name
Str $run, #= Task or file name
Str :$lang = 'perl6', #= Language, default perl6
Str :$lang = 'raku', #= Language, default raku
Int :$skip = 0, #= Skip # to jump partially into a list
Int :$skip = 0, #= Skip # to jump partially into a list
Bool :f(:$force), #= Override any skip parameter
Bool :f(:$force), #= Override any skip parameter
Line 404: Line 405:
}</lang>
}</lang>


{{out|When saved locally as main.p6 and invoked with no (or wrong) passed parameters}}
{{out|When saved locally as main.raku and invoked with no (or wrong) passed parameters}}
<pre>Usage:
<pre>Usage:
main.p6 [--lang=<Str>] [--skip=<Int>] [-f|--force] <run>
main.raku [--lang=<Str>] [--skip=<Int>] [-f|--force] <run>
<run> Task or file name
<run> Task or file name
--lang=<Str> Language, default perl6
--lang=<Str> Language, default raku
--skip=<Int> Skip # to jump partially into a list
--skip=<Int> Skip # to jump partially into a list
-f|--force Override any skip parameter
-f|--force Override any skip parameter
Retrieved from "https://rosettacode.org/wiki/Interactive_help"