.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "CPANPLUS::Shell::Default::Plugins::CustomSource 3"
.TH CPANPLUS::Shell::Default::Plugins::CustomSource 3 2023-07-25 "perl v5.38.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
CPANPLUS::Shell::Default::Plugins::CustomSource \- add custom sources to CPANPLUS
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    ### elaborate help text
\&    CPAN Terminal> /? cs
\&
\&    ### add a new custom source
\&    CPAN Terminal> /cs \-\-add file:///path/to/releases
\&
\&    ### list all your custom sources by
\&    CPAN Terminal> /cs \-\-list
\&
\&    ### display the contents of a custom source by URI or ID
\&    CPAN Terminal> /cs \-\-contents file:///path/to/releases
\&    CPAN Terminal> /cs \-\-contents 1
\&
\&    ### Update a custom source by URI or ID
\&    CPAN Terminal> /cs \-\-update file:///path/to/releases
\&    CPAN Terminal> /cs \-\-update 1
\&
\&    ### Remove a custom source by URI or ID
\&    CPAN Terminal> /cs \-\-remove file:///path/to/releases
\&    CPAN Terminal> /cs \-\-remove 1
\&
\&    ### Write an index file for a custom source, to share
\&    ### with 3rd parties or remote users
\&    CPAN Terminal> /cs \-\-write file:///path/to/releases
\&
\&    ### Make sure to save your sources when adding/removing
\&    ### sources, so your changes are reflected in the cache:
\&    CPAN Terminal> x
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a \f(CW\*(C`CPANPLUS::Shell::Default\*(C'\fR plugin that can add
custom sources to your CPANPLUS installation. This is a
wrapper around the \f(CW\*(C`custom module sources\*(C'\fR code as outlined
in "CUSTOM MODULE SOURCES" in CPANPLUS::Backend.
.PP
This allows you to extend your index of available modules
beyond what's available on \f(CW\*(C`CPAN\*(C'\fR with your own local
distributions, or ones offered by third parties.