local-lib5/man/man3/Test::NoTabs.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Test::NoTabs 3"
 127 .TH Test::NoTabs 3 "2009-07-03" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Test::NoTabs \- Check the presence of tabs in your project
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 \&\f(CW\*(C`Test::NoTabs\*(C'\fR lets you check the presence of tabs in your perl code. It
 137 report its results in standard \f(CW\*(C`Test::Simple\*(C'\fR fashion:
 138 .PP
 139 .Vb 2
 140 \&  use Test::NoTabs tests => 1;
 141 \&  notabs_ok( \*(Aqlib/Module.pm\*(Aq, \*(AqModule is tab free\*(Aq);
 142 .Ve
 143 .PP
 144 Module authors can include the following in a t/notabs.t and have \f(CW\*(C`Test::NoTabs\*(C'\fR
 145 automatically find and check all perl files in a module distribution:
 146 .PP
 147 .Vb 2
 148 \&  use Test::NoTabs;
 149 \&  all_perl_files_ok();
 150 .Ve
 151 .PP
 152 or
 153 .PP
 154 .Vb 2
 155 \&  use Test::NoTabs;
 156 \&  all_perl_files_ok( @mydirs );
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 This module scans your project/distribution for any perl files (scripts,
 161 modules, etc) for the presence of tabs.
 162 .SH "EXPORT"
 163 .IX Header "EXPORT"
 164 A list of functions that can be exported.  You can delete this section
 165 if you don't export anything, such as for a purely object-oriented module.
 166 .SH "FUNCTIONS"
 167 .IX Header "FUNCTIONS"
 168 .ie n .SS "all_perl_files_ok( [ @directories ] )"
 169 .el .SS "all_perl_files_ok( [ \f(CW@directories\fP ] )"
 170 .IX Subsection "all_perl_files_ok( [ @directories ] )"
 171 Applies \f(CW\*(C`notabs_ok()\*(C'\fR to all perl files found in \f(CW@directories\fR (and sub
 172 directories). If no <@directories> is given, the starting point is one level
 173 above the current running script, that should cover all the files of a typical
 174 \&\s-1CPAN\s0 distribution. A perl file is *.pl or *.pm or *.t or a file starting
 175 with \f(CW\*(C`#!...perl\*(C'\fR
 176 .PP
 177 If the test plan is defined:
 178 .PP
 179 .Vb 2
 180 \&  use Test::NoTabs tests => 3;
 181 \&  all_perl_files_ok();
 182 .Ve
 183 .PP
 184 the total number of files tested must be specified.
 185 .ie n .SS "notabs_ok( $file [, $text] )"
 186 .el .SS "notabs_ok( \f(CW$file\fP [, \f(CW$text\fP] )"
 187 .IX Subsection "notabs_ok( $file [, $text] )"
 188 Run a tab check on \f(CW$file\fR. For a module, the path (lib/My/Module.pm) or the
 189 name (My::Module) can be both used.
 190 .SH "AUTHOR"
 191 .IX Header "AUTHOR"
 192 Nick Gerakines, \f(CW\*(C`<nick at socklabs.com>\*(C'\fR
 193 .SH "BUGS"
 194 .IX Header "BUGS"
 195 Please report any bugs or feature requests to
 196 \&\f(CW\*(C`bug\-test\-notabs at rt.cpan.org\*(C'\fR, or through the web interface at
 197 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-NoTabs>.
 198 I will be notified, and then you'll automatically be notified of progress on
 199 your bug as I make changes.
 200 .SH "SUPPORT"
 201 .IX Header "SUPPORT"
 202 You can find documentation for this module with the perldoc command.
 203 .PP
 204 .Vb 1
 205 \&    perldoc Test::NoTabs
 206 .Ve
 207 .PP
 208 You can also look for information at:
 209 .IP "\(bu" 4
 210 AnnoCPAN: Annotated \s-1CPAN\s0 documentation
 211 .Sp
 212 <http://annocpan.org/dist/Test\-NoTabs>
 213 .IP "\(bu" 4
 214 \&\s-1CPAN\s0 Ratings
 215 .Sp
 216 <http://cpanratings.perl.org/d/Test\-NoTabs>
 217 .IP "\(bu" 4
 218 \&\s-1RT:\s0 \s-1CPAN\s0's request tracker
 219 .Sp
 220 <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test\-NoTabs>
 221 .IP "\(bu" 4
 222 Search \s-1CPAN\s0
 223 .Sp
 224 <http://search.cpan.org/dist/Test\-NoTabs>
 225 .SH "ACKNOWLEDGEMENTS"
 226 .IX Header "ACKNOWLEDGEMENTS"
 227 Inspired by some code written by Paul Lindner.
 228 .PP
 229 Test::Strict was used as an example when creating this module and
 230 distribution.
 231 .PP
 232 Rick Myers and Emanuele Zeppieri also provided valuable feedback.
 233 .PP
 234 Patch to fix warnings provided by Florian Ragwitz (rafl)
 235 .PP
 236 Currently maintained by Tomas Doran (t0m) \f(CW\*(C`bobtfish@bobtfish.net\*(C'\fR
 237 .SH "SEE ALSO"
 238 .IX Header "SEE ALSO"
 239 Test::More, Test::Pod. Test::Distribution, <Test:NoWarnings>
 240 .SH "COPYRIGHT & LICENSE"
 241 .IX Header "COPYRIGHT & LICENSE"
 242 Copyright 2006 Nick Gerakines, all rights reserved.
 243 .PP
 244 This program is free software; you can redistribute it and/or modify it
 245 under the same terms as Perl itself.