.\" 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 1"
.TH SYMPA 1 "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, sympa.pl \- Command line utility to manage Sympa
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\f(CW\*(C`sympa\*(C'\fR \fIcommand\fR [ \fIgeneral options\fR... ] ...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fB\s-1NOTE\s0\fR:
On overview of Sympa documentation see \fBsympa_toc\fR\|(1).
.PP
\&\fIsympa\fR is invoked from command line then performs various administration
tasks.
.SH "GENERAL OPTIONS"
.IX Header "GENERAL OPTIONS"
\&\fIsympa\fR may run with following options in general.
.ie n .IP """\-d"", ""\-\-debug""" 4
.el .IP "\f(CW\-d\fR, \f(CW\-\-debug\fR" 4
.IX Item "-d, --debug"
Enable debug mode.
.ie n .IP """\-f"", ""\-\-config=""\fIfile\fR" 4
.el .IP "\f(CW\-f\fR, \f(CW\-\-config=\fR\fIfile\fR" 4
.IX Item "-f, --config=file"
Force Sympa to use an alternative configuration file instead
of \fI/etc/sympa/sympa/sympa.conf\fR.
.ie n .IP """\-l"", ""\-\-lang=""\fIlang\fR" 4
.el .IP "\f(CW\-l\fR, \f(CW\-\-lang=\fR\fIlang\fR" 4
.IX Item "-l, --lang=lang"
Set this option to use a language for Sympa. The corresponding
gettext catalog file must be located in \fI\f(CI$LOCALEDIR\fI\fR
directory.
.ie n .IP """\-\-log_level=""\fIlevel\fR" 4
.el .IP "\f(CW\-\-log_level=\fR\fIlevel\fR" 4
.IX Item "--log_level=level"
Sets Sympa log level.
.ie n .IP """\-m"", ""\-\-mail""" 4
.el .IP "\f(CW\-m\fR, \f(CW\-\-mail\fR" 4
.IX Item "-m, --mail"
Enable \s-1SMTP\s0 logging.
.SH "COMMANDS"
.IX Header "COMMANDS"
Currently following commands are available.
To see detail of each command, run '\f(CW\*(C`sympa help\*(C'\fR \fIcommand\fR'.
.ie n .IP """sympa add""" 4
.el .IP "``sympa add''" 4
.IX Item "sympa add"
Add users to the list
.ie n .IP """sympa bouncers""" 4
.el .IP "``sympa bouncers''" 4
.IX Item "sympa bouncers"
Manipulate list bounced users
.ie n .IP """sympa check""" 4
.el .IP "``sympa check''" 4
.IX Item "sympa check"
Check environment
.ie n .IP """sympa close""" 4
.el .IP "``sympa close''" 4
.IX Item "sympa close"
Close a list or the lists belonging to a family
.ie n .IP """sympa conf_2_db""" 4
.el .IP "``sympa conf_2_db''" 4
.IX Item "sympa conf_2_db"
Load config into the database
.ie n .IP """sympa config""" 4
.el .IP "``sympa config''" 4
.IX Item "sympa config"
Manipulate configuration of Sympa
.ie n .IP """sympa copy""" 4
.el .IP "``sympa copy''" 4
.IX Item "sympa copy"
Copy the list
.ie n .IP """sympa create""" 4
.el .IP "``sympa create''" 4
.IX Item "sympa create"
Create a list
.ie n .IP """sympa del""" 4
.el .IP "``sympa del''" 4
.IX Item "sympa del"
Delete users from the list
.ie n .IP """sympa dump""" 4
.el .IP "``sympa dump''" 4
.IX Item "sympa dump"
Dump users of the lists
.ie n .IP """sympa export_list""" 4
.el .IP "``sympa export_list''" 4
.IX Item "sympa export_list"
\&\s-1TBD\s0
.ie n .IP """sympa help""" 4
.el .IP "``sympa help''" 4
.IX Item "sympa help"
Display help information about Sympa \s-1CLI\s0
.ie n .IP """sympa include""" 4
.el .IP "``sympa include''" 4
.IX Item "sympa include"
Update inclusion
.ie n .IP """sympa instantiate""" 4
.el .IP "``sympa instantiate''" 4
.IX Item "sympa instantiate"
Instantiate the lists in a family
.ie n .IP """sympa lowercase""" 4
.el .IP "``sympa lowercase''" 4
.IX Item "sympa lowercase"
Lowercase email addresses in database
.ie n .IP """sympa make_alias_file""" 4
.el .IP "``sympa make_alias_file''" 4
.IX Item "sympa make_alias_file"
Create aliases file
.ie n .IP """sympa md5_digest""" 4
.el .IP "``sympa md5_digest''" 4
.IX Item "sympa md5_digest"
Output a \s-1MD5\s0 digest
.ie n .IP """sympa move""" 4
.el .IP "``sympa move''" 4
.IX Item "sympa move"
Move or copy the list
.ie n .IP """sympa open""" 4
.el .IP "``sympa open''" 4
.IX Item "sympa open"
Open the list
.ie n .IP """sympa rebuildarc""" 4
.el .IP "``sympa rebuildarc''" 4
.IX Item "sympa rebuildarc"
Rebuild the archives of the list
.ie n .IP """sympa reload_list_config""" 4
.el .IP "``sympa reload_list_config''" 4
.IX Item "sympa reload_list_config"
Recreate config cache of the lists
.ie n .IP """sympa restore""" 4
.el .IP "``sympa restore''" 4
.IX Item "sympa restore"
Restore users of the lists
.ie n .IP """sympa review""" 4
.el .IP "``sympa review''" 4
.IX Item "sympa review"
Show subscribers of the list
.ie n .IP """sympa send_digest""" 4
.el .IP "``sympa send_digest''" 4
.IX Item "sympa send_digest"
Send digest
.ie n .IP """sympa show_pending_lists""" 4
.el .IP "``sympa show_pending_lists''" 4
.IX Item "sympa show_pending_lists"
Show pending lists
.ie n .IP """sympa sync_list_db""" 4
.el .IP "``sympa sync_list_db''" 4
.IX Item "sympa sync_list_db"
Synchronize database cache of the lists
.ie n .IP """sympa update""" 4
.el .IP "``sympa update''" 4
.IX Item "sympa update"
Modify the existing list in the family
.ie n .IP """sympa upgrade""" 4
.el .IP "``sympa upgrade''" 4
.IX Item "sympa upgrade"
Upgrade Sympa
.ie n .IP """sympa upgrade_config_location""" 4
.el .IP "``sympa upgrade_config_location''" 4
.IX Item "sympa upgrade_config_location"
\&\s-1TBD\s0
.ie n .IP """sympa user""" 4
.el .IP "``sympa user''" 4
.IX Item "sympa user"
Manipulate list users
.ie n .IP """sympa version""" 4
.el .IP "``sympa version''" 4
.IX Item "sympa version"
Print the version number of Sympa
.SH "DESCRIPTION FOR EARLIER VERSION"
.IX Header "DESCRIPTION FOR EARLIER VERSION"
\&\fB\s-1NOTE\s0\fR:
Description in this section is kept for compatibility to earlier versions.
Run \f(CW\*(C`sympa help\*(C'\fR or see \fBsympa\fR\|(1) to see recent conventions.
.SS "Synopsis"
.IX Subsection "Synopsis"
\&\f(CW\*(C`sympa.pl\*(C'\fR [\ \f(CW\*(C`\-d,\ \-\-debug\*(C'\fR\ ] [\ \f(CW\*(C`\-f,\ \-\-file\*(C'\fR=\fIanother.sympa.conf\fR\ ]
[\ \f(CW\*(C`\-l,\ \-\-lang\*(C'\fR=\fIlang\fR\ ] [\ \f(CW\*(C`\-m,\ \-\-mail\*(C'\fR\ ]
[\ \f(CW\*(C`\-h,\ \-\-help\*(C'\fR\ ] [\ \f(CW\*(C`\-v,\ \-\-version\*(C'\fR\ ]

[\ \f(CW\*(C`\-\-add\*(C'\fR=\fIlist\fR@\fIdomain\fR\ [\-\-role=\fIrole\fR]\ [\-\-quiet]\ [\-\-notify]\ [\-\-force]\ ]
[\ \f(CW\*(C`\-\-del\*(C'\fR=\fIlist\fR@\fIdomain\fR\ [\-\-role=\fIrole\fR]\ [\-\-quiet]\ [\-\-notify]\ [\-\-force]\ ]
[\ \f(CW\*(C`\-\-open_list\*(C'\fR=\fIlist\fR[\fI\f(CI@robot\fI\fR]\ [\-\-notify]\ ]
[\ \f(CW\*(C`\-\-close_list\*(C'\fR=\fIlist\fR[\fI\f(CI@robot\fI\fR]\ ]
[\ \f(CW\*(C`\-\-purge_list\*(C'\fR=\fIlist\fR[\fI\f(CI@robot\fI\fR]\ ]
[\ \f(CW\*(C`\-\-lowercase\*(C'\fR\ ] [\ \f(CW\*(C`\-\-make_alias_file\*(C'\fR\ ]
[\ \f(CW\*(C`\-\-dump_users\*(C'\fR\ \f(CW\*(C`\-\-list\*(C'\fR=\fIlist\fR@\fIdomain\fR|ALL\ [\ \f(CW\*(C`\-\-role\*(C'\fR=\fIroles\fR\ ]\ ]
[\ \f(CW\*(C`\-\-restore_users\*(C'\fR\ \f(CW\*(C`\-\-list\*(C'\fR=\fIlist\fR@\fIdomain\fR|ALL\ [\ \f(CW\*(C`\-\-role\*(C'\fR=\fIroles\fR\ ]\ ]
[\ \f(CW\*(C`\-\-show_pending_lists\*(C'\fR=\fIrobot\fR\ ]
[\ \f(CW\*(C`\-\-rebuildarc\*(C'\fR=\fIlist\fR[\fI\f(CI@robot\fI\fR]\ ]
.SS "Options"
.IX Subsection "Options"
\&\fIsympa.pl\fR may run with following options in general.
.ie n .IP """\-d"", ""\-\-debug""" 4
.el .IP "\f(CW\-d\fR, \f(CW\-\-debug\fR" 4
.IX Item "-d, --debug"
Enable debug mode.
.ie n .IP """\-f"", ""\-\-config=""\fIfile\fR" 4
.el .IP "\f(CW\-f\fR, \f(CW\-\-config=\fR\fIfile\fR" 4
.IX Item "-f, --config=file"
Force Sympa to use an alternative configuration file instead
of \fI/etc/sympa/sympa/sympa.conf\fR.
.ie n .IP """\-l"", ""\-\-lang=""\fIlang\fR" 4
.el .IP "\f(CW\-l\fR, \f(CW\-\-lang=\fR\fIlang\fR" 4
.IX Item "-l, --lang=lang"
Set this option to use a language for Sympa. The corresponding
gettext catalog file must be located in \fI\f(CI$LOCALEDIR\fI\fR
directory.
.ie n .IP """\-\-log_level=""\fIlevel\fR" 4
.el .IP "\f(CW\-\-log_level=\fR\fIlevel\fR" 4
.IX Item "--log_level=level"
Sets Sympa log level.
.PP
With the following options \fIsympa.pl\fR will run in batch mode:
.ie n .IP """\-\-add=""\fIlist\fR@\fIdomain\fR [ ""\-\-role""=\fIrole\fR ] [ ""\-\-quiet"" ] [ ""\-\-notify"" ] [ ""\-\-force"" ]" 4
.el .IP "\f(CW\-\-add=\fR\fIlist\fR@\fIdomain\fR [ \f(CW\-\-role\fR=\fIrole\fR ] [ \f(CW\-\-quiet\fR ] [ \f(CW\-\-notify\fR ] [ \f(CW\-\-force\fR ]" 4
.IX Item "--add=list@domain [ --role=role ] [ --quiet ] [ --notify ] [ --force ]"
Add email(s) from the list. Data are read from standard input.
The data should contain one email address per line.
.Sp
Sample:
.Sp
.Vb 3
\&    ## emails to be added
\&    john.steward@some.company.com       John Steward
\&    mary.blacksmith@another.company.com Mary Blacksmith
.Ve
.Sp
Note:
This option was added on Sympa 6.2.67b.2.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa add"" [ ""\-\-role""=\fIrole\fR ] [ ""\-\-quiet"" ] [ ""\-\-notify"" ] [ ""\-\-force"" ] \fIlist\fR""@""\fIdomain\fR" 4
.el .IP "\f(CWsympa add\fR [ \f(CW\-\-role\fR=\fIrole\fR ] [ \f(CW\-\-quiet\fR ] [ \f(CW\-\-notify\fR ] [ \f(CW\-\-force\fR ] \fIlist\fR\f(CW@\fR\fIdomain\fR" 4
.IX Item "sympa add [ --role=role ] [ --quiet ] [ --notify ] [ --force ] list@domain"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-add_list=""\fIfamily_name\fR ""\-\-robot=""\fIrobot_name\fR ""\-\-input_file=""\fI/path/to/file.xml\fR" 4
.el .IP "\f(CW\-\-add_list=\fR\fIfamily_name\fR \f(CW\-\-robot=\fR\fIrobot_name\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR" 4
.IX Item "--add_list=family_name --robot=robot_name --input_file=/path/to/file.xml"
.PD
Add the list described by the file.xml under robot_name, to the family
family_name.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa create"" ""\-\-input_file=""\fI/path/to/file.xml\fR \fIfamily_name\fR""@@""\fIrobot_name\fR" 4
.el .IP "\f(CWsympa create\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR \fIfamily_name\fR\f(CW@@\fR\fIrobot_name\fR" 4
.IX Item "sympa create --input_file=/path/to/file.xml family_name@@robot_name"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-change_user_email"" ""\-\-current_email=""\fIcurrent\fR ""\-\-new_email=""\fInew\fR" 4
.el .IP "\f(CW\-\-change_user_email\fR \f(CW\-\-current_email=\fR\fIcurrent\fR \f(CW\-\-new_email=\fR\fInew\fR" 4
.IX Item "--change_user_email --current_email=current --new_email=new"
.PD
Changes a user email address in all Sympa  databases (subscriber_table,
list config, etc) for all virtual robots.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa user move"" \fIcurrent\fR \fInew\fR" 4
.el .IP "\f(CWsympa user move\fR \fIcurrent\fR \fInew\fR" 4
.IX Item "sympa user move current new"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-close_family=""\fIfamily_name\fR ""\-\-robot=""\fIrobot_name\fR" 4
.el .IP "\f(CW\-\-close_family=\fR\fIfamily_name\fR \f(CW\-\-robot=\fR\fIrobot_name\fR" 4
.IX Item "--close_family=family_name --robot=robot_name"
.PD
Close lists of family_name family under robot_name.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa close"" \fIfamily_name\fR""@@""\fIrobot_name\fR" 4
.el .IP "\f(CWsympa close\fR \fIfamily_name\fR\f(CW@@\fR\fIrobot_name\fR" 4
.IX Item "sympa close family_name@@robot_name"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-close_list=""\fIlist\fR[""@""\fIrobot\fR]" 4
.el .IP "\f(CW\-\-close_list=\fR\fIlist\fR[\f(CW@\fR\fIrobot\fR]" 4
.IX Item "--close_list=list[@robot]"
.PD
Close the list (changing its status to closed), remove aliases and remove
subscribers from \s-1DB\s0 (a dump is created in the list directory to allow
restoring the list)
.Sp
New command line format:
.RS 4
.ie n .IP """sympa close"" \fIlist\fR[""@""\fIrobot\fR]" 4
.el .IP "\f(CWsympa close\fR \fIlist\fR[\f(CW@\fR\fIrobot\fR]" 4
.IX Item "sympa close list[@robot]"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-conf_2_db""" 4
.el .IP "\f(CW\-\-conf_2_db\fR" 4
.IX Item "--conf_2_db"
.PD
Load sympa.conf and each robot.conf into database.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-copy_list=""\fIlistname\fR""@""\fIrobot\fR ""\-\-new_listname=""\fInewlistname\fR ""\-\-new_listrobot=""\fInewrobot\fR" 4
.el .IP "\f(CW\-\-copy_list=\fR\fIlistname\fR\f(CW@\fR\fIrobot\fR \f(CW\-\-new_listname=\fR\fInewlistname\fR \f(CW\-\-new_listrobot=\fR\fInewrobot\fR" 4
.IX Item "--copy_list=listname@robot --new_listname=newlistname --new_listrobot=newrobot"
Copy a list.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa move \-\-mode=copy"" \fIlistname\fR""@""\fIrobot\fR \fInewlistname\fR""@""\fInewrobot\fR" 4
.el .IP "\f(CWsympa move \-\-mode=copy\fR \fIlistname\fR\f(CW@\fR\fIrobot\fR \fInewlistname\fR\f(CW@\fR\fInewrobot\fR" 4
.IX Item "sympa move --mode=copy listname@robot newlistname@newrobot"
.PD 0
.ie n .IP """sympa copy"" \fIlistname\fR""@""\fIrobot\fR \fInewlistname\fR""@""\fInewrobot\fR" 4
.el .IP "\f(CWsympa copy\fR \fIlistname\fR\f(CW@\fR\fIrobot\fR \fInewlistname\fR\f(CW@\fR\fInewrobot\fR" 4
.IX Item "sympa copy listname@robot newlistname@newrobot"
.RE
.RS 4
.RE
.ie n .IP """\-\-create_list"" ""\-\-robot=""\fIrobot_name\fR ""\-\-input_file=""\fI/path/to/file.xml\fR" 4
.el .IP "\f(CW\-\-create_list\fR \f(CW\-\-robot=\fR\fIrobot_name\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR" 4
.IX Item "--create_list --robot=robot_name --input_file=/path/to/file.xml"
.PD
Create a list with the \s-1XML\s0 file under robot robot_name.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa create"" ""\-\-input_file=""\fI/path/to/file.xml\fR \fIrobot_name\fR" 4
.el .IP "\f(CWsympa create\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR \fIrobot_name\fR" 4
.IX Item "sympa create --input_file=/path/to/file.xml robot_name"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-del=""\fIlist\fR""@""\fIdomain\fR [ ""\-\-role""=\fIrole\fR ] [ ""\-\-quiet"" ] [ ""\-\-notify"" ] [ ""\-\-force"" ]" 4
.el .IP "\f(CW\-\-del=\fR\fIlist\fR\f(CW@\fR\fIdomain\fR [ \f(CW\-\-role\fR=\fIrole\fR ] [ \f(CW\-\-quiet\fR ] [ \f(CW\-\-notify\fR ] [ \f(CW\-\-force\fR ]" 4
.IX Item "--del=list@domain [ --role=role ] [ --quiet ] [ --notify ] [ --force ]"
.PD
Delete email(s) from the list. Data are read from standard input.
The data should contain one email address per line.
.Sp
Sample:
.Sp
.Vb 3
\&    ## emails to be deleted
\&    john.steward@some.company.com
\&    mary.blacksmith@another.company.com
.Ve
.Sp
Note:
This options was added on Sympa 6.2.67b.2.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa del"" [ ""\-\-role""=\fIrole\fR ] [ ""\-\-quiet"" ] [ ""\-\-notify"" ] [ ""\-\-force"" ] \fIlist\fR""@""\fIdomain\fR" 4
.el .IP "\f(CWsympa del\fR [ \f(CW\-\-role\fR=\fIrole\fR ] [ \f(CW\-\-quiet\fR ] [ \f(CW\-\-notify\fR ] [ \f(CW\-\-force\fR ] \fIlist\fR\f(CW@\fR\fIdomain\fR" 4
.IX Item "sympa del [ --role=role ] [ --quiet ] [ --notify ] [ --force ] list@domain"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-dump=""\fIlist\fR@\fIdomain\fR|""ALL""" 4
.el .IP "\f(CW\-\-dump=\fR\fIlist\fR@\fIdomain\fR|\f(CWALL\fR" 4
.IX Item "--dump=list@domain|ALL"
.PD
Obsoleted option.  Use \f(CW\*(C`\-\-dump_users\*(C'\fR.
.ie n .IP """\-\-dump_users"" ""\-\-list=""\fIlist\fR@\fIdomain\fR|""ALL"" [ ""\-\-role=""\fIroles\fR ]" 4
.el .IP "\f(CW\-\-dump_users\fR \f(CW\-\-list=\fR\fIlist\fR@\fIdomain\fR|\f(CWALL\fR [ \f(CW\-\-role=\fR\fIroles\fR ]" 4
.IX Item "--dump_users --list=list@domain|ALL [ --role=roles ]"
Dumps users of a list or all lists.
.Sp
\&\f(CW\*(C`\-\-role\*(C'\fR may specify \f(CW\*(C`member\*(C'\fR, \f(CW\*(C`owner\*(C'\fR, \f(CW\*(C`editor\*(C'\fR or any of them separated
by comma (\f(CW\*(C`,\*(C'\fR). Only \f(CW\*(C`member\*(C'\fR is chosen by default.
.Sp
Users are dumped in files \fIrole\fR\f(CW\*(C`.dump\*(C'\fR in each list directory.
.Sp
Note: On Sympa prior to 6.2.31b.1, subscribers were dumped in
\&\fIsubscribers.db.dump\fR file, and owners and moderators could not be dumped.
.Sp
See also \f(CW\*(C`\-\-restore_users\*(C'\fR.
.Sp
Note: This option replaced \f(CW\*(C`\-\-dump\*(C'\fR on Sympa 6.2.34.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa dump"" [ ""\-\-roles=""\fIroles\fR ] \fIlist\fR""@""\fIdomain\fR" 4
.el .IP "\f(CWsympa dump\fR [ \f(CW\-\-roles=\fR\fIroles\fR ] \fIlist\fR\f(CW@\fR\fIdomain\fR" 4
.IX Item "sympa dump [ --roles=roles ] list@domain"
.PD 0
.ie n .IP """sympa dump"" [ ""\-\-roles=""\fIroles\fR ] ""*""" 4
.el .IP "\f(CWsympa dump\fR [ \f(CW\-\-roles=\fR\fIroles\fR ] \f(CW``*''\fR" 4
.IX Item "sympa dump [ --roles=roles ] ""*"""
.RE
.RS 4
.RE
.ie n .IP """\-\-health_check""" 4
.el .IP "\f(CW\-\-health_check\fR" 4
.IX Item "--health_check"
.PD
Check if \fIsympa.conf\fR, \fIrobot.conf\fR of virtual robots and database structure
are correct.  If any errors occur, exits with non-zero status.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa check""" 4
.el .IP "\f(CWsympa check\fR" 4
.IX Item "sympa check"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-import=""\fIlist\fR@\fIdom\fR" 4
.el .IP "\f(CW\-\-import=\fR\fIlist\fR@\fIdom\fR" 4
.IX Item "--import=list@dom"
.PD
Deprecated.  Use \f(CW\*(C`\-\-add\*(C'\fR instead.
.ie n .IP """\-\-instantiate_family=""\fIfamily_name\fR ""\-\-robot=""\fIrobot_name\fR ""\-\-input_file=""\fI/path/to/file.xml\fR [ ""\-\-close_unknown"" ] [ ""\-\-quiet"" ]" 4
.el .IP "\f(CW\-\-instantiate_family=\fR\fIfamily_name\fR \f(CW\-\-robot=\fR\fIrobot_name\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR [ \f(CW\-\-close_unknown\fR ] [ \f(CW\-\-quiet\fR ]" 4
.IX Item "--instantiate_family=family_name --robot=robot_name --input_file=/path/to/file.xml [ --close_unknown ] [ --quiet ]"
Instantiate family_name lists described in the file.xml under robot_name.
The family directory must exist; automatically close undefined lists in a
new instantiation if \-\-close_unknown is specified; do not print report if
\&\f(CW\*(C`\-\-quiet\*(C'\fR is specified.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa instantiate"" ""\-\-input_file=""\fI/path/to/file.xml\fR [ ""\-\-close_unknown"" ] [ ""\-\-quiet"" ] \fIfamily_name\fR""@@""\fIrobot_name\fR" 4
.el .IP "\f(CWsympa instantiate\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR [ \f(CW\-\-close_unknown\fR ] [ \f(CW\-\-quiet\fR ] \fIfamily_name\fR\f(CW@@\fR\fIrobot_name\fR" 4
.IX Item "sympa instantiate --input_file=/path/to/file.xml [ --close_unknown ] [ --quiet ] family_name@@robot_name"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-lowercase""" 4
.el .IP "\f(CW\-\-lowercase\fR" 4
.IX Item "--lowercase"
.PD
Lowercases email addresses in database.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-make_alias_file"" [ ""\-\-robot"" robot ]" 4
.el .IP "\f(CW\-\-make_alias_file\fR [ \f(CW\-\-robot\fR robot ]" 4
.IX Item "--make_alias_file [ --robot robot ]"
Create an aliases file in /tmp/ with all list aliases. It uses the
\&\fIlist_aliases.tt2\fR template  (useful when list_aliases.tt2 was changed).
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-md5_encode_password""" 4
.el .IP "\f(CW\-\-md5_encode_password\fR" 4
.IX Item "--md5_encode_password"
Rewrite password in \f(CW\*(C`user_table\*(C'\fR of database using \s-1MD5\s0 fingerprint.
\&\s-1YOU CAN\s0'T \s-1UNDO\s0 unless you save this table first.
.Sp
\&\fBNote\fR that this option was obsoleted.
Use \fBupgrade_sympa_password\fR\|(1).
.ie n .IP """\-\-modify_list=""\fIfamily_name\fR ""\-\-robot=""\fIrobot_name\fR ""\-\-input_file=""\fI/path/to/file.xml\fR" 4
.el .IP "\f(CW\-\-modify_list=\fR\fIfamily_name\fR \f(CW\-\-robot=\fR\fIrobot_name\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR" 4
.IX Item "--modify_list=family_name --robot=robot_name --input_file=/path/to/file.xml"
Modify the existing list installed under the robot robot_name and that
belongs to the family family_name. The new description is in the \f(CW\*(C`file.xml\*(C'\fR.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa update"" ""\-\-input_file=""\fI/path/to/file.xml\fR \fIfamily_name\fR""@@""\fIrobot_name\fR" 4
.el .IP "\f(CWsympa update\fR \f(CW\-\-input_file=\fR\fI/path/to/file.xml\fR \fIfamily_name\fR\f(CW@@\fR\fIrobot_name\fR" 4
.IX Item "sympa update --input_file=/path/to/file.xml family_name@@robot_name"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-open_list=""\fIlist\fR[""@""\fIrobot\fR] [ ""\-\-notify"" ]" 4
.el .IP "\f(CW\-\-open_list=\fR\fIlist\fR[\f(CW@\fR\fIrobot\fR] [ \f(CW\-\-notify\fR ]" 4
.IX Item "--open_list=list[@robot] [ --notify ]"
.PD
Restore the closed list (changing its status to open), add aliases and restore
users to \s-1DB\s0 (dump files in the list directory are imported).
.Sp
The \f(CW\*(C`\-\-notify\*(C'\fR is optional. If present, the owner(s) of the list will be notified.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa open"" [ ""\-\-notify"" ] \fIlist\fR[""@""\fIrobot\fR]" 4
.el .IP "\f(CWsympa open\fR [ \f(CW\-\-notify\fR ] \fIlist\fR[\f(CW@\fR\fIrobot\fR]" 4
.IX Item "sympa open [ --notify ] list[@robot]"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-purge_list""=\fIlist\fR[""@""\fIrobot\fR]" 4
.el .IP "\f(CW\-\-purge_list\fR=\fIlist\fR[\f(CW@\fR\fIrobot\fR]" 4
.IX Item "--purge_list=list[@robot]"
.PD
Remove the list (remove archive, configuration files, users and owners in admin table. Restore is not possible after this operation.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa close"" ""\-\-mode=purge"" \fIlist\fR[""@""\fIrobot\fR]" 4
.el .IP "\f(CWsympa close\fR \f(CW\-\-mode=purge\fR \fIlist\fR[\f(CW@\fR\fIrobot\fR]" 4
.IX Item "sympa close --mode=purge list[@robot]"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-show_pending_lists""=\fIrobot\fR" 4
.el .IP "\f(CW\-\-show_pending_lists\fR=\fIrobot\fR" 4
.IX Item "--show_pending_lists=robot"
.PD
Print all pending lists for the robot, with information.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-rebuildarc""=\fIlist\fR[\fI\f(CI@robot\fI\fR]" 4
.el .IP "\f(CW\-\-rebuildarc\fR=\fIlist\fR[\fI\f(CI@robot\fI\fR]" 4
.IX Item "--rebuildarc=list[@robot]"
Rebuild the archives of the list.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-reload_list_config"" [ ""\-\-list=""\fImylist\fR@\fImydom\fR ] [ ""\-\-robot=""\fImydom\fR ]" 4
.el .IP "\f(CW\-\-reload_list_config\fR [ \f(CW\-\-list=\fR\fImylist\fR@\fImydom\fR ] [ \f(CW\-\-robot=\fR\fImydom\fR ]" 4
.IX Item "--reload_list_config [ --list=mylist@mydom ] [ --robot=mydom ]"
Recreates all \fIconfig.bin\fR files or cache in \f(CW\*(C`list_table\*(C'\fR.
You should run this command if you edit authorization scenarios.
The list and robot parameters are optional.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-rename_list=""\fIlistname\fR""@""\fIrobot\fR ""\-\-new_listname=""\fInewlistname\fR ""\-\-new_listrobot=""\fInewrobot\fR" 4
.el .IP "\f(CW\-\-rename_list=\fR\fIlistname\fR\f(CW@\fR\fIrobot\fR \f(CW\-\-new_listname=\fR\fInewlistname\fR \f(CW\-\-new_listrobot=\fR\fInewrobot\fR" 4
.IX Item "--rename_list=listname@robot --new_listname=newlistname --new_listrobot=newrobot"
Renames a list or move it to another virtual robot.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa move"" \fIlistname\fR""@""\fIrobot\fR \fInewlistname\fR""@""\fInewrobot\fR" 4
.el .IP "\f(CWsympa move\fR \fIlistname\fR\f(CW@\fR\fIrobot\fR \fInewlistname\fR\f(CW@\fR\fInewrobot\fR" 4
.IX Item "sympa move listname@robot newlistname@newrobot"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-send_digest"" [ ""\-\-keep_digest"" ]" 4
.el .IP "\f(CW\-\-send_digest\fR [ \f(CW\-\-keep_digest\fR ]" 4
.IX Item "--send_digest [ --keep_digest ]"
.PD
Send digest right now.
If \f(CW\*(C`\-\-keep_digest\*(C'\fR is specified, stocked digest will not be removed.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-restore_users"" ""\-\-list=""\fIlist\fR@\fIdomain\fR|""ALL"" [ ""\-\-role=""\fIroles\fR ]" 4
.el .IP "\f(CW\-\-restore_users\fR \f(CW\-\-list=\fR\fIlist\fR@\fIdomain\fR|\f(CWALL\fR [ \f(CW\-\-role=\fR\fIroles\fR ]" 4
.IX Item "--restore_users --list=list@domain|ALL [ --role=roles ]"
Restore users from files dumped by \f(CW\*(C`\-\-dump_users\*(C'\fR.
.Sp
Note: This option was added on Sympa 6.2.34.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa restore"" [ ""\-\-roles=""\fIroles\fR ] \fIlist\fR""@""\fIdomain\fR" 4
.el .IP "\f(CWsympa restore\fR [ \f(CW\-\-roles=\fR\fIroles\fR ] \fIlist\fR\f(CW@\fR\fIdomain\fR" 4
.IX Item "sympa restore [ --roles=roles ] list@domain"
.PD 0
.ie n .IP """sympa restore"" [ ""\-\-roles=""\fIroles\fR ] ""*""" 4
.el .IP "\f(CWsympa restore\fR [ \f(CW\-\-roles=\fR\fIroles\fR ] \f(CW``*''\fR" 4
.IX Item "sympa restore [ --roles=roles ] ""*"""
.RE
.RS 4
.RE
.ie n .IP """\-\-sync_include=""\fIlistname\fR""@""\fIrobot\fR [ ""\-\-role=""\fIrole\fR ]" 4
.el .IP "\f(CW\-\-sync_include=\fR\fIlistname\fR\f(CW@\fR\fIrobot\fR [ \f(CW\-\-role=\fR\fIrole\fR ]" 4
.IX Item "--sync_include=listname@robot [ --role=role ]"
.PD
Trigger update of the list users included from data sources.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa include"" [ ""\-\-role=""\fIrole\fR ] \fIlistname\fR""@""\fIrobot\fR" 4
.el .IP "\f(CWsympa include\fR [ \f(CW\-\-role=\fR\fIrole\fR ] \fIlistname\fR\f(CW@\fR\fIrobot\fR" 4
.IX Item "sympa include [ --role=role ] listname@robot"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-sync_list_db"" [ ""\-\-list=""\fIlistname\fR@\fIrobot\fR ]" 4
.el .IP "\f(CW\-\-sync_list_db\fR [ \f(CW\-\-list=\fR\fIlistname\fR@\fIrobot\fR ]" 4
.IX Item "--sync_list_db [ --list=listname@robot ]"
.PD
Syncs filesystem list configs to the database cache of list configs,
optionally syncs an individual list if specified.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.ie n .IP """\-\-test_database_message_buffer""" 4
.el .IP "\f(CW\-\-test_database_message_buffer\fR" 4
.IX Item "--test_database_message_buffer"
\&\fBNote\fR:
This option was deprecated.
.Sp
Test the database message buffer size.
.ie n .IP """\-\-upgrade"" [ ""\-\-from=""\fIX\fR ] [ ""\-\-to=""\fIY\fR ]" 4
.el .IP "\f(CW\-\-upgrade\fR [ \f(CW\-\-from=\fR\fIX\fR ] [ \f(CW\-\-to=\fR\fIY\fR ]" 4
.IX Item "--upgrade [ --from=X ] [ --to=Y ]"
Runs Sympa maintenance script to upgrade from version \fIX\fR to version \fIY\fR.
.Sp
New command line format:
.RS 4
.ie n .IP """sympa upgrade"" [ <\-\-from=>\fIX\fR ] [ ""\-\-to=""\fIY\fR ]" 4
.el .IP "\f(CWsympa upgrade\fR [ <\-\-from=>\fIX\fR ] [ \f(CW\-\-to=\fR\fIY\fR ]" 4
.IX Item "sympa upgrade [ <--from=>X ] [ --to=Y ]"
.RE
.RS 4
.RE
.PD 0
.ie n .IP """\-\-upgrade_shared"" [ ""\-\-list=""\fIX\fR ] [ ""\-\-robot=""\fIY\fR ]" 4
.el .IP "\f(CW\-\-upgrade_shared\fR [ \f(CW\-\-list=\fR\fIX\fR ] [ \f(CW\-\-robot=\fR\fIY\fR ]" 4
.IX Item "--upgrade_shared [ --list=X ] [ --robot=Y ]"
.PD
\&\fBNote\fR:
This option was deprecated.
See \fBupgrade_shared_repository\fR\|(1).
.Sp
Rename files in shared.
.Sp
New command line format:
.Sp
\&\s-1TBD.\s0
.PP
With following options \fIsympa.pl\fR will print some information and exit.
.ie n .IP """\-h"", ""\-\-help""" 4
.el .IP "\f(CW\-h\fR, \f(CW\-\-help\fR" 4
.IX Item "-h, --help"
Print this help message.
.ie n .IP """\-\-md5_digest=""\fIpassword\fR" 4
.el .IP "\f(CW\-\-md5_digest=\fR\fIpassword\fR" 4
.IX Item "--md5_digest=password"
Output a \s-1MD5\s0 digest of a password (useful for \s-1SOAP\s0 client trusted
application).
.ie n .IP """\-v"", ""\-\-version""" 4
.el .IP "\f(CW\-v\fR, \f(CW\-\-version\fR" 4
.IX Item "-v, --version"
Print the version number.
.PP
\&\fBEnd of description for earlier version\fR.
.SH "FILES"
.IX Header "FILES"
\&\fI/etc/sympa/sympa/sympa.conf\fR main configuration file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa_toc\fR\|(1).
.SH "HISTORY"
.IX Header "HISTORY"
\&\fIsympa.pl\fR was originally written by:
.IP "Serge Aumont" 4
.IX Item "Serge Aumont"
Comite\*' Re\*'seau des Universite\*'s
.IP "Olivier Salau\*:n" 4
.IX Item "Olivier Salau:n"
Comite\*' Re\*'seau des Universite\*'s
.PP
As of Sympa 6.2b.4, it was split into three programs:
\&\fIsympa.pl\fR command line utility, \fIsympa_automatic.pl\fR daemon and
\&\fIsympa_msg.pl\fR daemon.
.PP
As of Sympa 6.2.68, \fIsympa.pl\fR was renamed to \fIsympa\fR
and the new form of command line arguments was introduced.