.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Rinci::package 3pm"
.TH Rinci::package 3pm 2024-01-20 "perl v5.38.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
Rinci::package \- Metadata for your namespaces/packages
.SH "SPECIFICATION VERSION"
.IX Header "SPECIFICATION VERSION"
.Vb 1
\& 1.1
.Ve
.SH VERSION
.IX Header "VERSION"
This document describes version 1.1.104 of Rinci::package (from Perl distribution Rinci), released on 2023\-09\-30.
.SH INTRODUCTION
.IX Header "INTRODUCTION"
This document describes metadata for namespaces/packages. This specification is
part of Rinci. Please do a read up on it first, if you have not already done
so.
.SH SPECIFICATION
.IX Header "SPECIFICATION"
\&\fBNamespace? Package?\fR The term "package" from Perl 5 is used here, where it
just means namespace. Perl also happens to use package to implement class, but
metadata for classes will be specified in another specification
(Rinci::class).
.SH FAQ
.IX Header "FAQ"
.SH HOMEPAGE
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Rinci>.
.SH SOURCE
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Rinci>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Rinci
.SH AUTHOR
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH CONTRIBUTING
.IX Header "CONTRIBUTING"
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
.PP
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
.PP
.Vb 1
\& % prove \-l
.Ve
.PP
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install Dist::Zilla,
Dist::Zilla::PluginBundle::Author::PERLANCAR,
Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other
Dist::Zilla\- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar <perlancar@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Rinci>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.