File: node5.html

package info (click to toggle)
sympa 5.2.3-1.2%2Betch1
  • links: PTS
  • area: main
  • in suites: etch
  • size: 21,384 kB
  • ctags: 3,566
  • sloc: perl: 27,368; sh: 3,990; makefile: 1,366; ansic: 226; php: 105; lisp: 32
file content (353 lines) | stat: -rw-r--r-- 11,335 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<!--Converted with LaTeX2HTML 2002-2-1 (1.70)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>4. Running Sympa </TITLE>
<META NAME="description" CONTENT="4. Running Sympa ">
<META NAME="keywords" CONTENT="sympa">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="sympa.css">

<LINK REL="next" HREF="node6.html">
<LINK REL="previous" HREF="node4.html">
<LINK REL="up" HREF="sympa.html">
<LINK REL="next" HREF="node6.html">
</HEAD>

<BODY TEXT="#000000" BGCOLOR="#ffffff">
<!--Navigation Panel-->
<A NAME="tex2html838"
  HREF="node6.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html832"
  HREF="sympa.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html826"
  HREF="node4.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html834"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html836"
  HREF="node30.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html839"
  HREF="node6.html">5. Upgrading Sympa</A>
<B> Up:</B> <A NAME="tex2html833"
  HREF="sympa.html">Sympa Mailing Lists Management Software version</A>
<B> Previous:</B> <A NAME="tex2html827"
  HREF="node4.html">3. Installing Sympa</A>
 &nbsp; <B>  <A NAME="tex2html835"
  HREF="node1.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html837"
  HREF="node30.html">Index</A></B> 
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>

<UL>
<LI><A NAME="tex2html840"
  HREF="node5.html#SECTION00510000000000000000">4.1 sympa.pl</A>
<LI><A NAME="tex2html841"
  HREF="node5.html#SECTION00520000000000000000">4.2 INIT script</A>
<LI><A NAME="tex2html842"
  HREF="node5.html#SECTION00530000000000000000">4.3 Stopping <I>Sympa</I> and signals</A>
</UL>
<!--End of Table of Child-Links-->
<HR>

<H1><A NAME="SECTION00500000000000000000">
4. Running <I>Sympa</I> </A>
</H1>

<P>

<H1><A NAME="SECTION00510000000000000000"></A>
<A NAME="sympa.pl"></A>
<BR>
4.1 sympa.pl
</H1>

<P>
<A NAME="7266"></A><TT>sympa.pl</TT> is the main daemon ; it processes mail commands and is in charge of
messages distribution.

<P>
<A NAME="7269"></A><TT>sympa.pl</TT> recognizes the following command line arguments:

<P>

<UL>
<LI><A NAME="7272"></A><TT>- - debug</TT> | <A NAME="7275"></A><TT>-d</TT> 

<P>
Sets <I>Sympa</I> in debug mode and keeps it attached to the terminal. 
  Debugging information is output to STDERR, along with standard log
  information. Each function call is traced. Useful while reporting
  a bug.

<P>
</LI>
<LI><A NAME="7279"></A><TT>service</TT>  <I>process_command</I> | <I>process_message</I>

<P>
Sets <I>Sympa</I> daemon in way it process only message distribution (process_message) or in way it process only command (process_command).

<P>
</LI>
<LI><A NAME="7292"></A><TT>- - config <I>config_file</I></TT> | <A NAME="7307"></A><TT>-f <I>config_file</I></TT>

<P>
Forces <I>Sympa</I> to use an alternative configuration file. Default behavior is
  to use the configuration file as defined in the Makefile ($CONFIG).

<P>
</LI>
<LI><A NAME="7314"></A><TT>- - mail</TT> | <A NAME="7317"></A><TT>-m</TT> 

<P>
<I>Sympa</I> will log calls to sendmail, including recipients. Useful for
  keeping track of each mail sent (log files may grow faster though).

<P>
</LI>
<LI><A NAME="7330"></A><TT>- - lang <I>catalog</I></TT> | <A NAME="7345"></A><TT>-l <I>catalog</I></TT>

<P>
Set this option to use a language catalog for <I>Sympa</I>. 
  The corresponding catalog file must be located in <A NAME="7352"></A><TT>~sympa/locale</TT>
  directory. 

<P>
</LI>
<LI><A NAME="7366"></A><TT>- - keepcopy <I>recipient_directory</I></TT> | <A NAME="7381"></A><TT>-k <I>recipient_directory</I></TT>

<P>
This option tells Sympa to keep a copy of every incoming message,
  instead of deleting them. <I>recipient_directory</I> is the directory
  to store messages.

<P><PRE>
/home/sympa/bin/sympa.pl
</PRE>

<P>
</LI>
<LI><A NAME="7399"></A><TT>- - create_list - - robot <I>robotname</I> - - input_file <I>/path/to/list_file.xml</I></TT>

<P>
Create the list described by the xml file, see <A HREF="node19.html#list-creation-sympa">18.3</A>, 
page&nbsp;<A HREF="node19.html#list-creation-sympa"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.

<P>
</LI>
<LI><A NAME="7417"></A><TT>- - close_list <I>listname@robot</I></TT>

<P>
Close the list (changing its status to closed), remove aliases and remove
subscribers from DB (a dump is created in the list directory to allow restoring
the list). See <A HREF="#family-close-list"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>, page&nbsp;<A HREF="#family-close-list"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A> when you
are in a family context.

<P>
</LI>
<LI><A NAME="7435"></A><TT>- - dump <I>listname <TT>|</TT> ALL</I></TT>

<P>
Dumps subscribers of a list or all lists. Subscribers are dumped
  in <A NAME="7444"></A><TT>subscribers.db.dump</TT>.

<P>
</LI>
<LI><A NAME="7456"></A><TT>- - import <I>listname</I></TT>

<P>
Import subscribers in the <I>listname</I> list. Data are read from STDIN.

<P>
</LI>
<LI><A NAME="7462"></A><TT>- - lowercase</TT>

<P>
Lowercases e-mail addresses in database.

<P>
</LI>
<LI><A NAME="7465"></A><TT>- - help</TT> | <A NAME="7468"></A><TT>-h</TT>

<P>
Print usage of sympa.pl.

<P>
</LI>
<LI><A NAME="7471"></A><TT>- - make_alias_file</TT>

<P>
Create an aliases file in /tmp/ with all list aliases (only list which status is 'open'). It uses the list_aliases.tt2
template.

<P>
</LI>
<LI><A NAME="7474"></A><TT>- - version</TT> | <A NAME="7477"></A><TT>-v</TT>

<P>
Print current version of <I>Sympa</I>.

<P>
</LI>
<LI><A NAME="7496"></A><TT>- - instanciate_family <I>familyname</I> <I>robotname</I> - - input_file <I>/path/to/family_file.xml</I></TT>

<P>
Instantiate the family <I>familyname</I>. See <A HREF="node20.html#lists-families">19</A>, 
page&nbsp;<A HREF="node20.html#lists-families"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.

<P>
</LI>
<LI><A NAME="7520"></A><TT>- - close_family <I>familyname</I> - - robot <I>robotname</I></TT>

<P>
Close the <I>familyname</I> family. See <A HREF="node20.html#family-closure">19.2.4</A>, 
   page&nbsp;<A HREF="node20.html#family-closure"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.

<P>
</LI>
<LI><A NAME="7544"></A><TT>- - add_list <I>familyname</I> - - robot <I>robotname</I> - - input_file <I>/path/to/list_file.xml</I></TT>

<P>
Add the list described in the XML file to the <I>familyname</I> family. See <A HREF="node20.html#family-add-list">19.2.5</A>, 
   page&nbsp;<A HREF="node20.html#family-add-list"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.

