1SYMPA(1)                         sympa 6.2.62                         SYMPA(1)
2
3
4

NAME

6       sympa, sympa.pl - Command line utility to manage Sympa
7

SYNOPSIS

9       "sympa.pl" [ "-d, --debug" ] [ "-f, --file"=another.sympa.conf ]
10       [ "-l, --lang"=lang ] [ "-m, --mail" ] [ "-h, --help" ]
11       [ "-v, --version" ]
12
13       [ "--import"=listname ] [ "--open_list"=list[@robot] [--notify] ]
14       [ "--close_list"=list[@robot] ] [ "--purge_list"=list[@robot] ]
15       [ "--lowercase" ] [ "--make_alias_file" ]
16       [ "--dump_users" "--list"=list@domain|ALL [ "--role"=roles ] ]
17       [ "--restore_users" "--list"=list@domain|ALL [ "--role"=roles ] ]
18       [ "--show_pending_lists"=robot ] [ "--rebuildarc"=list[@robot] ]
19

DESCRIPTION

21       NOTE: On overview of Sympa documentation see sympa_toc(1).
22
23       Sympa.pl is invoked from command line then performs various
24       administration tasks.
25

OPTIONS

27       sympa.pl may run with following options in general.
28
29       "-d", "--debug"
30           Enable debug mode.
31
32       "-f", "--config="file
33           Force Sympa to use an alternative configuration file instead of
34           /etc/sympa/sympa.conf.
35
36       "-l", "--lang="lang
37           Set this option to use a language for Sympa. The corresponding
38           gettext catalog file must be located in $LOCALEDIR directory.
39
40       "--log_level="level
41           Sets Sympa log level.
42
43       With the following options sympa.pl will run in batch mode:
44
45       "--add_list="family_name "--robot="robot_name
46       "--input_file="/path/to/file.xml
47           Add the list described by the file.xml under robot_name, to the
48           family family_name.
49
50       "--change_user_email" "--current_email="xx "--new_email="xx
51           Changes a user email address in all Sympa  databases
52           (subscriber_table, list config, etc) for all virtual robots.
53
54       "--close_family="family_name "--robot="robot_name
55           Close lists of family_name family under robot_name.
56
57       "--close_list="list[@robot]
58           Close the list (changing its status to closed), remove aliases and
59           remove subscribers from DB (a dump is created in the list directory
60           to allow restoring the list)
61
62       "--conf_2_db"
63           Load sympa.conf and each robot.conf into database.
64
65       "--copy_list="listname@robot "--new_listname="newlistname
66       "--new_listrobot="newrobot
67           Copy a list.
68
69       "--create_list" "--robot="robot_name "--input_file="/path/to/file.xml
70           Create a list with the XML file under robot robot_name.
71
72       "--dump="list@domain|"ALL"
73           Obsoleted option.  Use "--dump_users".
74
75       "--dump_users" "--list="list@domain|"ALL" [ "--role="roles ]
76           Dumps users of a list or all lists.
77
78           "--role" may specify "member", "owner", "editor" or any of them
79           separated by comma (","). Only "member" is chosen by default.
80
81           Users are dumped in files role".dump" in each list directory.
82
83           Note: On Sympa prior to 6.2.31b.1, subscribers were dumped in
84           subscribers.db.dump file, and owners and moderators could not be
85           dumped.
86
87           See also "--restore_users".
88
89           Note: This option replaced "--dump" on Sympa 6.2.34.
90
91       "--health_check"
92           Check if sympa.conf, robot.conf of virtual robots and database
93           structure are correct.  If any errors occur, exits with non-zero
94           status.
95
96       "--import="list@dom
97           Import subscribers in the list. Data are read from standard input.
98           The imported data should contain one entry per line : the first
99           field is an email address, the second (optional) field is the free
100           form name.  Fields are spaces-separated.
101
102           Use "--quiet" to prevent welcome emails.
103
104           Sample:
105
106               ## Data to be imported
107               ## email        gecos
108               john.steward@some.company.com           John - accountant
109               mary.blacksmith@another.company.com     Mary - secretary
110
111       "--instantiate_family="family_name "--robot="robot_name
112       "--input_file="/path/to/file.xml [ "--close_unknown" ] [ "--quiet" ]
113           Instantiate family_name lists described in the file.xml under
114           robot_name.  The family directory must exist; automatically close
115           undefined lists in a new instantiation if --close_unknown is
116           specified; do not print report if "--quiet" is specified.
117
118       "--lowercase"
119           Lowercases email addresses in database.
120
121       "--make_alias_file" [ "--robot" robot ]
122           Create an aliases file in /tmp/ with all list aliases. It uses the
123           list_aliases.tt2 template  (useful when list_aliases.tt2 was
124           changed).
125
126       "--md5_encode_password"
127           Rewrite password in "user_table" of database using MD5 fingerprint.
128           YOU CAN'T UNDO unless you save this table first.
129
130           Note that this option was obsoleted.  Use
131           upgrade_sympa_password(1).
132
133       "--modify_list="family_name "--robot="robot_name
134       "--input_file="/path/to/file.xml
135           Modify the existing list installed under the robot robot_name and
136           that belongs to the family family_name. The new description is in
137           the "file.xml".
138
139       "--open_list="list[@robot] [--notify]
140           Restore the closed list (changing its status to open), add aliases
141           and restore users to DB (dump files in the list directory are
142           imported).
143
144           The "--notify" is optional. If present, the owner(s) of the list
145           will be notified.
146
147       "--purge_list"=list[@robot]
148           Remove the list (remove archive, configuration files, users and
149           owners in admin table. Restore is not possible after this
150           operation.
151
152       "--show_pending_lists"=robot
153           Print all pending lists for the robot, with informations.
154
155       "--rebuildarc"=list[@robot]
156           Rebuild the archives of the list.
157
158       "--reload_list_config" [ "--list="mylist@mydom ] [ "--robot="mydom ]
159           Recreates all config.bin files or cache in "list_table".  You
160           should run this command if you edit authorization scenarios.  The
161           list and robot parameters are optional.
162
163       "--rename_list="listname@robot "--new_listname="newlistname
164       "--new_listrobot="newrobot
165           Renames a list or move it to another virtual robot.
166
167       "--send_digest" [ "--keep_digest" ]
168           Send digest right now.  If "--keep_digest" is specified, stocked
169           digest will not be removed.
170
171       "--restore_users" "--list="list@domain|"ALL" [ "--role="roles ]
172           Restore users from files dumped by "--dump_users".
173
174           Note: This option was added on Sympa 6.2.34.
175
176       "--sync_include="listname@robot [ "--role="role ]
177           Trigger update of the list users included from data sources.
178
179       "--sync_list_db" [ "--list="listname@robot ]
180           Syncs filesystem list configs to the database cache of list
181           configs, optionally syncs an individual list if specified.
182
183       "--test_database_message_buffer"
184           Note: This option was deprecated.
185
186           Test the database message buffer size.
187
188       "--upgrade" [ "--from="X ] [ "--to="Y ]
189           Runs Sympa maintenance script to upgrade from version X to version
190           Y.
191
192       "--upgrade_shared" [ "--list="X ] [ "--robot="Y ]
193           Note: This option was deprecated.  See
194           upgrade_shared_repository(1).
195
196           Rename files in shared.
197
198       With following options sympa.pl will print some information and exit.
199
200       "-h", "--help"
201           Print this help message.
202
203       "--md5_digest="password
204           Output a MD5 digest of a password (useful for SOAP client trusted
205           application).
206
207       "-v", "--version"
208           Print the version number.
209

FILES

211       /etc/sympa/sympa.conf main configuration file.
212

SEE ALSO

214       sympa_toc(1).
215

HISTORY

217       This program was originally written by:
218
219       Serge Aumont
220           Comite Reseau des Universites
221
222       Olivier Salauen
223           Comite Reseau des Universites
224
225       As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
226       line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
227
228
229
2306.2.62                            2021-04-27                          SYMPA(1)
Impressum