.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sympa::CLI 3Sympa"
.TH Sympa::CLI 3Sympa "2022-11-25" "6.2.70" "sympa 6.2.70"
.\" 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"
Sympa::CLI \- Base class of Sympa CLI modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package Sympa::CLI::mycommand;
\&  use parent qw(Sympa::CLI);
\&  
\&  use constant _options   => qw(...);
\&  use constant _args      => qw(...);
\&  use constant _need_priv => 0;
\&  
\&  sub _run {
\&      my $class   = shift;
\&      my $options = shift;
\&      my @argv    = @_;
\&  
\&      #... Do the job...
\&      exit 0;
\&  }
.Ve
.PP
This will implement the function of \fIsympa mycommand\fR.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Sympa::CLI is the base class of the classes which defines particular
command of command line utility.
\&\s-1TBD.\s0
.SS "Methods subclass should implement"
.IX Subsection "Methods subclass should implement"
.IP "_options ( )" 4
.IX Item "_options ( )"
\&\fIClass method\fR, \fIoverridable\fR.
Returns an array to define command line options.
About the format see \*(L"Summary of Option Specifications\*(R" in Getopt::Long.
.Sp
By default no options are defined.
.IP "_args ( )" 4
.IX Item "_args ( )"
\&\fIClass method\fR, \fIoverridable\fR.
Returns an array to define mandatory arguments.
\&\s-1TBD.\s0
.Sp
By default no mandatory arguments are defined.
.IP "_need_priv ( )" 4
.IX Item "_need_priv ( )"
\&\fIClass method\fR, \fIoverridable\fR.
If this returns true value (the default), the program tries getting privileges
of Sympa user, prepare database connection, loading main configuration
and then setting language according to configuration.
Otherwise, it sets language according to locale setting of console.
.IP "_log_to_stderr ( )" 4
.IX Item "_log_to_stderr ( )"
\&\fIClass method\fR, \fIoverridable\fR.
If this returns true value, output by logging facility will be redirected
to standard error output (stderr).
.Sp
By default redirection is disabled.
.ie n .IP "_run ( \e$options, @argv )" 4
.el .IP "_run ( \e$options, \f(CW@argv\fR )" 4
.IX Item "_run ( $options, @argv )"
\&\fIClass method\fR, \fImandatory\fR.
If the program is invoked, command line options are parsed as \fB_options()\fR
defines, arguments are checked as \fB_args()\fR defines and this method is called.
.SS "Subcommands"
.IX Subsection "Subcommands"
To implement a subcommand, simply create a submodule inheriting the module
for parent command:
.PP
.Vb 3
\&  package Sympa::CLI::mycommand::subcommand;
\&  use parent qw(Sympa::CLI::mycommand);
\&  ...
.Ve
.PP
Then this will implement the function of \fIsympa mycommand subcommand\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa\fR\|(1).
.SH "HISTORY"
.IX Header "HISTORY"
Sympa::CLI appeared on Sympa 6.2.68.