<P>
</LI>
<LI><A NAME="7571"></A><TT>- - modify_list <I>familyname</I> - - robot <I>robotname</I> - - input_file <I>/path/to/list_file.xml</I></TT>

<P>
Modify the existing family list, with description contained in the XML file. See <A HREF="node20.html#family-modify-list">19.2.7</A>, 
   page&nbsp;<A HREF="node20.html#family-modify-list"><IMG  ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>.

<P>
</LI>
<LI><A NAME="7592"></A><TT>- - sync_include <I>listaddress</I> </TT>

<P>
Trigger an update of list members, usefull if the list uses
   external data sources.

<P>
</LI>
<LI><A NAME="7598"></A><TT>- - upgrade - - from=X - -to=Y </TT>

<P>
Runs Sympa maintenance script to upgrate from version X to version Y

<P>
</LI>
<LI><A NAME="7601"></A><TT>- - reload_list_config - -list=mylist@dom </TT>

<P>
Recreates all <A NAME="7604"></A><TT>configbin</TT> files. You should run this command if you edit authorization scenarios. The list parameter is optional.

<P>
</LI>
</UL>

<P>

<H1><A NAME="SECTION00520000000000000000"></A>
<A NAME="init"></A>
<BR>
4.2 INIT script
</H1>

<P>
The <A NAME="7607"></A><TT>make install</TT> step should have installed a sysV init script in
 your <A NAME="7610"></A><TT>/etc/rc.d/init.d/</TT> directory (you can change this at <A NAME="7613"></A><TT>configure</TT>
 time with the <A NAME="7616"></A><TT>-with-initdir</TT> option). You should edit your runlevels to make
 sure <I>Sympa</I> starts after Apache and MySQL. Note that <A NAME="7620"></A>MySQL should
 also start before <A NAME="7621"></A>Apache because of <A NAME="7622"></A><TT>wwsympa.fcgi</TT>.

<P>
This script starts these deamons : sympa.pl, task_manager.pl, archived.pl and bounced.pl.

<P>

<H1><A NAME="SECTION00530000000000000000"></A>
 <A NAME="stop-signals"></A> <A NAME="655"></A>
<BR>
4.3 Stopping <I>Sympa</I> and signals
</H1>

<P>

<H3><A NAME="SECTION00530100000000000000"></A><A NAME="7626"></A>
<BR>
4.3.0.1 <TT>kill -TERM</TT>
</H3>

<P>
When this signal is sent to sympa.pl (<A NAME="7629"></A><TT>kill -TERM</TT>), the daemon is stopped ending message distribution in progress 
 and this can be long (for big lists). If <A NAME="7632"></A><TT>kill -TERM</TT> is used, sympa.pl will stop immediatly whatever a distribution 
 message is in progress. In this case, when sympa.pl restart, message will distributed many times.

<P>

<H3><A NAME="SECTION00530200000000000000"></A><A NAME="7635"></A>
<BR>
4.3.0.2 <TT>kill -HUP</TT>
</H3>

<P>
When this signal is sent to sympa.pl (<A NAME="7638"></A><TT>kill -HUP</TT>), it switchs of the <A NAME="7641"></A><TT>-mail</TT> logging option
 and continues current task.

<P>

<HR>
<!--Navigation Panel-->
<A NAME="tex2html838"
  HREF="node6.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html832"
  HREF="sympa.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html826"
  HREF="node4.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html834"
  HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html836"
  HREF="node30.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html839"
  HREF="node6.html">5. Upgrading Sympa</A>
<B> Up:</B> <A NAME="tex2html833"
  HREF="sympa.html">Sympa Mailing Lists Management Software version</A>
<B> Previous:</B> <A NAME="tex2html827"
  HREF="node4.html">3. Installing Sympa</A>
 &nbsp; <B>  <A NAME="tex2html835"
  HREF="node1.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html837"
  HREF="node30.html">Index</A></B> 
<!--End of Navigation Panel-->
<ADDRESS>
root
2006-10-20
</ADDRESS>
</BODY>
</HTML>