# PetaPerl documentation

A next-generation Perl 5 runtime written in Rust, with JIT and
auto-parallelization. This documentation covers installation, usage,
the built-in module reference, and the internals of the interpreter.

This is the **pperl {{ pperl_version }}** documentation, built
{{ build_date }} ({{ source_pages }} pages, ≈{{ source_words }} words).

::::{grid} 1 1 2 2
:gutter: 3

:::{grid-item-card} Getting started
:link: getting_started
:link-type: doc

First steps: install pperl, run your first script, see what's
different from system perl.
:::

:::{grid-item-card} How-To
:link: howto
:link-type: doc

Task-oriented material. **Guides** are long-form and multi-chapter
(regex, OO, debugging, concurrent execution, pperl architecture).
**Tutorials** are single-sitting (pack, I/O streams, references,
Unicode).
:::

:::{grid-item-card} Reference
:link: p5/index
:link-type: doc

Per-module reference for every built-in module; Perl language
reference (variables, functions, operators, regex). Split by
runtime — the **p5** reference here; the pp-runtime counterpart
lives under [pp/](pp/index).
:::

:::{grid-item-card} Index & glossary
:link: genindex
:link-type: ref

Alphabetical index of every documented module, function, and term;
short glossary of project vocabulary.
:::

::::

```{toctree}
:hidden:
:caption: User guide
:maxdepth: 2

introduction
getting_started
cli_options
howto
```

```{toctree}
:hidden:
:caption: Reference
:maxdepth: 2

p5/index
pp/index
```

<!-- Disclaimer, License, and Glossary are wired into the LaTeX build
     as Appendix A, B, C via `latex_appendices` in conf.py (Sphinx's
     built-in mechanism that emits `\appendix` before them and
     letters them A/B/C rather than numbering 7/8/9). In HTML they're
     orphan pages reachable via the footer. -->