para

TITLE

SUBTITLE

data

=begin data
{"type":"page","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/README.md","file":"work_mods/zef/rakudoc/rakudoc-0.2.6/README.md","sources":[],"node":{"type":"block","id":"fLDjJsW529eFV-tWEAhHc","margin":"","name":"root","content":[{"type":"para","id":"EuJn0UwSnMJLpEpPeokVs","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":108,"offset":107}},"text":"text","content":[{"meta":"https://travis-ci.com/Raku/rakudoc","type":"fcode","name":"L","content":[{"type":"block","id":"uglDiEI9Vk0c0yw9FBfr2","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":71,"offset":70}},"content":[{"type":"image","src":"https://travis-ci.com/Raku/rakudoc.svg?branch=master","alt":"Build Status"}]}]}]},{"type":"block","id":"53z-d1kRuYhPpJN5jQobv","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":109},"end":{"line":4,"column":5,"offset":118}},"content":[{"type":"text","value":"NAME"}]},{"type":"para","id":"kEYd6cLLkr9l4iTIxGkM2","margin":"","location":{"start":{"line":6,"column":1,"offset":120},"end":{"line":6,"column":48,"offset":167}},"text":"text","content":[{"type":"text","value":"rakudoc - A tool for reading Raku documentation"}]},{"type":"block","id":"wBw4IKN6pRzCkRV7MoUJM","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":169},"end":{"line":9,"column":9,"offset":186}},"content":[{"type":"text","value":"SYNOPSIS"}]},{"type":"block","id":"B_8ebl5ykzc2ryciONxMf","margin":"","name":"code","config":[],"location":{"start":{"line":11,"column":1,"offset":188},"end":{"line":19,"column":90,"offset":743}},"content":[{"type":"verbatim","value":"rakudoc [-d|--doc-sources=<Directories>] [-D|--no-default-docs] <query>\nrakudoc -b|--build-index [-d|--doc-sources=<Directories>] [-D|--no-default-docs]\nrakudoc -V|--version\nrakudoc -h|--help <ARGUMENTS>\n\n<query>                           Example: 'Map', 'IO::Path.add', '.add'\n-d|--doc-sources=<Directories>    Additional directories to search for documentation\n-D|--no-default-docs              Use only directories in --doc / $RAKUDOC\n-b|--build-index                  Index all documents found in doc source directories"}]},{"type":"block","id":"4Sj2RXksJuKHctazjB_Ox","margin":"","level":1,"name":"head","location":{"start":{"line":21,"column":1,"offset":745},"end":{"line":22,"column":12,"offset":768}},"content":[{"type":"text","value":"DESCRIPTION"}]},{"type":"para","id":"rCKS1nSClm7Evaks61JXb","margin":"","location":{"start":{"line":24,"column":1,"offset":770},"end":{"line":24,"column":95,"offset":864}},"text":"text","content":[{"type":"text","value":"The "},{"type":"fcode","name":"C","content":[{"type":"text","value":"rakudoc"}]},{"type":"text","value":" command displays Raku documentation for language features and installed modules."}]},{"type":"block","id":"ENI41anL2ujRsX4PugWsA","margin":"","level":1,"name":"head","location":{"start":{"line":26,"column":1,"offset":866},"end":{"line":27,"column":12,"offset":889}},"content":[{"type":"text","value":"ENVIRONMENT"}]},{"type":"list","id":"aD5hznxU2V2WAj-nLIeLk","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"tIENKscSc8R13OYVOGDaR","margin":"","name":"item","level":1,"location":{"start":{"line":29,"column":3,"offset":893},"end":{"line":29,"column":134,"offset":1024}},"content":[{"type":"para","id":"TFnZ9vy1axnKt17aJuPF4","margin":"","location":{"start":{"line":29,"column":5,"offset":895},"end":{"line":29,"column":134,"offset":1024}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC"}]},{"type":"text","value":" — Comma-separated list of doc directories (e.g., "},{"type":"fcode","name":"C","content":[{"type":"text","value":"../doc/doc,./t/test-doc"}]},{"type":"text","value":"); ignored if "},{"type":"fcode","name":"C","content":[{"type":"text","value":"--doc-sources"}]},{"type":"text","value":" option is given"}]}]},{"type":"block","id":"bJDzcW-H7BL6RmLXoNh4U","margin":"","name":"item","level":1,"location":{"start":{"line":31,"column":3,"offset":1028},"end":{"line":31,"column":81,"offset":1106}},"content":[{"type":"para","id":"JRm_iIG5nVd6Dcha1FRhE","margin":"","location":{"start":{"line":31,"column":5,"offset":1030},"end":{"line":31,"column":81,"offset":1106}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC_DATA"}]},{"type":"text","value":" — Path to directory where Rakudoc stores cache and index data"}]}]},{"type":"block","id":"AWbZYOFwh23L4YGo3RXP9","margin":"","name":"item","level":1,"location":{"start":{"line":33,"column":3,"offset":1110},"end":{"line":33,"column":56,"offset":1163}},"content":[{"type":"para","id":"5BCn0UqMtUajAr5Y_n3aJ","margin":"","location":{"start":{"line":33,"column":5,"offset":1112},"end":{"line":33,"column":56,"offset":1163}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC_PAGER"}]},{"type":"text","value":" — Pager program (default: "},{"type":"fcode","name":"C","content":[{"type":"text","value":"$PAGER"}]},{"type":"text","value":")"}]}]}]},{"type":"block","id":"0YiTGtcJ8Aropm_5V-Lvl","margin":"","level":1,"name":"head","location":{"start":{"line":35,"column":1,"offset":1165},"end":{"line":36,"column":8,"offset":1180}},"content":[{"type":"text","value":"LICENSE"}]},{"type":"para","id":"X-eDgR4BWlTLvXhHmGCZg","margin":"","location":{"start":{"line":38,"column":1,"offset":1182},"end":{"line":38,"column":77,"offset":1258}},"text":"text","content":[{"type":"text","value":"Rakudoc is Copyright (C) 2019–2021, by Joel Schüller, Tim Siegel and others."}]},{"type":"para","id":"lELon681yigZvDozulnob","margin":"","location":{"start":{"line":40,"column":1,"offset":1260},"end":{"line":40,"column":166,"offset":1425}},"text":"text","content":[{"type":"text","value":"It is free software; you can redistribute it and/or modify it under the terms of the "},{"meta":"https://www.perlfoundation.org/artistic-license-20.html","type":"fcode","name":"L","content":["Artistic License 2.0"]},{"type":"text","value":"."}]}]},"pluginsData":{"moduleInfo":{"meta":{"api":"1","auth":"zef:coke","authors":["Joel D. S. <@noisegul>","Tim Siegel <github:softmoth>","Will Coleda"],"build-depends":[],"depends":["Pod::Utils:ver<0.0.2+>"],"description":"A tool for reading Raku documentation","dist":"rakudoc:ver<0.2.6>:auth<zef:coke>","license":"Artistic-2.0","name":"rakudoc","path":"R/AK/RAKUDOC/a7a50254f8fc018bcfabdea8529bec408c358659.tar.gz","perl":"6.d","provides":{"Rakudoc":"lib/Rakudoc.rakumod","Rakudoc::CMD":"lib/Rakudoc/CMD.rakumod","Rakudoc::Documentable":"lib/Rakudoc/Documentable.rakumod","Rakudoc::Pod::Cache":"lib/Rakudoc/Pod/Cache.rakumod"},"raku":"6.d","resources":["doc/bin/rakudoc.rakudoc"],"support":{"bugtracker":"https://github.com/Raku/rakudoc/issues"},"tags":[],"test-depends":["IO::MiddleMan:ver<1.001003+>","File::Directory::Tree","File::Temp:ver<0.0.8+>"],"version":"0.2.6"},"files":[{"file":"work_mods/zef/rakudoc/rakudoc-0.2.6/README.md","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/README.md"},{"file":"work_mods/zef/rakudoc/rakudoc-0.2.6/resources/doc/bin/rakudoc.rakudoc","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/resources/doc/bin/rakudoc.rakudoc"}],"src":"zef","url":"/mods/zef/rakudoc"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/README.md","file":"work_mods/zef/rakudoc/rakudoc-0.2.6/README.md","sources":[],"node":{"type":"block","id":"fLDjJsW529eFV-tWEAhHc","margin":"","name":"root","content":[{"type":"para","id":"EuJn0UwSnMJLpEpPeokVs","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":108,"offset":107}},"text":"text","content":[{"meta":"https://travis-ci.com/Raku/rakudoc","type":"fcode","name":"L","content":[{"type":"block","id":"uglDiEI9Vk0c0yw9FBfr2","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":71,"offset":70}},"content":[{"type":"image","src":"https://travis-ci.com/Raku/rakudoc.svg?branch=master","alt":"Build Status"}]}]}]},{"type":"block","id":"53z-d1kRuYhPpJN5jQobv","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":109},"end":{"line":4,"column":5,"offset":118}},"content":[{"type":"text","value":"NAME"}]},{"type":"para","id":"kEYd6cLLkr9l4iTIxGkM2","margin":"","location":{"start":{"line":6,"column":1,"offset":120},"end":{"line":6,"column":48,"offset":167}},"text":"text","content":[{"type":"text","value":"rakudoc - A tool for reading Raku documentation"}]},{"type":"block","id":"wBw4IKN6pRzCkRV7MoUJM","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":169},"end":{"line":9,"column":9,"offset":186}},"content":[{"type":"text","value":"SYNOPSIS"}]},{"type":"block","id":"B_8ebl5ykzc2ryciONxMf","margin":"","name":"code","config":[],"location":{"start":{"line":11,"column":1,"offset":188},"end":{"line":19,"column":90,"offset":743}},"content":[{"type":"verbatim","value":"rakudoc [-d|--doc-sources=<Directories>] [-D|--no-default-docs] <query>\nrakudoc -b|--build-index [-d|--doc-sources=<Directories>] [-D|--no-default-docs]\nrakudoc -V|--version\nrakudoc -h|--help <ARGUMENTS>\n\n<query>                           Example: 'Map', 'IO::Path.add', '.add'\n-d|--doc-sources=<Directories>    Additional directories to search for documentation\n-D|--no-default-docs              Use only directories in --doc / $RAKUDOC\n-b|--build-index                  Index all documents found in doc source directories"}]},{"type":"block","id":"4Sj2RXksJuKHctazjB_Ox","margin":"","level":1,"name":"head","location":{"start":{"line":21,"column":1,"offset":745},"end":{"line":22,"column":12,"offset":768}},"content":[{"type":"text","value":"DESCRIPTION"}]},{"type":"para","id":"rCKS1nSClm7Evaks61JXb","margin":"","location":{"start":{"line":24,"column":1,"offset":770},"end":{"line":24,"column":95,"offset":864}},"text":"text","content":[{"type":"text","value":"The "},{"type":"fcode","name":"C","content":[{"type":"text","value":"rakudoc"}]},{"type":"text","value":" command displays Raku documentation for language features and installed modules."}]},{"type":"block","id":"ENI41anL2ujRsX4PugWsA","margin":"","level":1,"name":"head","location":{"start":{"line":26,"column":1,"offset":866},"end":{"line":27,"column":12,"offset":889}},"content":[{"type":"text","value":"ENVIRONMENT"}]},{"type":"list","id":"aD5hznxU2V2WAj-nLIeLk","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"tIENKscSc8R13OYVOGDaR","margin":"","name":"item","level":1,"location":{"start":{"line":29,"column":3,"offset":893},"end":{"line":29,"column":134,"offset":1024}},"content":[{"type":"para","id":"TFnZ9vy1axnKt17aJuPF4","margin":"","location":{"start":{"line":29,"column":5,"offset":895},"end":{"line":29,"column":134,"offset":1024}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC"}]},{"type":"text","value":" — Comma-separated list of doc directories (e.g., "},{"type":"fcode","name":"C","content":[{"type":"text","value":"../doc/doc,./t/test-doc"}]},{"type":"text","value":"); ignored if "},{"type":"fcode","name":"C","content":[{"type":"text","value":"--doc-sources"}]},{"type":"text","value":" option is given"}]}]},{"type":"block","id":"bJDzcW-H7BL6RmLXoNh4U","margin":"","name":"item","level":1,"location":{"start":{"line":31,"column":3,"offset":1028},"end":{"line":31,"column":81,"offset":1106}},"content":[{"type":"para","id":"JRm_iIG5nVd6Dcha1FRhE","margin":"","location":{"start":{"line":31,"column":5,"offset":1030},"end":{"line":31,"column":81,"offset":1106}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC_DATA"}]},{"type":"text","value":" — Path to directory where Rakudoc stores cache and index data"}]}]},{"type":"block","id":"AWbZYOFwh23L4YGo3RXP9","margin":"","name":"item","level":1,"location":{"start":{"line":33,"column":3,"offset":1110},"end":{"line":33,"column":56,"offset":1163}},"content":[{"type":"para","id":"5BCn0UqMtUajAr5Y_n3aJ","margin":"","location":{"start":{"line":33,"column":5,"offset":1112},"end":{"line":33,"column":56,"offset":1163}},"text":"text","content":[{"type":"fcode","name":"C","content":[{"type":"text","value":"RAKUDOC_PAGER"}]},{"type":"text","value":" — Pager program (default: "},{"type":"fcode","name":"C","content":[{"type":"text","value":"$PAGER"}]},{"type":"text","value":")"}]}]}]},{"type":"block","id":"0YiTGtcJ8Aropm_5V-Lvl","margin":"","level":1,"name":"head","location":{"start":{"line":35,"column":1,"offset":1165},"end":{"line":36,"column":8,"offset":1180}},"content":[{"type":"text","value":"LICENSE"}]},{"type":"para","id":"X-eDgR4BWlTLvXhHmGCZg","margin":"","location":{"start":{"line":38,"column":1,"offset":1182},"end":{"line":38,"column":77,"offset":1258}},"text":"text","content":[{"type":"text","value":"Rakudoc is Copyright (C) 2019–2021, by Joel Schüller, Tim Siegel and others."}]},{"type":"para","id":"lELon681yigZvDozulnob","margin":"","location":{"start":{"line":40,"column":1,"offset":1260},"end":{"line":40,"column":166,"offset":1425}},"text":"text","content":[{"type":"text","value":"It is free software; you can redistribute it and/or modify it under the terms of the "},{"meta":"https://www.perlfoundation.org/artistic-license-20.html","type":"fcode","name":"L","content":["Artistic License 2.0"]},{"type":"text","value":"."}]}]},"pluginsData":{"moduleInfo":{"meta":{"api":"1","auth":"zef:coke","authors":["Joel D. S. <@noisegul>","Tim Siegel <github:softmoth>","Will Coleda"],"build-depends":[],"depends":["Pod::Utils:ver<0.0.2+>"],"description":"A tool for reading Raku documentation","dist":"rakudoc:ver<0.2.6>:auth<zef:coke>","license":"Artistic-2.0","name":"rakudoc","path":"R/AK/RAKUDOC/a7a50254f8fc018bcfabdea8529bec408c358659.tar.gz","perl":"6.d","provides":{"Rakudoc":"lib/Rakudoc.rakumod","Rakudoc::CMD":"lib/Rakudoc/CMD.rakumod","Rakudoc::Documentable":"lib/Rakudoc/Documentable.rakumod","Rakudoc::Pod::Cache":"lib/Rakudoc/Pod/Cache.rakumod"},"raku":"6.d","resources":["doc/bin/rakudoc.rakudoc"],"support":{"bugtracker":"https://github.com/Raku/rakudoc/issues"},"tags":[],"test-depends":["IO::MiddleMan:ver<1.001003+>","File::Directory::Tree","File::Temp:ver<0.0.8+>"],"version":"0.2.6"},"files":[{"file":"work_mods/zef/rakudoc/rakudoc-0.2.6/README.md","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/README.md"},{"file":"work_mods/zef/rakudoc/rakudoc-0.2.6/resources/doc/bin/rakudoc.rakudoc","publishUrl":"/mods/zef/rakudoc/rakudoc-0.2.6/resources/doc/bin/rakudoc.rakudoc"}],"src":"zef","url":"/mods/zef/rakudoc"}}}
    =end data
    =end React


root

Convert Rakudoc files to formatted *roff input


rakudoc2man


A very incomplete mailgun module. PRs welcome.


raku-mailgun


A tool for reading Raku documentation


=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


rakudoc

NAME

SYNOPSIS

DESCRIPTION

ENVIRONMENT

LICENSE

rakudoc v0.2.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation