sympa(1) - f37

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

NAME

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

SYNOPSIS

9       "sympa" command [ general options... ] ...
10

DESCRIPTION

12       NOTE: On overview of Sympa documentation see sympa_toc(1).
13
14       sympa is invoked from command line then performs various administration
15       tasks.
16

GENERAL OPTIONS

18       sympa may run with following options in general.
19
20       "-d", "--debug"
21           Enable debug mode.
22
23       "-f", "--config="file
24           Force Sympa to use an alternative configuration file instead of
25           /etc/sympa/sympa.conf.
26
27       "-l", "--lang="lang
28           Set this option to use a language for Sympa. The corresponding
29           gettext catalog file must be located in $LOCALEDIR directory.
30
31       "--log_level="level
32           Sets Sympa log level.
33
34       "-m", "--mail"
35           Enable SMTP logging.
36

COMMANDS

38       Currently following commands are available.  To see detail of each
39       command, run '"sympa help" command'.
40
41       "sympa add"
42           Add users to the list
43
44       "sympa bouncers"
45           Manipulate list bounced users
46
47       "sympa check"
48           Check environment
49
50       "sympa close"
51           Close a list or the lists belonging to a family
52
53       "sympa conf_2_db"
54           Load config into the database
55
56       "sympa config"
57           Manipulate configuration of Sympa
58
59       "sympa copy"
60           Copy the list
61
62       "sympa create"
63           Create a list
64
65       "sympa del"
66           Delete users from the list
67
68       "sympa dump"
69           Dump users of the lists
70
71       "sympa export_list"
72           TBD
73
74       "sympa help"
75           Display help information about Sympa CLI
76
77       "sympa include"
78           Update inclusion
79
80       "sympa instantiate"
81           Instantiate the lists in a family
82
83       "sympa lowercase"
84           Lowercase email addresses in database
85
86       "sympa make_alias_file"
87           Create aliases file
88
89       "sympa md5_digest"
90           Output a MD5 digest
91
92       "sympa move"
93           Move or copy the list
94
95       "sympa open"
96           Open the list
97
98       "sympa rebuildarc"
99           Rebuild the archives of the list
100
101       "sympa reload_list_config"
102           Recreate config cache of the lists
103
104       "sympa restore"
105           Restore users of the lists
106
107       "sympa review"
108           Show subscribers of the list
109
110       "sympa send_digest"
111           Send digest
112
113       "sympa show_pending_lists"
114           Show pending lists
115
116       "sympa sync_list_db"
117           Synchronize database cache of the lists
118
119       "sympa update"
120           Modify the existing list in the family
121
122       "sympa upgrade"
123           Upgrade Sympa
124
125       "sympa upgrade_config_location"
126           TBD
127
128       "sympa user"
129           Manipulate list users
130
131       "sympa version"
132           Print the version number of Sympa
133

DESCRIPTION FOR EARLIER VERSION

