.\" 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::RequireFilenameMarkup 3pm"
.TH Perl::Critic::Policy::Documentation::RequireFilenameMarkup 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::RequireFilenameMarkup \- markup /foo filenames
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This policy is part of the \f(CW\*(C`Perl::Critic::Pulp\*(C'\fR
add-on.  It asks you to use \f(CW\*(C`F<>\*(C'\fR or other markup on filenames.
.PP
.Vb 1
\&    /usr/bin       # bad
\&
\&    F</usr/bin>    # ok
\&    C</bin/sh>     # ok
.Ve
.PP
\&\f(CW\*(C`F<>\*(C'\fR lets the formatters show filenames in a usual way, such as
italics in man pages.  This can help human readability but is a minor matter
and on that basis this policy is lowest severity and under the \*(L"cosmetic\*(R"
theme (see \*(L"\s-1POLICY THEMES\*(R"\s0 in Perl::Critic).
.PP
Filenames in text are identified by likely forms.  Currently words starting
as follows are considered filenames.  \fI/usr\fR and \fI/etc\fR are the most
common.
.PP
.Vb 9
\&    /bin
\&    /dev      
\&    /etc
\&    /opt         # some proprietary Unix
\&    /proc
\&    /tmp
\&    /usr
\&    /var
\&    C:\e          # MS\-DOS
.Ve
.PP
Any markup on a filename satisfies this policy.  \f(CW\*(C`F<>\*(C'\fR is usual,
but \f(CW\*(C`C<>\*(C'\fR might suit for instance \f(CW\*(C`C</bin/sh>\*(C'\fR to show
it's a command with path rather than a file as such.
.PP
\&\f(CW\*(C`=begin :foo\*(C'\fR blocks with <:> \s-1POD\s0 type are checked since they can have
markup.  \*(L"Verbatim\*(R" paragraphs are ignored since of course they cannot have
markup.
.SS "Disabling"
.IX Subsection "Disabling"
If you don't care about filename markup you can disable
\&\f(CW\*(C`RequireFilenameMarkup\*(C'\fR from your \fI.perlcriticrc\fR in the usual way (see
\&\*(L"\s-1CONFIGURATION\*(R"\s0 in Perl::Critic),
.PP
.Vb 1
\&    [\-Documentation::RequireFilenameMarkup]
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Perl::Critic::Pulp,
Perl::Critic
.SH "HOME PAGE"
.IX Header "HOME PAGE"
<http://user42.tuxfamily.org/perl\-critic\-pulp/index.html>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 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/>.