.\" 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::Config::Schema 3Sympa"
.TH Sympa::Config::Schema 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::ListDef \- Definition of list configuration parameters
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module keeps definition of configuration parameters for each list.
.SS "Global variable"
.IX Subsection "Global variable"
.ie n .IP "%alias" 4
.el .IP "\f(CW%alias\fR" 4
.IX Item "%alias"
Deprecated by Sympa 6.2.16.
.ie n .IP "%pgroup" 4
.el .IP "\f(CW%pgroup\fR" 4
.IX Item "%pgroup"
\&\s-1TBD.\s0
.ie n .IP "%pinfo" 4
.el .IP "\f(CW%pinfo\fR" 4
.IX Item "%pinfo"
This hash \s-1COMPLETELY\s0 defines \s-1ALL\s0 list parameters.
It is then used to load, save, view, edit list config files.
.Sp
List parameters format accepts the following keywords :
.RS 4
.IP "context" 4
.IX Item "context"
\&\s-1TBD.\s0
.Sp
Introduced on Sympa 6.2.57b.
.IP "format" 4
.IX Item "format"
Regexp applied to the configuration file entry.
Or arrayref containing all possible values of parameter.
.Sp
Or, if the parameter is paragraph, value of this item is a hashref containing
definitions of sub-parameters.
.Sp
See also \*(L"Node types\*(R" in Sympa::List::Config.
.IP "format_s" 4
.IX Item "format_s"
Template of regexp applied to the configuration file entry;
see also \*(L"format\*(R".
.Sp
Subpatterns \f(CW$word\fR indicate the name of pattern defined in
Sympa::Regexps.
.Sp
This was introduced on Sympa 6.2.19b.2.
.IP "file_format" 4
.IX Item "file_format"
Config file format of the parameter might not be
the same in memory.
.IP "split_char" 4
.IX Item "split_char"
Character used to separate multiple parameters.
Used with the set or the array of scalars.
.IP "length" 4
.IX Item "length"
Length of a scalar variable ; used in web forms.
.IP "scenario" 4
.IX Item "scenario"
Tells that the parameter is a scenario, providing its name.
.IP "default" 4
.IX Item "default"
Default value for the param ; may be a robot configuration
parameter (conf).
.Sp
If occurrence is \f(CW\*(C`0\-1\*(C'\fR or \f(CW\*(C`0\-n\*(C'\fR,
default value will be assigned
only when list is created or new node is added to configuration.
.IP "default_s" 4
.IX Item "default_s"
Template of constant used as default value in configuration file entry;
see also \*(L"default\*(R".
.Sp
Subpatterns \f(CW$WORD\fR indicate the name of constant defined in
Sympa::Constants.
.IP "synonym" 4
.IX Item "synonym"
Defines synonyms for parameter values (for compatibility
reasons).
.IP "gettext_unit" 4
.IX Item "gettext_unit"
Unit of the parameter ; this is used in web forms and refers
to translated
strings in \s-1NLS\s0 catalogs.
.IP "occurrence" 4
.IX Item "occurrence"
Occurrence of the parameter in the config file
possible values: \f(CW\*(C`0\-1\*(C'\fR, \f(CW1\fR, \f(CW\*(C`0\-n\*(C'\fR and \f(CW\*(C`1\-n\*(C'\fR.
Example: A list may have multiple owner.
.Sp
See also \*(L"Node types\*(R" in Sympa::List::Config.
.IP "gettext_id" 4
.IX Item "gettext_id"
Title reference in \s-1NLS\s0 catalogs.
.IP "gettext_comment" 4
.IX Item "gettext_comment"
Description text of a parameter.
.IP "group" 4
.IX Item "group"
Group of parameters.
.IP "obsolete" 4
.IX Item "obsolete"
Obsolete parameter ; should not be displayed
nor saved.
.Sp
As of 6.2.16, if the value is true value and is not \f(CW1\fR,
it defines reference to a fully upper-compatible new parameter.
.IP "obsolete_values" 4
.IX Item "obsolete_values"
\&\fBDeprecated\fR.
.Sp
Defined obsolete values for a parameter.
These values should not get proposed on the web interface
edition form.
.IP "not_before, not_after" 4
.IX Item "not_before, not_after"
The duration between these versions (inclusive) during which the parameter
is available.
.Sp
Introduced on Sympa 6.2.65b.
.IP "order" 4
.IX Item "order"
Order of parameters within paragraph.
.IP "internal" 4
.IX Item "internal"
Indicates that the parameter is an internal parameter
that should always be saved in the config file.
.IP "field_type" 4
.IX Item "field_type"
Used to special treatment of parameter value to show it.
.RS 4
.ie n .IP "\*(Aqdayofweek\*(Aq" 4
.el .IP "\f(CW\*(Aqdayofweek\*(Aq\fR" 4
.IX Item "dayofweek"
Day of week, \f(CW0\fR \- \f(CW6\fR.
.ie n .IP "\*(Aqlang\*(Aq" 4
.el .IP "\f(CW\*(Aqlang\*(Aq\fR" 4
.IX Item "lang"
Language tag.
.ie n .IP "\*(Aqpassword\*(Aq" 4
.el .IP "\f(CW\*(Aqpassword\*(Aq\fR" 4
.IX Item "password"
The value to be concealed.
.ie n .IP "\*(Aqreception\*(Aq" 4
.el .IP "\f(CW\*(Aqreception\*(Aq\fR" 4
.IX Item "reception"
Reception mode of list member.
.ie n .IP "\*(Aqstatus\*(Aq" 4
.el .IP "\f(CW\*(Aqstatus\*(Aq\fR" 4
.IX Item "status"
Status of list.
.ie n .IP "\*(Aqlisttopic\*(Aq" 4
.el .IP "\f(CW\*(Aqlisttopic\*(Aq\fR" 4
.IX Item "listtopic"
List topic.
.ie n .IP "\*(Aqunixtime\*(Aq" 4
.el .IP "\f(CW\*(Aqunixtime\*(Aq\fR" 4
.IX Item "unixtime"
The time in second from Unix epoch.
.ie n .IP "\*(Aqvisibility\*(Aq" 4
.el .IP "\f(CW\*(Aqvisibility\*(Aq\fR" 4
.IX Item "visibility"
Visibility mode of list member.
.RE
.RS 4
.Sp
Most of field types were introduced on Sympa 6.2.17.
.RE
.IP "filters" 4
.IX Item "filters"
See \*(L"Filters\*(R" in Sympa::List::Config.
.Sp
Introduced on Sympa 6.2.17.
.IP "validations" 4
.IX Item "validations"
See \*(L"Validations\*(R" in Sympa::List::Config.
.Sp
Introduced on Sympa 6.2.17.
.IP "privilege" 4
.IX Item "privilege"
\&\fIDynamically assigned\fR.
Privilege for specified user:
\&\f(CW\*(Aqwrite\*(Aq\fR, \f(CW\*(Aqread\*(Aq\fR or \f(CW\*(Aqhidden\*(Aq\fR.
.Sp
Introduced on Sympa 6.2.17.
.IP "enum" 4
.IX Item "enum"
\&\fIAutomatically assigned\fR.
\&\s-1TBD.\s0
.Sp
Introduced on Sympa 6.2.17.
.IP "file" 4
.IX Item "file"
Conf file where the parameter is defined.
\&\*(L"wwsympa.conf\*(R" is a synonym of \*(L"sympa.conf\*(R".
It remains there in order to migrating older versions of config.
.IP "db" 4
.IX Item "db"
\&'db_first', 'file_first' or 'no'.
\&\s-1TBD.\s0
.IP "importance" 4
.IX Item "importance"
Importance of the parameter. The value \f(CW100\fR means \*(L"minimal\*(R",
i.e. included in a set of parameters explicitly described
in the installation instruction.
\&\f(CW0\fR (default) means no importance.
This was introduced on 6.2.69b.
.RE
.RS 4
.RE
.ie n .IP "%user_info" 4
.el .IP "\f(CW%user_info\fR" 4
.IX Item "%user_info"
\&\s-1TBD.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlist_config\fR\|(5),
Sympa::List::Config,
Sympa::ListOpt.
.PP
\&\fBsympa.conf\fR\|(5), \fBrobot.conf\fR\|(5).
.SH "HISTORY"
.IX Header "HISTORY"
Sympa::ListDef was separated from List module on Sympa 6.2.
On Sympa 6.2.57b, its content was moved to Sympa::Config::Schema.
.PP
confdef was separated from Conf on Sympa 6.0a,
and renamed to Sympa::ConfDef on 6.2a.39.
On Sympa 6.2.57b, its content was moved to Sympa::Config::Schema.
.PP
Descriptions of parameters in this source file were partially taken from
chapters \*(L"sympa.conf parameters\*(R" in
\&\fISympa, Mailing List Management Software \- Reference manual\fR, written by
Serge Aumont, Stefan Hornburg, Soji Ikeda, Olivier Salau\*:n and
David Verdin.