.\" 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::Aliases::Template 3Sympa" .TH Sympa::Aliases::Template 3Sympa "2020-12-30" "6.2.58" "sympa 6.2.58" .\" 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::Aliases::Template \- Alias management: Aliases file based on template .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 6 \& use Sympa::Aliases; \& my $aliases = Sympa::Aliases\->new(\*(AqTemplate\*(Aq, \& [ file => \*(Aq/path/to/file\*(Aq ] ); \& $aliases\->check(\*(Aqlistname\*(Aq, \*(Aqdomain\*(Aq); \& $aliases\->add($list); \& $aliases\->del($list); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Sympa::Aliases::Template manages list aliases based on template \&\fIlist_aliases.tt2\fR. .SS "Methods" .IX Subsection "Methods" .ie n .IP "check ( $listname, $domain )" 4 .el .IP "check ( \f(CW$listname\fR, \f(CW$domain\fR )" 4 .IX Item "check ( $listname, $domain )" See Sympa::Aliases::CheckSMTP. .ie n .IP "add ( $list )" 4 .el .IP "add ( \f(CW$list\fR )" 4 .IX Item "add ( $list )" .PD 0 .ie n .IP "del ( $list )" 4 .el .IP "del ( \f(CW$list\fR )" 4 .IX Item "del ( $list )" .PD Adds or removes aliases of list \f(CW$list\fR. .Sp If constructor was called with \f(CW\*(C`file\*(C'\fR option, it will be used as aliases file and \fIsympa_newaliases\fR utility will not be executed. Otherwise, value of \f(CW\*(C`sendmail_aliases\*(C'\fR parameter will be used as aliases file and \fIsympa_newaliases\fR utility will be executed to update alias database. If \f(CW\*(C`sendmail_aliases\*(C'\fR parameter is set to \f(CW\*(C`none\*(C'\fR, aliases will never be updated. .SS "Configuration parameters" .IX Subsection "Configuration parameters" .IP "return_path_suffix" 4 .IX Item "return_path_suffix" Suffix of list return address. .IP "sendmail_aliases" 4 .IX Item "sendmail_aliases" Path of the file that contains all list related aliases. .IP "tmpdir" 4 .IX Item "tmpdir" A directory temporary files are placed. .SH "FILES" .IX Header "FILES" .IP "\fI\f(CI$SYSCONFDIR\fI/\fIdomain name\fI/list_aliases.tt2\fR" 4 .IX Item "$SYSCONFDIR/domain name/list_aliases.tt2" .PD 0 .IP "\fI\f(CI$SYSCONFDIR\fI/list_aliases.tt2\fR" 4 .IX Item "$SYSCONFDIR/list_aliases.tt2" .IP "\fI\f(CI$DEFAULTDIR\fI/list_aliases.tt2\fR" 4 .IX Item "$DEFAULTDIR/list_aliases.tt2" .PD Template of aliases: Specific to a domain, global context and the default. .IP "\fI\f(CI$SENDMAIL_ALIASES\fI\fR" 4 .IX Item "$SENDMAIL_ALIASES" Default location of aliases file. .IP "\fI\f(CI$SBINDIR\fI/sympa_newaliases\fR" 4 .IX Item "$SBINDIR/sympa_newaliases" Auxiliary program to update alias database. .SH "SEE ALSO" .IX Header "SEE ALSO" Sympa::Aliases, Sympa::Aliases::CheckSMTP, \&\fBsympa_newaliases\fR\|(1). .SH "HISTORY" .IX Header "HISTORY" \&\fIalias_manager.pl\fR to manage aliases using template appeared on Sympa 3.1b.13. .PP Sympa::Aliases::Template module appeared on Sympa 6.2.23b, and it obsoleted \fI\f(BIalias_manager\fI\|(8)\fR.