Commit 9b235f96 authored by sikeda's avatar sikeda
Browse files

[-dev] Merged PODs under doc/man8 to each program.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@9006 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 33fee6d7
man8_MANS = archived.8 bounced.8 alias_manager.8 sympa.8
man8_MANS = archived.8 bounced.8 alias_manager.8 bulk.8 spooler.8 sympa.8
EXTRA_DIST = archived.pod.in bounced.pod.in alias_manager.pod.in sympa.pod
CLEANFILES = $(man8_MANS)
CLEANFILES = $(man8_MANS) archived.pod bounced.pod alias_manager.pod
.pl.8:
.pod.8:
archived.8 bounced.8: Makefile
rm -f $@
$(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $< $@
--lax --release="$(VERSION)" $(srcdir)/../../wwsympa/$*.pl $@
archived.pod bounced.pod alias_manager.pod: Makefile
alias_manager.8 bulk.8 spooler.8 sympa.8: Makefile
rm -f $@
$(AM_V_GEN)$(SED) \
-e 's|--piddir--|$(piddir)|' \
-e 's|--libexecdir--|$(libexecdir)|' \
-e 's|--sysconfdir--|$(sysconfdir)|' \
-e 's|--defaultdir--|$(defaultdir)|' \
-e 's|--spooldir--|$(spooldir)|' \
-e 's|--docdir--|$(docdir)|' \
-e 's|--WWSCONFIG--|$(WWSCONFIG)|' \
-e 's|--SENDMAIL_ALIASES--|$(SENDMAIL_ALIASES)|' \
< $(srcdir)/$@.in > $@
$(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $(srcdir)/../../src/$*.pl $@
archived.pod: $(srcdir)/archived.pod.in
bounced.pod: $(srcdir)/bounced.pod.in
alias_manager.pod: $(srcdir)/alias_manager.pod.in
archived.8: $(srcdir)/../../wwsympa/archived.pl
bounced.8: $(srcdir)/../../wwsympa/bounced.pl
alias_manager.8: $(srcdir)/../../src/alias_manager.pl
bulk.8: $(srcdir)/../../src/bulk.pl
spooler.8: $(srcdir)/../../src/spooler.pl
sympa.8: $(srcdir)/../../src/sympa.pl
......@@ -77,7 +77,16 @@ alias_manager.pl bulk.pl task_manager.pl sympa.pl spooler.pl sympa_wizard.pl: Ma
rm -f $@
$(AM_V_GEN)$(SED) \
-e 's|--PERL--|$(PERL)|' \
-e 's|--defaultdir--|$(defaultdir)|' \
-e 's|--docdir--|$(docdir)|' \
-e 's|--libexecdir--|$(libexecdir)|' \
-e 's|--localedir--|$(localedir)|' \
-e 's|--modulesdir--|$(modulesdir)|' \
-e 's|--piddir--|$(piddir)|' \
-e 's|--spooldir--|$(spooldir)|' \
-e 's|--sysconfdir--|$(sysconfdir)|' \
-e 's|--CONFIG--|$(CONFIG)|' \
-e 's|--SENDMAIL_ALIASES--|$(SENDMAIL_ALIASES)|' \
< $(srcdir)/$@.in > $@
chmod +x $@
......
......@@ -27,11 +27,113 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
=encoding utf-8
=head1 NAME
alias_manager, alias_manager.pl - Manage Sympa aliases
=head1 SYNOPSIS
S<B<alias_manager> B<add> | B<del> I<listname> I<domain>>
=head1 DESCRIPTION
Alias_manager is a program that helps in installing aliases for newly
created lists and deleting aliases for closed lists.
It is called by
L<wwsympa.fcgi(8)> or L<sympa.pl(8)> via the I<aliaswrapper>.
Alias management is performed only if it was setup in F<--CONFIG-->
(C<sendmail_aliases> configuration parameter).
Administrators using MTA functionalities to manage aliases (ie
virtual_regexp and transport_regexp with postfix) can disable alias
management by setting
C<sendmail_aliases> configuration parameter to B<none>.
=head1 OPTIONS
=over 4
=item B<add> I<listname> I<domain>
Add the set of aliases for the mailing list I<listname> in the
domain I<domain>.
=item B<del> I<listname> I<domain>
Remove the set of aliases for the mailing list I<listname> in the
domain I<domain>.
=back
=head1 FILES
F<--SENDMAIL_ALIASES--> sendmail aliases file.
=head1 DOCUMENTATION
The full documentation in PDF format can be
found in F<--docdir--/sympa.pdf>.
The mailing lists (with web archives) can be accessed at
http://listes.renater.fr/sympa/lists/informatique/sympa.
=head1 AUTHORS
=over 4
=item Serge Aumont
ComitE<233> RE<233>seau des UniversitE<233>s
=item Olivier SalaE<252>n
ComitE<233> RE<233>seau des UniversitE<233>s
=back
Contact authors at <sympa-authors@renater.fr>
This manual page was initially written by
JE<233>rE<244>me Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system.
=head1 COPYRIGHT
Copyright E<169> 1997,1998,1999,2000,2001 ComitE<233> RE<233>seau des UniversitE<233>s
Copyright E<169> 1997,1998,1999 Institut Pasteur & Christophe Wolfhugel
You may distribute this software under the terms of the GNU General
Public License Version 2 (L<http://www.gnu.org/copyleft/gpl.html>)
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A
copy of the license can be found under
F</usr/share/common-licenses/FDL>
=head1 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa(8)>, L<sendmail(8)>.
=cut
$ENV{'PATH'} = '';
## Load Sympa.conf
use strict;
use lib '--modulesdir--';
use Getopt::Long;
use Pod::Usage;
use POSIX;
#use Conf; # load in Site - Robot
......@@ -40,6 +142,13 @@ use tt2;
#use Sympa::Constants; # load in confdef - Conf
use Robot;
my %options;
GetOptions(\%main::options, 'help|h');
if ($main::options{'help'}) {
pod2usage(0);
}
unless (Site->load('no_db' => 1)) {
printf STDERR
"Unable to load Sympa configuration, file %s or any of the virtual host robot.conf files contain errors. Exiting.\n",
......
......@@ -29,11 +29,29 @@
=head1 NAME
I<bulk.pl> - Daemon for submitting to smtp engine bulkmailer_table content.
I<bulk.pl> - Daemon for submitting to SMTP engine bulkmailer_table content.
=head1 DESCRIPTION
This script must be run along with sympa. It regularly checks the bulkmailer_table content and submit the messages it finds in it to the sendmail engine. Several deamon should be used on deferent server for hugue traffic.
This script must be run along with Sympa. It regularly checks the bulkmailer_table content and submit the messages it finds in it to the sendmail engine. Several daemon should be used on deferent server for huge traffic.
=head1 OPTIONS
=item B<-d>, B<--debug>
Sets the debug mode
=item B<-F>, B<--foreground>
Prevents the script from beeing daemonized
=item B<--log_level=>I<level>
Set log level.
=item B<-m>, B<--mail>
Logs every sendmail calls.
=cut
......@@ -41,6 +59,7 @@ use lib '--modulesdir--';
use strict;
use Getopt::Long;
use Pod::Uasage;
# tentative
use Data::Dumper;
......@@ -64,7 +83,8 @@ local $main::daemon_usage = 'DAEMON_MASTER'; ## Default is to launch bulk as mas
## --foreground : prevents the script from beeing daemonized
## --mail : logs every sendmail calls
my %options;
unless (&GetOptions(\%main::options, 'debug|d', 'foreground|F','mail|m')) {
unless (&GetOptions(\%main::options,
'debug|d', 'foreground|F', 'help|h', 'log_level=s', 'mail|m')) {
&Log::fatal_err("Unknown options.");
}
......@@ -75,6 +95,10 @@ if ($main::options{'debug'}) {
$main::options{'foreground'} = 1 if ($main::options{'debug'});
$main::options{'log_to_stderr'} = 1 if ($main::options{'debug'} || $main::options{'foreground'});
if ($main::optins{'help'}) {
pod2usage(0);
}
# Load sympa.conf
unless (Robot::get_robots()) {
print STDERR
......@@ -113,7 +137,7 @@ unless ($main::options{'debug'} || $main::options{'foreground'}) {
}
setpgrp(0, 0);
if ((my $child_pid = fork) != 0) {
&Log::do_log('info',"Starting bulk master daemon, pid %s",$child_pid);
&Log::do_log('info',"Starting bulk master daemon, PID %s",$child_pid);
exit(0);
}
}
......
......@@ -35,48 +35,44 @@ spooler.pl -- Sympa spooler
This daemon is the Sympa spooler that load into database (table spool_table)
messages from incoming spool.
=head2 Options
=head1 OPTIONS
=over 4
=item C<-d, --debug>
=item B<-d>, B<--debug>
Sets Sympa in debug mode.
Sets the daemon in debug mode.
=item C<-f, --config=FILE>
=item B<-f>, B<--config=>I<FILE>
Uses an alternative configuration file.
=item C<--foreground>
=item B<--foreground>
The process remains attached to the TTY.
=item C<-k, --keepcopy=dir>
=item B<-k>, B<--keepcopy=>I<DIRECTORY>
Keep a copy of incoming message.
=item C<--log_level=LEVEL>
=item B<--log_level=>I<LEVEL>
Sets Sympa log level.
Sets daemon log level.
=item C<--queue=PATH_TO_SPOOL>
=item B<--queue=>I<PATH_TO_SPOOL>
Override C<queue> Sympa parameter in order to choose spool location.
=item C<-h, --help>
=item B<-h>, B<--help>
Print this help.
=item C<-v, --version>
=item B<-v>, B<--version>
Print version number.
=back
=head1 AUTHORS
Sympa developers and contributors.
=cut
use strict;
......@@ -127,8 +123,8 @@ my %options;
unless (
&GetOptions(
\%main::options, 'debug|d',, 'log_level=s',
'foreground', 'keepcopy|k=s', 'queue=s', 'help',
'version'
'foreground', 'keepcopy|k=s', 'queue=s', 'help|h',
'version|v'
)
) {
Log::fatal_err("Unknown options.");
......
......@@ -25,164 +25,276 @@
=head1 NAME
sympa.pl - Sympa master daemon
sympa, sympa.pl - A Modern Mailing List Manager
=head1 SYNOPSIS
sympa.pl [OPTIONS]
S<B<sympa> [ B<-d, --debug> ] [ B<-f, --file>=I<another.sympa.conf> ]>
S<[ B<-k, --keepcopy>=I<directory> ]>
S<[ B<-l, --lang>=I<lang> ]> [ B<-m, --mail> ]
S<[ B<-h, --help> ]> [ B<-v, --version> ]
S<>
S<[ B<--import>=I<listname> ]> [ B<--close_list>=I<list[@robot]>][ B<--purge_list>=I<list[@robot]>]
S<[ B<--lowercase> ] [ B<--make_alias_file> ]>
S<[ B<--dump>=I<listname> | ALL]>
=head1 DESCRIPTION
Sympa is a mailing lists manager and comes with a complete (user and admin)
Web interface. Sympa can be linked to an LDAP directory or an RDBMS to
create dynamic mailing lists.
Sympa provides S/MIME and HTTPS based authentication and encryption.
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.
=head2 Options
=head1 OPTIONS
F<sympa.pl> may run with following options in general.
=over 4
=item C<--add_list=family_name --robot=robot_name
--input_file=/path/to/file.xml>
=item B<-d>, B<--debug>
Add the list described by the file.xml under robot_name, to the family
family_name.
Enable debug mode.
=item C<--change_user_email --current_email=xx --new_email=xx>
=item B<-f>, B<--config=>I<file>
Changes a user email address in all Sympa databases (subscriber_table,
list config, etc) for all virtual robots.
Force Sympa to use an alternative configuration file instead
of F<--CONFIG-->.
=item C<--close_family=family_name --robot=robot_name >
=item B<-l>, B<--lang=>I<lang>
Close lists of family_name family under robot_name.
Set this option to use a language for Sympa. The corresponding
gettext catalog file must be located in F<--localedir-->
directory.
=item C<--close_list=listname@robot>
=item B<--log_level=>I<level>
Close a list.
Sets Sympa log level.
=item C<--conf_2_db>
=back
Load sympa.conf and each robot.conf into database.
F<sympa.pl> may run in daemon mode with following options.
=item C<--config=FILE, -f>
=over 4
Uses an alternative configuration file.
=item B<--foreground>
=item C<--create_list --robot=robot_name --input_file=/path/to/file.xml >
The process remains attached to the TTY.
Create a list with the XML file under robot robot_name.
=item B<-k>, B<--keepcopy=>F<directory>
=item C<--debug, -d>
This option tells Sympa to keep a copy of every incoming message,
instead of deleting them. `directory' is the directory to
store messages.
Sets Sympa in debug mode.
=item B<-m>, B<--mail>
=item C<--dump=list@dom|ALL>
Sympa will log calls to sendmail, including recipients. This option is
useful for keeping track of each mail sent (log files may grow faster
though).
Dump subscribers.
=item B<--service=process_command>|B<process_message>|B<process_creation>
=item C<--foreground>
Process is dedicated to messages distribution, commands or to automatic lists
creation (default three of them).
The process remains attached to the TTY.
=back
=item C<--help, -h>
With the following options F<sympa.pl> will run in batch mode:
Print this help.
=over 4
=item C<--import=list@dom>
=item B<--add_list=>I<family_name> B<--robot=>I<robot_name>
B<--input_file=>I</path/to/file.xml>
Import subscribers (read from standard input).
Add the list described by the file.xml under robot_name, to the family
family_name.
=item C<--instantiate_family=family_name --robot=robot_name
--input_file=/path/to/file.xml [--close_unknown] [--quiet]>
=item B<--change_user_email> B<--current_email=>I<xx> B<--new_email=>I<xx>
Instantiate family_name lists described in the file.xml under robot_name.
The family directory must exist; automatically close undefined lists in a
new instantiation if --close_unknown is specified; do not print report if
C<--quiet> is specified.
Changes a user email address in all Sympa databases (subscriber_table,
list config, etc) for all virtual robots.
=item C<--keepcopy=dir, -k>
=item B<--close_family=>I<family_name> B<--robot=>I<robot_name>
Keep a copy of incoming message.
Close lists of family_name family under robot_name.
=item C<--lang=LANG, -l>
=item B<--close_list=>I<list[@robot]>
Use a language catalog for Sympa.
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)
=item C<--log_level=LEVEL>
=item B<--conf_2_db>
Sets Sympa log level.
Load sympa.conf and each robot.conf into database.
=item C<--lowercase>
=item B<--create_list> B<--robot=>I<robot_name>
B<--input_file=>I</path/to/file.xml >
Lowercase email addresses in database.
Create a list with the XML file under robot robot_name.
=item C<--mail, -m>
=item B<--dump=>I<list>@I<dom>|C<ALL>
Log calls to sendmail.
Dumps subscribers of for `listname' list or all lists. Subscribers are
dumped in subscribers.db.dump.
=item C<--make_alias_file>
=item B<--import=>I<list>@I<dom>
Create file with all aliases in /tmp (useful when list_aliases.tt2 was
changed).
Import subscribers in the list. Data are read from standard input.
The imported data should contain one entry per line : the first field
is an email address, the second (optional) field is the free form name.
Fields are spaces-separated.
=item C<--md5_digest=password>
Sample:
Output a MD5 digest of a password (useful for SOAP client trusted
application).
## Data to be imported
## email gecos
john.steward@some.company.com John - accountant
mary.blacksmith@another.company.com Mary - secretary
=item C<--md5_encode_password>
=item B<--instantiate_family=>I<family_name> B<--robot=>I<robot_name>
B<--input_file=>I</path/to/file.xml> [B<--close_unknown>] [B<--quiet>]
Instantiate family_name lists described in the file.xml under robot_name.
The family directory must exist; automatically close undefined lists in a
new instantiation if --close_unknown is specified; do not print report if
C<--quiet> is specified.
=item B<--lowercase>
Lowercases email addresses in database.
=item B<--make_alias_file>
Create an aliases file in /tmp/ with all list aliases. It uses the
F<list_aliases.tt2> template (useful when list_aliases.tt2 was changed).
=item B<--md5_encode_password>
Rewrite password in C<user_table> of database using MD5 fingerprint.
YOU CAN'T UNDO unless you save this table first.
=item C<--modify_list=family_name --robot=robot_name
--input_file=/path/to/file.xml>
=item B<--modify_list=>I<family_name> B<--robot=>I<robot_name>
B<--input_file=>I</path/to/file.xml>
Modify the existing list installed under the robot robot_name and that
belongs to the family family_name. The new description is in the C<file.xml>.
=item C<--purge_list=listname@robot>
=item B<--purge_list>=I<list>[@I<robot>]
Remove a list. No backup is possible.
Remove the list (remove archive, configuration files, users and owners in admin table. Restore is not possible after this operation.
=item C<--reload_list_config [--list=mylist@mydom] [--robot=mydom]>
=item B<--reload_list_config>
[B<--list=>I<mylist>@I<mydom>] [B<--robot=>I<mydom>]
Recreates all config.bin files. You should run this command if you edit
authorization scenarios. The list and robot parameters are optional.
=item C<--rename_list=listname@robot --new_listname=newlistname
--new_listrobot=newrobot>
=item B<--rename_list=>I<listname>@I<robot>
B<--new_listname=>I<newlistname> B<--new_listrobot=>I<newrobot>
Renames a list or move it to another virtual robot.
=item C<--service=process_command|process_message|process_creation>
Process is dedicated to messages distribution, commands or to automatic lists
creation (default three of them).
=item C<--sync_include=listname@robot>
=item B<--sync_include=>I<listname>@I<robot>
Trigger the list members update.
=item C<--test_database_message_buffer>
=item B<--test_database_message_buffer>
Test the database message buffer size.
=item C<--upgrade [--from=X] [--to=Y]>
=item B<--upgrade> [B<--from=>I<X>] [B<--to=>I<Y>]
Runs Sympa maintenance script to upgrade from version X to version Y.
Runs Sympa maintenance script to upgrade from version I<X> to version I<Y>.
=item C<--upgrade_shared --[listname=X] --[robot=Y]>
=item B<--upgrade_shared> [B<--listname=>I<X>] [B<--robot=>I<Y>]>
Rename files in shared.
=item C<--version>
=back
With following options F<sympa.pl> will print some information and exit.
=over 4
=item B<-h>, B<--help>
Print this help message.
=item B<--md5_digest=>I<password>
Output a MD5 digest of a password (useful for SOAP client trusted
application).
=item B<-v>, B<--version>
Print the version number.
=back
=head1 FILES
F<--CONFIG--> main configuration file.
F<--piddir--/sympa.pid> this file contains the process ID
of F<sympa.pl>.
=head1 AVAILABILITY
Print version number.
Latest version of B<Sympa> is available from L<http://www.sympa.org/>.
=head1 MORE DOCUMENTATION
The full documentation in PDF format can be
found in F<--docdir--/sympa.pdf>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
=head1 AUTHORS
=over 4
=item Serge Aumont
ComitE<233> RE<233>seau des UniversitE<233>s
=item Olivier SalaE<252>n
ComitE<233> RE<233>seau des UniversitE<233>s
=back