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

FreeBSD Manual Pages

  
 
  

home | help
Sympa::ConfDef(3Sympa)		 sympa 6.2.16		Sympa::ConfDef(3Sympa)

NAME
       Sympa::ConfDef -	Definition of site and robot configuration parameters

DESCRIPTION
       This module keeps definition of configuration parameters	for site
       default and each	robot.

   Global variable
       @params
	   Includes following items in order parameters	are shown.

	   "{ gettext_id => TITLE }"
	       Title for the group of parameters following.

	   "{ name => NAME, DEFINITIONS, ... }"
	       Definition of parameter.	 DEFINITIONS may contain following
	       pairs.

	       name => NAME
		   Name	of the parameter.

	       file => FILE
		   Conf	file where the parameter is defined.  If omitted, the
		   parameter won't be added automatically to the config	file,
		   even	if a default is	set.  "wwsympa.conf" is	a synonym of
		   "sympa.conf".  It remains there in order to migrating older
		   versions of config.

	       default => VALUE
		   Default value.  DON'T SET AN	EMPTY DEFAULT VALUE! It's
		   useless and can lead	to errors on fresh install.

	       gettext_id => STRING
		   Description of the parameter.

	       gettext_comment => STRING
		   Additionnal advice concerning the parameter.

	       sample => STRING
		   FIXME FIXME

	       edit => 1|0
		   This	defines	the parameters to be edited.

	       optional	=> 1|0
		   FIXME FIXME

	       vhost =>	1|0
		   If 1, the parameter can have	a specific value in a virtual
		   host.

	       db => OPTION
		   'db_first', 'file_first' or 'no'.

	       obfuscated => 1|0
		   FIXME FIXME

	       multiple	=> 1|0
		   If 1, the parameter can have	multiple values. Default is 0.

	       scenario	=> 1|0
		   If 1, the parameter is the name of scenario.

SEE ALSO
       sympa.conf(5), robot.conf(5).

6.2.16				  2016-01-06		Sympa::ConfDef(3Sympa)

NAME | DESCRIPTION | SEE ALSO

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

home | help