.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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 "CPAN::Uploader 3"
.TH CPAN::Uploader 3 2026-10-25 "perl v5.44.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 ORIGIN
.IX Header "ORIGIN"
This code is mostly derived from \f(CW\*(C`cpan\-upload\-http\*(C'\fR by Brad Fitzpatrick, which
in turn was based on \f(CW\*(C`cpan\-upload\*(C'\fR by Neil Bowers.  I (\fIrjbs\fR) didn\*(Aqt want to
have to use a \f(CW\*(C`system\*(C'\fR call to run either of those, so I refactored the code
into this module.
.PP
.Vb 1
\&  CPAN::Uploader\->upload_file($file, \e%arg);
\&
\&  $uploader\->upload_file($file);
.Ve
.PP
Valid arguments are:
.PP
.Vb 8
\&  user        \- (required) your CPAN / PAUSE id
\&  password    \- (required) your CPAN / PAUSE password
\&  subdir      \- the directory (under your home directory) to upload to
\&  http_proxy  \- uri of the http proxy to use
\&  upload_uri  \- uri of the upload handler; usually the default (PAUSE) is right
\&  debug       \- if set to true, spew lots more debugging output
\&  retries     \- number of retries to perform on upload failure (5xx response)
\&  retry_delay \- number of seconds to wait between retries
.Ve
.PP
This method attempts to actually upload the named file to the CPAN.  It will
raise an exception on error. \f(CW\*(C`upload_uri\*(C'\fR can also be set through the ENV
variable \f(CW\*(C`CPAN_UPLOADER_UPLOAD_URI\*(C'\fR.
.PP
.Vb 1
\&  my $uploader = CPAN::Uploader\->new(\e%arg);
.Ve
.PP
This method returns a new uploader.  You probably don\*(Aqt need to worry about
this method.
.PP
Valid arguments are the same as those to \f(CW\*(C`upload_file\*(C'\fR.
.PP
.Vb 1
\&  my $config = CPAN::Uploader\->read_config_file( $filename );
.Ve
.PP
This reads the config file and returns a hashref of its contents that can be
used as configuration for CPAN::Uploader.
.PP
If no filename is given, it looks for \fI.pause\fR in the user\*(Aqs home directory
(from the env var \f(CW\*(C`HOME\*(C'\fR, or the current directory if \f(CW\*(C`HOME\*(C'\fR isn\*(Aqt set).
.PP
See "CONFIGURATION" in cpan\-upload for the config format.
.PP
.Vb 1
\&  $uploader\->log($message);
.Ve
.PP
This method logs the given string.  The default behavior is to print it to the
screen.  The message should not end in a newline, as one will be added as
needed.
.PP
This method behaves like \f(CW"log"\fR, but only logs the message if the
CPAN::Uploader is in debug mode.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 25:" 4
.IX Item "Around line 25:"
Unknown directive: =method
.IP "Around line 193:" 4
.IX Item "Around line 193:"
Unknown directive: =method
.IP "Around line 211:" 4
.IX Item "Around line 211:"
Unknown directive: =method
.IP "Around line 281:" 4
.IX Item "Around line 281:"
Unknown directive: =method
.IP "Around line 296:" 4
.IX Item "Around line 296:"
Unknown directive: =method