sympa(1) - f39

1SYMPA(1)                         sympa 6.2.72                         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
37       "--noout"
38           Skip output to the console except for fatal error messages.
39

COMMANDS

41       Currently following commands are available.  To see detail of each
42       command, run '"sympa help" command'.
43
44       "sympa add"
45           Add users to the list
46
47       "sympa bouncers"
48           Manipulate list bounced users
49
50       "sympa check"
51           Check environment
52
53       "sympa close"
54           Close a list or the lists belonging to a family
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 set"
114           Set properties of the users of the list
115
116       "sympa show_pending_lists"
117           Show pending lists
118
119       "sympa sync_list_db"
120           Synchronize database cache of the lists
121
122       "sympa test"
123           Test the functions of Sympa
124
125       "sympa update"
126           Modify the existing list in the family
127
128       "sympa upgrade"
129           Upgrade Sympa
130
131       "sympa upgrade_config_location"
132           TBD
133
134       "sympa user"
135           Manipulate list users
136
137       "sympa version"
138           Print the version number of Sympa
139

DESCRIPTION FOR EARLIER VERSION

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

FILES

456       /etc/sympa/sympa.conf main configuration file.
457

HISTORY

462       sympa.pl was originally written by:
463
464       Serge Aumont
465           Comité Réseau des Universités
466
467       Olivier Salaün
468           Comité Réseau des Universités
469
470       As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
471       line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
472
473       As of Sympa 6.2.68, sympa.pl was renamed to sympa and the new form of
474       command line arguments was introduced.
475
476       The "--noout" option was introduced on Sympa 6.2.71b.
477
478
479
4806.2.72                            2023-07-22                          SYMPA(1)