.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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 "Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup 3pm"
.TH Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup 3pm "2021-02-28" "perl v5.32.1" "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"
Perl::Critic::Policy::Documentation::ProhibitBadAproposMarkup \- don't use C<> markup in a NAME section
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR
add-on.  It asks you not to write C<> markup in the \s-1NAME\s0 section of
the \s-1POD\s0 because it comes out badly in the man-db \*(L"apropos\*(R" database.  For
example,
.PP
.Vb 1
\&    =head1 NAME
\&
\&    foo \- like the C<bar> program     # bad
.Ve
.PP
\&\f(CW\*(C`pod2man\*(C'\fR formats \*(L"C<>\*(R" using nroff macros which \*(L"man\-db\*(R"'s
\&\f(CW\*(C`lexgrog\*(C'\fR program doesn't expand, resulting in unattractive description
lines from \f(CW\*(C`apropos\*(C'\fR like
.PP
.Vb 1
\&    foo \- like the *(C\`bar*(C\*(Aq program
.Ve
.PP
Man's actual formatted output is fine, and the desired text is in there,
just surrounded by \f(CW\*(C`*(C\*(C'\fR bits.  On that basis this policy is low severity
and under the \*(L"cosmetic\*(R" theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic).
.PP
The \s-1NAME\s0 section is everything from \f(CW\*(C`=head1 NAME\*(C'\fR to the next \f(CW\*(C`=head1\*(C'\fR.
Other markup like \*(L"B<>\*(R", \*(L"I<>\*(R" and \*(L"F<>\*(R" is allowed
because \f(CW\*(C`pod2man\*(C'\fR uses builtin \f(CW\*(C`\efB\*(C'\fR etc directives for them, which
\&\f(CW\*(C`lexgrog\*(C'\fR recognises.
.PP
\&\f(CW\*(C`=begin :man\*(C'\fR and \f(CW\*(C`=begin :roff\*(C'\fR blocks are checked since \f(CW\*(C`Pod::Man\*(C'\fR
processes those.  Other \f(CW\*(C`=begin\*(C'\fR blocks are ignored as they won't appear in
the roff output.
.SS "Disabling"
.IX Subsection "Disabling"
If want markup in the \s-1NAME\s0 line, perhaps if printed output is more important
than \f(CW\*(C`apropos\*(C'\fR, then you can always disable from your \fI.perlcriticrc\fR in
the usual way (see \*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic),
.PP
.Vb 1
\&    [\-Documentation::ProhibitBadAproposMarkup]
.Ve
.PP
Or in an individual file with the usual \f(CW\*(C`## no critic\*(C'\fR
.PP
.Vb 1
\&    ## no critic (ProhibitBadAproposMarkup)
.Ve
.PP
though if the \s-1NAME\s0 part is after an \f(CW\*(C`_\|_END_\|_\*(C'\fR token then \f(CW\*(C`Perl::Critic\*(C'\fR
1.112 or higher is required (and the annotation must be before the
\&\f(CW\*(C`_\|_END_\|_\*(C'\fR).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Pulp,
Perl::Critic,
Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName,
Perl::Critic::Policy::Documentation::RequirePodSections,
Perl::Critic::Policy::Documentation::ProhibitVerbatimMarkup
.PP
\&\fBman\fR\|(1), \fBapropos\fR\|(1), \fBlexgrog\fR\|(1)
.SH "HOME PAGE"
.IX Header "HOME PAGE"
<http://user42.tuxfamily.org/perl\-critic\-pulp/index.html>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2019, 2021 Kevin Ryde
.PP
Perl-Critic-Pulp is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.
.PP
Perl-Critic-Pulp is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0
or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0 General Public License for
more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along with
Perl-Critic-Pulp.  If not, see <http://www.gnu.org/licenses/>.