sympa_toc.pod 3.93 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
=encoding utf-8

=head1 NAME

sympa_toc - Documentation on Sympa - Table of Contents

=head1 DESCRIPTION

B<Sympa> is scalable and highly customizable mailing list manager.
It can cope with big lists (200,000 subscribers) and comes with
a complete (user and admin) Web interface. It is
internationalized, and supports the us, fr, de, es, it, fi, and
chinese locales. A scripting language allows you to extend the
behavior of commands. B<Sympa> can be linked to an LDAP directory
or an RDBMS to create dynamic mailing lists. B<Sympa> provides S/MIME
and HTTPS based authentication and encryption.
Sympa is a modern mailing-list manager. It supports a lot of useful
features.

20
Below is the list of documentation of Sympa.
21
22
23
24
25

=head2 Reference manual

=over

IKEDA Soji's avatar
IKEDA Soji committed
26
=item I<Sympa Administration Manual>
27

IKEDA Soji's avatar
IKEDA Soji committed
28
L<https://sympa-community.github.io/manual/>.
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

=back

=head2 Daemons

=over

=item L<archived(8)>

Mailing List Archiving Daemon for Sympa

=item L<bounced(8)>

Mailing List Bounce Processing Daemon for Sympa

=item L<bulk(8)>

sikeda's avatar
sikeda committed
46
Daemon for submitting messages to SMTP engine
47
48
49
50
51
52
53
54
55
56
57

=item L<sympa_automatic(8)>

Automatic list creation daemon

=item L<sympa_msg(8)>

Daemon to handle incoming messages

=item L<task_manager(8)>

IKEDA Soji's avatar
IKEDA Soji committed
58
Daemon to process periodical Sympa tasks
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

=back

=head2 Web interface

=over

=item L<sympa_soap_server(8)>

Sympa SOAP server

=item L<wwsympa(8)>

WWSympa, Sympa's web interface

=back

=head2 Shell Interface

=head3 Administration tools

=over

=item L<sympa(1)>

Command line utility to manage Sympa

=item L<sympa_newaliases(1)>

Alias database maintenance

=item L<sympa_wizard(1)>

Help Performing Sympa Initial Setup

=back

=head3 Maintenance tools

=over

=item L<arc2webarc(1)>

TBD.

=item L<init_comment(1)>

TBD.

=item L<mod2html(1)>

Generates HTML view of messages to be moderated

=item L<p12topem(1)>

TBD.

=item L<sympa_soap_client(1)>

TBD.

=item L<sympa_test_ldap(1)>

Testing LDAP connection for Sympa

=item L<testlogs(1)>

TBD.

=item L<tpl2tt2(1)>

TBD.

=item L<upgrade_bulk_spool(1)>

Migrating messages in bulk tables

=item L<upgrade_send_spool(1)>

Upgrade messages in incoming spool

140
141
142
143
=item L<upgrade_shared_repository(1)>

Encode file names in shared repositories.

144
145
146
147
148
149
150
151
152
153
154
155
=item L<upgrade_sympa_password(1)>

Upgrading password in database

=back

=head2 Auxiliary Programs

=over

=item L<alias_manager(8)>

156
Manage Sympa aliases (Obsoleted)
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

=item L<ldap_alias_manager(8)>

TBD.

=item L<mysql_alias_manager(8)>

TBD.

=item L<queue(8)>, L<bouncequeue(8)>, L<familyqueue(8)>

TBD.

=item L<sympa_newaliases-wrapper(8)>, L<sympa_soap_server-wrapper(8)>,
L<wwsympa-wrapper(8)>

TBD.

=back

=head2 Configuration files

=over

IKEDA Soji's avatar
IKEDA Soji committed
181
182
183
184
=item L<auth.conf(5)>

Configuration of authentication mechanisms for web interface of Sympa

185
186
=item L<charset.conf(5)>

187
Configuration file for legacy character set support by Sympa
188

IKEDA Soji's avatar
IKEDA Soji committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
=item L<crawlers_detection.conf(5)>

User agents to be excluded from session management

=item L<edit_list.conf(5)>

Configuration of privileges to edit list configuration

=item L<ldap_alias_manager.conf(5)>

Configuration of LDAP alias management

=item L<nrcpt_by_domain.conf(5)>

Grouping factor for SMTP sessions by recipient domains

205
=item L<sympa_config(5)>
206

207
Configuration files for Sympa mailing list manager
208

209
210
211
212
=item L<sympa_scenario(5)>

Authorization scenario

IKEDA Soji's avatar
IKEDA Soji committed
213
214
215
216
=item L<topics.conf(5)>

Configuration of list topics

217
218
219
220
221
222
223
224
225
226
227
228
=back

=head2 Internals

=over

=item L<Sympa::Internals(3)>

List of Sympa internal modules

=item L<sympa_database(5)>

229
Structure of Sympa core database
230
231
232
233
234

=back

=head1 AVAILABILITY

IKEDA Soji's avatar
IKEDA Soji committed
235
236
Latest version of B<Sympa> is available from
L<https://github.com/sympa-community/sympa/releases>.
237
238
239
240

=head1 MORE DOCUMENTATION

The full documentation in HTML format can be found in
IKEDA Soji's avatar
IKEDA Soji committed
241
L<https://sympa-community.github.io/manual/>.
242
243

The mailing lists (with web archives) can be accessed at
244
L<https://sympa-community.github.io/community/lists.html>.
245
246
247
248

=head1 BUGS

Report bugs to Sympa bug tracker.
249
See L<https://github.com/sympa-community/sympa/issues>.
250
251
252
253

=head1 SEE ALSO

=cut