135       NOTE: Description in this section is kept for compatibility to earlier
136       versions.  Run "sympa help" or see sympa(1) to see recent conventions.
137
138   Synopsis
139       "sympa.pl" [ "-d, --debug" ] [ "-f, --file"=another.sympa.conf ]
140       [ "-l, --lang"=lang ] [ "-m, --mail" ] [ "-h, --help" ]
141       [ "-v, --version" ]
142
143       [ "--add"=list@domain [--role=role] [--quiet] [--notify] [--force] ]
144       [ "--del"=list@domain [--role=role] [--quiet] [--notify] [--force] ]
145       [ "--open_list"=list[@robot] [--notify] ]
146       [ "--close_list"=list[@robot] ] [ "--purge_list"=list[@robot] ]
147       [ "--lowercase" ] [ "--make_alias_file" ]
148       [ "--dump_users" "--list"=list@domain|ALL [ "--role"=roles ] ]
149       [ "--restore_users" "--list"=list@domain|ALL [ "--role"=roles ] ]
150       [ "--show_pending_lists"=robot ] [ "--rebuildarc"=list[@robot] ]
151
152   Options
153       sympa.pl may run with following options in general.
154
155       "-d", "--debug"
156           Enable debug mode.
157
158       "-f", "--config="file
159           Force Sympa to use an alternative configuration file instead of
160           /etc/sympa/sympa.conf.
161
162       "-l", "--lang="lang
163           Set this option to use a language for Sympa. The corresponding
164           gettext catalog file must be located in $LOCALEDIR directory.
165
166       "--log_level="level
167           Sets Sympa log level.
168
169       With the following options sympa.pl will run in batch mode:
170
171       "--add="list@domain [ "--role"=role ] [ "--quiet" ] [ "--notify" ] [
172       "--force" ]
173           Add email(s) from the list. Data are read from standard input.  The
174           data should contain one email address per line.
175
176           Sample:
177
178               ## emails to be added
179               john.steward@some.company.com       John Steward
180               mary.blacksmith@another.company.com Mary Blacksmith
181
182           Note: This option was added on Sympa 6.2.67b.2.
183
184           New command line format:
185
186           "sympa add" [ "--role"=role ] [ "--quiet" ] [ "--notify" ] [
187           "--force" ] list"@"domain
188       "--add_list="family_name "--robot="robot_name
189       "--input_file="/path/to/file.xml
190           Add the list described by the file.xml under robot_name, to the
191           family family_name.
192
193           New command line format:
194
195           "sympa create" "--input_file="/path/to/file.xml
196           family_name"@@"robot_name
197       "--change_user_email" "--current_email="current "--new_email="new
198           Changes a user email address in all Sympa  databases
199           (subscriber_table, list config, etc) for all virtual robots.
200
201           New command line format:
202
203           "sympa user move" current new
204       "--close_family="family_name "--robot="robot_name
205           Close lists of family_name family under robot_name.
206
207           New command line format:
208
209           "sympa close" family_name"@@"robot_name
210       "--close_list="list["@"robot]
211           Close the list (changing its status to closed), remove aliases and
212           remove subscribers from DB (a dump is created in the list directory
213           to allow restoring the list)
214
215           New command line format:
216
217           "sympa close" list["@"robot]
218       "--conf_2_db"
219           Load sympa.conf and each robot.conf into database.
220
221           New command line format:
222
223           TBD.
224
225       "--copy_list="listname"@"robot "--new_listname="newlistname
226       "--new_listrobot="newrobot
227           Copy a list.
228
229           New command line format:
230
231           "sympa move --mode=copy" listname"@"robot newlistname"@"newrobot
232           "sympa copy" listname"@"robot newlistname"@"newrobot
233       "--create_list" "--robot="robot_name "--input_file="/path/to/file.xml
234           Create a list with the XML file under robot robot_name.
235
236           New command line format:
237
238           "sympa create" "--input_file="/path/to/file.xml robot_name
239       "--del="list"@"domain [ "--role"=role ] [ "--quiet" ] [ "--notify" ] [
240       "--force" ]
241           Delete email(s) from the list. Data are read from standard input.
242           The data should contain one email address per line.
243
244           Sample:
245
246               ## emails to be deleted
247               john.steward@some.company.com
248               mary.blacksmith@another.company.com
249
250           Note: This options was added on Sympa 6.2.67b.2.
251
252           New command line format:
253
254           "sympa del" [ "--role"=role ] [ "--quiet" ] [ "--notify" ] [
255           "--force" ] list"@"domain
256       "--dump="list@domain|"ALL"
257           Obsoleted option.  Use "--dump_users".
258
259       "--dump_users" "--list="list@domain|"ALL" [ "--role="roles ]
260           Dumps users of a list or all lists.
261
262           "--role" may specify "member", "owner", "editor" or any of them
263           separated by comma (","). Only "member" is chosen by default.
264
265           Users are dumped in files role".dump" in each list directory.
266
267           Note: On Sympa prior to 6.2.31b.1, subscribers were dumped in
268           subscribers.db.dump file, and owners and moderators could not be
269           dumped.
270
271           See also "--restore_users".
272
273           Note: This option replaced "--dump" on Sympa 6.2.34.
274
275           New command line format:
276
277           "sympa dump" [ "--roles="roles ] list"@"domain
278           "sympa dump" [ "--roles="roles ] "*"
279       "--health_check"
280           Check if sympa.conf, robot.conf of virtual robots and database
281           structure are correct.  If any errors occur, exits with non-zero
282           status.
283
284           New command line format:
285
286           "sympa check"
287       "--import="list@dom
288           Deprecated.  Use "--add" instead.
289
290       "--instantiate_family="family_name "--robot="robot_name
291       "--input_file="/path/to/file.xml [ "--close_unknown" ] [ "--quiet" ]
292           Instantiate family_name lists described in the file.xml under
293           robot_name.  The family directory must exist; automatically close
294           undefined lists in a new instantiation if --close_unknown is
295           specified; do not print report if "--quiet" is specified.
296
297           New command line format:
298
299           "sympa instantiate" "--input_file="/path/to/file.xml [
300           "--close_unknown" ] [ "--quiet" ] family_name"@@"robot_name
301       "--lowercase"
302           Lowercases email addresses in database.
303
304           New command line format:
305
306           TBD.
307
308       "--make_alias_file" [ "--robot" robot ]
309           Create an aliases file in /tmp/ with all list aliases. It uses the
310           list_aliases.tt2 template  (useful when list_aliases.tt2 was
311           changed).
312
313           New command line format:
314
315           TBD.
316
317       "--md5_encode_password"
318           Rewrite password in "user_table" of database using MD5 fingerprint.
319           YOU CAN'T UNDO unless you save this table first.
320
321           Note that this option was obsoleted.  Use
322           upgrade_sympa_password(1).
323
324       "--modify_list="family_name "--robot="robot_name
325       "--input_file="/path/to/file.xml
326           Modify the existing list installed under the robot robot_name and
327           that belongs to the family family_name. The new description is in
328           the "file.xml".
329
330           New command line format:
331
332           "sympa update" "--input_file="/path/to/file.xml
333           family_name"@@"robot_name
334       "--open_list="list["@"robot] [ "--notify" ]
335           Restore the closed list (changing its status to open), add aliases
336           and restore users to DB (dump files in the list directory are
337           imported).
338
339           The "--notify" is optional. If present, the owner(s) of the list
340           will be notified.
341
342           New command line format:
343
344           "sympa open" [ "--notify" ] list["@"robot]
345       "--purge_list"=list["@"robot]
346           Remove the list (remove archive, configuration files, users and
347           owners in admin table. Restore is not possible after this
348           operation.
349
350           New command line format:
351
352           "sympa close" "--mode=purge" list["@"robot]
353       "--show_pending_lists"=robot
354           Print all pending lists for the robot, with informations.
355
356           New command line format:
357
358           TBD.
359
360       "--rebuildarc"=list[@robot]
361           Rebuild the archives of the list.
362
363           New command line format:
364
365           TBD.
366
367       "--reload_list_config" [ "--list="mylist@mydom ] [ "--robot="mydom ]
368           Recreates all config.bin files or cache in "list_table".  You
369           should run this command if you edit authorization scenarios.  The
370           list and robot parameters are optional.
371
372           New command line format:
373
374           TBD.
375
376       "--rename_list="listname"@"robot "--new_listname="newlistname
377       "--new_listrobot="newrobot
378           Renames a list or move it to another virtual robot.
379
380           New command line format:
381
382           "sympa move" listname"@"robot newlistname"@"newrobot
383       "--send_digest" [ "--keep_digest" ]
384           Send digest right now.  If "--keep_digest" is specified, stocked
385           digest will not be removed.
386
387           New command line format:
388
389           TBD.
390
391       "--restore_users" "--list="list@domain|"ALL" [ "--role="roles ]
392           Restore users from files dumped by "--dump_users".
393
394           Note: This option was added on Sympa 6.2.34.
395
396           New command line format:
397
398           "sympa restore" [ "--roles="roles ] list"@"domain
399           "sympa restore" [ "--roles="roles ] "*"
400       "--sync_include="listname"@"robot [ "--role="role ]
401           Trigger update of the list users included from data sources.
402
403           New command line format:
404
405           "sympa include" [ "--role="role ] listname"@"robot
406       "--sync_list_db" [ "--list="listname@robot ]
407           Syncs filesystem list configs to the database cache of list
408           configs, optionally syncs an individual list if specified.
409
410           New command line format:
411
412           TBD.
413
414       "--test_database_message_buffer"
415           Note: This option was deprecated.
416
417           Test the database message buffer size.
418
419       "--upgrade" [ "--from="X ] [ "--to="Y ]
420           Runs Sympa maintenance script to upgrade from version X to version
421           Y.
422
423           New command line format:
424
425           "sympa upgrade" [ <--from=>X ] [ "--to="Y ]
426       "--upgrade_shared" [ "--list="X ] [ "--robot="Y ]
427           Note: This option was deprecated.  See
428           upgrade_shared_repository(1).
429
430           Rename files in shared.
431
432           New command line format:
433
434           TBD.
435
436       With following options sympa.pl will print some information and exit.
437
438       "-h", "--help"
439           Print this help message.
440
441       "--md5_digest="password
442           Output a MD5 digest of a password (useful for SOAP client trusted
443           application).
444
445       "-v", "--version"
446           Print the version number.
447
448       End of description for earlier version.
449

FILES

451       /etc/sympa/sympa.conf main configuration file.
452

HISTORY

457       sympa.pl was originally written by:
458
459       Serge Aumont
460           Comite Reseau des Universites
461
462       Olivier Salauen
463           Comite Reseau des Universites
464
465       As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
466       line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
467
468       As of Sympa 6.2.68, sympa.pl was renamed to sympa and the new form of
469       command line arguments was introduced.
470
471
472
4736.2.70                            2022-12-11                          SYMPA(1)