1COVER(1)              User Contributed Perl Documentation             COVER(1)
2
3
4

NAME

6       cover - report coverage statistics
7

VERSION

9       version 1.03
10

SYNOPSIS

12        cover -help -info -version
13              -summary -report report_format -outputdir dir
14              -select filename -ignore filename
15              -select_re RE -ignore_re RE
16              -write [db] -delete -dump_db -launch
17              -silent
18              -coverage criterion
19              -test -gcov
20              -make [make]
21              -add_uncoverable_point -delete_uncoverable_point
22              -clean_uncoverable_points -uncoverable_file
23              [report specific options]
24              coverage_database [coverage_database ...]
25

DESCRIPTION

27       Report coverage statistics in a variety of formats.
28
29       The summary option produces a short textual summary.  Other reports are
30       available by using the report option.
31
32       The following reports are currently available:
33
34        text                  - detailed textual summary
35        html                  - detailed HTML reports
36        html_basic            - detailed HTML reports with syntax highlighting
37        compilation           - output in a format similar to Perl
38

OPTIONS

40       The following command line options are supported:
41
42        -h -help              - show help
43        -i -info              - show documentation
44        -v -version           - show version
45
46        -silent               - don't print informational messages (default off)
47        -summary              - give summary report                (default on)
48        -report report_format - report format                      (default html)
49        -outputdir            - directory for output               (default db)
50        -launch               - launch report in viewer (if avail) (default off)
51
52        -select filename      - only report on the file            (default all)
53        -ignore filename      - don't report on the file           (default none)
54        -select_re RE         - append to REs of files to select   (default none)
55        -ignore_re RE         - append to REs of files to ignore   (default none)
56        -write [db]           - write the merged database          (default off)
57        -delete               - drop database(s)                   (default off)
58        -dump_db              - dump database(s) (for debugging)   (default off)
59
60        -coverage criterion   - report on criterion  (default all available)
61
62        -test                 - drop database(s) and run make test (default off)
63        -gcov                 - run gcov to cover XS code     (default on if using gcc)
64        -make make_prog       - use the given 'make' program for 'make test'
65
66        other options specific to the report format
67

REPORT FORMATS

69       Tool accepts -report option:
70
71       html|html_minimal (default)
72           HTML reporting. Percentage thresholds are color-coded and
73           configurable via -report_c0 <integer>, -report_c1 <integer> and
74           -report_c2 <integer>.:
75
76               0%      75%      90%      100%
77               |   ..   |   ..   |   ..   |
78                  <c0      <c1      <c2   c3
79                  red     yellow   orange green
80
81       html_basic
82           HTML reporting with syntax highlighting if PPI::HTML or Perl::Tidy
83           module is detected. Like html|html_minimal reporting, percentage
84           thresholds are color-coded and configurable.
85
86       text
87           Plain text reporting.
88
89       compilation
90           Like text but hacked to give a minimal output in a format similar
91           to that output by Perl itself so that it's easier to step through
92           the untested locations with Emacs compilation mode.
93

DETAILS

95       Any number of coverage databases may be specified on the command line.
96       These databases will be merged and the reports will be based on the
97       merged information.  If no databases are specified the default database
98       (cover_db) will be used.
99
100       The -write option will write out the merged database.  If no name is
101       given for the new database, the first database read in will be
102       overwritten.  When this option is used no reports are generated by
103       default.
104
105       Specify -select and -ignore options to report on specific files.
106
107       Specify -coverage options to report on specific criteria.  By default
108       all available information on all criteria in all files will be
109       reported.  Available coverage options are statement, branch, condition,
110       subroutine, and pod.  However, if you know you only want coverage
111       information for certain criteria it is better to only collect data for
112       those criteria in the first place by specifying them at that point.
113       This will make the data collection and reporting processes faster and
114       less memory intensive.  See the documentation for Devel::Cover for more
115       information.
116
117       The -test option will delete the databases and run your tests to
118       generate new coverage data before reporting on it.  Devel::Cover knows
119       how to work with standard Perl Makefiles as well as Module::Build based
120       distributions.  For detailed instructions see the documentation for
121       ExtUtils::MakeMaker at
122       <https://metacpan.org/module/ExtUtils::MakeMaker> or for Module::Build
123       at <https://metacpan.org/module/Module::Build> both of which come as
124       standard in recent Perl distributions.
125
126       The -gcov option will try to run gcov on any XS code.  This requires
127       that you are using gcc of course.  If you are using the -test option
128       will be turned on by default.
129

EXIT STATUS

131       The following exit values are returned:
132
133       0   All operations were completed successfully.
134
135       >0  An error occurred.
136
137       With the -test option the exit status of the underlying test run is
138       retuened.
139

SEE ALSO

141        L<Devel::Cover>
142

BUGS

144       Did I mention that this is alpha code?
145
146       See the BUGS file.
147

LICENCE

149       Copyright 2001-2013, Paul Johnson (paul@pjcj.net)
150
151       This software is free.  It is licensed under the same terms as Perl
152       itself.
153
154       The latest version of this software should be available from my
155       homepage: http://www.pjcj.net
156
157
158
159perl v5.16.3                      2013-05-20                          COVER(1)
Impressum