Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Sympa::ListDef(3Sympa)		 sympa 6.2.56		Sympa::ListDef(3Sympa)

NAME
       Sympa::ListDef -	Definition of list configuration parameters

DESCRIPTION
       This module keeps definition of configuration parameters	for each list.

   Global variable
       %alias
	   Deprecated by Sympa 6.2.16.

       %pinfo
	   This	hash COMPLETELY	defines	ALL list parameters.  It is then used
	   to load, save, view,	edit list config files.

	   List	parameters format accepts the following	keywords :

	   format
	       Regexp applied to the configuration file	entry.	Or arrayref
	       containing all possible values of parameter.

	       Or, if the parameter is paragraph, value	of this	item is	a
	       hashref containing definitions of sub-parameters.

	       See also	"Node types" in	Sympa::List::Config.

	   format_s
	       Template	of regexp applied to the configuration file entry; see
	       also "format".

	       Subpatterns $word indicate the name of pattern defined in
	       Sympa::Regexps.

	       This was	introduced on Sympa 6.2.19b.2.

	   file_format
	       Config file format of the parameter might not be	the same in
	       memory.

	   split_char
	       Character used to separate multiple parameters.	Used with the
	       set or the array	of scalars.

	   length
	       Length of a scalar variable ; used in web forms.

	   scenario
	       Tells that the parameter	is a scenario, providing its name.

	   default
	       Default value for the param ; may be a robot configuration
	       parameter (conf).

	       If occurrence is	"0-1" or "0-n",	default	value will be assigned
	       only when list is created or new	node is	added to
	       configuration.

	   synonym
	       Defines synonyms	for parameter values (for compatibility
	       reasons).

	   gettext_unit
	       Unit of the parameter ; this is used in web forms and refers to
	       translated strings in NLS catalogs.

	   occurrence
	       Occurrence of the parameter in the config file possible values:
	       "0-1", 1, "0-n" and "1-n".  Example: A list may have multiple
	       owner.

	       See also	"Node types" in	Sympa::List::Config.

	   gettext_id
	       Title reference in NLS catalogs.

	   gettext_comment
	       Description text	of a parameter.

	   group
	       Group of	parameters.

	   obsolete
	       Obsolete	parameter ; should not be displayed nor	saved.

	       As of 6.2.16, if	the value is true value	and is not 1, defines
	       parameter alias name mainly for backward	compatibility.

	   obsolete_values
	       Deprecated.

	       Defined obsolete	values for a parameter.	 These values should
	       not get proposed	on the web interface edition form.

	   order
	       Order of	parameters within paragraph.

	   internal
	       Indicates that the parameter is an internal parameter that
	       should always be	saved in the config file.

	   field_type
	       Used to special treatment of parameter value to show it.

	       'dayofweek'
		   Day of week,	0 - 6.

	       'lang'
		   Language tag.

	       'password'
		   The value to	be concealed.

	       'reception'
		   Reception mode of list member.

	       'status'
		   Status of list.

	       'listtopic'
		   List	topic.

	       'unixtime'
		   The time in second from Unix	epoch.

	       'visibility'
		   Visibility mode of list member.

	       Most of field types were	introduced on Sympa 6.2.17.

	   filters
	       See "Filters" in	Sympa::List::Config.

	       Introduced on Sympa 6.2.17.

	   validations
	       See "Validations" in Sympa::List::Config.

	       Introduced on Sympa 6.2.17.

	   privilege
	       Dynamically assigned.  Privilege	for specified user: 'write',
	       'read' or 'hidden'.

	       Introduced on Sympa 6.2.17.

	   enum
	       Automatically assigned.	TBD.

	       Introduced on Sympa 6.2.17.

SEE ALSO
       list_config(5), Sympa::List::Config, Sympa::ListOpt.

HISTORY
       Sympa::ListDef was separated from List module on	Sympa 6.2.

6.2.56				  2020-05-24		Sympa::ListDef(3Sympa)

NAME | DESCRIPTION | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Sympa::ListDef&sektion=3sympa&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help