1SYMPA(1) sympa 6.2.54 SYMPA(1)
2
6 sympa, sympa.pl - Command line utility to manage Sympa
7
9 "sympa.pl" [ "-d, --debug" ] [ "-f, --file"=another.sympa.conf ]
10 [ "-l, --lang"=lang ] [ "-m, --mail" ] [ "-h, --help" ]
11 [ "-v, --version" ]
12 [ "--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 ]
19
21 NOTE: On overview of Sympa documentation see sympa_toc(1).
22 Sympa.pl is invoked from command line then performs various
24 administration tasks.
25
27 sympa.pl may run with following options in general.
28 "-d", "--debug"
30 Enable debug mode.
31 "-f", "--config="file
33 Force Sympa to use an alternative configuration file instead of
34 /etc/sympa/sympa.conf.
35 "-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 "--log_level="level
41 Sets Sympa log level.
42 With the following options sympa.pl will run in batch mode:
44 "--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 "--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 "--close_family="family_name "--robot="robot_name
55 Close lists of family_name family under robot_name.
56 "--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 "--conf_2_db"
63 Load sympa.conf and each robot.conf into database.
64 "--copy_list="listname@robot "--new_listname="newlistname
66 "--new_listrobot="newrobot
67 Copy a list.
68 "--create_list" "--robot="robot_name "--input_file="/path/to/file.xml
70 Create a list with the XML file under robot robot_name.
71 "--dump="list@domain|"ALL"
73 Obsoleted option. Use "--dump_users".
74 "--dump_users" "--list="list@domain|"ALL" [ "--role="roles ]
76 Dumps users of a list or all lists.
77 "--role" may specify "member", "owner", "editor" or any of them
79 separated by comma (","). Only "member" is chosen by default.
80 Users are dumped in files role".dump" in each list directory.
82 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 See also "--restore_users".
88 Note: This option replaced "--dump" on Sympa 6.2.34.
90 "--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 "--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 Use "--quiet" to prevent welcome emails.
103 Sample:
105 ## Data to be imported
107 ## email gecos
108 john.steward@some.company.com John - accountant
109 mary.blacksmith@another.company.com Mary - secretary
110 "--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 "--lowercase"
119 Lowercases email addresses in database.
120 "--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 "--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 Note that this option was obsoleted. Use
131 upgrade_sympa_password(1).
132 "--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 "--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 The "--notify" is optional. If present, the owner(s) of the list
145 will be notified.
146 "--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 "--show_pending_lists"=robot
153 Print all pending lists for the robot, with informations.
154 "--reload_list_config" [ "--list="mylist@mydom ] [ "--robot="mydom ]
156 Recreates all config.bin files or cache in "list_table". You
157 should run this command if you edit authorization scenarios. The
158 list and robot parameters are optional.
159 "--rename_list="listname@robot "--new_listname="newlistname
161 "--new_listrobot="newrobot
162 Renames a list or move it to another virtual robot.
163 "--send_digest" [ "--keep_digest" ]
165 Send digest right now. If "--keep_digest" is specified, stocked
166 digest will not be removed.
167 "--restore_users" "--list="list@domain|"ALL" [ "--role="roles ]
169 Restore users from files dumped by "--dump_users".
170 Note: This option was added on Sympa 6.2.34.
172 "--sync_include="listname@robot
174 Trigger the list members update.
175 "--sync_list_db" [ "--list="listname@robot ]
177 Syncs filesystem list configs to the database cache of list
178 configs, optionally syncs an individual list if specified.
179 "--test_database_message_buffer"
181 Note: This option was deprecated.
182 Test the database message buffer size.
184 "--upgrade" [ "--from="X ] [ "--to="Y ]
186 Runs Sympa maintenance script to upgrade from version X to version
187 Y.
188 "--upgrade_shared" [ "--list="X ] [ "--robot="Y ]
190 Note: This option was deprecated. See
191 upgrade_shared_repository(1).
192 Rename files in shared.
194 With following options sympa.pl will print some information and exit.
196 "-h", "--help"
198 Print this help message.
199 "--md5_digest="password
201 Output a MD5 digest of a password (useful for SOAP client trusted
202 application).
203 "-v", "--version"
205 Print the version number.
206
208 /etc/sympa/sympa.conf main configuration file.
209
211 sympa_toc(1).
212
214 This program was originally written by:
215 Serge Aumont
217 Comite Reseau des Universites
218 Olivier Salauen
220 Comite Reseau des Universites
221 As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
223 line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
2246.2.54 2020-03-02 SYMPA(1)