Commit daa4fbf8 authored by sikeda's avatar sikeda
Browse files

[-dev] More documentation cleanups.


git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@9010 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent ae298a7a
......@@ -27,7 +27,8 @@ SUBDIRS = sample
EXTRA_DIST = $(pdf_DATA)
man1_MANS = sympa_wizard.1
man8_MANS = archived.8 bounced.8 alias_manager.8 bulk.8 spooler.8 sympa.8
man8_MANS = archived.8 bounced.8 \
alias_manager.8 bulk.8 spooler.8 sympa.8 task_manager.8
CLEANFILES = $(man1_MANS) $(man8_MANS)
......@@ -44,7 +45,7 @@ archived.8 bounced.8: Makefile
$(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $(srcdir)/../wwsympa/$*.pl $@
alias_manager.8 bulk.8 spooler.8 sympa.8: Makefile
alias_manager.8 bulk.8 spooler.8 sympa.8 task_manager.8: Makefile
rm -f $@
$(AM_V_GEN)$(POD2MAN) --section=8 --center="sympa $(VERSION)" \
--lax --release="$(VERSION)" $(srcdir)/../src/$*.pl $@
......@@ -56,3 +57,5 @@ 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
task_manager.8: $(srcdir)/../src/task_manager.pl
......@@ -31,11 +31,11 @@
=head1 NAME
alias_manager, alias_manager.pl - Manage Sympa aliases
alias_manager, alias_manager.pl - Manage Sympa Aliases
=head1 SYNOPSIS
S<B<alias_manager> B<add> | B<del> I<listname> I<domain>>
S<B<alias_manager.pl> B<add> | B<del> I<listname> I<domain>>
=head1 DESCRIPTION
......@@ -129,8 +129,8 @@ L<sympa(8)>, L<sendmail(8)>.
$ENV{'PATH'} = '';
## Load Sympa.conf
use strict;
use warnings;
use lib '--modulesdir--';
use Getopt::Long;
use Pod::Usage;
......
......@@ -21,19 +21,22 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
## Options : F -> do not detach TTY
## : d -> debug -d is equiv to -dF
## Now, it is impossible to use -dF but you have to write it -d -F
=encoding utf-8
=head1 NAME
I<bulk.pl> - Daemon for submitting to SMTP engine bulkmailer_table content.
bulk, bulk.pl - Daemon for Submitting Bulk Content to SMTP Engine
=head1 SYNOPSIS
S<B<bulk.pl> [ B<--foreground> ] [ B<--debug> ]>
=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 daemon should be used on deferent server for huge traffic.
This daemon must be run along with Sympa. It regularly checks the
C<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
......@@ -47,6 +50,10 @@ Sets the debug mode
Prevents the script from beeing daemonized
=item B<-h>, B<--help>
Prints this help message.
=item B<--log_level=>I<level>
Set log level.
......@@ -57,13 +64,35 @@ Logs every sendmail calls.
=back
=head1 FILES
F<--piddir--/bulk.pid> this file contains the process IDs
of F<bulk.pl>.
=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 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa(8)>, L<sendmail(8)>
=cut
use lib '--modulesdir--';
use strict;
use warnings;
use Getopt::Long;
use Pod::Uasage;
use Pod::Usage;
# tentative
use Data::Dumper;
......@@ -99,7 +128,7 @@ 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'}) {
if ($main::options{'help'}) {
pod2usage(0);
}
......
......@@ -23,10 +23,43 @@
# 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
p12topem.pl - Convert PKCS#12 certificates to PEM format
=head1 SYNOPSIS
p12topem.pl --pkcs12 <PKCS#12_cert_file> --listname <listname> or
p12topem.pl --pkcs12 <PKCS#12_cert_file> --robot <robot>
=head1 DESCRIPTION
This script is intended to convert a PKCS#12 certificates in PEM format
using Openssl. This is useful because most PKI providers deliver certificates
using a web interface so the certificate is stored in your browser.
When exporting a certificate from a browser (Netscape, IE, Mozilla etc)
the result is stored using PKCS#12 format. Sympa requires a pair of PEM
certificate and private key. You must then convert your PKCS#12 into PEM.
For a list certificate, the file will be installed in
$home_sympa/<listname>/cert.pem and $home_sympa/<listname>/private_key.
For Sympa itself a certificate will be installed in
$etc_sympa/<robot>/cert.pem and $etc_sympa/<robot>/private_key or
$etc_sympa/cert.pem and $etc_sympa/private_key.
You are then prompted for inpassword (the password used to encrypt the
PKCS#12 file).
=cut
use strict;
use lib '--modulesdir--';
use Getopt::Long;
use Pod::Usage;
#use Sympa::Constants; # used by Conf
#use Conf; # used in List - Robot - Site
......@@ -62,7 +95,7 @@ my $p12input = $main::options{'pkcs12'};
my ($cert,$privatekey,$inpass,$key);
if ($main::options{'help'} or ! -r $p12input or ($listname and $robot_id)) {
print_usage();
pod2usage(0);
}else{
if ($listname) {
my $list = List->new($listname);
......@@ -107,7 +140,7 @@ if ($main::options{'help'} or ! -r $p12input or ($listname and $robot_id)) {
unless ($outpass) {
system 'stty', '-echo';
printf "sympa password to protect list private key %s:", $key;
printf "Sympa password to protect list private key %s:", $key;
chop($outpass = <STDIN>);
print "\n";
system 'stty', 'echo';
......@@ -120,32 +153,6 @@ if ($main::options{'help'} or ! -r $p12input or ($listname and $robot_id)) {
exit;
}
sub print_usage {
print <<"EOF";
Usage p12topem.pl --pkcs12 <pkcs#12_cert_file> --listname <listname> or
p12topem.pl --pkcs12 <pkcs#12_cert_file> --robot <robot>
This script is intended to convert a PKCS#12 certificates in PEM format
using Openssl. This is usefull because most PKI providerd deliver certificates
using a web interface so the certificat is stored in your browser.
When exporting a certificate from a browser (Netscape, IE, Mozilla etc)
the result is stored using PKCS#12 format.Sympa requires a pair of PEM
certificat and private key. You must then convert your pkcs#12 into PEM.
For a list certificat, the file will be installed in
$home_sympa/<listname>/cert.pem and $home_sympa/<listname>/private_key
For Sympa itself a certificate will be installed in
$etc_sympa/<robot>/cert.pem and $etc_sympa/<robot>/private_key or
$etc_sympa/cert.pem and $etc_sympa/private_key
You are then prompted for inpassword (the password used to encrypt the
pkc#12 file).
EOF
unless ($outpass) {
print <<"EOF";
Because you did not configure Sympa's password \"key_passwd\" in
......
......@@ -24,11 +24,11 @@
=head1 NAME
spooler.pl -- Sympa spooler
spooler, spooler.pl -- Sympa Spooler
=head1 SYNOPSIS
spooler.pl [OPTIONS]
B<spooler.pl> [OPTIONS]
=head1 DESCRIPTION
......@@ -73,6 +73,32 @@ Print version number.
=back
=head1 FILES
F<--spooldir--/msg/> directory for incoming spool.
F<--spooldir--/bounce/> directory for bounce incoming spool.
F<--piddir--/spooler.pid> this file contains the process IDs
of F<spooler.pl>.
=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 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa(8)>
=cut
use strict;
......
......@@ -29,14 +29,16 @@ sympa, sympa.pl - A Modern Mailing List Manager
=head1 SYNOPSIS
S<B<sympa> [ B<-d, --debug> ] [ B<-f, --file>=I<another.sympa.conf> ]>
S<B<sympa.pl> [ 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<--import>=I<listname> ]>
S<[ B<--close_list>=I<list[@robot]> ]>
S<[ B<--purge_list>=I<list[@robot]> ]>
S<[ B<--lowercase> ] [ B<--make_alias_file> ]>
S<[ B<--dump>=I<listname> | ALL]>
S<[ B<--dump>=I<listname> | ALL ]>
=head1 DESCRIPTION
......@@ -98,11 +100,17 @@ 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).
=begin comment
=item B<--service=process_command>|B<process_message>|B<process_creation>
Process is dedicated to messages distribution, commands or to automatic lists
creation (default three of them).
B<Not implemented>.
=end comment
=back
With the following options F<sympa.pl> will run in batch mode:
......@@ -144,6 +152,19 @@ Create a list with the XML file under robot robot_name.
Dumps subscribers of for `listname' list or all lists. Subscribers are
dumped in subscribers.db.dump.
=begin comment
=item B<--export_list> [B<--robot=>I<robot_name>]
B<Not fully implemented>.
=end comment
=item B<--health_check>
Check if F<sympa.conf>, F<robot.conf> of virtual robots and database structure
are correct. If any errors occur, exits with non-zero status.
=item B<--import=>I<list>@I<dom>
Import subscribers in the list. Data are read from standard input.
......@@ -193,8 +214,9 @@ Remove the list (remove archive, configuration files, users and owners in admin
=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.
Recreates all F<config.bin> files or cache in C<list_table>.
You should run this command if you edit authorization scenarios.
The list and robot parameters are optional.
=item B<--rename_list=>I<listname>@I<robot>
B<--new_listname=>I<newlistname> B<--new_listrobot=>I<newrobot>
......@@ -205,6 +227,14 @@ Renames a list or move it to another virtual robot.
Trigger the list members update.
=begin comment
=item B<--sync_list_db>
B<Deprecated>. Use B<--reload_list_config>.
=end comment
=item B<--test_database_message_buffer>
Test the database message buffer size.
......@@ -213,7 +243,7 @@ Test the database message buffer size.
Runs Sympa maintenance script to upgrade from version I<X> to version I<Y>.
=item B<--upgrade_shared> [B<--listname=>I<X>] [B<--robot=>I<Y>]>
=item B<--upgrade_shared> [B<--list=>I<X>] [B<--robot=>I<Y>]>
Rename files in shared.
......
......@@ -21,7 +21,7 @@
=head1 NAME
sympa_wizard, sympa_wizard.pl - help performing Sympa initial setup
sympa_wizard, sympa_wizard.pl - Help Performing Sympa Initial Setup
=head1 SYNOPSIS
......@@ -71,6 +71,7 @@ Print version number.
use lib '--modulesdir--';
use strict;
use warnings;
use POSIX qw(strftime);
use English qw(-no_match_vars);
use Getopt::Long;
......
......@@ -21,12 +21,73 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
## Options : F -> do not detach TTY
## : d -> debug -d is equiv to -dF
=encoding utf-8
=head1 NAME
task_manager, task_manager.pl - Daemon to Process Periodical Sympa Tasks
=head1 SYNOPSIS
S<B<task_manager.pl> [ B<--foreground> ] [ B<--debug> ]>
=head1 DESCRIPTION
XXX @todo doc
=head1 OPTIONS
=over 4
=item B<-d>, B<--debug>
Sets the debug mode
=item B<-F>, B<--foreground>
Prevents the script from beeing daemonized
=item B<-h>, B<--help>
Prints this help message.
=item B<--log_level=>I<level>
Set log level.
=back
=head1 FILES
F<--spooldir--/task> directory for task spool.
F<--piddir--/task_manager.pid> this file contains the process ID
of F<task_manager.pl>.
=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 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa(8)>, L<wwsympa(8)>
=cut
use lib '--modulesdir--';
use strict "vars";
use warnings;
use Getopt::Long;
use Pod::Usage;
# tentative
use Data::Dumper;
......@@ -38,17 +99,17 @@ use List;
#use Task; # used by List
#use TaskSpool; # used by Task
#use tools; # used by Conf
##XXXuse wwslib; # no longer used
my $opt_d;
my $opt_F;
my %options;
unless (&GetOptions(\%main::options, 'debug|d', 'log_level=s', 'foreground')) {
&Log::fatal_err("Unknown options.");
unless (GetOptions(\%main::options,
'debug|d', 'help|h', 'log_level=s', 'foreground|F')) {
Log::fatal_err("Unknown options.");
}
# $main::options{'debug2'} = 1 if ($main::options{'debug'});
if ($main::options{'help'}) {
pod2usage(0);
}
if ($main::options{'debug'}) {
$main::options{'log_level'} = 2 unless ($main::options{'log_level'});
......
......@@ -33,7 +33,7 @@ archived, archived.pl - Mailing List Archiving Daemon for Sympa
=head1 SYNOPSIS
S<B<archived> [ B<-F> ] [ B<-d, -dF> ]>
S<B<archived.pl> [ B<--foreground> ] [ B<--debug> ]>
=head1 DESCRIPTION
......@@ -56,14 +56,18 @@ options is included below.
=over 5
=item B<-F>
=item B<-F>, B<--foreground>
Do not detach TTY.
=item B<-d>
=item B<-d>, B<--debug>
Run the program in a debug mode.
=item B<-h>, B<--help>
Print this help message.
=back
=head1 FILES
......@@ -134,9 +138,10 @@ L<sympa(8)>, L<bounced(8)>, L<mhonarc(1)>, L<sympa.conf(5)>.
use lib '--modulesdir--';
use strict;
#use Getopt::Std;
use warnings;
use Getopt::Long;
use Digest::MD5;
use Pod::Usage;
#use Archive; # used in List
use List;
......@@ -156,14 +161,16 @@ use Commands;
my $daemon_name = &Log::set_daemon($0);
my $ip = $ENV{'REMOTE_HOST'};
#getopts('dF');
## Check options
my %options;
unless (&GetOptions(\%main::options, 'debug|d', 'foreground|F')) {
unless (&GetOptions(\%main::options, 'debug|d', 'foreground|F', 'help|h')) {
&Log::fatal_err("Unknown options.");
}
if ($main::options{'help'}) {
pod2usage(0);
}
if ($main::options{'debug'}) {
$main::options{'log_level'} = 2 unless ($main::options{'log_level'});
}
......
......@@ -36,7 +36,7 @@ bounced, bounced.pl - Mailing List Bounce Processing Daemon for Sympa
=head1 SYNOPSIS
S<B<bounced> [ B<-F> ] [ B<-d, -dF> ]>
S<B<bounced> [ B<--foreground> ] [ B<--debug> ]>
=head1 DESCRIPTION
......@@ -55,14 +55,22 @@ options is included below.
=over 5
=item B<-F>
=item B<-F>, B<--foreground>
Do not detach TTY.
=item B<-d>, B<-dF>
=item B<-d>, B<--debug>
Run the program in a debug mode.
=item B<-h>, B<--help>
Print this help message.
=item B<--log_level=>I<level>
Sets daemon log level.
=back
=head1 FILES
......@@ -100,7 +108,8 @@ ComitE<233> RE<233>seau des UniversitE<233>s
Contact authors at <sympa-authors@renater.fr>
This manual page was initially written by JE<233>rE<244>me Marant <jerome.marant@IDEALX.org>
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
......@@ -117,7 +126,7 @@ 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<--docdir--/COPYING>.
F</usr/share/common-licenses/FDL>
=head1 BUGS
......@@ -126,7 +135,7 @@ See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa(8)>, L<archived(8)>, L<mhonarc(1)>, L<sympa.conf(5)>.
L<sympa(8)>, L<wwsympa(8)>, L<mhonarc(1)>, L<sympa.conf(5)>.
=cut
......@@ -136,9 +145,10 @@ L<sympa(8)>, L<archived(8)>, L<mhonarc(1)>, L<sympa.conf(5)>.
use lib '--modulesdir--';
use strict;
use warnings;
use FileHandle;
use Getopt::Long;
use Pod::Usage;
use POSIX;
use List;
......@@ -147,8 +157,13 @@ use BounceMessage;
## Check options
my %options;
unless (&GetOptions(\%main::options, 'debug|d','log_level=s','foreground|F')) {
&Log::fatal_err("Unknown options.");
unless (&GetOptions(\%main::options,
'debug|d', 'help|h', 'log_level=s','foreground|F')) {
Log::fatal_err("Unknown options.");
}
if ($main::options{'help'}) {
pod2usage(0);
}
if ($main::options{'debug'}) {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment