.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "CPANCOVER 1"
.TH CPANCOVER 1 2026-03-09 "perl v5.42.0" "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
cpancover \- report coverage statistics on CPAN modules
.SH VERSION
.IX Header "VERSION"
version 1.52
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 11
\&  cpancover \-\-help \-\-info \-\-version
\&            \-\-collect \-\-redo_cpancover_html \-\-redo_html \-\-force \-\-dryrun
\&            \-\-modules module_name
\&            \-\-results_dir /path/to/dir
\&            \-\-outputdir /path/to/dir
\&            \-\-outputfile filename.html
\&            \-\-report report_name
\&            \-\-generate_html
\&            \-\-compress_old_versions number_to_keep
\&            \-\-local
\&            \-\-local_build
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SH OPTIONS
.IX Header "OPTIONS"
The following command line options are supported:
.PP
.Vb 3
\&  \-h \-\-help               \- show help
\&  \-i \-\-info               \- show documentation
\&  \-v \-\-version            \- show version
\&
\&  \-\-collect               \- collect coverage from modules       (on)
\&  \-\-compress_old_versions \- compress data older than n versions (3)
\&  \-\-directory             \- location of the modules             ($cwd)
\&  \-\-dryrun                \- don\*(Aqt execute (for some commands)   (off)
\&  \-\-force                 \- recollect coverage                  (off)
\&  \-\-generate_html         \- generate html                       (off)
\&  \-\-local                 \- use local (uninstalled) code        (off)
\&  \-\-local_build           \- build coveraage for all the modules (off)
\&  \-\-modules               \- modules to use                      (all in $dir)
\&  \-\-outputdir             \- where to store output               ($directory)
\&  \-\-outputfile            \- top level index                     (coverage.html)
\&  \-\-redo_cpancover_html   \- don\*(Aqt set default modules           (off)
\&  \-\-redo_html             \- force html generation for modules   (off)
\&  \-\-report                \- report to use                       (html_basic)
.Ve
.SH DETAILS
.IX Header "DETAILS"
.SH REQUIREMENTS
.IX Header "REQUIREMENTS"
Collect coverage for results and create html, csv and json output.
.PP
The modules Template and Parallel::Iterator are required.
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
The following exit values are returned:
.IP 0 4
All operations were completed successfully.
.IP >0 4
.IX Item ">0"
An error occurred.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Devel::Cover
.SH LICENCE
.IX Header "LICENCE"
Copyright 2002\-2026, Paul Johnson (paul@pjcj.net)
.PP
This software is free.  It is licensed under the same terms as Perl itself.
.PP
The latest version of this software should be available from my homepage:
https://pjcj.net