1SYMPA(1) sympa 6.2.48 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] ]
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 Sample:
103 ## Data to be imported
105 ## email gecos
106 john.steward@some.company.com John - accountant
107 mary.blacksmith@another.company.com Mary - secretary
108 "--instantiate_family="family_name "--robot="robot_name
110 "--input_file="/path/to/file.xml [ "--close_unknown" ] [ "--quiet" ]
111 Instantiate family_name lists described in the file.xml under
112 robot_name. The family directory must exist; automatically close
113 undefined lists in a new instantiation if --close_unknown is
114 specified; do not print report if "--quiet" is specified.
115 "--lowercase"
117 Lowercases email addresses in database.
118 "--make_alias_file" [ "--robot" robot ]
120 Create an aliases file in /tmp/ with all list aliases. It uses the
121 list_aliases.tt2 template (useful when list_aliases.tt2 was
122 changed).
123 "--md5_encode_password"
125 Rewrite password in "user_table" of database using MD5 fingerprint.
126 YOU CAN'T UNDO unless you save this table first.
127 Note that this option was obsoleted. Use
129 upgrade_sympa_password(1).
130 "--modify_list="family_name "--robot="robot_name
132 "--input_file="/path/to/file.xml
133 Modify the existing list installed under the robot robot_name and
134 that belongs to the family family_name. The new description is in
135 the "file.xml".
136 "--open_list="list[@robot]
138 Restore the closed list (changing its status to open), add aliases
139 and restore users to DB (dump files in the list directory are
140 imported).
141 "--purge_list"=list[@robot]
143 Remove the list (remove archive, configuration files, users and
144 owners in admin table. Restore is not possible after this
145 operation.
146 "--show_pending_lists"=robot
148 Print all pending lists for the robot, with informations.
149 "--reload_list_config" [ "--list="mylist@mydom ] [ "--robot="mydom ]
151 Recreates all config.bin files or cache in "list_table". You
152 should run this command if you edit authorization scenarios. The
153 list and robot parameters are optional.
154 "--rename_list="listname@robot "--new_listname="newlistname
156 "--new_listrobot="newrobot
157 Renames a list or move it to another virtual robot.
158 "--send_digest" [ "--keep_digest" ]
160 Send digest right now. If "--keep_digest" is specified, stocked
161 digest will not be removed.
162 "--restore_users" "--list="list@domain|"ALL" [ "--role="roles ]
164 Restore users from files dumped by "--dump_users".
165 Note: This option was added on Sympa 6.2.34.
167 "--sync_include="listname@robot
169 Trigger the list members update.
170 "--sync_list_db" [ "--list="listname@robot ]
172 Syncs filesystem list configs to the database cache of list
173 configs, optionally syncs an individual list if specified.
174 "--test_database_message_buffer"
176 Note: This option was deprecated.
177 Test the database message buffer size.
179 "--upgrade" [ "--from="X ] [ "--to="Y ]
181 Runs Sympa maintenance script to upgrade from version X to version
182 Y.
183 "--upgrade_shared" [ "--list="X ] [ "--robot="Y ]
185 Note: This option was deprecated. See
186 upgrade_shared_repository(1).
187 Rename files in shared.
189 With following options sympa.pl will print some information and exit.
191 "-h", "--help"
193 Print this help message.
194 "--md5_digest="password
196 Output a MD5 digest of a password (useful for SOAP client trusted
197 application).
198 "-v", "--version"
200 Print the version number.
201
203 /etc/sympa/sympa.conf main configuration file.
204
206 sympa_toc(1).
207
209 This program was originally written by:
210 Serge Aumont
212 Comite Reseau des Universites
213 Olivier Salauen
215 Comite Reseau des Universites
216 As of Sympa 6.2b.4, it was split into three programs: sympa.pl command
218 line utility, sympa_automatic.pl daemon and sympa_msg.pl daemon.
2196.2.48 2019-11-29 SYMPA(1)