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

NAME

6       cover - report coverage statistics
7

SYNOPSIS

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

DESCRIPTION

23       Report coverage statistics in a variety of formats.
24
25       The summary option produces a short textual summary.  Other reports are
26       available by using the report option.
27
28       The following reports are currently available:
29
30        text                  - detailed textual summary
31        html                  - detailed HTML reports
32

OPTIONS

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

DETAILS

61       Any number of coverage databases may be specified on the command line.
62       These databases will be merged and the reports will be based on the
63       merged information.  If no databases are specified the default database
64       (cover_db) will be used.
65
66       The -write option will write out the merged database.  If no name is
67       given for the new database, the first database read in will be over‐
68       written.  When this option is used no reports are generated by default.
69
70       Specify -select and -ignore options to report on specific files.  Spec‐
71       ify -coverage options to report on specific criteria.  By default all
72       available information on all criteria in all files will be reported.
73
74       The -test option will delete the databases and run make test to gener‐
75       ate new coverage data before reporting on it.  The -gcov option will
76       try to run gcov on any XS code.  This requires that you are using gcc
77       of course.  If you are this option will be turned on by default.
78

EXIT STATUS

80       The following exit values are returned:
81
82       0   All operaions were completed successfully.
83
84       >0  An error occurred.
85

SEE ALSO

87        Devel::Cover
88

BUGS

90       Did I mention that this is alpha code?
91
92       See the BUGS file.
93

VERSION

95       Version 0.61 - 10th January 2007
96

LICENCE

98       Copyright 2001-2007, Paul Johnson (pjcj@cpan.org)
99
100       This software is free.  It is licensed under the same terms as Perl
101       itself.
102
103       The latest version of this software should be available from my home‐
104       page: http://www.pjcj.net
105
106
107
108perl v5.8.8                       2007-01-10                          COVER(1)
Impressum