sympa(1) - f36

1SYMPA(1)                         sympa 6.2.68                         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 check"
45           Check environment
46
47       "sympa close"
48           Close a list or the lists belonging to a family
49
50       "sympa conf_2_db"
51           Load config into the database
52
53       "sympa copy"
54           Copy the list
55
56       "sympa create"
57           Create a list
58
59       "sympa del"
60           Delete users from the list
61
62       "sympa dump"
63           Dump users of the lists
64
65       "sympa export_list"
66           TBD
67
68       "sympa help"
69           Display help information about Sympa CLI
70
71       "sympa include"
72           Update inclusion
73
74       "sympa instantiate"
75           Instantiate the lists in a family
76
77       "sympa lowercase"
78           Lowercase email addresses in database
79
80       "sympa make_alias_file"
81           Create aliases file
82
83       "sympa md5_digest"
84           Output a MD5 digest
85
86       "sympa move"
87           Move or copy the list
88
89       "sympa open"
90           Open the list
91
92       "sympa rebuildarc"
93           Rebuild the archives of the list
94
95       "sympa reload_list_config"
96           Recreate config cache of the lists
97
98       "sympa restore"
99           Restore users of the lists
100
101       "sympa send_digest"
102           Send digest
103
104       "sympa show_pending_lists"
105           Show pending lists
106
107       "sympa sync_list_db"
108           Synchronize database cache of the lists
109
110       "sympa update"
111           Modify the existing list in the family
112
113       "sympa upgrade"
114           Upgrade Sympa
115
116       "sympa upgrade_config_location"
117           TBD
118
119       "sympa user"
120           Manipulate list users
121
122       "sympa version"
123           Print the version number of Sympa
124

DESCRIPTION FOR EARLIER VERSION

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

FILES

442       /etc/sympa/sympa.conf main configuration file.
443

HISTORY

448       sympa.pl was originally written by:
449
450       Serge Aumont
451           Comite Reseau des Universites
452
453       Olivier Salauen
454           Comite Reseau des Universites
455
456       As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
457       line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
458
459       As of Sympa 6.2.68, sympa.pl was renamed to sympa and the new form of
460       command line arguments was introduced.
461
462
463
4646.2.68                            2022-01-25                          SYMPA(1)